# Ініціалізація, фіналізація та потоки

See Python Initialization Configuration for details on how to configure the interpreter prior to initialization.

## Перед ініціалізацією Python

У програмі, яка вбудовує Python, функція `Py_Initialize()` має бути викликана перед використанням будь-яких інших функцій API Python/C; за винятком кількох функцій і глобальних змінних конфігурації.

Наступні функції можна безпечно викликати до ініціалізації Python:

- Functions that initialize the interpreter:

  - `Py_Initialize()`

  - `Py_InitializeEx()`

  - `Py_InitializeFromConfig()`

  - `Py_BytesMain()`

  - `Py_Main()`

  - the runtime pre-initialization functions covered in Конфігурація ініціалізації Python

- Функції конфігурації:

  - `PyImport_AppendInittab()`

  - `PyImport_ExtendInittab()`

  - `PyInitFrozenExtensions()`

  - `PyMem_SetAllocator()`

  - `PyMem_SetupDebugHooks()`

  - `PyObject_SetArenaAllocator()`

  - `Py_SetProgramName()`

  - `Py_SetPythonHome()`

  - the configuration functions covered in Конфігурація ініціалізації Python

- Інформативні функції:

  - `Py_IsInitialized()`

  - `PyMem_GetAllocator()`

  - `PyObject_GetArenaAllocator()`

  - `Py_GetBuildInfo()`

  - `Py_GetCompiler()`

  - `Py_GetCopyright()`

  - `Py_GetPlatform()`

  - `Py_GetVersion()`

  - `Py_IsInitialized()`

- Утиліти:

  - `Py_DecodeLocale()`

  - the status reporting and utility functions covered in Конфігурація ініціалізації Python

- Розподільники пам’яті:

  - `PyMem_RawMalloc()`

  - `PyMem_RawRealloc()`

  - `PyMem_RawCalloc()`

  - `PyMem_RawFree()`

- Synchronization:

  - `PyMutex_Lock()`

  - `PyMutex_Unlock()`

Примітка

Despite their apparent similarity to some of the functions listed above, the following functions should not be called before the interpreter has been initialized: `Py_EncodeLocale()`, `PyEval_InitThreads()`, and `Py_RunMain()`.

## Глобальні змінні конфігурації

Python має змінні для глобальної конфігурації для керування різними функціями та параметрами. За замовчуванням ці позначки контролюються параметрами командного рядка.

Коли параметр встановлює прапор, значення прапора дорівнює кількості разів, коли цей параметр було встановлено. Наприклад, `-b` встановлює `Py_BytesWarningFlag` на 1, а `-bb` встановлює `Py_BytesWarningFlag` на 2.

int Py_BytesWarningFlag

  This API is kept for backward compatibility: setting `PyConfig.bytes_warning` should be used instead, see Python Initialization Configuration.

  Видає попередження, коли порівнює `bytes` або `bytearray` з `str` або `bytes` з `int`. Видає помилку, якщо більше або дорівнює `2`.

  Встановлюється параметром `-b`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_DebugFlag

  This API is kept for backward compatibility: setting `PyConfig.parser_debug` should be used instead, see Python Initialization Configuration.

  Увімкніть вихід налагодження аналізатора (лише для експерта, залежно від параметрів компіляції).

  Встановлюється параметром `-d` і змінною середовища `PYTHONDEBUG`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_DontWriteBytecodeFlag

  This API is kept for backward compatibility: setting `PyConfig.write_bytecode` should be used instead, see Python Initialization Configuration.

  Якщо встановлено ненульове значення, Python не намагатиметься записати файли `.pyc` під час імпорту вихідних модулів.

  Встановлюється параметром `-B` і змінною середовища `PYTHONDONTWRITEBYTECODE`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_FrozenFlag

  This API is kept for backward compatibility: setting `PyConfig.pathconfig_warnings` should be used instead, see Python Initialization Configuration.

  Private flag used by `_freeze_module` and `frozenmain` programs.

  Deprecated since version 3.12, removed in version 3.15.

int Py_HashRandomizationFlag

  This API is kept for backward compatibility: setting `PyConfig.hash_seed` and `PyConfig.use_hash_seed` should be used instead, see Python Initialization Configuration.

  Установіть значення `1`, якщо змінна середовища `PYTHONHASHSEED` має значення непорожнього рядка.

  Якщо прапорець відмінний від нуля, прочитайте змінну середовища `PYTHONHASHSEED`, щоб ініціалізувати секретне початкове значення хешу.

  Deprecated since version 3.12, removed in version 3.15.

int Py_IgnoreEnvironmentFlag

  This API is kept for backward compatibility: setting `PyConfig.use_environment` should be used instead, see Python Initialization Configuration.

  Ignore all `PYTHON*` environment variables, e.g. `PYTHONPATH` and `PYTHONHOME`, that might be set.

  Встановлюється параметрами `-E` і `-I`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_InspectFlag

  This API is kept for backward compatibility: setting `PyConfig.inspect` should be used instead, see Python Initialization Configuration.

  Якщо сценарій передається як перший аргумент або використовується параметр `-c`, увійдіть в інтерактивний режим після виконання сценарію або команди, навіть якщо `sys.stdin` не виглядає як термінал.

  Встановлюється параметром `-i` і змінною середовища `PYTHONINSPECT`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_InteractiveFlag

  This API is kept for backward compatibility: setting `PyConfig.interactive` should be used instead, see Python Initialization Configuration.

  Встановлюється параметром `-i`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_IsolatedFlag

  This API is kept for backward compatibility: setting `PyConfig.isolated` should be used instead, see Python Initialization Configuration.

  Запустіть Python в ізольованому режимі. В ізольованому режимі `sys.path` не містить ані каталогу сценарію, ані каталогу сайту-пакетів користувача.

  Встановлюється параметром `-I`.

  Added in version 3.4.

  Deprecated since version 3.12, removed in version 3.15.

int Py_LegacyWindowsFSEncodingFlag

  This API is kept for backward compatibility: setting `PyPreConfig.legacy_windows_fs_encoding` should be used instead, see Python Initialization Configuration.

  Якщо прапорець відмінний від нуля, використовуйте кодування `mbcs` із обробником помилок `replace`, замість кодування UTF-8 із `surrogatepass` обробником помилок, для filesystem encoding and error handler.

  Установіть значення `1`, якщо змінна середовища `PYTHONLEGACYWINDOWSFSENCODING` має значення непорожнього рядка.

  Дивіться PEP 529 для більш детальної інформації.

  Availability: Windows.

  Deprecated since version 3.12, removed in version 3.15.

int Py_LegacyWindowsStdioFlag

  This API is kept for backward compatibility: setting `PyConfig.legacy_windows_stdio` should be used instead, see Python Initialization Configuration.

  If the flag is non-zero, use `io.FileIO` instead of `io._WindowsConsoleIO` for `sys` standard streams.

  Установіть значення `1`, якщо змінна середовища `PYTHONLEGACYWINDOWSSTDIO` має значення непорожнього рядка.

  Дивіться PEP 528 для більш детальної інформації.

  Availability: Windows.

  Deprecated since version 3.12, removed in version 3.15.

int Py_NoSiteFlag

  This API is kept for backward compatibility: setting `PyConfig.site_import` should be used instead, see Python Initialization Configuration.

  Вимкніть імпорт модуля `site` і залежні від сайту маніпуляції `sys.path`, які він передбачає. Також вимкніть ці маніпуляції, якщо `site` буде явно імпортовано пізніше (викличте `site.main()`, якщо ви хочете, щоб вони були активовані).

  Встановлюється параметром `-S`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_NoUserSiteDirectory

  This API is kept for backward compatibility: setting `PyConfig.user_site_directory` should be used instead, see Python Initialization Configuration.

  Не додавайте каталог `user site-packages` до `sys.path`.

  Встановлюється параметрами `-s` і `-I`, а також змінною середовища `PYTHONNOUSERSITE`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_OptimizeFlag

  This API is kept for backward compatibility: setting `PyConfig.optimization_level` should be used instead, see Python Initialization Configuration.

  Встановлюється параметром `-O` і змінною середовища `PYTHONOPTIMIZE`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_QuietFlag

  This API is kept for backward compatibility: setting `PyConfig.quiet` should be used instead, see Python Initialization Configuration.

  Не відображайте повідомлення про авторські права та версію навіть в інтерактивному режимі.

  Встановлюється параметром `-q`.

  Added in version 3.2.

  Deprecated since version 3.12, removed in version 3.15.

int Py_UnbufferedStdioFlag

  This API is kept for backward compatibility: setting `PyConfig.buffered_stdio` should be used instead, see Python Initialization Configuration.

  Примусово розбуферизувати потоки stdout і stderr.

  Встановлюється параметром `-u` і змінною середовища `PYTHONUNBUFFERED`.

  Deprecated since version 3.12, removed in version 3.15.

int Py_VerboseFlag

  This API is kept for backward compatibility: setting `PyConfig.verbose` should be used instead, see Python Initialization Configuration.

  Друкувати повідомлення кожного разу, коли модуль ініціалізовано, із зазначенням місця (ім’я файлу чи вбудованого модуля), з якого він завантажується. Якщо більше або дорівнює `2`, друкувати повідомлення для кожного файлу, який перевіряється під час пошуку модуля. Також надає інформацію про очищення модуля при виході.

  Встановлюється параметром `-v` і змінною середовища `PYTHONVERBOSE`.

  Deprecated since version 3.12, removed in version 3.15.

## Ініціалізація та завершення інтерпретатора

void Py_Initialize()
  Part of the Stable ABI.

  Ініціалізація інтерпретатора Python. У програмі, що вбудовує Python, це слід викликати перед використанням будь-яких інших функцій API Python/C; див. Перед ініціалізацією Python для кількох винятків.

  This initializes the table of loaded modules (`sys.modules`), and creates the fundamental modules `builtins`, `__main__` and `sys`. It also initializes the module search path (`sys.path`). It does not set `sys.argv`; use the Python Initialization Configuration API for that. This is a no-op when called for a second time (without calling `Py_FinalizeEx()` first). There is no return value; it is a fatal error if the initialization fails.

  Use `Py_InitializeFromConfig()` to customize the Python Initialization Configuration.

  Примітка

  У Windows змінює режим консолі з `O_TEXT` на `O_BINARY`, що також вплине на використання консолі не на Python за допомогою C Runtime.

void Py_InitializeEx(int initsigs)
  Part of the Stable ABI.

  This function works like `Py_Initialize()` if initsigs is `1`. If initsigs is `0`, it skips initialization registration of signal handlers, which may be useful when CPython is embedded as part of a larger application.

  Use `Py_InitializeFromConfig()` to customize the Python Initialization Configuration.

