> **Источник:** https://python-all.ru/3.12/c-api/init.html > > «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor. --- # Инициализация, финализация и потоки См. также [Конфигурация инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). ## Перед инициализацией Python В приложении, внедряющем Python, функция [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize) должна быть вызвана до использования любых других функций Python/C API; за исключением нескольких функций и [глобальных переменных конфигурации](https://python-all.ru/3.12/c-api/init.html#global-conf-vars). Следующие функции можно безопасно вызывать до инициализации Python: - Функции конфигурации: - [`PyImport_AppendInittab()`](https://python-all.ru/3.12/c-api/import.html#c.PyImport_AppendInittab) - [`PyImport_ExtendInittab()`](https://python-all.ru/3.12/c-api/import.html#c.PyImport_ExtendInittab) - `PyInitFrozenExtensions()` - [`PyMem_SetAllocator()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_SetAllocator) - [`PyMem_SetupDebugHooks()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_SetupDebugHooks) - [`PyObject_SetArenaAllocator()`](https://python-all.ru/3.12/c-api/memory.html#c.PyObject_SetArenaAllocator) - [`Py_SetPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetPath) - [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName) - [`Py_SetPythonHome()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetPythonHome) - [`Py_SetStandardStreamEncoding()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetStandardStreamEncoding) - [`PySys_AddWarnOption()`](https://python-all.ru/3.12/c-api/sys.html#c.PySys_AddWarnOption) - [`PySys_AddXOption()`](https://python-all.ru/3.12/c-api/sys.html#c.PySys_AddXOption) - [`PySys_ResetWarnOptions()`](https://python-all.ru/3.12/c-api/sys.html#c.PySys_ResetWarnOptions) - Информационные функции: - [`Py_IsInitialized()`](https://python-all.ru/3.12/c-api/init.html#c.Py_IsInitialized) - [`PyMem_GetAllocator()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_GetAllocator) - [`PyObject_GetArenaAllocator()`](https://python-all.ru/3.12/c-api/memory.html#c.PyObject_GetArenaAllocator) - [`Py_GetBuildInfo()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetBuildInfo) - [`Py_GetCompiler()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetCompiler) - [`Py_GetCopyright()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetCopyright) - [`Py_GetPlatform()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPlatform) - [`Py_GetVersion()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetVersion) - Утилиты: - [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) - Распределители памяти: - [`PyMem_RawMalloc()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_RawMalloc) - [`PyMem_RawRealloc()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_RawRealloc) - [`PyMem_RawCalloc()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_RawCalloc) - [`PyMem_RawFree()`](https://python-all.ru/3.12/c-api/memory.html#c.PyMem_RawFree) > **Примечание** > > Следующие функции **нельзя вызывать** до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize): [`Py_EncodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_EncodeLocale), [`Py_GetPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPath), [`Py_GetPrefix()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPrefix), [`Py_GetExecPrefix()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetExecPrefix), [`Py_GetProgramFullPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetProgramFullPath), [`Py_GetPythonHome()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPythonHome), [`Py_GetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetProgramName) и [`PyEval_InitThreads()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_InitThreads). ## Глобальные переменные конфигурации В Python есть переменные глобальной конфигурации, управляющие различными возможностями и настройками. По умолчанию эти флаги задаются [параметрами командной строки](https://python-all.ru/3.12/using/cmdline.html#using-on-interface-options). Когда флаг устанавливается через параметр, значение флага равно количеству раз, которое этот параметр был указан. Например, `-b` устанавливает [`Py_BytesWarningFlag`](https://python-all.ru/3.12/c-api/init.html#c.Py_BytesWarningFlag) в 1, а `-bb` устанавливает [`Py_BytesWarningFlag`](https://python-all.ru/3.12/c-api/init.html#c.Py_BytesWarningFlag) в 2. #### `int Py_BytesWarningFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.bytes_warning`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.bytes_warning). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Выдавать предупреждение при сравнении [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes) или [`bytearray`](https://python-all.ru/3.12/library/stdtypes.html#bytearray) с [`str`](https://python-all.ru/3.12/library/stdtypes.html#str) или [`bytes`](https://python-all.ru/3.12/library/stdtypes.html#bytes) с [`int`](https://python-all.ru/3.12/library/functions.html#int). Если значение больше или равно `2`, выдавать ошибку. Устанавливается опцией [`-b`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-b). Устарело с версии 3.12. #### `int Py_DebugFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.parser_debug`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.parser_debug). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Включает отладочный вывод парсера (только для экспертов, зависит от опций компиляции). Устанавливается опцией [`-d`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-d) и переменной окружения [`PYTHONDEBUG`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONDEBUG). Устарело с версии 3.12. #### `int Py_DontWriteBytecodeFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.write_bytecode`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.write_bytecode). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Если установлено ненулевое значение, Python не будет пытаться записывать файлы `.pyc` при импорте исходных модулей. Устанавливается опцией [`-B`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-B) и переменной окружения [`PYTHONDONTWRITEBYTECODE`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONDONTWRITEBYTECODE). Устарело с версии 3.12. #### `int Py_FrozenFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.pathconfig_warnings`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.pathconfig_warnings); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Подавляет сообщения об ошибках при вычислении пути поиска модулей в [`Py_GetPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPath). Внутренний флаг, используемый программами `_freeze_module` и `frozenmain`. Устарело с версии 3.12. #### `int Py_HashRandomizationFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.hash_seed`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.hash_seed) и [`PyConfig.use_hash_seed`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.use_hash_seed); см. [конфигурацию инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливается в `1`, если переменная окружения [`PYTHONHASHSEED`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONHASHSEED) установлена в непустую строку. Если флаг ненулевой, читает переменную окружения [`PYTHONHASHSEED`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONHASHSEED) для инициализации секретного начального значения хеша. Устарело с версии 3.12. #### `int Py_IgnoreEnvironmentFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.use_environment`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.use_environment); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Игнорировать все переменные окружения `PYTHON*`, например [`PYTHONPATH`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONPATH) и [`PYTHONHOME`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONHOME), которые могли быть установлены. Устанавливается параметрами [`-E`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-E) и [`-I`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-I). Устарело с версии 3.12. #### `int Py_InspectFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.inspect`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.inspect); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Если скрипт передан первым аргументом или используется параметр [`-c`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-c), после выполнения скрипта или команды перейти в интерактивный режим, даже если [`sys.stdin`](https://python-all.ru/3.12/library/sys.html#sys.stdin) не является терминалом. Устанавливается опцией [`-i`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-i) и переменной окружения [`PYTHONINSPECT`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONINSPECT). Устарело с версии 3.12. #### `int Py_InteractiveFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.interactive`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.interactive); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливается опцией [`-i`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-i). Устарело с версии 3.12. #### `int Py_IsolatedFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.isolated`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.isolated); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Запуск Python в изолированном режиме. В изолированном режиме [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path) не содержит ни каталог скрипта, ни каталог site-packages пользователя. Устанавливается опцией [`-I`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-I). Добавлено в версии 3.4. Устарело с версии 3.12. #### `int Py_LegacyWindowsFSEncodingFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyPreConfig.legacy_windows_fs_encoding`](https://python-all.ru/3.12/c-api/init_config.html#c.PyPreConfig.legacy_windows_fs_encoding); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Если флаг ненулевой, используется кодировка `mbcs` с обработчиком ошибок `replace` вместо кодировки UTF-8 с обработчиком ошибок `surrogatepass` для [кодировки файловой системы и обработчика ошибок](https://python-all.ru/3.12/glossary.html#term-filesystem-encoding-and-error-handler). Устанавливается в `1`, если переменная окружения [`PYTHONLEGACYWINDOWSFSENCODING`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONLEGACYWINDOWSFSENCODING) установлена в непустую строку. См. [**PEP 529**](https://python-all.ru/3.12/c-api/init.html) для подробностей. [Доступность](https://python-all.ru/3.12/library/intro.html#availability): Windows. Устарело с версии 3.12. #### `int Py_LegacyWindowsStdioFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.legacy_windows_stdio`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.legacy_windows_stdio); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Если флаг ненулевой, используется [`io.FileIO`](https://python-all.ru/3.12/library/io.html#io.FileIO) вместо `io._WindowsConsoleIO` для [`sys`](https://python-all.ru/3.12/library/sys.html#module-sys) стандартных потоков. Устанавливается в `1`, если переменная окружения [`PYTHONLEGACYWINDOWSSTDIO`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONLEGACYWINDOWSSTDIO) установлена в непустую строку. См. [**PEP 528**](https://python-all.ru/3.12/c-api/init.html) для подробностей. [Доступность](https://python-all.ru/3.12/library/intro.html#availability): Windows. Устарело с версии 3.12. #### `int Py_NoSiteFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.site_import`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.site_import); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Отключает импорт модуля [`site`](https://python-all.ru/3.12/library/site.html#module-site) и связанные с ним site-зависимые манипуляции с [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path). Также отключает эти манипуляции, если [`site`](https://python-all.ru/3.12/library/site.html#module-site) явно импортирован позже (для их выполнения следует вызвать [`site.main()`](https://python-all.ru/3.12/library/site.html#site.main)). Устанавливается опцией [`-S`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-S). Устарело с версии 3.12. #### `int Py_NoUserSiteDirectory` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.user_site_directory`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.user_site_directory); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Не добавляет [`user site-packages directory`](https://python-all.ru/3.12/library/site.html#site.USER_SITE) в [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path). Устанавливается параметрами [`-s`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-s) и [`-I`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-I), а также переменной окружения [`PYTHONNOUSERSITE`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONNOUSERSITE). Устарело с версии 3.12. #### `int Py_OptimizeFlag` Этот API сохранён для обратной совместимости: следует использовать настройку [`PyConfig.optimization_level`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.optimization_level); см. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливается опцией [`-O`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-O) и переменной окружения [`PYTHONOPTIMIZE`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONOPTIMIZE). Устарело с версии 3.12. #### `int Py_QuietFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.quiet`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.quiet). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Не выводить сообщения об авторских правах и версии, даже в интерактивном режиме. Устанавливается опцией [`-q`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-q). Добавлено в версии 3.2. Устарело с версии 3.12. #### `int Py_UnbufferedStdioFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.buffered_stdio`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.buffered_stdio). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Принудительно отключает буферизацию потоков stdout и stderr. Устанавливается опцией [`-u`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-u) и переменной окружения [`PYTHONUNBUFFERED`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONUNBUFFERED). Устарело с версии 3.12. #### `int Py_VerboseFlag` Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.verbose`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.verbose). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Выводит сообщение каждый раз при инициализации модуля, указывая, откуда он загружается (имя файла или встроенный модуль). Если значение больше или равно `2`, выводит сообщение для каждого файла, который проверяется при поиске модуля. Также предоставляет информацию об очистке модулей при завершении работы. Устанавливается опцией [`-v`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-v) и переменной окружения [`PYTHONVERBOSE`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONVERBOSE). Устарело с версии 3.12. ## Инициализация и завершение работы интерпретатора #### `void Py_Initialize()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Инициализирует интерпретатор Python. В приложении, встраивающем Python, эту функцию следует вызывать до использования любых других функций Python/C API; за несколькими исключениями обращайтесь к [Before Python Initialization](https://python-all.ru/3.12/c-api/init.html#pre-init-safe). Эта функция инициализирует таблицу загруженных модулей (`sys.modules`) и создает фундаментальные модули [`builtins`](https://python-all.ru/3.12/library/builtins.html#module-builtins), [`__main__`](https://python-all.ru/3.12/library/__main__.html#module-__main__) и [`sys`](https://python-all.ru/3.12/library/sys.html#module-sys). Она также инициализирует путь поиска модулей (`sys.path`). Она не устанавливает `sys.argv`; для этого используйте [`PySys_SetArgvEx()`](https://python-all.ru/3.12/c-api/init.html#c.PySys_SetArgvEx). При повторном вызове (без предварительного вызова [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx)) ничего не происходит. Возвращаемого значения нет; если инициализация не удалась, это фатальная ошибка. Используйте функцию [`Py_InitializeFromConfig()`](https://python-all.ru/3.12/c-api/init_config.html#c.Py_InitializeFromConfig) для настройки [конфигурации инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). > **Примечание** > > В Windows изменяет режим консоли с `O_TEXT` на `O_BINARY`, что также повлияет на использование консоли из других приложений на C Runtime. #### `void Py_InitializeEx(int initsigs)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Эта функция работает как [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), если *initsigs* равно `1`. Если *initsigs* равно `0`, она пропускает регистрацию обработчиков сигналов при инициализации, что может быть полезно при встраивании Python. Используйте функцию [`Py_InitializeFromConfig()`](https://python-all.ru/3.12/c-api/init_config.html#c.Py_InitializeFromConfig) для настройки [конфигурации инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). #### `int Py_IsInitialized()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает true (ненулевое значение), если интерпретатор Python был инициализирован, и false (ноль), если нет. После вызова [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx) функция возвращает false до тех пор, пока не будет снова вызвана [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `int Py_FinalizeEx()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.6.* Отменяет всю инициализацию, выполненную с помощью [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), и последующее использование функций Python/C API, а также уничтожает все под-интерпретаторы (см. [`Py_NewInterpreter()`](https://python-all.ru/3.12/c-api/init.html#c.Py_NewInterpreter) ниже), которые были созданы и ещё не уничтожены после последнего вызова [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). В идеале это освобождает всю память, выделенную интерпретатором Python. При повторном вызове (без предварительного вызова [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize) сначала) эта функция ничего не делает. Поскольку эта функция является обратной по отношению к [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), её следует вызывать в том же потоке с тем же активным интерпретатором. Это означает главный поток и главный интерпретатор. Никогда не следует вызывать её во время работы [`Py_RunMain()`](https://python-all.ru/3.12/c-api/init_config.html#c.Py_RunMain). Обычно возвращаемое значение – `0`. Если во время завершения (сброса буферизованных данных) произошли ошибки, возвращается `-1`. Эта функция предусмотрена по ряду причин. Встраивающее приложение может захотеть перезапустить Python без перезапуска самого приложения. Приложение, загрузившее интерпретатор Python из динамически загружаемой библиотеки (или DLL), может захотеть освободить всю память, выделенную Python, перед выгрузкой DLL. В процессе поиска утечек памяти в приложении разработчик может захотеть освободить всю память, выделенную Python, перед выходом из приложения. **Ошибки и предостережения:** Уничтожение модулей и объектов в модулях происходит в случайном порядке; из-за этого деструкторы (методы [`__del__()`](https://python-all.ru/3.12/reference/datamodel.html#object.__del__)) могут давать сбой, если они зависят от других объектов (даже функций) или модулей. Динамически загруженные модули расширений, загруженные Python, не выгружаются. Небольшие объёмы памяти, выделенные интерпретатором Python, могут не освобождаться (если вы обнаружили утечку, сообщите о ней). Память, связанная циклическими ссылками между объектами, не освобождается. Некоторая память, выделенная модулями расширений, может не освобождаться. Некоторые расширения могут работать неправильно, если их процедура инициализации вызывается более одного раза; это может произойти, если приложение вызывает [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize) и [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx) более одного раза. Возбуждает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `cpython._PySys_ClearAuditHooks` без аргументов. Добавлено в версии 3.6. #### `void Py_Finalize()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Это обратно совместимая версия [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx), которая игнорирует возвращаемое значение. ## Общепроцессные параметры #### `int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)` Этот API сохранён для обратной совместимости: настройки [`PyConfig.stdio_encoding`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.stdio_encoding) и [`PyConfig.stdio_errors`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.stdio_errors) следует использовать вместо него; см. [Конфигурация инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). Эта функция должна вызываться до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), если она вообще вызывается. Она указывает, какую кодировку и обработку ошибок использовать для стандартного ввода-вывода, с теми же значениями, что и в [`str.encode()`](https://python-all.ru/3.12/library/stdtypes.html#str.encode). Она переопределяет значения [`PYTHONIOENCODING`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONIOENCODING) и позволяет встраивать код для управления кодировкой ввода-вывода, когда переменная окружения не работает. *encoding* и/или *errors* могут быть `NULL`, чтобы использовать [`PYTHONIOENCODING`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONIOENCODING) и/или значения по умолчанию (в зависимости от других настроек). Обратите внимание, что [`sys.stderr`](https://python-all.ru/3.12/library/sys.html#sys.stderr) всегда использует обработчик ошибок «backslashreplace», независимо от этой (или любой другой) настройки. Если вызывается [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx), эту функцию потребуется вызвать снова, чтобы повлиять на последующие вызовы [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). Возвращает `0` в случае успеха, ненулевое значение при ошибке (например, при вызове после того, как интерпретатор уже был инициализирован). Добавлено в версии 3.4. Устарело с версии 3.11. #### `void Py_SetProgramName(const wchar_t *name)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.program_name`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.program_name). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Эту функцию следует вызвать до первого вызова [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), если она вообще вызывается. Она сообщает интерпретатору значение аргумента `argv[0]` функции `main()` программы (преобразованное в широкие символы). Это используется [`Py_GetPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPath) и некоторыми другими функциями ниже для поиска библиотек времени выполнения Python относительно исполняемого файла интерпретатора. Значение по умолчанию – `'python'`. Аргумент должен указывать на строку широких символов, завершающуюся нулём, в статической памяти, содержимое которой не изменится за время выполнения программы. Никакой код в интерпретаторе Python не изменит содержимое этой памяти. Используйте [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) для декодирования строки байтов, чтобы получить строку wchar\_t\*. Устарело с версии 3.11. #### `wchar_t *Py_GetProgramName()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает имя программы, установленное с помощью [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName), или значение по умолчанию. Возвращаемая строка указывает на статическую память; вызывающий не должен изменять её значение. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `wchar_t *Py_GetPrefix()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает *префикс* для установленных платформонезависимых файлов. Он определяется по ряду сложных правил из имени программы, установленного с помощью [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName), и некоторых переменных окружения; например, если имя программы – `'/usr/local/bin/python'`, префикс – `'/usr/local'`. Возвращаемая строка указывает на статическую память; вызывающий не должен изменять её значение. Это соответствует переменной **prefix** в корневом `Makefile` и аргументу [`--prefix`](https://python-all.ru/3.12/using/configure.html#cmdoption-prefix) сценария **configure** во время сборки. Значение доступно в коде Python как `sys.prefix`. Полезен только в Unix. Смотрите также следующую функцию. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `wchar_t *Py_GetExecPrefix()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает *exec-prefix* для установленных *зависящих от платформы* файлов. Это значение вычисляется по ряду сложных правил на основе имени программы, заданного с помощью [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName), и некоторых переменных окружения; например, если имя программы – `'/usr/local/bin/python'`, то exec-prefix – `'/usr/local'`. Возвращаемая строка указывает на статическую память; вызывающий не должен изменять её значение. Это соответствует переменной **exec\_prefix** в верхнеуровневом `Makefile` и аргументу `--exec-prefix` сценария **configure** во время сборки. Значение доступно коду Python как `sys.exec_prefix`. Это имеет смысл только в Unix. Контекст: exec-prefix отличается от префикса (prefix), когда зависящие от платформы файлы (например, исполняемые файлы и динамические библиотеки) устанавливаются в другое дерево каталогов. В типичной установке платформенно-зависимые файлы могут быть установлены в поддерево `/usr/local/plat`, а платформенно-независимые – в `/usr/local`. Вообще говоря, платформа – это комбинация семейств аппаратного и программного обеспечения; например, машины Sparc под управлением ОС Solaris 2.x считаются одной платформой, машины Intel под Solaris 2.x – другой, а машины Intel под Linux – третьей. Разные основные версии одной и той же ОС обычно также образуют разные платформы. Операционные системы, отличные от Unix, – это отдельная история; стратегии установки на этих системах настолько различаются, что префикс и exec-prefix не имеют смысла и устанавливаются в пустую строку. Обратите внимание: скомпилированные файлы байт-кода Python не зависят от платформы (но не от версии Python, под которой они были скомпилированы!). Системные администраторы знают, как настроить программы **mount** или **automount** для совместного использования `/usr/local` между платформами, при этом `/usr/local/plat` будет отдельной файловой системой для каждой платформы. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `wchar_t *Py_GetProgramFullPath()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает полное имя программы исполняемого файла Python; оно вычисляется как побочный эффект при получении пути поиска модулей по умолчанию из имени программы (заданного с помощью [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName) выше). Возвращаемая строка указывает на статическую память; вызывающий не должен изменять её значение. Значение доступно коду Python как `sys.executable`. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `wchar_t *Py_GetPath()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает путь поиска модулей по умолчанию; он вычисляется из имени программы (заданного с помощью [`Py_SetProgramName()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetProgramName) выше) и некоторых переменных окружения. Возвращаемая строка состоит из последовательности имён каталогов, разделённых символом-разделителем, зависящим от платформы. На Unix и macOS символом-разделителем является `':'`, на Windows – `';'`. Возвращаемая строка указывает на статическую память; вызывающий не должен изменять её значение. Список [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path) инициализируется этим значением при запуске интерпретатора; он может быть (и обычно) изменён позднее для изменения пути поиска модулей. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). #### `void Py_SetPath(const wchar_t*)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Этот API сохранён для обратной совместимости: настройки [`PyConfig.module_search_paths`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.module_search_paths) и [`PyConfig.module_search_paths_set`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.module_search_paths_set) следует использовать вместо него; см. [Конфигурация инициализации Python](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливает путь поиска модулей по умолчанию. Если эта функция вызывается до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), то [`Py_GetPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetPath) не будет пытаться вычислить путь по умолчанию, а использует предоставленный. Это полезно, если Python встраивается в приложение, которое точно знает расположение всех модулей. Компоненты пути должны разделяться символом-разделителем, зависящим от платформы: `':'` на Unix и macOS, `';'` на Windows. Это также приводит к тому, что [`sys.executable`](https://python-all.ru/3.12/library/sys.html#sys.executable) устанавливается в полный путь программы (см. [`Py_GetProgramFullPath()`](https://python-all.ru/3.12/c-api/init.html#c.Py_GetProgramFullPath)), а [`sys.prefix`](https://python-all.ru/3.12/library/sys.html#sys.prefix) и [`sys.exec_prefix`](https://python-all.ru/3.12/library/sys.html#sys.exec_prefix) становятся пустыми. Вызывающий может изменить их при необходимости после вызова [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). Используйте [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) для декодирования строки bytes, чтобы получить строку wchar\_\*. Аргумент path копируется внутри, поэтому вызывающий может освободить его после завершения вызова. Изменено в версии 3.8: Теперь для [`sys.executable`](https://python-all.ru/3.12/library/sys.html#sys.executable) используется полный путь программы, а не имя программы. Устарело с версии 3.11. #### `const char *Py_GetVersion()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает версию данного интерпретатора Python. Это строка, которая выглядит примерно так: ```c "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]" ``` Первое слово (до первого пробела) – это текущая версия Python; первые символы – это мажорная и минорная версии, разделённые точкой. Возвращаемая строка указывает на статическую память; вызывающий код не должен изменять её значение. Это значение доступно в коде Python как [`sys.version`](https://python-all.ru/3.12/library/sys.html#sys.version). Смотрите также константу [`Py_Version`](https://python-all.ru/3.12/c-api/apiabiversion.html#c.Py_Version). #### `const char *Py_GetPlatform()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает идентификатор платформы для текущей платформы. В Unix он формируется из «официального» имени операционной системы, преобразованного в нижний регистр, за которым следует номер основной ревизии; например, для Solaris 2.x, также известного как SunOS 5.x, значение – `'sunos5'`. В macOS – `'darwin'`. В Windows – `'win'`. Возвращаемая строка указывает на статическую память; вызывающий код не должен изменять её значение. Значение доступно в коде Python как `sys.platform`. #### `const char *Py_GetCopyright()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает официальную строку авторских прав для текущей версии Python, например `'Copyright 1991-1995 Stichting Mathematisch Centrum, Amsterdam'` Возвращаемая строка указывает на статическую память; вызывающий код не должен изменять её значение. Значение доступно в коде Python как `sys.copyright`. #### `const char *Py_GetCompiler()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает указание компилятора, использованного для сборки текущей версии Python, в квадратных скобках, например: ```c "[GCC 2.7.2.2]" ``` Возвращаемая строка указывает на статическую память; вызывающий код не должен изменять её значение. Значение доступно коду Python как часть переменной `sys.version`. #### `const char *Py_GetBuildInfo()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает информацию о номере сборки, дате и времени сборки текущего экземпляра интерпретатора Python, например ```c "#67, Aug 1 1997, 22:34:28" ``` Возвращаемая строка указывает на статическую память; вызывающий код не должен изменять её значение. Значение доступно коду Python как часть переменной `sys.version`. #### `void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.argv), [`PyConfig.parse_argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.parse_argv) и [`PyConfig.safe_path`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.safe_path). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливает [`sys.argv`](https://python-all.ru/3.12/library/sys.html#sys.argv) на основе *argc* и *argv*. Эти параметры похожи на передаваемые функции `main()` программы, с тем отличием, что первый элемент должен указывать на исполняемый файл сценария, а не на исполняемый файл, в котором работает интерпретатор Python. Если запускаемый сценарий отсутствует, первый элемент в *argv* может быть пустой строкой. Если этой функции не удаётся инициализировать [`sys.argv`](https://python-all.ru/3.12/library/sys.html#sys.argv), фатальная ситуация сигнализируется с помощью [`Py_FatalError()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_FatalError). Если *updatepath* равен нулю, на этом работа функции заканчивается. Если *updatepath* не равен нулю, функция также изменяет [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path) по следующему алгоритму: - Если в `argv[0]` передано имя существующего сценария, то абсолютный путь к каталогу, в котором находится сценарий, добавляется в начало [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path). - В противном случае (то есть если *argc* равен `0` или `argv[0]` не указывает на существующее имя файла), пустая строка добавляется в начало [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path), что эквивалентно добавлению текущего рабочего каталога (`"."`). Используйте [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) для декодирования строки байтов, чтобы получить строку wchar\_t\*. См. также члены [`PyConfig.orig_argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.orig_argv) и [`PyConfig.argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.argv) структуры [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). > **Примечание** > > Приложениям, встраивающим интерпретатор Python не для выполнения одного сценария, рекомендуется передавать `0` в качестве *updatepath* и при желании обновлять [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path) самостоятельно. См. [**CVE 2008-5983**](https://python-all.ru/3.12/c-api/init.html). > > В версиях до 3.1.3 того же эффекта можно достичь, вручную удалив первый элемент [`sys.path`](https://python-all.ru/3.12/library/sys.html#sys.path) после вызова [`PySys_SetArgv()`](https://python-all.ru/3.12/c-api/init.html#c.PySys_SetArgv), например используя: > > ```c > PyRun_SimpleString("import sys; sys.path.pop(0)\n"); > ``` Добавлено в версии 3.1.3. Устарело с версии 3.11. #### `void PySys_SetArgv(int argc, wchar_t **argv)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.argv) и [`PyConfig.parse_argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.parse_argv). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Эта функция работает как [`PySys_SetArgvEx()`](https://python-all.ru/3.12/c-api/init.html#c.PySys_SetArgvEx) с *updatepath*, установленным в `1`, если только интерпретатор **python** не был запущен с [`-I`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-I). Используйте [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) для декодирования строки байтов, чтобы получить строку wchar\_t\*. См. также члены [`PyConfig.orig_argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.orig_argv) и [`PyConfig.argv`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.argv) структуры [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Изменено в версии 3.4: Значение *updatepath* зависит от [`-I`](https://python-all.ru/3.12/using/cmdline.html#cmdoption-I). Устарело с версии 3.11. #### `void Py_SetPythonHome(const wchar_t *home)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот API сохранён для обратной совместимости: вместо него следует использовать [`PyConfig.home`](https://python-all.ru/3.12/c-api/init_config.html#c.PyConfig.home). См. [Python Initialization Configuration](https://python-all.ru/3.12/c-api/init_config.html#init-config). Устанавливает домашний каталог по умолчанию, то есть расположение стандартных библиотек Python. См. [`PYTHONHOME`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONHOME) для пояснения значения строки аргумента. Аргумент должен указывать на строку символов, завершающуюся нулём, в статической памяти, содержимое которой не будет изменяться в течение всего времени выполнения программы. Никакой код в интерпретаторе Python не будет менять содержимое этой памяти. Используйте [`Py_DecodeLocale()`](https://python-all.ru/3.12/c-api/sys.html#c.Py_DecodeLocale) для декодирования строки байтов, чтобы получить строку wchar\_t\*. Устарело с версии 3.11. #### `wchar_t *Py_GetPythonHome()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает «домашний» каталог по умолчанию, то есть значение, установленное предыдущим вызовом [`Py_SetPythonHome()`](https://python-all.ru/3.12/c-api/init.html#c.Py_SetPythonHome), или значение переменной окружения [`PYTHONHOME`](https://python-all.ru/3.12/using/cmdline.html#envvar-PYTHONHOME), если она задана. Эту функцию не следует вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), иначе она возвращает `NULL`. Изменено в версии 3.10: Теперь возвращает `NULL`, если вызвано до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). ## Состояние потока и глобальная блокировка интерпретатора Интерпретатор Python не является полностью потокобезопасным. Для поддержки многопоточных программ на Python существует глобальная блокировка, называемая [глобальной блокировкой интерпретатора](https://python-all.ru/3.12/glossary.html#term-global-interpreter-lock) или [GIL](https://python-all.ru/3.12/glossary.html#term-GIL), которую текущий поток должен удерживать перед тем, как безопасно обращаться к объектам Python. Без этой блокировки даже простейшие операции могут вызывать проблемы в многопоточной программе: например, когда два потока одновременно увеличивают счётчик ссылок одного и того же объекта, счётчик может в итоге увеличиться только один раз вместо двух. Поэтому существует правило: только поток, захвативший [GIL](https://python-all.ru/3.12/glossary.html#term-GIL), может работать с объектами Python или вызывать функции Python/C API. Для эмуляции параллелизма выполнения интерпретатор регулярно пытается переключать потоки (см. [`sys.setswitchinterval()`](https://python-all.ru/3.12/library/sys.html#sys.setswitchinterval)). Блокировка также освобождается вокруг потенциально блокирующих операций ввода-вывода, таких как чтение или запись файла, чтобы тем временем могли работать другие потоки Python. Интерпретатор Python хранит некоторую служебную информацию, специфичную для потока, в структуре данных, называемой [`PyThreadState`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState). Существует также одна глобальная переменная, указывающая на текущий [`PyThreadState`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState): её можно получить с помощью [`PyThreadState_Get()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Get). ### Освобождение GIL из кода расширения Большая часть кода расширения, работающего с [GIL](https://python-all.ru/3.12/glossary.html#term-GIL), имеет следующую простую структуру: ```c Save the thread state in a local variable. Release the global interpreter lock. ... Do some blocking I/O operation ... Reacquire the global interpreter lock. Restore the thread state from the local variable. ``` Это настолько распространено, что существует пара макросов для упрощения: ```c Py_BEGIN_ALLOW_THREADS ... Do some blocking I/O operation ... Py_END_ALLOW_THREADS ``` Макрос [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) открывает новый блок и объявляет скрытую локальную переменную; макрос [`Py_END_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS) закрывает блок. Приведённый выше блок раскрывается в следующий код: ```c PyThreadState *_save; _save = PyEval_SaveThread(); ... Do some blocking I/O operation ... PyEval_RestoreThread(_save); ``` Вот как работают эти функции: глобальная блокировка интерпретатора используется для защиты указателя на текущее состояние потока. При освобождении блокировки и сохранении состояния потока указатель на текущее состояние потока должен быть получен до освобождения блокировки (поскольку другой поток может немедленно захватить блокировку и сохранить своё состояние потока в глобальной переменной). И наоборот, при захвате блокировки и восстановлении состояния потока блокировка должна быть захвачена до сохранения указателя на состояние потока. > **Примечание** > > Вызов системных функций ввода-вывода – это наиболее распространённый случай освобождения GIL, но он также может быть полезен перед вызовом длительных вычислений, не требующих доступа к объектам Python, таких как функции сжатия или шифрования, работающие с буферами памяти. Например, стандартные модули [`zlib`](https://python-all.ru/3.12/library/zlib.html#module-zlib) и [`hashlib`](https://python-all.ru/3.12/library/hashlib.html#module-hashlib) освобождают GIL при сжатии или хешировании данных. ### Потоки, созданные не из Python Когда потоки создаются с помощью специализированных Python API (например, модуля [`threading`](https://python-all.ru/3.12/library/threading.html#module-threading)), с ними автоматически связывается состояние потока, и приведённый выше код корректен. Однако, когда потоки создаются из C (например, сторонней библиотекой с собственным управлением потоками), они не удерживают GIL и для них не существует структуры состояния потока. Если необходимо вызвать код Python из этих потоков (часто это будет частью API колбэков, предоставляемого упомянутой сторонней библиотекой), сначала нужно зарегистрировать эти потоки в интерпретаторе, создав структуру данных состояния потока, затем захватить GIL и, наконец, сохранить указатель на их состояние потока, прежде чем можно будет начать использовать Python/C API. После завершения следует сбросить указатель состояния потока, освободить GIL и освободить структуру данных состояния потока. Функции [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) и [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release) делают всё вышеописанное автоматически. Типичный способ вызова Python из потока C: ```c PyGILState_STATE gstate; gstate = PyGILState_Ensure(); /* Выполнить действия Python здесь. */ result = CallSomeFunction(); /* вычислить результат или обработать исключение */ /* Освободить поток. После этой точки API Python не допускается. */ PyGILState_Release(gstate); ``` Обратите внимание, что функции `PyGILState_*` предполагают наличие только одного глобального интерпретатора (создаваемого автоматически с помощью [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize)). Python поддерживает создание дополнительных интерпретаторов (с помощью [`Py_NewInterpreter()`](https://python-all.ru/3.12/c-api/init.html#c.Py_NewInterpreter)), но смешивание нескольких интерпретаторов и API `PyGILState_*` не поддерживается. ### Предостережения относительно fork() Ещё одна важная особенность потоков – их поведение при вызове C `fork()`. На большинстве систем с `fork()` после fork процесса остаётся только тот поток, который вызвал fork. Это оказывает конкретное влияние как на обработку блокировок, так и на всё сохранённое состояние в среде выполнения CPython. То, что остаётся только «текущий» поток, означает, что любые блокировки, удерживаемые другими потоками, никогда не будут освобождены. Python решает эту проблему для [`os.fork()`](https://python-all.ru/3.12/library/os.html#os.fork), захватывая блокировки, которые использует внутри, до вызова fork и освобождая их после. Кроме того, он сбрасывает любые [объекты блокировок](https://python-all.ru/3.12/library/threading.html#lock-objects) в дочернем процессе. При расширении или встраивании Python невозможно сообщить Python о дополнительных (не-Python) блокировках, которые необходимо захватить до fork или сбросить после. Для достижения того же эффекта потребуется использовать средства ОС, такие как `pthread_atfork()`. Кроме того, при расширении или встраивании Python вызов `fork()` напрямую, а не через [`os.fork()`](https://python-all.ru/3.12/library/os.html#os.fork) (и возврат в Python или вызов Python) может привести к взаимоблокировке из-за того, что одна из внутренних блокировок Python удерживается потоком, который перестаёт существовать после fork. [`PyOS_AfterFork_Child()`](https://python-all.ru/3.12/c-api/sys.html#c.PyOS_AfterFork_Child) пытается сбросить необходимые блокировки, но не всегда может это сделать. Тот факт, что все остальные потоки исчезают, также означает, что состояние среды выполнения CPython должно быть правильно очищено, что и делает [`os.fork()`](https://python-all.ru/3.12/library/os.html#os.fork). Это означает завершение всех остальных объектов [`PyThreadState`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState), принадлежащих текущему интерпретатору, и всех остальных объектов [`PyInterpreterState`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState). Из-за этого и особой природы [«главного» интерпретатора](https://python-all.ru/3.12/c-api/init.html#sub-interpreter-support), `fork()` следует вызывать только в «главном» потоке этого интерпретатора, где изначально была инициализирована глобальная среда выполнения CPython. Единственное исключение – если `exec()` будет вызван сразу после. ### API высокого уровня Это наиболее часто используемые типы и функции при написании кода C-расширения или при встраивании интерпретатора Python: #### `type PyInterpreterState` *Часть [Limited API](https://python-all.ru/3.12/c-api/stable.html#stable) (как непрозрачная структура).* Эта структура данных представляет состояние, совместно используемое несколькими взаимодействующими потоками. Потоки, принадлежащие одному интерпретатору, разделяют администрирование модулей и несколько других внутренних элементов. В этой структуре нет открытых членов. Потоки, принадлежащие разным интерпретаторам, изначально не разделяют ничего, кроме состояния процесса, такого как доступная память, открытые файловые дескрипторы и т.п. Глобальная блокировка интерпретатора также разделяется всеми потоками, независимо от того, какому интерпретатору они принадлежат. #### `type PyThreadState` *Часть [Limited API](https://python-all.ru/3.12/c-api/stable.html#stable) (как непрозрачная структура).* Эта структура данных представляет состояние одного потока. Единственный открытый элемент данных: #### `PyInterpreterState *interp` Состояние интерпретатора этого потока. #### `void PyEval_InitThreads()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Устаревшая функция, которая ничего не делает. В Python 3.6 и старше эта функция создавала GIL, если его не существовало. Изменено в версии 3.9: Теперь функция ничего не делает. Изменено в версии 3.7: Теперь эта функция вызывается [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize), так что вам больше не нужно вызывать её самостоятельно. Изменено в версии 3.2: Эту функцию больше нельзя вызывать до [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). Устарело с версии 3.9. #### `int PyEval_ThreadsInitialized()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает ненулевое значение, если [`PyEval_InitThreads()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_InitThreads) был вызван. Эту функцию можно вызывать без удержания GIL, поэтому её можно использовать для избежания вызовов API блокировок при однопоточном выполнении. Изменено в версии 3.7: теперь [GIL](https://python-all.ru/3.12/glossary.html#term-GIL) инициализируется с помощью [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). Устарело с версии 3.9. #### `PyThreadState *PyEval_SaveThread()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Освобождает глобальную блокировку интерпретатора (если она была создана) и сбрасывает состояние потока на `NULL`, возвращая предыдущее состояние потока (которое не равно `NULL`). Если блокировка была создана, текущий поток должен был её захватить. #### `void PyEval_RestoreThread(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Захватывает глобальную блокировку интерпретатора (если она была создана) и устанавливает состояние потока в *tstate*, которое не должно быть `NULL`. Если блокировка была создана, текущий поток не должен был её захватить, иначе возникает взаимоблокировка. > **Примечание** > > Вызов этой функции из потока, когда среда выполнения завершает работу, приведёт к завершению потока, даже если этот поток не был создан Python. Перед вызовом этой функции можно использовать `_Py_IsFinalizing()` или [`sys.is_finalizing()`](https://python-all.ru/3.12/library/sys.html#sys.is_finalizing), чтобы проверить, находится ли интерпретатор в процессе завершения, и избежать нежелательного завершения. #### `PyThreadState *PyThreadState_Get()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает текущее состояние потока. Глобальная блокировка интерпретатора должна быть захвачена. Если текущее состояние потока равно `NULL`, вызывается фатальная ошибка (так что вызывающему коду не нужно проверять на `NULL`). #### `PyThreadState *PyThreadState_Swap(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Заменяет текущее состояние потока на состояние потока, заданное аргументом *tstate*, который может быть `NULL`. Глобальная блокировка интерпретатора должна быть удержана и не освобождается. Следующие функции используют локальное хранилище потока и несовместимы с подынтерпретаторами: #### `PyGILState_STATE PyGILState_Ensure()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Обеспечивает, что текущий поток готов к вызову Python C API независимо от текущего состояния Python или глобальной блокировки интерпретатора. Этот вызов может вызываться потоком сколько угодно раз, при условии, что каждый вызов завершается вызовом [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release). В общем случае другие API, связанные с потоками, могут использоваться между вызовами [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) и [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release), если состояние потока будет восстановлено в предыдущее состояние перед Release(). Например, обычное использование макросов [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) и [`Py_END_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS) допустимо. Возвращаемое значение – это непрозрачный «дескриптор» состояния потока на момент вызова [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure), и его необходимо передать в [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release), чтобы гарантировать, что Python останется в том же состоянии. Хотя рекурсивные вызовы разрешены, эти дескрипторы *нельзя* совместно использовать – каждый уникальный вызов [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) должен сохранить свой дескриптор для вызова [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release). Когда функция возвращает управление, текущий поток будет удерживать GIL и сможет вызывать произвольный код Python. Сбой является фатальной ошибкой. > **Примечание** > > Вызов этой функции из потока, когда среда выполнения завершает работу, приведёт к завершению потока, даже если этот поток не был создан Python. Перед вызовом этой функции можно использовать `_Py_IsFinalizing()` или [`sys.is_finalizing()`](https://python-all.ru/3.12/library/sys.html#sys.is_finalizing), чтобы проверить, находится ли интерпретатор в процессе завершения, и избежать нежелательного завершения. #### `void PyGILState_Release(PyGILState_STATE)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Освобождает любые ресурсы, полученные ранее. После этого вызова состояние Python будет таким же, как до соответствующего вызова [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) (но обычно это состояние неизвестно вызывающему, поэтому используется GILState API). Каждый вызов [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) должен сопровождаться вызовом [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release) в том же потоке. #### `PyThreadState *PyGILState_GetThisThreadState()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает состояние текущего потока. Может вернуть `NULL`, если на текущем потоке не использовался GILState API. Обратите внимание, что главный поток всегда имеет такое состояние, даже если для него не вызывался auto-thread-state. Это вспомогательная/диагностическая функция. #### `int PyGILState_Check()` Возвращает `1`, если текущий поток удерживает GIL, и `0` в противном случае. Эту функцию можно вызывать из любого потока в любое время. Только если состояние потока Python инициализировано и он в данный момент удерживает GIL, она вернёт `1`. Это в основном вспомогательная/диагностическая функция. Она может быть полезна, например, в контекстах колбэков или функциях выделения памяти, когда знание того, что GIL заблокирован, позволяет вызывающей стороне выполнять чувствительные действия или вести себя иначе. Добавлено в версии 3.4. Следующие макросы обычно используются без точки с запятой в конце; примеры использования можно найти в дистрибутиве исходного кода Python. #### `Py_BEGIN_ALLOW_THREADS` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот макрос раскрывается в `{ PyThreadState *_save; _save = PyEval_SaveThread();`. Обратите внимание, что он содержит открывающую фигурную скобку; она должна быть сопоставлена с последующим макросом [`Py_END_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS). См. выше дополнительное обсуждение этого макроса. #### `Py_END_ALLOW_THREADS` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот макрос раскрывается в `PyEval_RestoreThread(_save); }`. Обратите внимание, что он содержит закрывающую фигурную скобку; она должна быть сопоставлена с предыдущим макросом [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS). См. выше дополнительное обсуждение этого макроса. #### `Py_BLOCK_THREADS` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот макрос разворачивается в `PyEval_RestoreThread(_save);`: он эквивалентен [`Py_END_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS) без закрывающей фигурной скобки. #### `Py_UNBLOCK_THREADS` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Этот макрос разворачивается в `_save = PyEval_SaveThread();`: он эквивалентен [`Py_BEGIN_ALLOW_THREADS`](https://python-all.ru/3.12/c-api/init.html#c.Py_BEGIN_ALLOW_THREADS) без открывающей фигурной скобки и объявления переменной. ### Низкоуровневый API Все следующие функции должны вызываться после [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize). Изменено в версии 3.7: [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize) теперь инициализирует [GIL](https://python-all.ru/3.12/glossary.html#term-GIL). #### `PyInterpreterState *PyInterpreterState_New()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Создаёт новый объект состояния интерпретатора. Глобальная блокировка интерпретатора может не удерживаться, но может удерживаться, если необходимо сериализовать вызовы этой функции. Возбуждает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `cpython.PyInterpreterState_New` без аргументов. #### `void PyInterpreterState_Clear(PyInterpreterState *interp)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Сбрасывает всю информацию в объекте состояния интерпретатора. Глобальная блокировка интерпретатора должна удерживаться. Возбуждает [событие аудита](https://python-all.ru/3.12/library/sys.html#auditing) `cpython.PyInterpreterState_Clear` без аргументов. #### `void PyInterpreterState_Delete(PyInterpreterState *interp)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Уничтожает объект состояния интерпретатора. Глобальная блокировка интерпретатора может не удерживаться. Состояние интерпретатора должно быть предварительно сброшено вызовом [`PyInterpreterState_Clear()`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState_Clear). #### `PyThreadState *PyThreadState_New(PyInterpreterState *interp)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Создаёт новый объект состояния потока, принадлежащий данному объекту интерпретатора. Глобальная блокировка интерпретатора может не удерживаться, но может удерживаться, если необходимо сериализовать вызовы этой функции. #### `void PyThreadState_Clear(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Сбрасывает всю информацию в объекте состояния потока. Глобальная блокировка интерпретатора должна удерживаться. Изменено в версии 3.9: Теперь эта функция вызывает колбэк `PyThreadState.on_delete`. Ранее это происходило в [`PyThreadState_Delete()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Delete). #### `void PyThreadState_Delete(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Уничтожает объект состояния потока. Глобальная блокировка интерпретатора может не удерживаться. Состояние потока должно быть предварительно сброшено вызовом [`PyThreadState_Clear()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Clear). #### `void PyThreadState_DeleteCurrent(void)` Уничтожает текущее состояние потока и освобождает глобальную блокировку интерпретатора. Как и [`PyThreadState_Delete()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Delete), глобальная блокировка интерпретатора должна удерживаться. Состояние потока должно быть предварительно сброшено вызовом [`PyThreadState_Clear()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Clear). #### `PyFrameObject *PyThreadState_GetFrame(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.* Возвращает текущий кадр состояния потока Python *tstate*. Возвращает [сильную ссылку](https://python-all.ru/3.12/glossary.html#term-strong-reference). Возвращает `NULL`, если в данный момент кадр не выполняется. См. также [`PyEval_GetFrame()`](https://python-all.ru/3.12/c-api/reflection.html#c.PyEval_GetFrame). *tstate* не должно быть `NULL`. Добавлено в версии 3.9. #### `uint64_t PyThreadState_GetID(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.* Возвращает уникальный идентификатор состояния потока Python для *tstate*. *tstate* не должно быть `NULL`. Добавлено в версии 3.9. #### `PyInterpreterState *PyThreadState_GetInterpreter(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.10.* Возвращает интерпретатор состояния потока Python *tstate*. *tstate* не должно быть `NULL`. Добавлено в версии 3.9. #### `void PyThreadState_EnterTracing(PyThreadState *tstate)` Приостанавливает трассировку и профилирование в состоянии потока Python *tstate*. Возобновляет их с помощью функции [`PyThreadState_LeaveTracing()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_LeaveTracing). Добавлено в версии 3.12. #### `void PyThreadState_LeaveTracing(PyThreadState *tstate)` Возобновляет трассировку и профилирование в состоянии потока Python *tstate*, приостановленные функцией [`PyThreadState_EnterTracing()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_EnterTracing). См. также функции [`PyEval_SetTrace()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetTrace) и [`PyEval_SetProfile()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetProfile). Добавлено в версии 3.12. #### `PyInterpreterState *PyInterpreterState_Get(void)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.9.* Получает текущий интерпретатор. Вызывает фатальную ошибку, если отсутствует текущее состояние потока Python или текущий интерпретатор. Функция не может вернуть NULL. Вызывающий должен удерживать GIL. Добавлено в версии 3.9. #### `int64_t PyInterpreterState_GetID(PyInterpreterState *interp)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает уникальный идентификатор интерпретатора. Если при этом произошла ошибка, возвращается `-1` и устанавливается исключение. Вызывающий должен удерживать GIL. Добавлено в версии 3.7. #### `PyObject *PyInterpreterState_GetDict(PyInterpreterState *interp)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) с версии 3.8.* Возвращает словарь, в котором могут храниться данные, специфичные для интерпретатора. Если эта функция возвращает `NULL`, исключение не было возбуждено, и вызывающий код должен считать, что словарь данных интерпретатора недоступен. Это не замена [`PyModule_GetState()`](https://python-all.ru/3.12/c-api/module.html#c.PyModule_GetState), который расширения должны использовать для хранения информации о состоянии интерпретатора. Добавлено в версии 3.8. #### `typedef PyObject *(*_PyFrameEvalFunction)(PyThreadState *tstate, _PyInterpreterFrame *frame, int throwflag)` Тип функции вычисления фрейма. Параметр *throwflag* используется методом `throw()` генераторов: если он не равен нулю, обрабатывается текущее исключение. Изменено в версии 3.9: Теперь функция принимает параметр *tstate*. Изменено в версии 3.11: Параметр *frame* изменился с `PyFrameObject*` на `_PyInterpreterFrame*`. #### `_PyFrameEvalFunction _PyInterpreterState_GetEvalFrameFunc(PyInterpreterState *interp)` Возвращает функцию вычисления фрейма. См. [**PEP 523**](https://python-all.ru/3.12/c-api/init.html) «Добавление API вычисления фрейма в CPython». Добавлено в версии 3.9. #### `void _PyInterpreterState_SetEvalFrameFunc(PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)` Устанавливает функцию вычисления фрейма. См. [**PEP 523**](https://python-all.ru/3.12/c-api/init.html) «Добавление API вычисления фрейма в CPython». Добавлено в версии 3.9. #### `PyObject *PyThreadState_GetDict()` *Возвращаемое значение: заимствованная ссылка.* *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Возвращает словарь, в котором расширения могут хранить информацию о состоянии, специфичном для потока. Каждое расширение должно использовать уникальный ключ для хранения состояния в словаре. Допускается вызывать эту функцию, когда нет текущего состояния потока. Если эта функция возвращает `NULL`, исключение не было возбуждено, и вызывающий должен предполагать, что текущее состояние потока недоступно. #### `int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Асинхронно возбуждает исключение в потоке. Аргумент *id* – это идентификатор потока целевого потока; *exc* – это объект исключения, которое нужно возбудить. Эта функция не крадёт ссылки на *exc*. Для предотвращения наивного misuse требуется написать собственное C-расширение для её вызова. Должна вызываться с удержанием GIL. Возвращает количество изменённых состояний потока; обычно это единица, но будет нулём, если идентификатор потока не найден. Если *exc* равно `NULL`, отложенное исключение (если есть) для потока очищается. Эта функция не возбуждает исключений. Изменено в версии 3.7: Тип параметра *id* изменён с long на unsigned long. #### `void PyEval_AcquireThread(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Захватывает глобальную блокировку интерпретатора и устанавливает текущее состояние потока в *tstate*, которое не должно быть `NULL`. Блокировка должна быть создана ранее. Если этот поток уже удерживает блокировку, возникает взаимоблокировка. > **Примечание** > > Вызов этой функции из потока в момент завершения работы среды выполнения приведёт к завершению потока, даже если поток не был создан Python. Для проверки того, завершается ли интерпретатор, перед вызовом этой функции можно использовать `_Py_IsFinalizing()` или [`sys.is_finalizing()`](https://python-all.ru/3.12/library/sys.html#sys.is_finalizing), чтобы избежать нежелательного завершения. Изменено в версии 3.8: Функция обновлена для согласованности с [`PyEval_RestoreThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_RestoreThread), [`Py_END_ALLOW_THREADS()`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS) и [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure), и теперь завершает текущий поток, если вызвана во время завершения работы интерпретатора. [`PyEval_RestoreThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_RestoreThread) – функция более высокого уровня, которая всегда доступна (даже если потоки не были инициализированы). #### `void PyEval_ReleaseThread(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Сбрасывает текущее состояние потока в `NULL` и освобождает глобальную блокировку интерпретатора. Блокировка должна быть создана ранее и должна удерживаться текущим потоком. Аргумент *tstate*, который не должен быть `NULL`, используется только для проверки, что он представляет текущее состояние потока – если это не так, выводится фатальная ошибка. [`PyEval_SaveThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SaveThread) – функция более высокого уровня, которая всегда доступна (даже если потоки не были инициализированы). #### `void PyEval_AcquireLock()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Захватывает глобальную блокировку интерпретатора. Блокировка должна быть создана заранее. Если этот поток уже удерживает блокировку, возникает взаимоблокировка. Устарело с версии 3.2: Эта функция не обновляет текущее состояние потока. Вместо неё используйте [`PyEval_RestoreThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_RestoreThread) или [`PyEval_AcquireThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_AcquireThread). > **Примечание** > > Вызов этой функции из потока в момент завершения работы среды выполнения приведёт к завершению потока, даже если поток не был создан Python. Для проверки того, завершается ли интерпретатор, перед вызовом этой функции можно использовать `_Py_IsFinalizing()` или [`sys.is_finalizing()`](https://python-all.ru/3.12/library/sys.html#sys.is_finalizing), чтобы избежать нежелательного завершения. Изменено в версии 3.8: Функция обновлена для согласованности с [`PyEval_RestoreThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_RestoreThread), [`Py_END_ALLOW_THREADS()`](https://python-all.ru/3.12/c-api/init.html#c.Py_END_ALLOW_THREADS) и [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure), и теперь завершает текущий поток, если вызвана во время завершения работы интерпретатора. #### `void PyEval_ReleaseLock()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Освобождает глобальную блокировку интерпретатора. Блокировка должна быть создана заранее. Устарело с версии 3.2: Эта функция не обновляет текущее состояние потока. Вместо неё используйте [`PyEval_SaveThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SaveThread) или [`PyEval_ReleaseThread()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_ReleaseThread). ## Поддержка под-интерпретаторов Хотя в большинстве случаев достаточно встроить один интерпретатор Python, бывают ситуации, когда требуется создать несколько независимых интерпретаторов в одном процессе и даже в одном потоке. Под-интерпретаторы позволяют это сделать. «Главный» интерпретатор – это первый интерпретатор, создаваемый при инициализации среды выполнения. Обычно он является единственным интерпретатором Python в процессе. В отличие от под-интерпретаторов, главный интерпретатор обладает уникальными общепроцессными обязанностями, такими как обработка сигналов. Он также отвечает за выполнение при инициализации среды выполнения и обычно является активным интерпретатором при завершении работы среды выполнения. Функция [`PyInterpreterState_Main()`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState_Main) возвращает указатель на его состояние. Переключаться между под-интерпретаторами можно с помощью функции [`PyThreadState_Swap()`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState_Swap). Создавать и удалять их можно с помощью следующих функций: #### `type PyInterpreterConfig` Структура, содержащая большинство параметров для настройки под-интерпретатора. Её значения используются только в [`Py_NewInterpreterFromConfig()`](https://python-all.ru/3.12/c-api/init.html#c.Py_NewInterpreterFromConfig) и никогда не изменяются средой выполнения. Добавлено в версии 3.12. Поля структуры: #### `int use_main_obmalloc` Если это `0`, то под-интерпретатор будет использовать собственное состояние аллокатора «объектов». В противном случае он будет использовать (разделять) состояние главного интерпретатора. Если это `0`, то [`check_multi_interp_extensions`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig.check_multi_interp_extensions) должен быть `1` (ненулевым). Если это `1`, то [`gil`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig.gil) не должен быть [`PyInterpreterConfig_OWN_GIL`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig_OWN_GIL). #### `int allow_fork` Если это `0`, то среда выполнения не будет поддерживать создание форка процесса в любом потоке, где в данный момент активен под-интерпретатор. В противном случае форк не ограничен. Обратите внимание, что модуль [`subprocess`](https://python-all.ru/3.12/library/subprocess.html#module-subprocess) по-прежнему работает, когда форк запрещён. #### `int allow_exec` Если это `0`, то среда выполнения не будет поддерживать замену текущего процесса через exec (например, [`os.execv()`](https://python-all.ru/3.12/library/os.html#os.execv)) в любом потоке, где в данный момент активен под-интерпретатор. В противном случае exec не ограничен. Обратите внимание, что модуль [`subprocess`](https://python-all.ru/3.12/library/subprocess.html#module-subprocess) по-прежнему работает, когда exec запрещён. #### `int allow_threads` Если это `0`, то модуль [`threading`](https://python-all.ru/3.12/library/threading.html#module-threading) под-интерпретатора не будет создавать потоки. В противном случае потоки разрешены. #### `int allow_daemon_threads` Если это `0`, то модуль [`threading`](https://python-all.ru/3.12/library/threading.html#module-threading) под-интерпретатора не будет создавать потоки-демоны. В противном случае потоки-демоны разрешены (при условии, что [`allow_threads`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig.allow_threads) не равен нулю). #### `int check_multi_interp_extensions` Если это `0`, то все модули расширений могут быть импортированы, включая устаревшие модули (с однофазной инициализацией), в любом потоке, где активен под-интерпретатор. В противном случае могут быть импортированы только модули расширений с многофазной инициализацией (см. [**PEP 489**](https://python-all.ru/3.12/c-api/init.html)). (См. также [`Py_mod_multiple_interpreters`](https://python-all.ru/3.12/c-api/module.html#c.Py_mod_multiple_interpreters).) Это должно быть `1` (ненулевым), если [`use_main_obmalloc`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig.use_main_obmalloc) равно `0`. #### `int gil` Это определяет режим работы GIL для под-интерпретатора. Он может быть одним из следующих: #### `PyInterpreterConfig_DEFAULT_GIL` Использовать выбор по умолчанию ([`PyInterpreterConfig_SHARED_GIL`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig_SHARED_GIL)). #### `PyInterpreterConfig_SHARED_GIL` Использовать (разделять) GIL главного интерпретатора. #### `PyInterpreterConfig_OWN_GIL` Использовать собственный GIL под-интерпретатора. Если это [`PyInterpreterConfig_OWN_GIL`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig_OWN_GIL), то [`PyInterpreterConfig.use_main_obmalloc`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterConfig.use_main_obmalloc) должен быть `0`. #### `PyStatus Py_NewInterpreterFromConfig(PyThreadState **tstate_p, const PyInterpreterConfig *config)` Создаёт новый под-интерпретатор. Это (почти) полностью независимое окружение для выполнения кода Python. В частности, новый интерпретатор имеет отдельные, независимые версии всех импортированных модулей, включая фундаментальные модули [`builtins`](https://python-all.ru/3.12/library/builtins.html#module-builtins), [`__main__`](https://python-all.ru/3.12/library/__main__.html#module-__main__) и [`sys`](https://python-all.ru/3.12/library/sys.html#module-sys). Таблица загруженных модулей (`sys.modules`) и путь поиска модулей (`sys.path`) также отдельные. В новом окружении нет переменной `sys.argv` . У него есть новые файловые объекты стандартных потоков ввода-вывода `sys.stdin`, `sys.stdout` и `sys.stderr` (однако они ссылаются на те же нижележащие файловые дескрипторы). Переданный *config* управляет параметрами, с которыми инициализируется интерпретатор. В случае успеха *tstate\_p* будет установлен на первое состояние потока, созданное в новом под-интерпретаторе. Это состояние потока создаётся в текущем состоянии потока. Обратите внимание, что реальный поток не создаётся; см. обсуждение состояний потока ниже. Если создание нового интерпретатора не удаётся, *tstate\_p* устанавливается в `NULL`; исключение не устанавливается, так как состояние исключения хранится в текущем состоянии потока, и текущего состояния потока может не существовать. Как и все остальные функции Python/C API, перед вызовом этой функции должна быть захвачена глобальная блокировка интерпретатора, и она остаётся захваченной после возврата. Также при входе должно быть установлено текущее состояние потока. В случае успеха возвращённое состояние потока становится текущим. Если под-интерпретатор создаётся с собственным GIL, то GIL вызывающего интерпретатора будет освобождён. Когда функция возвращает управление, GIL нового интерпретатора будет захвачен текущим потоком, а GIL предыдущего интерпретатора останется освобождённым. Добавлено в версии 3.12. Под-интерпретаторы наиболее эффективны при изоляции друг от друга, с ограничением определённой функциональности: ```c PyInterpreterConfig config = { .use_main_obmalloc = 0, .allow_fork = 0, .allow_exec = 0, .allow_threads = 1, .allow_daemon_threads = 0, .check_multi_interp_extensions = 1, .gil = PyInterpreterConfig_OWN_GIL, }; PyThreadState *tstate = NULL; PyStatus status = Py_NewInterpreterFromConfig(&tstate, &config); if (PyStatus_Exception(status)) { Py_ExitStatusException(status); } ``` Обратите внимание, что config используется только кратковременно и не изменяется. Во время инициализации значения config преобразуются в различные значения [`PyInterpreterState`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState). Копия config только для чтения может быть сохранена внутри на [`PyInterpreterState`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState). Модули расширения совместно используются (под-)интерпретаторами следующим образом: - Для модулей, использующих многофазную инициализацию, например [`PyModule_FromDefAndSpec()`](https://python-all.ru/3.12/c-api/module.html#c.PyModule_FromDefAndSpec), для каждого интерпретатора создаётся и инициализируется отдельный объект модуля. Между этими объектами модулей совместно используются только статические и глобальные переменные на уровне C. - Для модулей, использующих однофазную инициализацию, например [`PyModule_Create()`](https://python-all.ru/3.12/c-api/module.html#c.PyModule_Create), при первом импорте определённого расширения оно инициализируется обычным образом, и (поверхностная) копия его словаря модуля сохраняется. Когда то же расширение импортируется другим (под-)интерпретатором, новый модуль инициализируется и заполняется содержимым этой копии; функция `init` расширения не вызывается. Таким образом, объекты в словаре модуля оказываются общими для (под-)интерпретаторов, что может вызывать нежелательное поведение (см. [Ошибки и предостережения](https://python-all.ru/3.12/c-api/init.html#bugs-and-caveats) ниже). Обратите внимание, что это отличается от ситуации, когда расширение импортируется после полной повторной инициализации интерпретатора вызовом [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx) и [`Py_Initialize()`](https://python-all.ru/3.12/c-api/init.html#c.Py_Initialize); в этом случае функция `initmodule` расширения *вызывается* снова. Как и при многофазной инициализации, это означает, что между этими модулями совместно используются только статические и глобальные переменные на уровне C. #### `PyThreadState *Py_NewInterpreter(void)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Создаёт новый под-интерпретатор. По сути, это просто обёртка вокруг [`Py_NewInterpreterFromConfig()`](https://python-all.ru/3.12/c-api/init.html#c.Py_NewInterpreterFromConfig) с config, который сохраняет существующее поведение. Результатом является неизолированный под-интерпретатор, который разделяет GIL главного интерпретатора, допускает fork/exec, разрешает фоновые потоки и допускает модули с однофазной инициализацией. #### `void Py_EndInterpreter(PyThreadState *tstate)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Уничтожает (под-)интерпретатор, представленный указанным состоянием потока. Указанное состояние потока должно быть текущим состоянием потока. См. обсуждение состояний потока ниже. Когда вызов возвращает управление, текущее состояние потока равно `NULL`. Все состояния потока, связанные с этим интерпретатором, уничтожаются. Глобальная блокировка интерпретатора, используемая целевым интерпретатором, должна быть захвачена перед вызовом этой функции. При возврате GIL не удерживается. [`Py_FinalizeEx()`](https://python-all.ru/3.12/c-api/init.html#c.Py_FinalizeEx) уничтожит все под-интерпретаторы, которые не были явно уничтожены к этому моменту. ### Перинтерпретаторный GIL С помощью [`Py_NewInterpreterFromConfig()`](https://python-all.ru/3.12/c-api/init.html#c.Py_NewInterpreterFromConfig) можно создать под-интерпретатор, который полностью изолирован от других интерпретаторов, в том числе имеет собственный GIL. Самое главное преимущество такой изоляции в том, что такой интерпретатор может выполнять код Python, не блокируясь другими интерпретаторами и не блокируя их. Таким образом, один процесс Python может по-настоящему задействовать несколько ядер CPU при выполнении кода Python. Изоляция также способствует иному подходу к конкурентности, нежели просто использование потоков. (См. [**PEP 554**](https://python-all.ru/3.12/c-api/init.html).) Использование изолированного интерпретатора требует осторожности для сохранения этой изоляции. Это особенно означает, что нельзя передавать объекты или изменяемое состояние без гарантий потокобезопасности. Даже объекты, которые в остальном неизменяемы (например, `None`, `(1, 5)`), обычно нельзя передавать из-за счётчика ссылок. Один из простых, но менее эффективных подходов к этому – использовать глобальную блокировку при любой работе с некоторым состоянием (или объектом). В качестве альтернативы, практически неизменяемые объекты (например, целые числа или строки) можно сделать безопасными, несмотря на их счётчики ссылок, сделав их «бессмертными». На самом деле, это уже сделано для встроенных одиночных объектов, малых целых чисел и ряда других встроенных объектов. Если сохранять изоляцию, то будет доступ к настоящим многоядерным вычислениям без осложнений, связанных со свободной многопоточностью. Несоблюдение изоляции приведёт ко всем последствиям свободной многопоточности, включая гонки и трудноотлаживаемые крахи. Кроме того, одна из главных проблем использования нескольких изолированных интерпретаторов – как безопасно (не нарушая изоляцию) и эффективно общаться между ними. Среда выполнения и стандартная библиотека пока не предоставляют стандартного подхода для этого. Будущий модуль стандартной библиотеки поможет уменьшить усилия по сохранению изоляции и предоставит эффективные инструменты для обмена (и совместного использования) данными между интерпретаторами. Добавлено в версии 3.12. ### Ошибки и предостережения Поскольку под-интерпретаторы (и главный интерпретатор) являются частью одного процесса, изоляция между ними не идеальна – например, с помощью низкоуровневых файловых операций, таких как [`os.close()`](https://python-all.ru/3.12/library/os.html#os.close), они могут (случайно или намеренно) влиять на открытые файлы друг друга. Из-за того, как расширения совместно используются (под-)интерпретаторами, некоторые расширения могут работать некорректно; это особенно вероятно при использовании однофазной инициализации или (статических) глобальных переменных. Можно вставлять объекты, созданные в одном под-интерпретаторе, в пространство имён другого (под-)интерпретатора; этого следует избегать, если возможно. Следует проявлять особую осторожность, чтобы избежать совместного использования пользовательских функций, методов, экземпляров или классов между под-интерпретаторами, поскольку операции импорта, выполняемые такими объектами, могут повлиять на словарь загруженных модулей не того (под-)интерпретатора. Не менее важно избегать совместного использования объектов, из которых доступны вышеперечисленные. Также обратите внимание, что комбинирование этой функциональности с API `PyGILState_*` является деликатным, поскольку эти API предполагают взаимно однозначное соответствие между состояниями потоков Python и потоками уровня ОС, а это предположение нарушается наличием под-интерпретаторов. Настоятельно рекомендуется не переключать под-интерпретаторы между парой соответствующих вызовов [`PyGILState_Ensure()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Ensure) и [`PyGILState_Release()`](https://python-all.ru/3.12/c-api/init.html#c.PyGILState_Release). Более того, расширения (такие как [`ctypes`](https://python-all.ru/3.12/library/ctypes.html#module-ctypes)), использующие эти API для вызова кода Python из потоков, созданных не в Python, вероятно, будут работать неправильно при использовании под-интерпретаторов. ## Асинхронные уведомления Предоставляется механизм для асинхронных уведомлений основному потоку интерпретатора. Эти уведомления имеют форму указателя на функцию и аргумента в виде указателя void. #### `int Py_AddPendingCall(int (*func)(void*), void *arg)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* Планирует вызов функции из основного потока интерпретатора. В случае успеха возвращается `0`, и *func* помещается в очередь для вызова в основном потоке. В случае неудачи возвращается `-1` без установки какого-либо исключения. При успешной постановке в очередь *func* будет *в конечном итоге* вызвана из основного потока интерпретатора с аргументом *arg*. Она будет вызвана асинхронно по отношению к нормально выполняющемуся коду Python, но при соблюдении обоих этих условий: - на границе [байткода](https://python-all.ru/3.12/glossary.html#term-bytecode); - при этом главный поток удерживает [глобальную блокировку интерпретатора](https://python-all.ru/3.12/glossary.html#term-global-interpreter-lock) (поэтому *func* может использовать полный C API). *func* должна возвращать `0` при успехе или `-1` при неудаче с установленным исключением. *func* не будет прервана для рекурсивного выполнения другого асинхронного уведомления, но её всё ещё можно прервать для переключения потоков, если глобальная блокировка интерпретатора освобождена. Для выполнения этой функции не требуется текущее состояние потока, и ей не нужна глобальная блокировка интерпретатора. Для вызова этой функции в под-интерпретаторе вызывающий должен удерживать GIL. В противном случае функция *func* может быть запланирована к вызову из неправильного интерпретатора. > **Предупреждение** > > Это низкоуровневая функция, полезная только в особых случаях. Нет гарантии, что *func* будет вызвана максимально быстро. Если главный поток занят выполнением системного вызова, *func* не будет вызвана до возврата из системного вызова. Эта функция в целом **не** подходит для вызова кода Python из произвольных C-потоков. Вместо неё используйте [PyGILState API](https://python-all.ru/3.12/c-api/init.html#gilstate). Добавлено в версии 3.1. Изменено в версии 3.9: Если эта функция вызывается в подынтерпретаторе, функция *func* теперь планируется для вызова из подынтерпретатора, а не из основного интерпретатора. Каждый подынтерпретатор теперь имеет свой собственный список запланированных вызовов. ## Профилирование и трассировка Интерпретатор Python предоставляет низкоуровневую поддержку для подключения средств профилирования и трассировки выполнения. Они используются в инструментах профилирования, отладки и анализа покрытия. Этот C-интерфейс позволяет коду профилирования или трассировки избежать накладных расходов на вызов через вызываемые объекты уровня Python, выполняя вместо этого прямой вызов C-функции. Основные характеристики механизма не изменились; интерфейс позволяет устанавливать функции трассировки для каждого потока, а базовые события, сообщаемые функции трассировки, такие же, как и в предыдущих версиях для функций трассировки уровня Python. #### `typedef int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg)` Тип функции трассировки, регистрируемой с помощью [`PyEval_SetProfile()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetProfile) и [`PyEval_SetTrace()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetTrace). Первый параметр – это объект, переданный функции регистрации как *obj*, *frame* – это объект фрейма, к которому относится событие, *what* – одна из констант [`PyTrace_CALL`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_CALL), [`PyTrace_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_EXCEPTION), [`PyTrace_LINE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_LINE), [`PyTrace_RETURN`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_RETURN), [`PyTrace_C_CALL`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_CALL), [`PyTrace_C_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_EXCEPTION), [`PyTrace_C_RETURN`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_RETURN) или [`PyTrace_OPCODE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_OPCODE), а *arg* зависит от значения *what*: | Значение *what* | Смысл *arg* | | --- | --- | | [`PyTrace_CALL`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_CALL) | Всегда [`Py_None`](https://python-all.ru/3.12/c-api/none.html#c.Py_None). | | [`PyTrace_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_EXCEPTION) | Информация об исключении, возвращаемая [`sys.exc_info()`](https://python-all.ru/3.12/library/sys.html#sys.exc_info). | | [`PyTrace_LINE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_LINE) | Всегда [`Py_None`](https://python-all.ru/3.12/c-api/none.html#c.Py_None). | | [`PyTrace_RETURN`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_RETURN) | Значение, возвращаемое вызывающему коду, или `NULL`, если вызвано исключением. | | [`PyTrace_C_CALL`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_CALL) | Вызываемый объект функции. | | [`PyTrace_C_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_EXCEPTION) | Вызываемый объект функции. | | [`PyTrace_C_RETURN`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_RETURN) | Вызываемый объект функции. | | [`PyTrace_OPCODE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_OPCODE) | Всегда [`Py_None`](https://python-all.ru/3.12/c-api/none.html#c.Py_None). | #### `int PyTrace_CALL` Значение параметра *what* для функции [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда сообщается о новом вызове функции или метода, или о новом входе в генератор. Обратите внимание, что создание итератора для функции-генератора не сообщается, поскольку в соответствующем фрейме не происходит передачи управления байт-коду Python. #### `int PyTrace_EXCEPTION` Значение параметра *what* в функции [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда возникло исключение. Функция колбэка вызывается с этим значением для *what* после обработки любого байт-кода, после которого исключение оказывается установленным в выполняемом фрейме. Эффект этого заключается в том, что по мере распространения исключения, вызывающего раскрутку стека Python, колбэк вызывается при возврате в каждый фрейм по мере распространения исключения. Только функции трассировки получают эти события; профилировщику они не нужны. #### `int PyTrace_LINE` Значение, передаваемое в качестве параметра *what* функции [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc) (но не функции профилирования), когда сообщается о событии номера строки. Его можно отключить для фрейма, установив [`f_trace_lines`](https://python-all.ru/3.12/reference/datamodel.html#frame.f_trace_lines) в *0* в этом фрейме. #### `int PyTrace_RETURN` Значение параметра *what* для функций [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда вызов собирается вернуться. #### `int PyTrace_C_CALL` Значение параметра *what* для функций [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда собирается быть вызвана C-функция. #### `int PyTrace_C_EXCEPTION` Значение параметра *what* для функций [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда C-функция вызвала исключение. #### `int PyTrace_C_RETURN` Значение параметра *what* для функций [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc), когда C-функция вернулась. #### `int PyTrace_OPCODE` Значение параметра *what* для функций [`Py_tracefunc`](https://python-all.ru/3.12/c-api/init.html#c.Py_tracefunc) (но не функций профилирования), когда собирается быть выполнен новый опкод. Это событие не генерируется по умолчанию: его нужно явно запросить, установив [`f_trace_opcodes`](https://python-all.ru/3.12/reference/datamodel.html#frame.f_trace_opcodes) в *1* во фрейме. #### `void PyEval_SetProfile(Py_tracefunc func, PyObject *obj)` Устанавливает функцию профилирования в *func*. Параметр *obj* передаётся функции в качестве первого аргумента; это может быть любой объект Python или `NULL`. Если функции профилирования нужно поддерживать состояние, использование разных значений *obj* для каждого потока предоставляет удобное и потокобезопасное место для его хранения. Функция профилирования вызывается для всех отслеживаемых событий, кроме [`PyTrace_LINE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_LINE), [`PyTrace_OPCODE`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_OPCODE) и [`PyTrace_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_EXCEPTION). См. также функцию [`sys.setprofile()`](https://python-all.ru/3.12/library/sys.html#sys.setprofile). Вызывающий должен удерживать [GIL](https://python-all.ru/3.12/glossary.html#term-GIL). #### `void PyEval_SetProfileAllThreads(Py_tracefunc func, PyObject *obj)` Как [`PyEval_SetProfile()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetProfile), но устанавливает функцию профилирования во всех работающих потоках, принадлежащих текущему интерпретатору, а не только в текущем потоке. Вызывающий должен удерживать [GIL](https://python-all.ru/3.12/glossary.html#term-GIL). Как и [`PyEval_SetProfile()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetProfile), эта функция игнорирует любые исключения, возникшие при установке функций профилирования во всех потоках. Добавлено в версии 3.12. #### `void PyEval_SetTrace(Py_tracefunc func, PyObject *obj)` Устанавливает функцию трассировки в *func*. Это похоже на [`PyEval_SetProfile()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetProfile), за исключением того, что функция трассировки получает события номеров строк и события на каждую операцию, но не получает событий, связанных с вызовом объектов функций C. Любая функция трассировки, зарегистрированная через [`PyEval_SetTrace()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetTrace), не будет получать [`PyTrace_C_CALL`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_CALL), [`PyTrace_C_EXCEPTION`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_EXCEPTION) или [`PyTrace_C_RETURN`](https://python-all.ru/3.12/c-api/init.html#c.PyTrace_C_RETURN) в качестве значения параметра *what*. См. также функцию [`sys.settrace()`](https://python-all.ru/3.12/library/sys.html#sys.settrace). Вызывающий должен удерживать [GIL](https://python-all.ru/3.12/glossary.html#term-GIL). #### `void PyEval_SetTraceAllThreads(Py_tracefunc func, PyObject *obj)` Как [`PyEval_SetTrace()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetTrace), но устанавливает функцию трассировки во всех работающих потоках, принадлежащих текущему интерпретатору, а не только в текущем потоке. Вызывающий должен удерживать [GIL](https://python-all.ru/3.12/glossary.html#term-GIL). Как и [`PyEval_SetTrace()`](https://python-all.ru/3.12/c-api/init.html#c.PyEval_SetTrace), эта функция игнорирует любые исключения, возникшие при установке функций трассировки во всех потоках. Добавлено в версии 3.12. ## Поддержка расширенного отладчика Эти функции предназначены только для использования расширенными инструментами отладки. #### `PyInterpreterState *PyInterpreterState_Head()` Возвращает объект состояния интерпретатора, находящийся в начале списка всех таких объектов. #### `PyInterpreterState *PyInterpreterState_Main()` Возвращает объект состояния основного интерпретатора. #### `PyInterpreterState *PyInterpreterState_Next(PyInterpreterState *interp)` Возвращает следующий объект состояния интерпретатора после *interp* из списка всех таких объектов. #### `PyThreadState *PyInterpreterState_ThreadHead(PyInterpreterState *interp)` Возвращает указатель на первый объект [`PyThreadState`](https://python-all.ru/3.12/c-api/init.html#c.PyThreadState) в списке потоков, связанных с интерпретатором *interp*. #### `PyThreadState *PyThreadState_Next(PyThreadState *tstate)` Возвращает следующий объект состояния потока после *tstate* из списка всех таких объектов, принадлежащих тому же объекту [`PyInterpreterState`](https://python-all.ru/3.12/c-api/init.html#c.PyInterpreterState). ## Поддержка локального хранилища потоков Интерпретатор Python предоставляет низкоуровневую поддержку для потоково-локального хранилища (TLS), которая оборачивает базовую нативную реализацию TLS для поддержки API потоково-локального хранилища на уровне Python ([`threading.local`](https://python-all.ru/3.12/library/threading.html#threading.local)). API CPython на уровне C похожи на те, что предоставляются pthreads и Windows: используется ключ потока и функции для ассоциации void\* значения на поток. GIL *не* нужно удерживать при вызове этих функций; они обеспечивают собственную блокировку. Обратите внимание, что `Python.h` не содержит объявления TLS-функций; для использования локальной памяти потока необходимо включить `pythread.h`. > **Примечание** > > Ни одна из этих функций API не занимается управлением памятью для значений void\*. Вы должны сами выделять и освобождать память. Если значения void\* оказываются [PyObject](https://python-all.ru/3.12/c-api/structures.html#c.PyObject)\*, эти функции также не выполняют операции с подсчётом ссылок. ### API потоково-специфичного хранилища (TSS) API TSS введен для замены использования существующего API TLS в интерпретаторе CPython. Этот API использует новый тип [`Py_tss_t`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_t) вместо int для представления ключей потоков. Добавлено в версии 3.7. > **См. также** > > «Новый C-API для локальной памяти потока в CPython» ([**PEP 539**](https://python-all.ru/3.12/c-api/init.html)) #### `type Py_tss_t` Эта структура данных представляет состояние ключа потока; её определение может зависеть от конкретной реализации TLS, и она содержит внутреннее поле, отражающее состояние инициализации ключа. Открытых членов этой структуры нет. Если [Py\_LIMITED\_API](https://python-all.ru/3.12/c-api/stable.html#stable) не определён, допускается статическое размещение этого типа с помощью [`Py_tss_NEEDS_INIT`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_NEEDS_INIT). #### `Py_tss_NEEDS_INIT` Этот макрос раскрывается в инициализатор для переменных типа [`Py_tss_t`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_t). Обратите внимание, что этот макрос не будет определён вместе с [Py\_LIMITED\_API](https://python-all.ru/3.12/c-api/stable.html#stable). #### Динамическое выделение Динамическое выделение [`Py_tss_t`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_t) требуется в модулях расширения, собранных с [Py\_LIMITED\_API](https://python-all.ru/3.12/c-api/stable.html#stable), где статическое размещение этого типа невозможно из-за того, что его реализация скрыта во время сборки. #### `Py_tss_t *PyThread_tss_alloc()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает значение, находящееся в том же состоянии, что и значение, инициализированное с помощью [`Py_tss_NEEDS_INIT`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_NEEDS_INIT), или `NULL` в случае ошибки динамического выделения. #### `void PyThread_tss_free(Py_tss_t *key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Освобождает заданный *key*, выделенный с помощью [`PyThread_tss_alloc()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_alloc), предварительно вызвав [`PyThread_tss_delete()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_delete), чтобы сбросить все привязанные к нему локальные данные потока. Эта операция ничего не делает, если аргумент *key* равен `NULL`. > **Примечание** > > Освобождённый ключ становится висячим указателем. Следует сбросить ключ обратно в `NULL`. #### Методы Параметр *key* этих функций не должен быть `NULL`. Кроме того, поведение [`PyThread_tss_set()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_set) и [`PyThread_tss_get()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_get) не определено, если заданный [`Py_tss_t`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_t) не был инициализирован с помощью [`PyThread_tss_create()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_create). #### `int PyThread_tss_is_created(Py_tss_t *key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает ненулевое значение, если заданный [`Py_tss_t`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_t) был инициализирован с помощью [`PyThread_tss_create()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_create). #### `int PyThread_tss_create(Py_tss_t *key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает нулевое значение при успешной инициализации TSS-ключа. Поведение не определено, если значение, на которое указывает аргумент *key*, не инициализировано с помощью [`Py_tss_NEEDS_INIT`](https://python-all.ru/3.12/c-api/init.html#c.Py_tss_NEEDS_INIT). Эту функцию можно вызывать для одного и того же ключа многократно – вызов для уже инициализированного ключа ничего не делает и сразу возвращает успех. #### `void PyThread_tss_delete(Py_tss_t *key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Уничтожает TSS-ключ, забывая связанные с ним значения во всех потоках, и переводит состояние инициализации ключа в «не инициализирован». Уничтоженный ключ можно повторно инициализировать с помощью [`PyThread_tss_create()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_tss_create). Эту функцию можно вызывать для одного и того же ключа многократно – вызов для уже уничтоженного ключа ничего не делает. #### `int PyThread_tss_set(Py_tss_t *key, void *value)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает нулевое значение при успешной привязке значения void\* к TSS-ключу в текущем потоке. Каждый поток имеет собственное отображение ключа на значение void\*. #### `void *PyThread_tss_get(Py_tss_t *key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable) начиная с версии 3.7.* Возвращает значение void\*, связанное с ключом TSS в текущем потоке. Возвращает `NULL`, если с ключом в текущем потоке не связано никакого значения. ### API локального хранилища потоков (TLS) Устарело с версии 3.7: Этот API заменён [API поток-специфичного хранилища (TSS)](https://python-all.ru/3.12/c-api/init.html#thread-specific-storage-api). > **Примечание** > > Эта версия API не поддерживает платформы, где нативный ключ TLS определён так, что его нельзя безопасно привести к `int`. На таких платформах [`PyThread_create_key()`](https://python-all.ru/3.12/c-api/init.html#c.PyThread_create_key) немедленно возвращает статус ошибки, а остальные функции TLS на таких платформах ничего не делают. Из-за упомянутой выше проблемы совместимости эту версию API не следует использовать в новом коде. #### `int PyThread_create_key()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* #### `void PyThread_delete_key(int key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* #### `int PyThread_set_key_value(int key, void *value)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* #### `void *PyThread_get_key_value(int key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* #### `void PyThread_delete_key_value(int key)` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).* #### `void PyThread_ReInitTLS()` *Часть [Stable ABI](https://python-all.ru/3.12/c-api/stable.html#stable).*