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

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
Konfiguracja funkcja:
- PyImport_AppendInittab()
- PyImport_ExtendInittab()
- PyInitFrozenExtensions()
- PyMem_SetAllocator()
- PyMem_SetupDebugHooks()
- PyObject_SetArenaAllocator()
- Py_SetProgramName()
- Py_SetPythonHome()
- PySys_ResetWarnOptions()
- the configuration functions covered in Конфігурація ініціалізації Python
Informatiwne funkcje:
Narzędzia:
- Py_DecodeLocale()
- the status reporting and utility functions covered in Конфігурація ініціалізації Python
Alokatory pamięci:
Synchronization:
- PyMutex_Lock()
- PyMutex_Unlock()

Catatan

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(), Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix(), Py_GetProgramFullPath(), Py_GetPythonHome(), Py_GetProgramName(), 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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

int Py_FrozenFlag¶

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

Придушити повідомлення про помилки під час обчислення шляху пошуку модуля в Py_GetPath().

Private flag used by _freeze_module and frozenmain programs.

Deprecated since version 3.12, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be 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, will be removed in version 3.14.

int Py_LegacyWindowsFSEncodingFlag¶

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

If the flag is non-zero, use the mbcs encoding with replace error handler, instead of the UTF-8 encoding with surrogatepass error handler, for the filesystem encoding and error handler.

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

Lihat PEP 529 untuk lebih detail.

Availability: Windows.

Deprecated since version 3.12, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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, will be removed in version 3.14.

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

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.

Catatan

У 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(). Ideally, this frees all memory allocated by the Python interpreter. 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.

Ця функція передбачена з кількох причин. Програма для вбудовування може захотіти перезапустити 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. 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 Baris perintah.

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.

The GIL must be held 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.

Цю функцію слід викликати перед першим викликом Py_Initialize(), якщо вона взагалі викликається. Він повідомляє інтерпретатору значення аргументу argv[0] для функції main() програми (перетворене на широкі символи). Це використовується Py_GetPath() та деякими іншими функціями нижче для пошуку бібліотек часу виконання Python відносно виконуваного файлу інтерпретатора. Значення за замовчуванням - 'python'. Аргумент має вказувати на широкий символьний рядок із нульовим закінченням у статичній пам’яті, вміст якої не змінюватиметься протягом виконання програми. Жоден код інтерпретатора Python не змінить вміст цього сховища.

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

Ditinggalkan sejak versi 3.11.

wchar_t *Py_GetProgramName()¶

Part of the Stable ABI.

Return the program name set with PyConfig.program_name, or the default. The returned string points into static storage; the caller should not modify its value.

This function should not be called before Py_Initialize(), otherwise it returns NULL.

Berubah pada versi 3.10: It now returns NULL if called before Py_Initialize().

Deprecated since version 3.13, will be removed in version 3.15: Get sys.executable instead.

wchar_t *Py_GetPrefix()¶

Part of the Stable ABI.

Return the prefix for installed platform-independent files. This is derived through a number of complicated rules from the program name set with PyConfig.program_name and some environment variables; for example, if the program name is '/usr/local/bin/python', the prefix is '/usr/local'. The returned string points into static storage; the caller should not modify its value. This corresponds to the prefix variable in the top-level Makefile and the --prefix argument to the configure script at build time. The value is available to Python code as sys.base_prefix. It is only useful on Unix. See also the next function.

This function should not be called before Py_Initialize(), otherwise it returns NULL.

Berubah pada versi 3.10: It now returns NULL if called before Py_Initialize().

Deprecated since version 3.13, will be removed in version 3.15: Get sys.base_prefix instead, or sys.prefix if virtual environments need to be handled.

wchar_t *Py_GetExecPrefix()¶

Part of the Stable ABI.

Return the exec-prefix for installed platform-dependent files. This is derived through a number of complicated rules from the program name set with PyConfig.program_name and some environment variables; for example, if the program name is '/usr/local/bin/python', the exec-prefix is '/usr/local'. The returned string points into static storage; the caller should not modify its value. This corresponds to the exec_prefix variable in the top-level Makefile and the --exec-prefix argument to the configure script at build time. The value is available to Python code as sys.base_exec_prefix. It is only useful on Unix.