PyStatus Py_InitializeFromConfig(const PyConfig *config)

  Initialize Python from config configuration, as described in Ініціалізація за допомогою PyConfig.

  See the Конфігурація ініціалізації Python section for details on pre-initializing the interpreter, populating the runtime configuration structure, and querying the returned status structure.

int Py_IsInitialized()
  Part of the Stable ABI.

  Повертає істину (не нуль), якщо інтерпретатор Python ініціалізовано, і false (нуль), якщо ні. Після виклику `Py_FinalizeEx()` повертається false, доки `Py_Initialize()` не буде викликано знову.

int Py_IsFinalizing()
  Part of the Stable ABI since version 3.13.

  Return true (non-zero) if the main Python interpreter is shutting down. Return false (zero) otherwise.

  Added in version 3.13.

int Py_FinalizeEx()
  Part of the Stable ABI since version 3.6.

  Undo all initializations made by `Py_Initialize()` and subsequent use of Python/C API functions, and destroy all sub-interpreters (see `Py_NewInterpreter()` below) that were created and not yet destroyed since the last call to `Py_Initialize()`. This is a no-op when called for a second time (without calling `Py_Initialize()` again first).

  Since this is the reverse of `Py_Initialize()`, it should be called in the same thread with the same interpreter active. That means the main thread and the main interpreter. This should never be called while `Py_RunMain()` is running.

  Normally the return value is `0`. If there were errors during finalization (flushing buffered data), `-1` is returned.

  Note that Python will do a best effort at freeing all memory allocated by the Python interpreter. Therefore, any C-Extension should make sure to correctly clean up all of the preveiously allocated PyObjects before using them in subsequent calls to `Py_Initialize()`. Otherwise it could introduce vulnerabilities and incorrect behavior.

  Ця функція передбачена з кількох причин. Програма для вбудовування може захотіти перезапустити Python без необхідності перезапускати саму програму. Програма, яка завантажила інтерпретатор Python із динамічно завантажуваної бібліотеки (або DLL), може захотіти звільнити всю пам’ять, виділену Python, перед вивантаженням DLL. Під час пошуку витоків пам’яті в програмі розробник може захотіти звільнити всю пам’ять, виділену Python, перш ніж вийти з програми.

  Bugs and caveats: The destruction of modules and objects in modules is done in random order; this may cause destructors (`__del__()` methods) to fail when they depend on other objects (even functions) or modules. Dynamically loaded extension modules loaded by Python are not unloaded. Small amounts of memory allocated by the Python interpreter may not be freed (if you find a leak, please report it). Memory tied up in circular references between objects is not freed. Interned strings will all be deallocated regardless of their reference count. Some memory allocated by extension modules may not be freed. Some extensions may not work properly if their initialization routine is called more than once; this can happen if an application calls `Py_Initialize()` and `Py_FinalizeEx()` more than once. `Py_FinalizeEx()` must not be called recursively from within itself. Therefore, it must not be called by any code that may be run as part of the interpreter shutdown process, such as `atexit` handlers, object finalizers, or any code that may be run while flushing the stdout and stderr files.

  Викликає подію аудиту `cpython._PySys_ClearAuditHooks` без аргументів.

  Added in version 3.6.

void Py_Finalize()
  Part of the Stable ABI.

  Це зворотно сумісна версія `Py_FinalizeEx()`, яка не враховує значення, що повертається.

int Py_BytesMain(int argc, char **argv)
  Part of the Stable ABI since version 3.8.

  Similar to `Py_Main()` but argv is an array of bytes strings, allowing the calling application to delegate the text decoding step to the CPython runtime.

  Added in version 3.8.

int Py_Main(int argc, wchar_t **argv)
  Part of the Stable ABI.

  The main program for the standard interpreter, encapsulating a full initialization/finalization cycle, as well as additional behaviour to implement reading configurations settings from the environment and command line, and then executing `__main__` in accordance with Командний рядок.

  This is made available for programs which wish to support the full CPython command line interface, rather than just embedding a Python runtime in a larger application.

  The argc and argv parameters are similar to those which are passed to a C program’s `main()` function, except that the argv entries are first converted to `wchar_t` using `Py_DecodeLocale()`. It is also important to note that the argument list entries may be modified to point to strings other than those passed in (however, the contents of the strings pointed to by the argument list are not modified).

  The return value is `2` if the argument list does not represent a valid Python command line, and otherwise the same as `Py_RunMain()`.

  In terms of the CPython runtime configuration APIs documented in the runtime configuration section (and without accounting for error handling), `Py_Main` is approximately equivalent to:

      PyConfig config;
      PyConfig_InitPythonConfig(&config);
      PyConfig_SetArgv(&config, argc, argv);
      Py_InitializeFromConfig(&config);
      PyConfig_Clear(&config);

      Py_RunMain();

  In normal usage, an embedding application will call this function instead of calling `Py_Initialize()`, `Py_InitializeEx()` or `Py_InitializeFromConfig()` directly, and all settings will be applied as described elsewhere in this documentation. If this function is instead called after a preceding runtime initialization API call, then exactly which environmental and command line configuration settings will be updated is version dependent (as it depends on which settings correctly support being modified after they have already been set once when the runtime was first initialized).

int Py_RunMain(void)

  Executes the main module in a fully configured CPython runtime.

  Executes the command (`PyConfig.run_command`), the script (`PyConfig.run_filename`) or the module (`PyConfig.run_module`) specified on the command line or in the configuration. If none of these values are set, runs the interactive Python prompt (REPL) using the `__main__` module’s global namespace.

  If `PyConfig.inspect` is not set (the default), the return value will be `0` if the interpreter exits normally (that is, without raising an exception), the exit status of an unhandled `SystemExit`, or `1` for any other unhandled exception.

  If `PyConfig.inspect` is set (such as when the `-i` option is used), rather than returning when the interpreter exits, execution will instead resume in an interactive Python prompt (REPL) using the `__main__` module’s global namespace. If the interpreter exited with an exception, it is immediately raised in the REPL session. The function return value is then determined by the way the REPL session terminates: `0`, `1`, or the status of a `SystemExit`, as specified above.

  This function always finalizes the Python interpreter before it returns.

  See Python Configuration for an example of a customized Python that always runs in isolated mode using `Py_RunMain()`.

int PyUnstable_AtExit(PyInterpreterState *interp, void (*func)(void*), void *data)
  This is Unstable API. It may change without warning in minor releases.

  Register an `atexit` callback for the target interpreter interp. This is similar to `Py_AtExit()`, but takes an explicit interpreter and data pointer for the callback.

  There must be an attached thread state for interp.

  Added in version 3.13.

## Параметри для всього процесу

void Py_SetProgramName(const wchar_t *name)
  Part of the Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.program_name` should be used instead, see Python Initialization Configuration.

  This function should be called before `Py_Initialize()` is called for the first time, if it is called at all. It tells the interpreter the value of the `argv[0]` argument to the `main()` function of the program (converted to wide characters). This is used by some other functions below to find the Python run-time libraries relative to the interpreter executable. The default value is `'python'`. The argument should point to a zero-terminated wide character string in static storage whose contents will not change for the duration of the program’s execution. No code in the Python interpreter will change the contents of this storage.

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  Deprecated since version 3.11, removed in version 3.15.

const char *Py_GetVersion()
  Part of the Stable ABI.

  Повернути версію цього інтерпретатора Python. Це рядок, який виглядає приблизно так:

      "3.0a5+ (py3k:63103M, May 12 2008, 00:53:55) \n[GCC 4.2.3]"

  Перше слово (до першого символу пробілу) є поточною версією Python; перші символи — це головна та другорядна версії, розділені крапкою. Повернений рядок вказує на статичне сховище; абонент не повинен змінювати його значення. Значення доступне для коду Python як `sys.version`.

  See also the `Py_Version` constant.

const char *Py_GetPlatform()
  Part of the Stable ABI.

  Повертає ідентифікатор платформи для поточної платформи. В Unix це формується з «офіційної» назви операційної системи, перетвореної на нижній регістр, за якою йде основний номер версії; наприклад, для Solaris 2.x, яка також відома як SunOS 5.x, значенням є `'sunos5`. У macOS це `'darwin'`. У Windows це `'win'`. Повернений рядок вказує на статичне сховище; абонент не повинен змінювати його значення. Значення доступне для коду Python як `sys.platform`.

const char *Py_GetCopyright()
  Part of the Stable ABI.

  Поверніть, наприклад, офіційний рядок авторських прав для поточної версії Python

  `'Авторське право 1991-1995 Stichting Mathematisch Centrum, Amsterdam'`

  Повернений рядок вказує на статичне сховище; абонент не повинен змінювати його значення. Значення доступне для коду Python як `sys.copyright`.

const char *Py_GetCompiler()
  Part of the Stable ABI.

  Повертає вказівку компілятора, використаного для створення поточної версії Python, у квадратних дужках, наприклад:

      "[GCC 2.7.2.2]"

  Повернений рядок вказує на статичне сховище; абонент не повинен змінювати його значення. Значення доступне для коду Python як частина змінної `sys.version`.

const char *Py_GetBuildInfo()
  Part of the Stable ABI.

  Повертає інформацію про порядковий номер, дату й час збирання поточного екземпляра інтерпретатора Python, наприклад:

      "#67, Aug  1 1997, 22:34:28"

  Повернений рядок вказує на статичне сховище; абонент не повинен змінювати його значення. Значення доступне для коду Python як частина змінної `sys.version`.

void PySys_SetArgvEx(int argc, wchar_t **argv, int updatepath)
  Part of the Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.argv`, `PyConfig.parse_argv` and `PyConfig.safe_path` should be used instead, see Python Initialization Configuration.

  Встановити `sys.argv` на основі argc і argv. Ці параметри подібні до тих, що передаються до функції програми `main()` з тією різницею, що перший запис має посилатися на файл сценарію, який буде виконано, а не на виконуваний файл, у якому розміщено інтерпретатор Python. Якщо сценарію, який буде запущено, немає, перший запис у argv може бути порожнім рядком. Якщо цій функції не вдається ініціалізувати `sys.argv`, за допомогою `Py_FatalError()` повідомляється про фатальну умову.

  Якщо updatepath дорівнює нулю, це все, що функція робить. Якщо updatepath відмінний від нуля, функція також змінює `sys.path` відповідно до наступного алгоритму:

  - Якщо ім’я існуючого сценарію передається в `argv[0]`, абсолютний шлях до каталогу, де розташований сценарій, додається до `sys.path`.

  - В іншому випадку (тобто, якщо argc дорівнює `0` або `argv[0]` не вказує на існуюче ім’я файлу), до `sys.path` додається порожній рядок, що те саме, що додавати поточний робочий каталог (`"."`).

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  See also `PyConfig.orig_argv` and `PyConfig.argv` members of the Python Initialization Configuration.

  Примітка

  It is recommended that applications embedding the Python interpreter for purposes other than executing a single script pass `0` as updatepath, and update `sys.path` themselves if desired. See CVE 2008-5983.

  У версіях до 3.1.3 ви можете досягти того самого ефекту, вручну витягнувши перший елемент `sys.path` після виклику `PySys_SetArgv()`, наприклад, використовуючи:

      PyRun_SimpleString("import sys; sys.path.pop(0)\n");

  Added in version 3.1.3.

  Deprecated since version 3.11, removed in version 3.15.

void PySys_SetArgv(int argc, wchar_t **argv)
  Part of the Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.argv` and `PyConfig.parse_argv` should be used instead, see Python Initialization Configuration.

  Ця функція працює як `PySys_SetArgvEx()` з updatepath, встановленим на `1`, якщо інтерпретатор python не було запущено з `-I`.

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  See also `PyConfig.orig_argv` and `PyConfig.argv` members of the Python Initialization Configuration.

  Змінено в версії 3.4: Значення updatepath залежить від `-I`.

  Deprecated since version 3.11, removed in version 3.15.

