`veryhigh.md`

252 строк · 27.4 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/c-api/veryhigh.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Слой очень высокого уровня89Функции этой главы позволяют выполнять исходный код Python, переданный в файле или буфере, но не дают возможности взаимодействовать с интерпретатором на более детальном уровне.1011Некоторые из этих функций принимают начальный символ из грамматики в качестве параметра. Доступные начальные символы: `Py_eval_input`, `Py_file_input` и `Py_single_input`. Они описаны после функций, которые принимают их в качестве параметров.1213Обратите также внимание, что некоторые из этих функций принимают параметры `FILE*`. Одна из проблем, требующих особой осторожности, заключается в том, что структура `FILE` для разных C-библиотек может быть разной и несовместимой. В Windows (по крайней мере) динамически связанные расширения могут использовать разные библиотеки, поэтому следует быть внимательным и передавать параметры `FILE*` этим функциям только в том случае, если есть уверенность, что они созданы той же библиотекой, которую использует среда выполнения Python.1415#### `int Py_Main(int argc, wchar_t **argv)`1617*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*1819Главная программа стандартного интерпретатора. Она доступна для программ, встраивающих Python. Параметры *argc* и *argv* следует подготовить так же, как они передаются функции `main()` программы на C (с преобразованием в wchar\_t в соответствии с локалью пользователя). Важно отметить, что список аргументов может быть изменён (но содержимое строк, на которые он указывает, не изменяется). Возвращаемое значение будет `0` при нормальном завершении интерпретатора (то есть без исключения), `1` при завершении из-за исключения или `2`, если список параметров не представляет собой допустимую командную строку Python.2021Обратите внимание: если возникло необрабатываемое иначе исключение [`SystemExit`](https://python-all.ru/3.10/library/exceptions.html#SystemExit), эта функция не возвращает `1`, а завершает процесс, при условии, что `Py_InspectFlag` не установлен.2223#### `int Py_BytesMain(int argc, char **argv)`2425*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) с версии 3.8.*2627Аналогична [`Py_Main()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_Main), но *argv* – это массив строк в байтах.2829Новое в версии 3.8.3031#### `int PyRun_AnyFile(FILE *fp, const char *filename)`3233Это упрощённый интерфейс к [`PyRun_AnyFileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_AnyFileExFlags) (см. ниже), в котором параметр *closeit* установлен в `0`, а *flags* – в `NULL`.3435#### `int PyRun_AnyFileFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)`3637Это упрощённый интерфейс к [`PyRun_AnyFileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_AnyFileExFlags) (см. ниже); аргумент *closeit* оставлен равным `0`.3839#### `int PyRun_AnyFileEx(FILE *fp, const char *filename, int closeit)`4041Это упрощённый интерфейс к [`PyRun_AnyFileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_AnyFileExFlags) (см. ниже); аргумент *flags* оставлен равным `NULL`.4243#### `int PyRun_AnyFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)`4445Если *fp* ссылается на файл, связанный с интерактивным устройством (консоль, терминальный ввод или Unix-псевдотерминал), возвращается значение [`PyRun_InteractiveLoop()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_InteractiveLoop); в противном случае возвращается результат [`PyRun_SimpleFile()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_SimpleFile). *filename* декодируется из кодировки файловой системы ([`sys.getfilesystemencoding()`](https://python-all.ru/3.10/library/sys.html#sys.getfilesystemencoding)). Если *filename* равно `NULL`, эта функция использует `"???"` в качестве имени файла. Если *closeit* истинно, файл закрывается до возврата `PyRun_SimpleFileExFlags()`.4647#### `int PyRun_SimpleString(const char *command)`4849Это упрощённый интерфейс к [`PyRun_SimpleStringFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_SimpleStringFlags) (см. ниже); аргумент [`PyCompilerFlags`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyCompilerFlags)\* оставлен равным `NULL`.5051#### `int PyRun_SimpleStringFlags(const char *command, PyCompilerFlags *flags)`5253Выполняет исходный код Python из *command* в модуле [`__main__`](https://python-all.ru/3.10/library/__main__.html#module-__main__) в соответствии с аргументом *flags*. Если [`__main__`](https://python-all.ru/3.10/library/__main__.html#module-__main__) не существует, он создаётся. Возвращает `0` при успехе или `-1`, если было возбуждено исключение. В случае ошибки получить информацию об исключении невозможно. Значение *flags* описано ниже.5455Обратите внимание: если возникло необрабатываемое иначе исключение [`SystemExit`](https://python-all.ru/3.10/library/exceptions.html#SystemExit), эта функция не возвращает `-1`, а завершает процесс, при условии, что `Py_InspectFlag` не установлен.5657#### `int PyRun_SimpleFile(FILE *fp, const char *filename)`5859Это упрощённый интерфейс к [`PyRun_SimpleFileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_SimpleFileExFlags) (см. ниже); *closeit* оставлен равным `0`, а *flags* – `NULL`.6061#### `int PyRun_SimpleFileEx(FILE *fp, const char *filename, int closeit)`6263Это упрощённый интерфейс к [`PyRun_SimpleFileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_SimpleFileExFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.6465#### `int PyRun_SimpleFileExFlags(FILE *fp, const char *filename, int closeit, PyCompilerFlags *flags)`6667Аналогично [`PyRun_SimpleStringFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_SimpleStringFlags), но исходный код Python читается из *fp*, а не из строки в памяти. *filename* должно быть именем файла; оно декодируется из [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.10/glossary.html#term-filesystem-encoding-and-error-handler). Если *closeit* истинно, файл закрывается до возврата `PyRun_SimpleFileExFlags()`.6869> **Примечание**70>71> В Windows *fp* должен быть открыт в бинарном режиме (например, `fopen(filename, "rb")`). В противном случае Python может некорректно обрабатывать файлы скриптов с концами строк LF.7273#### `int PyRun_InteractiveOne(FILE *fp, const char *filename)`7475Это упрощённый интерфейс к [`PyRun_InteractiveOneFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_InteractiveOneFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.7677#### `int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)`7879Читает и выполняет один оператор из файла, связанного с интерактивным устройством, в соответствии с аргументом *flags*. Пользователю выдаётся приглашение с помощью `sys.ps1` и `sys.ps2`. *filename* декодируется из [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.10/glossary.html#term-filesystem-encoding-and-error-handler).8081Возвращает `0` при успешном выполнении ввода, `-1` при возникновении исключения или код ошибки из заголовочного файла `errcode.h`, распространяемого в составе Python, в случае ошибки синтаксического анализа. (Обратите внимание, что `errcode.h` не включается `Python.h`, поэтому при необходимости его нужно включать отдельно.)8283#### `int PyRun_InteractiveLoop(FILE *fp, const char *filename)`8485Это упрощённый интерфейс к [`PyRun_InteractiveLoopFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_InteractiveLoopFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.8687#### `int PyRun_InteractiveLoopFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)`8889Читает и выполняет инструкции из файла, связанного с интерактивным устройством, до достижения EOF. Пользователю выводится приглашение с помощью `sys.ps1` и `sys.ps2`. *filename* декодируется из [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.10/glossary.html#term-filesystem-encoding-and-error-handler). Возвращает `0` при EOF или отрицательное число в случае ошибки.9091#### `int (*PyOS_InputHook)(void)`9293*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*9495Можно установить так, чтобы указывать на функцию с прототипом `int func(void)`. Эта функция будет вызываться, когда приглашение интерпретатора Python готовится перейти в состояние ожидания и ждёт ввода пользователя с терминала. Возвращаемое значение игнорируется. Переопределение этого хука можно использовать для интеграции приглашения интерпретатора с другими циклами событий, как это сделано в `Modules/_tkinter.c` в исходном коде Python.9697#### `char *(*PyOS_ReadlineFunctionPointer)(FILE*, FILE*, const char*)`9899Может быть установлен на функцию с прототипом `char *func(FILE *stdin, FILE *stdout, char *prompt)`, переопределяя стандартную функцию для чтения одной строки ввода в приглашении интерпретатора. Ожидается, что функция выведет строку *prompt*, если она не `NULL`, а затем прочитает строку ввода из предоставленного стандартного входного файла и вернёт полученную строку. Например, модуль [`readline`](https://python-all.ru/3.10/library/readline.html#module-readline) устанавливает этот хук для поддержки редактирования строки и автодополнения по табуляции.100101Результатом должна быть строка, выделенная с помощью [`PyMem_RawMalloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_RawMalloc) или [`PyMem_RawRealloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_RawRealloc), или `NULL`, если произошла ошибка.102103Изменено в версии 3.4: Результат должен выделяться с помощью [`PyMem_RawMalloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_RawMalloc) или [`PyMem_RawRealloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_RawRealloc), а не с помощью [`PyMem_Malloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_Malloc) или [`PyMem_Realloc()`](https://python-all.ru/3.10/c-api/memory.html#c.PyMem_Realloc).104105#### `PyObject *PyRun_String(const char *str, int start, PyObject *globals, PyObject *locals)`106107*Возвращаемое значение: новая ссылка.*108109Это упрощённый интерфейс к [`PyRun_StringFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_StringFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.110111#### `PyObject *PyRun_StringFlags(const char *str, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)`112113*Возвращаемое значение: новая ссылка.*114115Выполняет исходный код Python из *str* в контексте, заданном объектами *globals* и *locals*, с флагами компилятора, указанными в *flags*. *globals* должен быть словарём; *locals* может быть любым объектом, реализующим протокол отображения. Параметр *start* задаёт начальный токен, который следует использовать для разбора исходного кода.116117Возвращает результат выполнения кода в виде объекта Python, или `NULL`, если было возбуждено исключение.118119#### `PyObject *PyRun_File(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals)`120121*Возвращаемое значение: новая ссылка.*122123Это упрощённый интерфейс к [`PyRun_FileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_FileExFlags) (см. ниже), в котором параметр *closeit* установлен в `0`, а *flags* – в `NULL`.124125#### `PyObject *PyRun_FileEx(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit)`126127*Возвращаемое значение: новая ссылка.*128129Это упрощённый интерфейс к [`PyRun_FileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_FileExFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.130131#### `PyObject *PyRun_FileFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, PyCompilerFlags *flags)`132133*Возвращаемое значение: новая ссылка.*134135Это упрощённый интерфейс к [`PyRun_FileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_FileExFlags) (см. ниже), в котором параметр *closeit* установлен в `0`.136137#### `PyObject *PyRun_FileExFlags(FILE *fp, const char *filename, int start, PyObject *globals, PyObject *locals, int closeit, PyCompilerFlags *flags)`138139*Возвращаемое значение: новая ссылка.*140141Аналогично [`PyRun_StringFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_StringFlags), но исходный код Python читается из *fp*, а не из строки в памяти. *filename* должен быть именем файла, он декодируется из [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.10/glossary.html#term-filesystem-encoding-and-error-handler). Если *closeit* истинно, файл закрывается перед возвратом из [`PyRun_FileExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyRun_FileExFlags).142143#### `PyObject *Py_CompileString(const char *str, const char *filename, int start)`144145*Возвращаемое значение: новая ссылка.*146147*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*148149Это упрощённый интерфейс к [`Py_CompileStringFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileStringFlags) (см. ниже), в котором параметр *flags* установлен в `NULL`.150151#### `PyObject *Py_CompileStringFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags)`152153*Возвращаемое значение: новая ссылка.*154155Это упрощённый интерфейс к [`Py_CompileStringExFlags()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileStringExFlags) (см. ниже), в котором параметр *optimize* установлен в `-1`.156157#### `PyObject *Py_CompileStringObject(const char *str, PyObject *filename, int start, PyCompilerFlags *flags, int optimize)`158159*Возвращаемое значение: новая ссылка.*160161Разбирает и компилирует исходный код Python из *str*, возвращая полученный объект кода. Начальный токен задаётся *start*; его можно использовать для ограничения компилируемого кода; он должен быть `Py_eval_input`, `Py_file_input` или `Py_single_input`. Имя файла, указанное *filename*, используется для создания объекта кода и может появляться в сообщениях трассировки или [`SyntaxError`](https://python-all.ru/3.10/library/exceptions.html#SyntaxError) исключениях. Возвращает `NULL`, если код не удаётся разобрать или скомпилировать.162163Целое число *optimize* задаёт уровень оптимизации компилятора; значение `-1` выбирает уровень оптимизации интерпретатора, заданный опциями [`-O`](https://python-all.ru/3.10/using/cmdline.html#cmdoption-O). Явные уровни: `0` (без оптимизации; `__debug__` истинно), `1` (утверждения удалены, `__debug__` ложно) или `2` (докстринги также удалены).164165Новое в версии 3.4.166167#### `PyObject *Py_CompileStringExFlags(const char *str, const char *filename, int start, PyCompilerFlags *flags, int optimize)`168169*Возвращаемое значение: новая ссылка.*170171Как [`Py_CompileStringObject()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileStringObject), но *filename* – это байтовая строка, декодированная из [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.10/glossary.html#term-filesystem-encoding-and-error-handler).172173Новое в версии 3.2.174175#### `PyObject *PyEval_EvalCode(PyObject *co, PyObject *globals, PyObject *locals)`176177*Возвращаемое значение: новая ссылка.*178179*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*180181Это упрощённый интерфейс к [`PyEval_EvalCodeEx()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyEval_EvalCodeEx), содержащий только объект кода, а также глобальные и локальные переменные. Остальные аргументы устанавливаются в `NULL`.182183#### `PyObject *PyEval_EvalCodeEx(PyObject *co, PyObject *globals, PyObject *locals, PyObject *const *args, int argcount, PyObject *const *kws, int kwcount, PyObject *const *defs, int defcount, PyObject *kwdefs, PyObject *closure)`184185*Возвращаемое значение: новая ссылка.*186187*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*188189Выполняет предварительно скомпилированный объект кода в заданном окружении для его вычисления. Это окружение состоит из словаря глобальных переменных, объекта отображения локальных переменных, массивов аргументов, ключевых слов и значений по умолчанию, словаря значений по умолчанию для [только ключевых](https://python-all.ru/3.10/glossary.html#keyword-only-parameter) аргументов и кортежа замыкания с ячейками.190191#### `type PyFrameObject`192193*Часть [Limited API](https://python-all.ru/3.10/c-api/stable.html#stable) (как непрозрачная структура).*194195C-структура объектов, используемых для описания объектов фреймов. Поля этого типа могут быть изменены в любой момент.196197#### `PyObject *PyEval_EvalFrame(PyFrameObject *f)`198199*Возвращаемое значение: новая ссылка.*200201*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*202203Выполняет фрейм исполнения. Это упрощённый интерфейс к [`PyEval_EvalFrameEx()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.PyEval_EvalFrameEx), обеспечивающий обратную совместимость.204205#### `PyObject *PyEval_EvalFrameEx(PyFrameObject *f, int throwflag)`206207*Возвращаемое значение: новая ссылка.*208209*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*210211Это основная, неприукрашенная функция интерпретации Python. Выполняется объект кода, связанный с фреймом исполнения *f*, с интерпретацией байткода и вызовом функций по мере необходимости. Дополнительный параметр *throwflag* в основном можно игнорировать – если он равен true, то немедленно возбуждается исключение; это используется для методов [`throw()`](https://python-all.ru/3.10/reference/expressions.html#generator.throw) объектов-генераторов.212213Изменено в версии 3.4: Эта функция теперь включает отладочное утверждение, помогающее гарантировать, что она не игнорирует активное исключение без уведомления.214215#### `int PyEval_MergeCompilerFlags(PyCompilerFlags *cf)`216217Эта функция изменяет флаги текущего фрейма вычислений и возвращает true в случае успеха, false в случае ошибки.218219#### `int Py_eval_input`220221Стартовый символ из грамматики Python для изолированных выражений; используется с [`Py_CompileString()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileString).222223#### `int Py_file_input`224225Стартовый символ из грамматики Python для последовательностей операторов, читаемых из файла или другого источника; используется с [`Py_CompileString()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileString). Это символ, который следует использовать при компиляции произвольно длинного исходного кода Python.226227#### `int Py_single_input`228229Начальный символ грамматики Python для одного оператора; используется с [`Py_CompileString()`](https://python-all.ru/3.10/c-api/veryhigh.html#c.Py_CompileString). Этот символ используется в интерактивном цикле интерпретатора.230231#### `struct PyCompilerFlags`232233Это структура, используемая для хранения флагов компилятора. Если код только компилируется, она передаётся как `int flags`, а если код выполняется, она передаётся как `PyCompilerFlags *flags`. В этом случае `from __future__ import` может изменять *flags*.234235Когда `PyCompilerFlags *flags` равно `NULL`, `cf_flags` рассматривается как равный `0`, и любые изменения, вызванные `from __future__ import`, отбрасываются.236237#### `int cf_flags`238239Флаги компилятора.240241#### `int cf_feature_version`242243*cf\_feature\_version* – это минорная версия Python. Его следует инициализировать значением `PY_MINOR_VERSION`.244245По умолчанию это поле игнорируется; оно используется только в том случае, если флаг `PyCF_ONLY_AST` установлен в *cf\_flags*.246247Изменено в версии 3.8: Добавлено поле *cf\_feature\_version*.248249#### `int CO_FUTURE_DIVISION`250251Этот бит можно установить в *flags*, чтобы оператор деления `/` интерпретировался как «истинное деление» в соответствии с [**PEP 238**](https://python-all.ru/3.10/c-api/veryhigh.html).252