Довідкова інформація: префікс exec відрізняється від префікса, коли залежні від платформи файли (такі як виконувані файли та спільні бібліотеки) інстальовано в іншому дереві каталогів. У типовій інсталяції залежні від платформи файли можна інсталювати у піддереві /usr/local/plat, а незалежні від платформи — у /usr/local.

Загалом, платформа – це комбінація сімейства апаратного та програмного забезпечення, напр. Машини Sparc під керуванням операційної системи Solaris 2.x вважаються тією самою платформою, але машини Intel під керуванням Solaris 2.x є іншою платформою, а машини Intel під керуванням Linux є ще іншою платформою. Різні основні версії однієї операційної системи, як правило, створюють різні платформи. Інша історія — операційні системи, відмінні від Unix; стратегії встановлення в цих системах настільки різні, що префікс і префікс exec не мають сенсу та встановлюються як порожній рядок. Зауважте, що скомпільовані файли байт-коду Python не залежать від платформи (але не залежать від версії Python, за допомогою якої вони були скомпільовані!).

Системні адміністратори знатимуть, як налаштувати програми mount або automount для спільного використання /usr/local між платформами, використовуючи /usr/local/plat різні файлові системи для кожної платформи.

This function should not be called before Py_Initialize(), otherwise it returns NULL.

Berubah pada versi 3.10: It now returns NULL if called before Py_Initialize().

Deprecated since version 3.13, will be removed in version 3.15: Get sys.base_exec_prefix instead, or sys.exec_prefix if virtual environments need to be handled.

wchar_t *Py_GetProgramFullPath()¶

Part of the Stable ABI.

Return the full program name of the Python executable; this is computed as a side-effect of deriving the default module search path from the program name (set by PyConfig.program_name). The returned string points into static storage; the caller should not modify its value. The value is available to Python code as sys.executable.

This function should not be called before Py_Initialize(), otherwise it returns NULL.

Berubah pada versi 3.10: It now returns NULL if called before Py_Initialize().

Deprecated since version 3.13, will be removed in version 3.15: Get sys.executable instead.

wchar_t *Py_GetPath()¶

Part of the Stable ABI.

Return the default module search path; this is computed from the program name (set by PyConfig.program_name) and some environment variables. The returned string consists of a series of directory names separated by a platform dependent delimiter character. The delimiter character is ':' on Unix and macOS, ';' on Windows. The returned string points into static storage; the caller should not modify its value. The list sys.path is initialized with this value on interpreter startup; it can be (and usually is) modified later to change the search path for loading modules.

This function should not be called before Py_Initialize(), otherwise it returns NULL.

Berubah pada versi 3.10: It now returns NULL if called before Py_Initialize().

Deprecated since version 3.13, will be removed in version 3.15: Get sys.path instead.

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.

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

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. There's also one global variable pointing to the current PyThreadState: it can be retrieved using PyThreadState_Get().

Releasing the GIL from extension code¶

Most extension code manipulating the GIL has the following simple structure:

Save the thread state in a local variable.
Release the global interpreter lock.
... Do some blocking I/O operation ...
Reacquire the global interpreter lock.
Restore the thread state from the local variable.

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

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 global interpreter lock is used to protect the pointer to the current thread state. When releasing the lock and saving the thread state, the current thread state pointer must be retrieved before the lock is released (since another thread could immediately acquire the lock and store its own thread state in the global variable). Conversely, when acquiring the lock and restoring the thread state, the lock must be acquired before storing the thread state pointer.

Catatan

Calling system I/O functions is the most common use case for releasing the GIL, 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 release the GIL 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, nor is there a thread state structure for them.

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 a thread state data structure, then acquiring the GIL, and finally storing their thread state pointer, before you can start using the Python/C API. When you are done, you should reset the thread state pointer, release the GIL, and finally free the thread state data structure.

Функції 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.

Застереження щодо 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 acquire the GIL during finalization, either explicitly via PyGILState_Ensure(), Py_END_ALLOW_THREADS, PyEval_AcquireThread(), or PyEval_AcquireLock(), or implicitly when the interpreter attempts to reacquire it after having yielded it, 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.7 and earlier. The CPython runtime GIL acquiring C APIs have never had any error reporting or handling expectations at GIL acquisition 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).

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

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

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, якщо його не існувало.