void Py_SetPythonHome(const wchar_t *home)
  Part of the Stable ABI.

  This API is kept for backward compatibility: setting `PyConfig.home` should be used instead, see Python Initialization Configuration.

  Встановіть типовий «домашній» каталог, тобто розташування стандартних бібліотек Python. Дивіться `PYTHONHOME` для визначення значення рядка аргументу.

  Аргумент має вказувати на символьний рядок із нульовим закінченням у статичному сховищі, вміст якого не змінюватиметься протягом виконання програми. Жоден код інтерпретатора Python не змінить вміст цього сховища.

  Use `Py_DecodeLocale()` to decode a bytes string to get a wchar_t* string.

  Deprecated since version 3.11, removed in version 3.15.

## Стан потоку та глобальне блокування інтерпретатора

Unless on a free-threaded build of CPython, the Python interpreter is not fully thread-safe. In order to support multi-threaded Python programs, there’s a global lock, called the global interpreter lock or GIL, that must be held by the current thread before it can safely access Python objects. Without the lock, even the simplest operations could cause problems in a multi-threaded program: for example, when two threads simultaneously increment the reference count of the same object, the reference count could end up being incremented only once instead of twice.

Тому існує правило, згідно з яким лише потік, який отримав GIL, може працювати з об’єктами Python або викликати функції API Python/C. Щоб імітувати паралельне виконання, інтерпретатор регулярно намагається перемикати потоки (див. `sys.setswitchinterval()`). Блокування також знімається навколо можливого блокування операцій введення-виведення, таких як читання або запис файлу, щоб тим часом могли працювати інші потоки Python.

The Python interpreter keeps some thread-specific bookkeeping information inside a data structure called `PyThreadState`, known as a thread state. Each OS thread has a thread-local pointer to a `PyThreadState`; a thread state referenced by this pointer is considered to be attached.

A thread can only have one attached thread state at a time. An attached thread state is typically analogous with holding the GIL, except on free-threaded builds. On builds with the GIL enabled, attaching a thread state will block until the GIL can be acquired. However, even on builds with the GIL disabled, it is still required to have an attached thread state to call most of the C API.

In general, there will always be an attached thread state when using Python’s C API. Only in some specific cases (such as in a `Py_BEGIN_ALLOW_THREADS` block) will the thread not have an attached thread state. If uncertain, check if `PyThreadState_GetUnchecked()` returns `NULL`.

### Detaching the thread state from extension code

Most extension code manipulating the thread state has the following simple structure:

    Save the thread state in a local variable.
    ... Do some blocking I/O operation ...
    Restore the thread state from the local variable.

Це настільки поширене явище, що для його спрощення існує пара макросів:

    Py_BEGIN_ALLOW_THREADS
    ... Do some blocking I/O operation ...
    Py_END_ALLOW_THREADS

Макрос `Py_BEGIN_ALLOW_THREADS` відкриває новий блок і оголошує приховану локальну змінну; макрос `Py_END_ALLOW_THREADS` закриває блок.

Блок вище розширюється до наступного коду:

    PyThreadState *_save;

    _save = PyEval_SaveThread();
    ... Do some blocking I/O operation ...
    PyEval_RestoreThread(_save);

Here is how these functions work:

The attached thread state holds the GIL for the entire interpreter. When detaching the attached thread state, the GIL is released, allowing other threads to attach a thread state to their own thread, thus getting the GIL and can start executing. The pointer to the prior attached thread state is stored as a local variable. Upon reaching `Py_END_ALLOW_THREADS`, the thread state that was previously attached is passed to `PyEval_RestoreThread()`. This function will block until another releases its thread state, thus allowing the old thread state to get re-attached and the C API can be called again.

For free-threaded builds, the GIL is normally out of the question, but detaching the thread state is still required for blocking I/O and long operations. The difference is that threads don’t have to wait for the GIL to be released to attach their thread state, allowing true multi-core parallelism.

Примітка

Calling system I/O functions is the most common use case for detaching the thread state, but it can also be useful before calling long-running computations which don’t need access to Python objects, such as compression or cryptographic functions operating over memory buffers. For example, the standard `zlib` and `hashlib` modules detach the thread state when compressing or hashing data.

### Потоки, створені не на Python

When threads are created using the dedicated Python APIs (such as the `threading` module), a thread state is automatically associated to them and the code showed above is therefore correct. However, when threads are created from C (for example by a third-party library with its own thread management), they don’t hold the GIL, because they don’t have an attached thread state.

If you need to call Python code from these threads (often this will be part of a callback API provided by the aforementioned third-party library), you must first register these threads with the interpreter by creating an attached thread state before you can start using the Python/C API. When you are done, you should detach the thread state, and finally free it.

Функції `PyGILState_Ensure()` і `PyGILState_Release()` виконують усе вищезазначене автоматично. Типова ідіома виклику Python із потоку C:

    PyGILState_STATE gstate;
    gstate = PyGILState_Ensure();

    /* Perform Python actions here. */
    result = CallSomeFunction();
    /* evaluate result or handle exception */

    /* Release the thread. No Python API allowed beyond this point. */
    PyGILState_Release(gstate);

Note that the `PyGILState_*` functions assume there is only one global interpreter (created automatically by `Py_Initialize()`). Python supports the creation of additional interpreters (using `Py_NewInterpreter()`), but mixing multiple interpreters and the `PyGILState_*` API is unsupported. This is because `PyGILState_Ensure()` and similar functions default to attaching a thread state for the main interpreter, meaning that the thread can’t safely interact with the calling subinterpreter.

### Supporting subinterpreters in non-Python threads

If you would like to support subinterpreters with non-Python created threads, you must use the `PyThreadState_*` API instead of the traditional `PyGILState_*` API.

In particular, you must store the interpreter state from the calling function and pass it to `PyThreadState_New()`, which will ensure that the thread state is targeting the correct interpreter:

    /* The return value of PyInterpreterState_Get() from the
       function that created this thread. */
    PyInterpreterState *interp = ThreadData->interp;
    PyThreadState *tstate = PyThreadState_New(interp);
    PyThreadState_Swap(tstate);

    /* GIL of the subinterpreter is now held.
       Perform Python actions here. */
    result = CallSomeFunction();
    /* evaluate result or handle exception */

    /* Destroy the thread state. No Python API allowed beyond this point. */
    PyThreadState_Clear(tstate);
    PyThreadState_DeleteCurrent();

### Застереження щодо fork()

Ще одна важлива річ, на яку слід звернути увагу щодо потоків, це їхня поведінка перед викликом C `fork()`. У більшості систем із `fork()` після розгалуження процесу існуватиме лише потік, який видав розгалуження. Це має конкретний вплив як на те, як потрібно обробляти блокування, так і на весь збережений стан у середовищі виконання CPython.

The fact that only the «current» thread remains means any locks held by other threads will never be released. Python solves this for `os.fork()` by acquiring the locks it uses internally before the fork, and releasing them afterwards. In addition, it resets any Lock objects in the child. When extending or embedding Python, there is no way to inform Python of additional (non-Python) locks that need to be acquired before or reset after a fork. OS facilities such as `pthread_atfork()` would need to be used to accomplish the same thing. Additionally, when extending or embedding Python, calling `fork()` directly rather than through `os.fork()` (and returning to or calling into Python) may result in a deadlock by one of Python’s internal locks being held by a thread that is defunct after the fork. `PyOS_AfterFork_Child()` tries to reset the necessary locks, but is not always able to.

Той факт, що всі інші потоки зникають, також означає, що стан виконання CPython там має бути належним чином очищено, що й робить `os.fork()`. Це означає завершення всіх інших об’єктів `PyThreadState`, що належать поточному інтерпретатору, і всіх інших об’єктів `PyInterpreterState`. Через це та особливу природу «main» інтерпретатора, `fork()` слід викликати лише в тому «main» потоці цього інтерпретатора, де початково ініціалізовано глобальне середовище виконання CPython. Єдиним винятком є те, що `exec()` буде викликано одразу після.

### Cautions regarding runtime finalization

In the late stage of interpreter shutdown, after attempting to wait for non-daemon threads to exit (though this can be interrupted by `KeyboardInterrupt`) and running the `atexit` functions, the runtime is marked as finalizing: `Py_IsFinalizing()` and `sys.is_finalizing()` return true. At this point, only the finalization thread that initiated finalization (typically the main thread) is allowed to acquire the GIL.

If any thread, other than the finalization thread, attempts to attach a thread state during finalization, either explicitly or implicitly, the thread enters a permanently blocked state where it remains until the program exits. In most cases this is harmless, but this can result in deadlock if a later stage of finalization attempts to acquire a lock owned by the blocked thread, or otherwise waits on the blocked thread.

Gross? Yes. This prevents random crashes and/or unexpectedly skipped C++ finalizations further up the call stack when such threads were forcibly exited here in CPython 3.13 and earlier. The CPython runtime thread state C APIs have never had any error reporting or handling expectations at thread state attachment time that would’ve allowed for graceful exit from this situation. Changing that would require new stable C APIs and rewriting the majority of C code in the CPython ecosystem to use those with error handling.

### API високого рівня

Це типи та функції, які найчастіше використовуються під час написання коду розширення C або під час вбудовування інтерпретатора Python:

type PyInterpreterState
  Part of the Limited API (as an opaque struct).

  Ця структура даних представляє стан, спільний для кількох взаємодіючих потоків. Потоки, що належать одному інтерпретатору, спільно використовують адміністрування модуля та кілька інших внутрішніх елементів. У цій структурі немає громадських учасників.

  Потоки, що належать різним інтерпретаторам, спочатку нічого спільного не мають, окрім стану процесу, наприклад доступної пам’яті, відкритих файлових дескрипторів тощо. Глобальне блокування інтерпретатора також використовується для всіх потоків, незалежно від того, до якого інтерпретатора вони належать.

  Змінено в версії 3.12: PEP 684 introduced the possibility of a per-interpreter GIL. See `Py_NewInterpreterFromConfig()`.

type PyThreadState
  Part of the Limited API (as an opaque struct).

  This data structure represents the state of a single thread. The only public data member is:

  PyInterpreterState *interp

    This thread’s interpreter state.

void PyEval_InitThreads()
  Part of the Stable ABI.

  Застаріла функція, яка нічого не робить.

  У Python 3.6 і старіших версіях ця функція створювала GIL, якщо його не існувало.

  Змінено в версії 3.9: Тепер функція нічого не робить.

  Змінено в версії 3.7: Ця функція тепер викликається `Py_Initialize()`, тому вам більше не потрібно викликати її самостійно.

  Змінено в версії 3.2: Цю функцію більше не можна викликати до `Py_Initialize()`.

  Застаріло починаючи з версії 3.9.

PyThreadState *PyEval_SaveThread()
  Part of the Stable ABI.

  Detach the attached thread state and return it. The thread will have no thread state upon returning.

void PyEval_RestoreThread(PyThreadState *tstate)
  Part of the Stable ABI.

  Set the attached thread state to tstate. The passed thread state should not be attached, otherwise deadlock ensues. tstate will be attached upon returning.

  Примітка

  Calling this function from a thread when the runtime is finalizing will hang the thread until the program exits, even if the thread was not created by Python. Refer to Cautions regarding runtime finalization for more details.

  Змінено в версії 3.14: Hangs the current thread, rather than terminating it, if called while the interpreter is finalizing.

PyThreadState *PyThreadState_Get()
  Part of the Stable ABI.

  Return the attached thread state. If the thread has no attached thread state, (such as when inside of `Py_BEGIN_ALLOW_THREADS` block), then this issues a fatal error (so that the caller needn’t check for `NULL`).

  See also `PyThreadState_GetUnchecked()`.

PyThreadState *PyThreadState_GetUnchecked()

  Similar to `PyThreadState_Get()`, but don’t kill the process with a fatal error if it is NULL. The caller is responsible to check if the result is NULL.

  Added in version 3.13: In Python 3.5 to 3.12, the function was private and known as `_PyThreadState_UncheckedGet()`.

PyThreadState *PyThreadState_Swap(PyThreadState *tstate)
  Part of the Stable ABI.

  Set the attached thread state to tstate, and return the thread state that was attached prior to calling.

  This function is safe to call without an attached thread state; it will simply return `NULL` indicating that there was no prior thread state.

  Дивись також

  `PyEval_ReleaseThread()`

  Примітка

  Similar to `PyGILState_Ensure()`, this function will hang the thread if the runtime is finalizing.

Наступні функції використовують локальне сховище потоків і несумісні з підінтерпретаторами:

type PyGILState_STATE
  Part of the Stable ABI.

  The type of the value returned by `PyGILState_Ensure()` and passed to `PyGILState_Release()`.

  enumerator PyGILState_LOCKED

    The GIL was already held when `PyGILState_Ensure()` was called.

  enumerator PyGILState_UNLOCKED

    The GIL was not held when `PyGILState_Ensure()` was called.

PyGILState_STATE PyGILState_Ensure()
  Part of the Stable ABI.

  Ensure that the current thread is ready to call the Python C API regardless of the current state of Python, or of the attached thread state. This may be called as many times as desired by a thread as long as each call is matched with a call to `PyGILState_Release()`. In general, other thread-related APIs may be used between `PyGILState_Ensure()` and `PyGILState_Release()` calls as long as the thread state is restored to its previous state before the Release(). For example, normal usage of the `Py_BEGIN_ALLOW_THREADS` and `Py_END_ALLOW_THREADS` macros is acceptable.

  The return value is an opaque «handle» to the attached thread state when `PyGILState_Ensure()` was called, and must be passed to `PyGILState_Release()` to ensure Python is left in the same state. Even though recursive calls are allowed, these handles cannot be shared - each unique call to `PyGILState_Ensure()` must save the handle for its call to `PyGILState_Release()`.

  When the function returns, there will be an attached thread state and the thread will be able to call arbitrary Python code. Failure is a fatal error.

  Попередження

  Calling this function when the runtime is finalizing is unsafe. Doing so will either hang the thread until the program ends, or fully crash the interpreter in rare cases. Refer to Cautions regarding runtime finalization for more details.

  Змінено в версії 3.14: Hangs the current thread, rather than terminating it, if called while the interpreter is finalizing.

void PyGILState_Release(PyGILState_STATE)
  Part of the Stable ABI.

  Вивільніть будь-які раніше отримані ресурси. Після цього виклику стан Python буде таким же, як і до відповідного виклику `PyGILState_Ensure()` (але зазвичай цей стан буде невідомий абоненту, тому використовується GILState API).

  Кожен виклик `PyGILState_Ensure()` має відповідати виклику `PyGILState_Release()` у тому самому потоці.

PyThreadState *PyGILState_GetThisThreadState()
  Part of the Stable ABI.

  Get the attached thread state for this thread. May return `NULL` if no GILState API has been used on the current thread. Note that the main thread always has such a thread-state, even if no auto-thread-state call has been made on the main thread. This is mainly a helper/diagnostic function.

  Примітка

  This function may return non-`NULL` even when the thread state is detached. Prefer `PyThreadState_Get()` or `PyThreadState_GetUnchecked()` for most cases.

  Дивись також

  `PyThreadState_Get()`

int PyGILState_Check()

  Return `1` if the current thread is holding the GIL and `0` otherwise. This function can be called from any thread at any time. Only if it has had its thread state initialized via `PyGILState_Ensure()` will it return `1`. This is mainly a helper/diagnostic function. It can be useful for example in callback contexts or memory allocation functions when knowing that the GIL is locked can allow the caller to perform sensitive actions or otherwise behave differently.

  Примітка

  If the current Python process has ever created a subinterpreter, this function will always return `1`. Prefer `PyThreadState_GetUnchecked()` for most cases.

  Added in version 3.4.

Наступні макроси зазвичай використовуються без крапки з комою в кінці; подивіться, наприклад, використання в вихідному дистрибутиві Python.

Py_BEGIN_ALLOW_THREADS
  Part of the Stable ABI.

  Цей макрос розширюється до `{ PyThreadState *_save; _save = PyEval_SaveThread();`. Зауважте, що він містить відкриваючу дужку; він повинен відповідати наступному макросу `Py_END_ALLOW_THREADS`. Дивіться вище для подальшого обговорення цього макросу.

Py_END_ALLOW_THREADS
  Part of the Stable ABI.

  Цей макрос розширюється до `PyEval_RestoreThread(_save); }`. Зверніть увагу, що він містить закриваючу дужку; він повинен відповідати попередньому макросу `Py_BEGIN_ALLOW_THREADS`. Дивіться вище для подальшого обговорення цього макросу.

Py_BLOCK_THREADS
  Part of the Stable ABI.

  Цей макрос розширюється до `PyEval_RestoreThread(_save);`: він еквівалентний `Py_END_ALLOW_THREADS` без закриваючої дужки.

Py_UNBLOCK_THREADS
  Part of the Stable ABI.

  Цей макрос розширюється до `_save = PyEval_SaveThread();`: він еквівалентний `Py_BEGIN_ALLOW_THREADS` без відкриваючої дужки та оголошення змінної.

### API низького рівня

Усі наведені нижче функції мають викликатися після `Py_Initialize()`.

Змінено в версії 3.7: `Py_Initialize()` now initializes the GIL and sets an attached thread state.

PyInterpreterState *PyInterpreterState_New()
  Part of the Stable ABI.

  Create a new interpreter state object. An attached thread state is not needed, but may optionally exist if it is necessary to serialize calls to this function.

  Викликає подію аудиту `cpython.PyInterpreterState_New` без аргументів.

void PyInterpreterState_Clear(PyInterpreterState *interp)
  Part of the Stable ABI.

  Reset all information in an interpreter state object. There must be an attached thread state for the interpreter.

  Викликає подію аудиту `cpython.PyInterpreterState_Clear` без аргументів.

void PyInterpreterState_Delete(PyInterpreterState *interp)
  Part of the Stable ABI.

  Destroy an interpreter state object. There should not be an attached thread state for the target interpreter. The interpreter state must have been reset with a previous call to `PyInterpreterState_Clear()`.

PyThreadState *PyThreadState_New(PyInterpreterState *interp)
  Part of the Stable ABI.

  Create a new thread state object belonging to the given interpreter object. An attached thread state is not needed.

void PyThreadState_Clear(PyThreadState *tstate)
  Part of the Stable ABI.

  Reset all information in a thread state object. tstate must be attached

  Змінено в версії 3.9: This function now calls the `PyThreadState.on_delete` callback. Previously, that happened in `PyThreadState_Delete()`.

  Змінено в версії 3.13: The `PyThreadState.on_delete` callback was removed.

void PyThreadState_Delete(PyThreadState *tstate)
  Part of the Stable ABI.

  Destroy a thread state object. tstate should not be attached to any thread. tstate must have been reset with a previous call to `PyThreadState_Clear()`.

void PyThreadState_DeleteCurrent(void)

  Detach the attached thread state (which must have been reset with a previous call to `PyThreadState_Clear()`) and then destroy it.

  No thread state will be attached upon returning.

PyFrameObject *PyThreadState_GetFrame(PyThreadState *tstate)
  Part of the Stable ABI since version 3.10.

  Отримати поточний кадр стану потоку Python tstate.

  Повертає strong reference. Повертає `NULL`, якщо наразі не виконується жоден кадр.

  Дивіться також `PyEval_GetFrame()`.

  tstate must not be `NULL`, and must be attached.

  Added in version 3.9.

uint64_t PyThreadState_GetID(PyThreadState *tstate)
  Part of the Stable ABI since version 3.10.

  Get the unique thread state identifier of the Python thread state tstate.

  tstate must not be `NULL`, and must be attached.

  Added in version 3.9.

PyInterpreterState *PyThreadState_GetInterpreter(PyThreadState *tstate)
  Part of the Stable ABI since version 3.10.

  Отримайте інтерпретатор стану потоку Python tstate.

  tstate must not be `NULL`, and must be attached.

  Added in version 3.9.

void PyThreadState_EnterTracing(PyThreadState *tstate)

  Suspend tracing and profiling in the Python thread state tstate.

  Resume them using the `PyThreadState_LeaveTracing()` function.

  Added in version 3.11.

void PyThreadState_LeaveTracing(PyThreadState *tstate)

  Resume tracing and profiling in the Python thread state tstate suspended by the `PyThreadState_EnterTracing()` function.

  See also `PyEval_SetTrace()` and `PyEval_SetProfile()` functions.

  Added in version 3.11.