Berubah pada versi 3.9: Тепер функція нічого не робить.

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

Berubah pada versi 3.2: Цю функцію більше не можна викликати до Py_Initialize().

Ditinggalkan sejak versi 3.9.

PyThreadState *PyEval_SaveThread()¶: Part of the Stable ABI.
Release the global interpreter lock (if it has been created) and reset the thread state to NULL, returning the previous thread state (which is not NULL). If the lock has been created, the current thread must have acquired it.

void PyEval_RestoreThread(PyThreadState *tstate)¶: Part of the Stable ABI.
Acquire the global interpreter lock (if it has been created) and set the thread state to tstate, which must not be NULL. If the lock has been created, the current thread must not have acquired it, otherwise deadlock ensues.

Catatan

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.

Berubah pada versi 3.13.7 (unreleased): 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 current thread state. The global interpreter lock must be held. When the current thread state is NULL, this issues a fatal error (so that the caller needn't check for NULL).

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.

Swap the current thread state with the thread state given by the argument tstate, which may be NULL.

The GIL does not need to be held, but will be held upon returning if tstate is non-NULL.

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

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 global interpreter lock. 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 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, the current thread will hold the GIL and be able to call arbitrary Python code. Failure is a fatal error.

Catatan

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.

Berubah pada versi 3.13.7 (unreleased): 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 current 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.

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 Python thread state initialized and currently is holding the GIL 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.

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().

Berubah pada versi 3.7: Py_Initialize() now initializes the GIL.

PyInterpreterState *PyInterpreterState_New()¶

Part of the Stable ABI.

Create a new interpreter state object. The global interpreter lock need not be held, but may be held 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. The global interpreter lock must be held.

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

void PyInterpreterState_Delete(PyInterpreterState *interp)¶: Part of the Stable ABI.
Destroy an interpreter state object. The global interpreter lock need not be held. 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. The global interpreter lock need not be held, but may be held if it is necessary to serialize calls to this function.

void PyThreadState_Clear(PyThreadState *tstate)¶: Part of the Stable ABI.
Reset all information in a thread state object. The global interpreter lock must be held.

Berubah pada versi 3.9: Ця функція тепер викликає зворотний виклик PyThreadState.on_delete. Раніше це траплялося в PyThreadState_Delete().

Berubah pada versi 3.13: The PyThreadState.on_delete callback was removed.

void PyThreadState_Delete(PyThreadState *tstate)¶: Part of the Stable ABI.
Destroy a thread state object. The global interpreter lock need not be held. The thread state must have been reset with a previous call to PyThreadState_Clear().

void PyThreadState_DeleteCurrent(void)¶: Destroy the current thread state and release the global interpreter lock. Like PyThreadState_Delete(), the global interpreter lock must be held. The thread state must have been reset with a previous call to PyThreadState_Clear().

PyFrameObject *PyThreadState_GetFrame(PyThreadState *tstate)¶

Part of the Stable ABI since version 3.10.

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

Return a strong reference. Return NULL if no frame is currently executing.

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

tstate must not be NULL.

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.

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.

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.

PyInterpreterState *PyInterpreterState_Get(void)¶

Part of the Stable ABI since version 3.9.

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

Issue a fatal error if there no current Python thread state or no current interpreter. It cannot return NULL.

The caller must hold the GIL.

Added in version 3.9.

int64_t PyInterpreterState_GetID(PyInterpreterState *interp)¶

Part of the Stable ABI since version 3.7.

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

The caller must hold the GIL.

Added in version 3.7.

PyObject *PyInterpreterState_GetDict(PyInterpreterState *interp)¶

Part of the Stable ABI since version 3.8.

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

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

Added in version 3.8.

PyObject *PyUnstable_InterpreterState_GetMainModule(PyInterpreterState *interp)¶

This is Unstable API. It may change without warning in minor releases.

Return a strong reference to the __main__ module object for the given interpreter.

The caller must hold the GIL.

Added in version 3.13.

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

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

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

Berubah pada versi 3.9: Тепер функція приймає параметр tstate.

Berubah pada versi 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 current thread state is available. If this function returns NULL, no exception has been raised and the caller should assume no current thread state is available.

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 the GIL held. 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.

Berubah pada versi 3.7: The type of the id parameter changed from long to unsigned long.

void PyEval_AcquireThread(PyThreadState *tstate)¶

Part of the Stable ABI.

Acquire the global interpreter lock and set the current thread state to tstate, which must not be NULL. The lock must have been created earlier. If this thread already has the lock, deadlock ensues.

Catatan

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.

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

Berubah pada versi 3.13.7 (unreleased): 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.

Reset the current thread state to NULL and release the global interpreter lock. The lock must have been created earlier and must be held by the current thread. The tstate argument, which must not be NULL, is only used to check that it represents the current 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 made in the current thread state. 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 current thread state and there may not be a current thread state.

Like all other Python/C API functions, the global interpreter lock must be held before calling this function and is still held when it returns. Likewise a current thread state must be set on entry. On success, the returned thread state will be set as current. If the sub-interpreter is created with its own GIL then the GIL of the calling interpreter will be released. When the function returns, the new interpreter's GIL will be held by the current thread and the previously interpreter's GIL will remain released here.

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 використовуються між цими об’єктами модуля.
Для модулів, які використовують однофазну ініціалізацію, напр. PyModule_Create(), коли конкретне розширення імпортується вперше, воно ініціалізується звичайним чином, а (неглибока) копія словника його модуля видаляється. Коли те саме розширення імпортується іншим (під)інтерпретатором, новий модуль ініціалізується та заповнюється вмістом цієї копії; функція init розширення не викликається. Таким чином, об’єкти в словнику модуля розподіляються між (суб-)інтерпретаторами, що може спричинити небажану поведінку (див. Bugs and caveats нижче).

Зауважте, що це відрізняється від того, що відбувається, коли розширення імпортується після повної повторної ініціалізації інтерпретатора викликом 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 the current thread state. See the discussion of thread states below. When the call returns, the current thread state is NULL. All thread states associated with this interpreter are destroyed. The global interpreter lock used by the target interpreter must be held before calling this function. No GIL is held when it returns.

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.)

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 the global interpreter lock (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 global interpreter lock is released.

This function doesn't need a current thread state to run, and it doesn't need the global interpreter lock.

To call this function in a subinterpreter, the caller must hold the GIL. Otherwise, the function func can be scheduled to be called from the wrong interpreter.

Peringatan

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

Added in version 3.1.

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

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

Інтерпретатор 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`	Zawsze `Py_None`.
`PyTrace_EXCEPTION`	Інформація про винятки, яку повертає `sys.exc_info()`.
`PyTrace_LINE`	Zawsze `Py_None`.
`PyTrace_RETURN`	Значення, що повертається абоненту, або `NULL`, якщо викликано винятком.
`PyTrace_C_CALL`	Об’єкт функції, що викликається.
`PyTrace_C_EXCEPTION`	Об’єкт функції, що викликається.
`PyTrace_C_RETURN`	Об’єкт функції, що викликається.
`PyTrace_OPCODE`	Zawsze `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 hold the GIL.

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 hold the GIL.

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.

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.

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_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. The GIL will be held every time the tracer function is called.

The GIL must be held when calling this function.

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.

The GIL must be held 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.

The GIL does not need to be held when calling these functions; they supply their own locking.

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

Catatan

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.

Lihat juga

"Новий 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.

Catatan

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

Metode-Metode¶

Параметр 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).¶

Ditinggalkan sejak versi 3.7: Цей API замінено API спеціального зберігання потоків (TSS).

Catatan

Ця версія 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.

Catatan

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 release the GIL if it is held.

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.

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.

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.

Catatan

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_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_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.

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

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

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

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

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

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

Releasing the GIL from extension code¶

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

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

Cautions regarding runtime finalization¶

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

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

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

A Per-Interpreter GIL¶

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

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

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

Reference tracing¶

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

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

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

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

Metode-Metode¶

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

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

Python Critical Section API¶

Daftar Isi

Topik sebelumnya

Topik berikutnya

This page