int PyUnstable_ThreadState_SetStackProtection(PyThreadState *tstate, void *stack_start_addr, size_t stack_size)
  This is Unstable API. It may change without warning in minor releases.

  Set the stack protection start address and stack protection size of a Python thread state.

  On success, return `0`. On failure, set an exception and return `-1`.

  CPython implements recursion control for C code by raising `RecursionError` when it notices that the machine execution stack is close to overflow. See for example the `Py_EnterRecursiveCall()` function. For this, it needs to know the location of the current thread’s stack, which it normally gets from the operating system. When the stack is changed, for example using context switching techniques like the Boost library’s `boost::context`, you must call `PyUnstable_ThreadState_SetStackProtection()` to inform CPython of the change.

  Call `PyUnstable_ThreadState_SetStackProtection()` either before or after changing the stack. Do not call any other Python C API between the call and the stack change.

  See `PyUnstable_ThreadState_ResetStackProtection()` for undoing this operation.

  Added in version 3.15.

void PyUnstable_ThreadState_ResetStackProtection(PyThreadState *tstate)
  This is Unstable API. It may change without warning in minor releases.

  Reset the stack protection start address and stack protection size of a Python thread state to the operating system defaults.

  See `PyUnstable_ThreadState_SetStackProtection()` for an explanation.

  Added in version 3.15.

PyInterpreterState *PyInterpreterState_Get(void)
  Part of the Stable ABI since version 3.9.

  Отримати поточний перекладач.

  Issue a fatal error if there no attached thread state. It cannot return NULL.

  Added in version 3.9.

int64_t PyInterpreterState_GetID(PyInterpreterState *interp)
  Part of the Stable ABI since version 3.7.

  Повернути унікальний ідентифікатор перекладача. Якщо під час цього сталася якась помилка, повертається `-1` і встановлюється помилка.

  The caller must have an attached thread state.

  Added in version 3.7.

PyObject *PyInterpreterState_GetDict(PyInterpreterState *interp)
  Return value: Borrowed reference. Part of the Stable ABI since version 3.8.

  Повертає словник, у якому можуть зберігатися дані інтерпретатора. Якщо ця функція повертає `NULL`, це означає, що жодного винятку не було викликано, і абонент повинен припустити, що недоступний dict інтерпретатора.

  Це не заміна `PyModule_GetState()`, який розширення мають використовувати для зберігання інформації про стан інтерпретатора.

  The returned dictionary is borrowed from the interpreter and is valid until interpreter shutdown.

  Added in version 3.8.

typedef PyObject *(*_PyFrameEvalFunction)(PyThreadState *tstate, _PyInterpreterFrame *frame, int throwflag)

  Тип функції оцінки фрейму.

  Параметр throwflag використовується методом `throw()` генераторів: якщо він відмінний від нуля, обробити поточний виняток.

  Змінено в версії 3.9: Тепер функція приймає параметр tstate.

  Змінено в версії 3.11: The frame parameter changed from `PyFrameObject*` to `_PyInterpreterFrame*`.

_PyFrameEvalFunction _PyInterpreterState_GetEvalFrameFunc(PyInterpreterState *interp)

  Отримати функцію оцінки фрейму.

  Перегляньте PEP 523 «Додавання API оцінки фрейму до CPython».

  Added in version 3.9.

void _PyInterpreterState_SetEvalFrameFunc(PyInterpreterState *interp, _PyFrameEvalFunction eval_frame)

  Встановіть функцію оцінки кадру.

  Перегляньте PEP 523 «Додавання API оцінки фрейму до CPython».

  Added in version 3.9.

PyObject *PyThreadState_GetDict()
  Return value: Borrowed reference. Part of the Stable ABI.

  Return a dictionary in which extensions can store thread-specific state information. Each extension should use a unique key to use to store state in the dictionary. It is okay to call this function when no thread state is attached. If this function returns `NULL`, no exception has been raised and the caller should assume no thread state is attached.

int PyThreadState_SetAsyncExc(unsigned long id, PyObject *exc)
  Part of the Stable ABI.

  Asynchronously raise an exception in a thread. The id argument is the thread id of the target thread; exc is the exception object to be raised. This function does not steal any references to exc. To prevent naive misuse, you must write your own C extension to call this. Must be called with an attached thread state. Returns the number of thread states modified; this is normally one, but will be zero if the thread id isn’t found. If exc is `NULL`, the pending exception (if any) for the thread is cleared. This raises no exceptions.

  Змінено в версії 3.7: The type of the id parameter changed from long to unsigned long.

void PyEval_AcquireThread(PyThreadState *tstate)
  Part of the Stable ABI.

  Attach tstate to the current thread, which must not be `NULL` or already attached.

  The calling thread must not already have an attached thread state.

  Примітка

  Calling this function from a thread when the runtime is finalizing will hang the thread until the program exits, even if the thread was not created by Python. Refer to Cautions regarding runtime finalization for more details.

  Змінено в версії 3.8: Оновлено для узгодження з `PyEval_RestoreThread()`, `Py_END_ALLOW_THREADS()` і `PyGILState_Ensure()`, а також завершує поточний потік, якщо він викликається, поки інтерпретатор завершує роботу.

  Змінено в версії 3.14: Hangs the current thread, rather than terminating it, if called while the interpreter is finalizing.

  `PyEval_RestoreThread()` — це функція вищого рівня, яка завжди доступна (навіть якщо потоки не ініціалізовано).

void PyEval_ReleaseThread(PyThreadState *tstate)
  Part of the Stable ABI.

  Detach the attached thread state. The tstate argument, which must not be `NULL`, is only used to check that it represents the attached thread state — if it isn’t, a fatal error is reported.

  `PyEval_SaveThread()` — це функція вищого рівня, яка завжди доступна (навіть якщо потоки не ініціалізовано).

## Підтримка субінтерпретатора

Хоча в більшості випадків ви вбудовуєте лише один інтерпретатор Python, є випадки, коли вам потрібно створити кілька незалежних інтерпретаторів в одному процесі і, можливо, навіть в одному потоці. Суб-інтерпретатори дозволяють це зробити.

«Головний» інтерпретатор є першим, який створюється під час ініціалізації середовища виконання. Зазвичай це єдиний інтерпретатор Python у процесі. На відміну від субінтерпретаторів, головний інтерпретатор має унікальні глобальні обов’язки процесу, такі як обробка сигналів. Він також відповідає за виконання під час ініціалізації середовища виконання та зазвичай є активним інтерпретатором під час завершення виконання. Функція `PyInterpreterState_Main()` повертає вказівник на його стан.

Ви можете перемикатися між підінтерпретаторами за допомогою функції `PyThreadState_Swap()`. Ви можете створювати та знищувати їх за допомогою таких функцій:

type PyInterpreterConfig

  Structure containing most parameters to configure a sub-interpreter. Its values are used only in `Py_NewInterpreterFromConfig()` and never modified by the runtime.

  Added in version 3.12.

  Поля структури:

  int use_main_obmalloc

    If this is `0` then the sub-interpreter will use its own «object» allocator state. Otherwise it will use (share) the main interpreter’s.

    If this is `0` then `check_multi_interp_extensions` must be `1` (non-zero). If this is `1` then `gil` must not be `PyInterpreterConfig_OWN_GIL`.

  int allow_fork

    If this is `0` then the runtime will not support forking the process in any thread where the sub-interpreter is currently active. Otherwise fork is unrestricted.

    Note that the `subprocess` module still works when fork is disallowed.

  int allow_exec

    If this is `0` then the runtime will not support replacing the current process via exec (e.g. `os.execv()`) in any thread where the sub-interpreter is currently active. Otherwise exec is unrestricted.

    Note that the `subprocess` module still works when exec is disallowed.

  int allow_threads

    If this is `0` then the sub-interpreter’s `threading` module won’t create threads. Otherwise threads are allowed.

  int allow_daemon_threads

    If this is `0` then the sub-interpreter’s `threading` module won’t create daemon threads. Otherwise daemon threads are allowed (as long as `allow_threads` is non-zero).

  int check_multi_interp_extensions

    If this is `0` then all extension modules may be imported, including legacy (single-phase init) modules, in any thread where the sub-interpreter is currently active. Otherwise only multi-phase init extension modules (see PEP 489) may be imported. (Also see `Py_mod_multiple_interpreters`.)

    This must be `1` (non-zero) if `use_main_obmalloc` is `0`.

  int gil

    This determines the operation of the GIL for the sub-interpreter. It may be one of the following:

    PyInterpreterConfig_DEFAULT_GIL

      Use the default selection (`PyInterpreterConfig_SHARED_GIL`).

    PyInterpreterConfig_SHARED_GIL

      Use (share) the main interpreter’s GIL.

    PyInterpreterConfig_OWN_GIL

      Use the sub-interpreter’s own GIL.

    If this is `PyInterpreterConfig_OWN_GIL` then `PyInterpreterConfig.use_main_obmalloc` must be `0`.

PyStatus Py_NewInterpreterFromConfig(PyThreadState **tstate_p, const PyInterpreterConfig *config)

  Створіть новий підінтерпретатор. Це (майже) повністю окреме середовище для виконання коду Python. Зокрема, новий інтерпретатор має окремі незалежні версії всіх імпортованих модулів, включаючи фундаментальні модулі `builtins`, `__main__` і `sys`. Таблиця завантажених модулів (`sys.modules`) і шлях пошуку модуля (`sys.path`) також окремі. Нове середовище не має змінної `sys.argv`. Він має нові стандартні файлові об’єкти потоку вводу/виводу `sys.stdin`, `sys.stdout` і `sys.stderr` (однак вони посилаються на ті самі основні дескриптори файлів).

  The given config controls the options with which the interpreter is initialized.

  Upon success, tstate_p will be set to the first thread state created in the new sub-interpreter. This thread state is attached. Note that no actual thread is created; see the discussion of thread states below. If creation of the new interpreter is unsuccessful, tstate_p is set to `NULL`; no exception is set since the exception state is stored in the attached thread state, which might not exist.

  Like all other Python/C API functions, an attached thread state must be present before calling this function, but it might be detached upon returning. On success, the returned thread state will be attached. If the sub-interpreter is created with its own GIL then the attached thread state of the calling interpreter will be detached. When the function returns, the new interpreter’s thread state will be attached to the current thread and the previous interpreter’s attached thread state will remain detached.

  Added in version 3.12.

  Sub-interpreters are most effective when isolated from each other, with certain functionality restricted:

      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);
      }

  Note that the config is used only briefly and does not get modified. During initialization the config’s values are converted into various `PyInterpreterState` values. A read-only copy of the config may be stored internally on the `PyInterpreterState`.

  Модулі розширення розподіляються між (під)інтерпретаторами наступним чином:

  - Для модулів, які використовують багатофазову ініціалізацію, напр. `PyModule_FromDefAndSpec()`, окремий об’єкт модуля створюється та ініціалізується для кожного інтерпретатора. Лише статичні та глобальні змінні рівня C використовуються між цими об’єктами модуля.

  - For modules using legacy single-phase initialization, e.g. `PyModule_Create()`, the first time a particular extension is imported, it is initialized normally, and a (shallow) copy of its module’s dictionary is squirreled away. When the same extension is imported by another (sub-)interpreter, a new module is initialized and filled with the contents of this copy; the extension’s `init` function is not called. Objects in the module’s dictionary thus end up shared across (sub-)interpreters, which might cause unwanted behavior (see Bugs and caveats below).

    Зауважте, що це відрізняється від того, що відбувається, коли розширення імпортується після повної повторної ініціалізації інтерпретатора викликом `Py_FinalizeEx()` і `Py_Initialize()`; у цьому випадку функція `initmodule` розширення викликається знову. Як і у випадку з багатофазною ініціалізацією, це означає, що ці модулі спільно використовують лише статичні та глобальні змінні рівня C.

PyThreadState *Py_NewInterpreter(void)
  Part of the Stable ABI.

  Create a new sub-interpreter. This is essentially just a wrapper around `Py_NewInterpreterFromConfig()` with a config that preserves the existing behavior. The result is an unisolated sub-interpreter that shares the main interpreter’s GIL, allows fork/exec, allows daemon threads, and allows single-phase init modules.

void Py_EndInterpreter(PyThreadState *tstate)
  Part of the Stable ABI.

  Destroy the (sub-)interpreter represented by the given thread state. The given thread state must be attached. When the call returns, there will be no attached thread state. All thread states associated with this interpreter are destroyed.

  `Py_FinalizeEx()` will destroy all sub-interpreters that haven’t been explicitly destroyed at that point.

### A Per-Interpreter GIL

Using `Py_NewInterpreterFromConfig()` you can create a sub-interpreter that is completely isolated from other interpreters, including having its own GIL. The most important benefit of this isolation is that such an interpreter can execute Python code without being blocked by other interpreters or blocking any others. Thus a single Python process can truly take advantage of multiple CPU cores when running Python code. The isolation also encourages a different approach to concurrency than that of just using threads. (See PEP 554 and PEP 684.)

Using an isolated interpreter requires vigilance in preserving that isolation. That especially means not sharing any objects or mutable state without guarantees about thread-safety. Even objects that are otherwise immutable (e.g. `None`, `(1, 5)`) can’t normally be shared because of the refcount. One simple but less-efficient approach around this is to use a global lock around all use of some state (or object). Alternately, effectively immutable objects (like integers or strings) can be made safe in spite of their refcounts by making them immortal. In fact, this has been done for the builtin singletons, small integers, and a number of other builtin objects.

If you preserve isolation then you will have access to proper multi-core computing without the complications that come with free-threading. Failure to preserve isolation will expose you to the full consequences of free-threading, including races and hard-to-debug crashes.

Aside from that, one of the main challenges of using multiple isolated interpreters is how to communicate between them safely (not break isolation) and efficiently. The runtime and stdlib do not provide any standard approach to this yet. A future stdlib module would help mitigate the effort of preserving isolation and expose effective tools for communicating (and sharing) data between interpreters.

Added in version 3.12.

### Помилки та застереження

Оскільки субінтерпретатори (і головний інтерпретатор) є частиною одного процесу, ізоляція між ними не є ідеальною — наприклад, використовуючи низькорівневі файлові операції, такі як `os.close()`, вони можуть (випадково або зловмисно) впливають на відкриті файли один одного. Через те, як розширення розподіляються між (під)інтерпретаторами, деякі розширення можуть не працювати належним чином; це особливо ймовірно при використанні однофазної ініціалізації або (статичних) глобальних змінних. Можна вставляти об’єкти, створені в одному суб-інтерпретаторі, у простір імен іншого (суб-)інтерпретатора; цього слід уникати, якщо це можливо.

Слід приділяти особливу увагу уникненню спільного використання визначених користувачем функцій, методів, екземплярів або класів між підінтерпретаторами, оскільки операції імпорту, які виконуються такими об’єктами, можуть вплинути на неправильний (під)інтерпретатор словник завантажених модулів. Не менш важливо уникати спільного використання об’єктів, з яких доступні вищевказані.

Also note that combining this functionality with `PyGILState_*` APIs is delicate, because these APIs assume a bijection between Python thread states and OS-level threads, an assumption broken by the presence of sub-interpreters. It is highly recommended that you don’t switch sub-interpreters between a pair of matching `PyGILState_Ensure()` and `PyGILState_Release()` calls. Furthermore, extensions (such as `ctypes`) using these APIs to allow calling of Python code from non-Python created threads will probably be broken when using sub-interpreters.

## Асинхронні сповіщення

Надається механізм для створення асинхронних сповіщень головному потоку інтерпретатора. Ці сповіщення приймають форму вказівника функції та аргументу вказівника void.

int Py_AddPendingCall(int (*func)(void*), void *arg)
  Part of the Stable ABI.

  Заплануйте виклик функції з основного потоку інтерпретатора. У разі успіху повертається `0` і func ставиться в чергу для виклику в основному потоці. У разі помилки повертається `-1` без встановлення винятків.

  Після успішного розміщення в черзі func буде зрештою викликано з основного потоку інтерпретатора з аргументом arg. Його буде викликано асинхронно щодо нормально запущеного коду Python, але з дотриманням обох цих умов:

  - на межі bytecode;

  - with the main thread holding an attached thread state (func can therefore use the full C API).

  func must return `0` on success, or `-1` on failure with an exception set. func won’t be interrupted to perform another asynchronous notification recursively, but it can still be interrupted to switch threads if the thread state is detached.

  This function doesn’t need an attached thread state. However, to call this function in a subinterpreter, the caller must have an attached thread state. Otherwise, the function func can be scheduled to be called from the wrong interpreter.

  Попередження

  Це функція низького рівня, корисна лише в дуже особливих випадках. Немає гарантії, що func буде викликано якомога швидше. Якщо основний потік зайнятий виконанням системного виклику, func не буде викликано до повернення системного виклику. Ця функція зазвичай не підходить для виклику коду Python із довільних потоків C. Замість цього використовуйте PyGILState API.

  Added in version 3.1.

  Змінено в версії 3.9: Якщо ця функція викликається у підінтерпретаторі, функція func тепер запланована для виклику з підінтерпретатора, а не з основного інтерпретатора. Кожен субінтерпретатор тепер має власний список запланованих викликів.

  Змінено в версії 3.12: This function now always schedules func to be run in the main interpreter.

int Py_MakePendingCalls(void)
  Part of the Stable ABI.

  Execute all pending calls. This is usually executed automatically by the interpreter.

  This function returns `0` on success, and returns `-1` with an exception set on failure.

  If this is not called in the main thread of the main interpreter, this function does nothing and returns `0`. The caller must hold an attached thread state.

  Added in version 3.1.

  Змінено в версії 3.12: This function only runs pending calls in the main interpreter.

## Профілювання та трасування

Інтерпретатор Python надає деяку низькорівневу підтримку для підключення засобів профілювання та трасування виконання. Вони використовуються для інструментів профілювання, налагодження та аналізу покриття.

Цей інтерфейс C дозволяє коду профілювання або трасування уникнути накладних витрат на виклик через викликані об’єкти на рівні Python, замість цього здійснюючи прямий виклик функції C. Основні атрибути закладу не змінилися; інтерфейс дозволяє встановлювати функції трасування для кожного потоку, а основні події, які повідомляються у функцію трасування, є такими самими, як повідомлялося функціям трасування на рівні Python у попередніх версіях.

typedef int (*Py_tracefunc)(PyObject *obj, PyFrameObject *frame, int what, PyObject *arg)

  The type of the trace function registered using `PyEval_SetProfile()` and `PyEval_SetTrace()`. The first parameter is the object passed to the registration function as obj, frame is the frame object to which the event pertains, what is one of the constants `PyTrace_CALL`, `PyTrace_EXCEPTION`, `PyTrace_LINE`, `PyTrace_RETURN`, `PyTrace_C_CALL`, `PyTrace_C_EXCEPTION`, `PyTrace_C_RETURN`, or `PyTrace_OPCODE`, and arg depends on the value of what:

  Значення чого | Значення arg
  --- | ---
  `PyTrace_CALL` | Завжди `Py_None`.
  `PyTrace_EXCEPTION` | Інформація про винятки, яку повертає `sys.exc_info()`.
  `PyTrace_LINE` | Завжди `Py_None`.
  `PyTrace_RETURN` | Значення, що повертається абоненту, або `NULL`, якщо викликано винятком.
  `PyTrace_C_CALL` | Об’єкт функції, що викликається.
  `PyTrace_C_EXCEPTION` | Об’єкт функції, що викликається.
  `PyTrace_C_RETURN` | Об’єкт функції, що викликається.
  `PyTrace_OPCODE` | Завжди `Py_None`.

int PyTrace_CALL

  Значення параметра what для функції `Py_tracefunc`, коли повідомляється про новий виклик функції чи методу або новий запис у генераторі. Зауважте, що створення ітератора для функції генератора не повідомляється, оскільки немає передачі керування до байт-коду Python у відповідному кадрі.

int PyTrace_EXCEPTION

  Значення параметра what для функції `Py_tracefunc`, коли виникає виняткова ситуація. Функція зворотного виклику викликається з цим значенням для what, коли після обробки будь-якого байт-коду, після чого виняток стає встановленим у кадрі, що виконується. Наслідком цього є те, що коли розповсюдження винятку спричиняє розгортання стека Python, зворотний виклик викликається після повернення до кожного кадру під час поширення винятку. Лише функції трасування отримують ці події; вони не потрібні профайлеру.

int PyTrace_LINE

  The value passed as the what parameter to a `Py_tracefunc` function (but not a profiling function) when a line-number event is being reported. It may be disabled for a frame by setting `f_trace_lines` to 0 on that frame.

int PyTrace_RETURN

  Значення для параметра what для `Py_tracefunc` функціонує, коли виклик збирається повернутися.

int PyTrace_C_CALL

  Значення параметра what для функцій `Py_tracefunc`, коли має бути викликана функція C.

int PyTrace_C_EXCEPTION

  Значення для параметра what для функцій `Py_tracefunc`, коли функція C викликала виняткову ситуацію.

int PyTrace_C_RETURN

  Значення для параметра what для функцій `Py_tracefunc`, коли функція C повертає.

int PyTrace_OPCODE

  The value for the what parameter to `Py_tracefunc` functions (but not profiling functions) when a new opcode is about to be executed. This event is not emitted by default: it must be explicitly requested by setting `f_trace_opcodes` to 1 on the frame.

void PyEval_SetProfile(Py_tracefunc func, PyObject *obj)

  Set the profiler function to func. The obj parameter is passed to the function as its first parameter, and may be any Python object, or `NULL`. If the profile function needs to maintain state, using a different value for obj for each thread provides a convenient and thread-safe place to store it. The profile function is called for all monitored events except `PyTrace_LINE` `PyTrace_OPCODE` and `PyTrace_EXCEPTION`.

  See also the `sys.setprofile()` function.

  The caller must have an attached thread state.

void PyEval_SetProfileAllThreads(Py_tracefunc func, PyObject *obj)

  Like `PyEval_SetProfile()` but sets the profile function in all running threads belonging to the current interpreter instead of the setting it only on the current thread.

  The caller must have an attached thread state.

  As `PyEval_SetProfile()`, this function ignores any exceptions raised while setting the profile functions in all threads.

Added in version 3.12.

void PyEval_SetTrace(Py_tracefunc func, PyObject *obj)

  Set the tracing function to func. This is similar to `PyEval_SetProfile()`, except the tracing function does receive line-number events and per-opcode events, but does not receive any event related to C function objects being called. Any trace function registered using `PyEval_SetTrace()` will not receive `PyTrace_C_CALL`, `PyTrace_C_EXCEPTION` or `PyTrace_C_RETURN` as a value for the what parameter.

  See also the `sys.settrace()` function.

  The caller must have an attached thread state.

void PyEval_SetTraceAllThreads(Py_tracefunc func, PyObject *obj)

  Like `PyEval_SetTrace()` but sets the tracing function in all running threads belonging to the current interpreter instead of the setting it only on the current thread.

  The caller must have an attached thread state.

  As `PyEval_SetTrace()`, this function ignores any exceptions raised while setting the trace functions in all threads.

Added in version 3.12.

## Reference tracing

Added in version 3.13.

typedef int (*PyRefTracer)(PyObject*, int event, void *data)

  The type of the trace function registered using `PyRefTracer_SetTracer()`. The first parameter is a Python object that has been just created (when event is set to `PyRefTracer_CREATE`) or about to be destroyed (when event is set to `PyRefTracer_DESTROY`). The data argument is the opaque pointer that was provided when `PyRefTracer_SetTracer()` was called.

  If a new tracing function is registered replacing the current a call to the trace function will be made with the object set to NULL and event set to `PyRefTracer_TRACKER_REMOVED`. This will happen just before the new function is registered.

Added in version 3.13.

int PyRefTracer_CREATE

  The value for the event parameter to `PyRefTracer` functions when a Python object has been created.

int PyRefTracer_DESTROY

  The value for the event parameter to `PyRefTracer` functions when a Python object has been destroyed.

int PyRefTracer_TRACKER_REMOVED

  The value for the event parameter to `PyRefTracer` functions when the current tracer is about to be replaced by a new one.

  Added in version 3.14.

int PyRefTracer_SetTracer(PyRefTracer tracer, void *data)

  Register a reference tracer function. The function will be called when a new Python has been created or when an object is going to be destroyed. If data is provided it must be an opaque pointer that will be provided when the tracer function is called. Return `0` on success. Set an exception and return `-1` on error.

  Not that tracer functions must not create Python objects inside or otherwise the call will be re-entrant. The tracer also must not clear any existing exception or set an exception. A thread state will be active every time the tracer function is called.

  There must be an attached thread state when calling this function.

  If another tracer function was already registered, the old function will be called with event set to `PyRefTracer_TRACKER_REMOVED` just before the new function is registered.

Added in version 3.13.

PyRefTracer PyRefTracer_GetTracer(void **data)

  Get the registered reference tracer function and the value of the opaque data pointer that was registered when `PyRefTracer_SetTracer()` was called. If no tracer was registered this function will return NULL and will set the data pointer to NULL.

  There must be an attached thread state when calling this function.

Added in version 3.13.

## Розширена підтримка налагоджувача

Ці функції призначені лише для використання розширеними інструментами налагодження.

PyInterpreterState *PyInterpreterState_Head()

  Повертає об’єкт стану інтерпретатора на початку списку всіх таких об’єктів.

PyInterpreterState *PyInterpreterState_Main()

  Повертає основний об’єкт стану інтерпретатора.

PyInterpreterState *PyInterpreterState_Next(PyInterpreterState *interp)

  Повертає наступний об’єкт стану інтерпретатора після interp зі списку всіх таких об’єктів.

PyThreadState *PyInterpreterState_ThreadHead(PyInterpreterState *interp)

  Поверніть вказівник на перший об’єкт `PyThreadState` у списку потоків, пов’язаних з інтерпретатором interp.

PyThreadState *PyThreadState_Next(PyThreadState *tstate)

  Повертає наступний об’єкт стану потоку після tstate зі списку всіх таких об’єктів, що належать до того самого об’єкта `PyInterpreterState`.

## Підтримка потокового локального сховища

The Python interpreter provides low-level support for thread-local storage (TLS) which wraps the underlying native TLS implementation to support the Python-level thread local storage API (`threading.local`). The CPython C level APIs are similar to those offered by pthreads and Windows: use a thread key and functions to associate a void* value per thread.

A thread state does not need to be attached when calling these functions; they supply their own locking.

Зауважте, що `Python.h` не містить оголошення TLS API, вам потрібно включити `pythread.h`, щоб використовувати локальне сховище потоків.

Примітка

None of these API functions handle memory management on behalf of the void* values. You need to allocate and deallocate them yourself. If the void* values happen to be PyObject*, these functions don’t do refcount operations on them either.

### API для спеціального зберігання потоків (TSS).

TSS API is introduced to supersede the use of the existing TLS API within the CPython interpreter. This API uses a new type `Py_tss_t` instead of int to represent thread keys.

Added in version 3.7.

Дивись також

«Новий C-API для локального зберігання потоків у CPython» (PEP 539)

type Py_tss_t

  Ця структура даних представляє стан ключа потоку, визначення якого може залежати від базової реалізації TLS, і вона має внутрішнє поле, що представляє стан ініціалізації ключа. У цій структурі немає громадських учасників.

  Якщо Py_LIMITED_API не визначено, статичний розподіл цього типу за допомогою `Py_tss_NEEDS_INIT` дозволений.

Py_tss_NEEDS_INIT

  Цей макрос розширюється до ініціалізатора для змінних `Py_tss_t`. Зауважте, що цей макрос не буде визначено за допомогою Py_LIMITED_API.

#### Динамічний розподіл

Динамічне розміщення `Py_tss_t`, необхідне в модулях розширення, створених за допомогою Py_LIMITED_API, де статичне розміщення цього типу неможливе через те, що його реалізація непрозора під час створення.

Py_tss_t *PyThread_tss_alloc()
  Part of the Stable ABI since version 3.7.

  Повертає значення, яке є таким самим станом, як і значення, ініціалізоване за допомогою `Py_tss_NEEDS_INIT` або `NULL` у разі помилки динамічного розподілу.

void PyThread_tss_free(Py_tss_t *key)
  Part of the Stable ABI since version 3.7.

  Free the given key allocated by `PyThread_tss_alloc()`, after first calling `PyThread_tss_delete()` to ensure any associated thread locals have been unassigned. This is a no-op if the key argument is `NULL`.

  Примітка

  A freed key becomes a dangling pointer. You should reset the key to `NULL`.

#### методи

Параметр key цих функцій не має бути `NULL`. Крім того, поведінка `PyThread_tss_set()` і `PyThread_tss_get()` є невизначеною, якщо даний `Py_tss_t` не був ініціалізований `PyThread_tss_create()`.

int PyThread_tss_is_created(Py_tss_t *key)
  Part of the Stable ABI since version 3.7.

  Повертає ненульове значення, якщо заданий `Py_tss_t` ініціалізовано `PyThread_tss_create()`.

int PyThread_tss_create(Py_tss_t *key)
  Part of the Stable ABI since version 3.7.

  Повертає нульове значення в разі успішної ініціалізації ключа TSS. Поведінка не визначена, якщо значення, на яке вказує аргумент key, не ініціалізовано `Py_tss_NEEDS_INIT`. Цю функцію можна викликати неодноразово для одного і того ж ключа — виклик її для вже ініціалізованого ключа є безопераційним і негайно повертає успіх.

void PyThread_tss_delete(Py_tss_t *key)
  Part of the Stable ABI since version 3.7.

  Знищіть ключ TSS, щоб забути значення, пов’язані з ключем у всіх потоках, і змініть стан ініціалізації ключа на неініціалізований. Знищений ключ можна знову ініціалізувати за допомогою `PyThread_tss_create()`. Цю функцію можна багаторазово викликати для одного і того ж ключа – виклик її для вже знищеного ключа є безопераційним.

int PyThread_tss_set(Py_tss_t *key, void *value)
  Part of the Stable ABI since version 3.7.

  Return a zero value to indicate successfully associating a void* value with a TSS key in the current thread. Each thread has a distinct mapping of the key to a void* value.

void *PyThread_tss_get(Py_tss_t *key)
  Part of the Stable ABI since version 3.7.

  Return the void* value associated with a TSS key in the current thread. This returns `NULL` if no value is associated with the key in the current thread.

### API локального зберігання потоків (TLS).

Застаріло починаючи з версії 3.7: Цей API замінено API спеціального зберігання потоків (TSS).

Примітка

Ця версія API не підтримує платформи, де власний ключ TLS визначено таким чином, що його неможливо безпечно перевести в `int`. На таких платформах `PyThread_create_key()` негайно повернеться зі статусом помилки, а всі інші функції TLS будуть безопераційними на таких платформах.

Через проблему сумісності, зазначену вище, цю версію API не слід використовувати в новому коді.

int PyThread_create_key()
  Part of the Stable ABI.

void PyThread_delete_key(int key)
  Part of the Stable ABI.

int PyThread_set_key_value(int key, void *value)
  Part of the Stable ABI.

void *PyThread_get_key_value(int key)
  Part of the Stable ABI.

void PyThread_delete_key_value(int key)
  Part of the Stable ABI.

void PyThread_ReInitTLS()
  Part of the Stable ABI.

## Примітиви синхронізації

The C-API provides a basic mutual exclusion lock.

type PyMutex

  A mutual exclusion lock. The `PyMutex` should be initialized to zero to represent the unlocked state. For example:

      PyMutex mutex = {0};

  Instances of `PyMutex` should not be copied or moved. Both the contents and address of a `PyMutex` are meaningful, and it must remain at a fixed, writable location in memory.

  Примітка

  A `PyMutex` currently occupies one byte, but the size should be considered unstable. The size may change in future Python releases without a deprecation period.

  Added in version 3.13.

void PyMutex_Lock(PyMutex *m)

  Lock mutex m. If another thread has already locked it, the calling thread will block until the mutex is unlocked. While blocked, the thread will temporarily detach the thread state if one exists.

  Added in version 3.13.

void PyMutex_Unlock(PyMutex *m)

  Unlock mutex m. The mutex must be locked — otherwise, the function will issue a fatal error.

  Added in version 3.13.

int PyMutex_IsLocked(PyMutex *m)

  Returns non-zero if the mutex m is currently locked, zero otherwise.

  Примітка

  This function is intended for use in assertions and debugging only and should not be used to make concurrency control decisions, as the lock state may change immediately after the check.

  Added in version 3.14.

### Python Critical Section API

The critical section API provides a deadlock avoidance layer on top of per-object locks for free-threaded CPython. They are intended to replace reliance on the global interpreter lock, and are no-ops in versions of Python with the global interpreter lock.

Critical sections are intended to be used for custom types implemented in C-API extensions. They should generally not be used with built-in types like `list` and `dict` because their public C-APIs already use critical sections internally, with the notable exception of `PyDict_Next()`, which requires critical section to be acquired externally.

Critical sections avoid deadlocks by implicitly suspending active critical sections, hence, they do not provide exclusive access such as provided by traditional locks like `PyMutex`. When a critical section is started, the per-object lock for the object is acquired. If the code executed inside the critical section calls C-API functions then it can suspend the critical section thereby releasing the per-object lock, so other threads can acquire the per-object lock for the same object.

Variants that accept `PyMutex` pointers rather than Python objects are also available. Use these variants to start a critical section in a situation where there is no `PyObject` – for example, when working with a C type that does not extend or wrap `PyObject` but still needs to call into the C API in a manner that might lead to deadlocks.

The functions and structs used by the macros are exposed for cases where C macros are not available. They should only be used as in the given macro expansions. Note that the sizes and contents of the structures may change in future Python versions.

Примітка

Operations that need to lock two objects at once must use `Py_BEGIN_CRITICAL_SECTION2`. You cannot use nested critical sections to lock more than one object at once, because the inner critical section may suspend the outer critical sections. This API does not provide a way to lock more than two objects at once.

Приклад використання:

    static PyObject *
    set_field(MyObject *self, PyObject *value)
    {
       Py_BEGIN_CRITICAL_SECTION(self);
       Py_SETREF(self->field, Py_XNewRef(value));
       Py_END_CRITICAL_SECTION();
       Py_RETURN_NONE;
    }

In the above example, `Py_SETREF` calls `Py_DECREF`, which can call arbitrary code through an object’s deallocation function. The critical section API avoids potential deadlocks due to reentrancy and lock ordering by allowing the runtime to temporarily suspend the critical section if the code triggered by the finalizer blocks and calls `PyEval_SaveThread()`.

Py_BEGIN_CRITICAL_SECTION(op)

  Acquires the per-object lock for the object op and begins a critical section.

  In the free-threaded build, this macro expands to:

      {
          PyCriticalSection _py_cs;
          PyCriticalSection_Begin(&_py_cs, (PyObject*)(op))

  In the default build, this macro expands to `{`.

  Added in version 3.13.

Py_BEGIN_CRITICAL_SECTION_MUTEX(m)

  Locks the mutex m and begins a critical section.

  In the free-threaded build, this macro expands to:

      {
           PyCriticalSection _py_cs;
           PyCriticalSection_BeginMutex(&_py_cs, m)

  Note that unlike `Py_BEGIN_CRITICAL_SECTION`, there is no cast for the argument of the macro - it must be a `PyMutex` pointer.

  On the default build, this macro expands to `{`.

  Added in version 3.14.

Py_END_CRITICAL_SECTION()

  Ends the critical section and releases the per-object lock.

  In the free-threaded build, this macro expands to:

          PyCriticalSection_End(&_py_cs);
      }

  In the default build, this macro expands to `}`.

  Added in version 3.13.

Py_BEGIN_CRITICAL_SECTION2(a, b)

  Acquires the per-objects locks for the objects a and b and begins a critical section. The locks are acquired in a consistent order (lowest address first) to avoid lock ordering deadlocks.

  In the free-threaded build, this macro expands to:

      {
          PyCriticalSection2 _py_cs2;
          PyCriticalSection2_Begin(&_py_cs2, (PyObject*)(a), (PyObject*)(b))

  In the default build, this macro expands to `{`.

  Added in version 3.13.

Py_BEGIN_CRITICAL_SECTION2_MUTEX(m1, m2)

  Locks the mutexes m1 and m2 and begins a critical section.

  In the free-threaded build, this macro expands to:

      {
           PyCriticalSection2 _py_cs2;
           PyCriticalSection2_BeginMutex(&_py_cs2, m1, m2)

  Note that unlike `Py_BEGIN_CRITICAL_SECTION2`, there is no cast for the arguments of the macro - they must be `PyMutex` pointers.

  On the default build, this macro expands to `{`.

  Added in version 3.14.

Py_END_CRITICAL_SECTION2()

  Ends the critical section and releases the per-object locks.

  In the free-threaded build, this macro expands to:

          PyCriticalSection2_End(&_py_cs2);
      }

  In the default build, this macro expands to `}`.

  Added in version 3.13.

### Legacy Locking APIs

These APIs are obsolete since Python 3.13 with the introduction of `PyMutex`.

Змінено в версії 3.15: These APIs are now a simple wrapper around `PyMutex`.

type PyThread_type_lock

  A pointer to a mutual exclusion lock.

type PyLockStatus

  The result of acquiring a lock with a timeout.

  enumerator PY_LOCK_FAILURE

    Failed to acquire the lock.

  enumerator PY_LOCK_ACQUIRED

    The lock was successfully acquired.

  enumerator PY_LOCK_INTR

    The lock was interrupted by a signal.

PyThread_type_lock PyThread_allocate_lock(void)
  Part of the Stable ABI.

  Allocate a new lock.

  On success, this function returns a lock; on failure, this function returns `0` without an exception set.

  The caller does not need to hold an attached thread state.

  Змінено в версії 3.15: This function now always uses `PyMutex`. In prior versions, this would use a lock provided by the operating system.

void PyThread_free_lock(PyThread_type_lock lock)
  Part of the Stable ABI.

  Destroy lock. The lock should not be held by any thread when calling this.

  The caller does not need to hold an attached thread state.

PyLockStatus PyThread_acquire_lock_timed(PyThread_type_lock lock, long long microseconds, int intr_flag)
  Part of the Stable ABI.

  Acquire lock with a timeout.

  This will wait for microseconds microseconds to acquire the lock. If the timeout expires, this function returns `PY_LOCK_FAILURE`. If microseconds is `-1`, this will wait indefinitely until the lock has been released.

  If intr_flag is `1`, acquiring the lock may be interrupted by a signal, in which case this function returns `PY_LOCK_INTR`. Upon interruption, it’s generally expected that the caller makes a call to `Py_MakePendingCalls()` to propagate an exception to Python code.

  If the lock is successfully acquired, this function returns `PY_LOCK_ACQUIRED`.

  The caller does not need to hold an attached thread state.

int PyThread_acquire_lock(PyThread_type_lock lock, int waitflag)
  Part of the Stable ABI.

  Acquire lock.

  If waitflag is `1` and another thread currently holds the lock, this function will wait until the lock can be acquired and will always return `1`.

  If waitflag is `0` and another thread holds the lock, this function will not wait and instead return `0`. If the lock is not held by any other thread, then this function will acquire it and return `1`.

  Unlike `PyThread_acquire_lock_timed()`, acquiring the lock cannot be interrupted by a signal.

  The caller does not need to hold an attached thread state.

int PyThread_release_lock(PyThread_type_lock lock)
  Part of the Stable ABI.

  Release lock. If lock is not held, then this function issues a fatal error.

  The caller does not need to hold an attached thread state.

## Operating System Thread APIs

PYTHREAD_INVALID_THREAD_ID

  Sentinel value for an invalid thread ID.

  This is currently equivalent to `(unsigned long)-1`.

unsigned long PyThread_start_new_thread(void (*func)(void*), void *arg)
  Part of the Stable ABI.

  Start function func in a new thread with argument arg. The resulting thread is not intended to be joined.

  func must not be `NULL`, but arg may be `NULL`.

  On success, this function returns the identifier of the new thread; on failure, this returns `PYTHREAD_INVALID_THREAD_ID`.

  The caller does not need to hold an attached thread state.

unsigned long PyThread_get_thread_ident(void)
  Part of the Stable ABI.

  Return the identifier of the current thread, which will never be zero.

  This function cannot fail, and the caller does not need to hold an attached thread state.

  Дивись також

  `threading.get_ident()`

PyObject *PyThread_GetInfo(void)
  Part of the Stable ABI since version 3.3.

  Get general information about the current thread in the form of a struct sequence object. This information is accessible as `sys.thread_info` in Python.

  On success, this returns a new strong reference to the thread information; on failure, this returns `NULL` with an exception set.

  The caller must hold an attached thread state.

PY_HAVE_THREAD_NATIVE_ID

  This macro is defined when the system supports native thread IDs.

unsigned long PyThread_get_thread_native_id(void)
  Part of the Stable ABI on platforms with native thread IDs.

  Get the native identifier of the current thread as it was assigned by the operating system’s kernel, which will never be less than zero.

  This function is only available when `PY_HAVE_THREAD_NATIVE_ID` is defined.

  This function cannot fail, and the caller does not need to hold an attached thread state.

  Дивись також

  `threading.get_native_id()`

void PyThread_exit_thread(void)
  Part of the Stable ABI.

  Terminate the current thread. This function is generally considered unsafe and should be avoided. It is kept solely for backwards compatibility.

  This function is only safe to call if all functions in the full call stack are written to safely allow it.

  Попередження

  If the current system uses POSIX threads (also known as «pthreads»), this calls pthread_exit(3), which attempts to unwind the stack and call C++ destructors on some libc implementations. However, if a `noexcept` function is reached, it may terminate the process. Other systems, such as macOS, do unwinding.

  On Windows, this function calls `_endthreadex()`, which kills the thread without calling C++ destructors.

  In any case, there is a risk of corruption on the thread’s stack.

  Застаріло починаючи з версії 3.14.

void PyThread_init_thread(void)
  Part of the Stable ABI.

  Initialize `PyThread*` APIs. Python executes this function automatically, so there’s little need to call it from an extension module.

int PyThread_set_stacksize(size_t size)
  Part of the Stable ABI.

  Set the stack size of the current thread to size bytes.

  This function returns `0` on success, `-1` if size is invalid, or `-2` if the system does not support changing the stack size. This function does not set exceptions.

  The caller does not need to hold an attached thread state.

size_t PyThread_get_stacksize(void)
  Part of the Stable ABI.

  Return the stack size of the current thread in bytes, or `0` if the system’s default stack size is in use.

  The caller does not need to hold an attached thread state.