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

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

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

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

Примітка

The following functions should not be called before Py_Initialize(): Py_EncodeLocale(), Py_GetPath(), Py_GetPrefix(), Py_GetExecPrefix(), Py_GetProgramFullPath(), Py_GetPythonHome(), Py_GetProgramName() and PyEval_InitThreads().

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

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.

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

int Py_DebugFlag¶

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

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

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

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

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.

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

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.

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

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, щоб ініціалізувати секретне початкове значення хешу.

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

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.

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

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.

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

int Py_InteractiveFlag¶

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

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

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

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.

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

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.

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

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.

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

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.

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

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.

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

int Py_OptimizeFlag¶

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

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

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

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.

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

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.

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

int Py_VerboseFlag¶

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

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

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

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

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

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 PySys_SetArgvEx() 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 the Py_InitializeFromConfig() function 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 might be useful when Python is embedded.

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

int Py_IsInitialized()¶: Part of the Stable ABI.
Повертає істину (не нуль), якщо інтерпретатор Python ініціалізовано, і false (нуль), якщо ні. Після виклику Py_FinalizeEx() повертається false, доки Py_Initialize() не буде викликано знову.

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.

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

Added in version 3.6.

void Py_Finalize()¶: Part of the Stable ABI.
Це зворотно сумісна версія Py_FinalizeEx(), яка не враховує значення, що повертається.

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

int Py_SetStandardStreamEncoding(const char *encoding, const char *errors)¶

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

This function should be called before Py_Initialize(), if it is called at all. It specifies which encoding and error handling to use with standard IO, with the same meanings as in str.encode().

It overrides PYTHONIOENCODING values, and allows embedding code to control IO encoding when the environment variable does not work.

encoding and/or errors may be NULL to use PYTHONIOENCODING and/or default values (depending on other settings).

Note that sys.stderr always uses the «backslashreplace» error handler, regardless of this (or any other) setting.

If Py_FinalizeEx() is called, this function will need to be called again in order to affect subsequent calls to Py_Initialize().

Returns 0 if successful, a nonzero value on error (e.g. calling after the interpreter has already been initialized).

Added in version 3.4.

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

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.

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

wchar_t *Py_GetProgramName()¶

Part of the Stable ABI.

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

Цю функцію не слід викликати перед Py_Initialize(), інакше вона повертає NULL.

Змінено в версії 3.10: Тепер він повертає NULL, якщо викликаний перед Py_Initialize().

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 Py_SetProgramName() 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.prefix. It is only useful on Unix. See also the next function.

Цю функцію не слід викликати перед Py_Initialize(), інакше вона повертає NULL.

Змінено в версії 3.10: Тепер він повертає NULL, якщо викликаний перед Py_Initialize().

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 Py_SetProgramName() 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.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 різні файлові системи для кожної платформи.

Цю функцію не слід викликати перед Py_Initialize(), інакше вона повертає NULL.

Змінено в версії 3.10: Тепер він повертає NULL, якщо викликаний перед Py_Initialize().

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 Py_SetProgramName() above). The returned string points into static storage; the caller should not modify its value. The value is available to Python code as sys.executable.

Цю функцію не слід викликати перед Py_Initialize(), інакше вона повертає NULL.

Змінено в версії 3.10: Тепер він повертає NULL, якщо викликаний перед Py_Initialize().

wchar_t *Py_GetPath()¶

Part of the Stable ABI.

Return the default module search path; this is computed from the program name (set by Py_SetProgramName() above) 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.

Цю функцію не слід викликати перед Py_Initialize(), інакше вона повертає NULL.

Змінено в версії 3.10: Тепер він повертає NULL, якщо викликаний перед Py_Initialize().

void Py_SetPath(const wchar_t*)¶

Part of the Stable ABI since version 3.7.

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

Set the default module search path. If this function is called before Py_Initialize(), then Py_GetPath() won’t attempt to compute a default search path but uses the one provided instead. This is useful if Python is embedded by an application that has full knowledge of the location of all modules. The path components should be separated by the platform dependent delimiter character, which is ':' on Unix and macOS, ';' on Windows.

This also causes sys.executable to be set to the program full path (see Py_GetProgramFullPath()) and for sys.prefix and sys.exec_prefix to be empty. It is up to the caller to modify these if required after calling Py_Initialize().

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

The path argument is copied internally, so the caller may free it after the call completes.

Змінено в версії 3.8: The program full path is now used for sys.executable, instead of the program name.

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

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.

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

Інтерпретатор Python не є повністю потокобезпечним. Щоб підтримувати багатопотокові програми Python, існує глобальне блокування, яке називається global interpreter lock або GIL, яке має утримуватися поточним потоком, перш ніж він зможе безпечно отримати доступ до об’єктів Python. Без блокування навіть найпростіші операції можуть спричинити проблеми в багатопотоковій програмі: наприклад, коли два потоки одночасно збільшують кількість посилань на один і той же об’єкт, кількість посилань може збільшитися лише один раз, а не двічі.

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

Інтерпретатор Python зберігає певну облікову інформацію про потоки в структурі даних під назвою PyThreadState. Існує також одна глобальна змінна, яка вказує на поточний PyThreadState: її можна отримати за допомогою PyThreadState_Get().

Реліз GIL від коду розширення¶

Більшість кодів розширення, які маніпулюють GIL, мають таку просту структуру:

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

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

Примітка

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

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

Коли потоки створюються за допомогою спеціальних API Python (таких як модуль threading), стан потоку автоматично пов’язується з ними, і код, показаний вище, є правильним. Однак, коли потоки створюються з C (наприклад, сторонньою бібліотекою з власним керуванням потоками), вони не містять GIL, а також для них не існує структури стану потоку.

Якщо вам потрібно викликати код Python із цих потоків (часто це буде частиною API зворотного виклику, наданого вищезгаданою сторонньою бібліотекою), ви повинні спочатку зареєструвати ці потоки в інтерпретаторі, створивши структуру даних стану потоку, а потім отримати GIL і, нарешті, збереження покажчика стану потоку, перш ніж ви зможете почати використовувати API Python/C. Коли ви закінчите, ви повинні скинути вказівник стану потоку, звільнити GIL і, нарешті, звільнити структуру даних стану потоку.

Функції 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 Блокування об’єктів 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() буде викликано одразу після.

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

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

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

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

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

int PyEval_ThreadsInitialized()¶: Part of the Stable ABI.
Returns a non-zero value if PyEval_InitThreads() has been called. This function can be called without holding the GIL, and therefore can be used to avoid calls to the locking API when running single-threaded.

Змінено в версії 3.7: The GIL is now initialized by Py_Initialize().

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

PyThreadState *PyEval_SaveThread()¶: Part of the Stable ABI.
Звільніть глобальне блокування інтерпретатора (якщо його було створено) і скиньте стан потоку до NULL, повертаючи попередній стан потоку (який не є NULL). Якщо блокування було створено, поточний потік повинен отримати його.

void PyEval_RestoreThread(PyThreadState *tstate)¶: Part of the Stable ABI.
Отримайте глобальне блокування інтерпретатора (якщо його було створено) і встановіть стан потоку на tstate, який не має бути NULL. Якщо блокування було створено, поточний потік не повинен отримати його, інакше виникає взаємоблокування.

Примітка

Calling this function from a thread when the runtime is finalizing will terminate the thread, even if the thread was not created by Python. You can use _Py_IsFinalizing() or sys.is_finalizing() to check if the interpreter is in process of being finalized before calling this function to avoid unwanted termination.

PyThreadState *PyThreadState_Get()¶: Part of the Stable ABI.
Повертає поточний стан потоку. Необхідно утримувати глобальне блокування інтерпретатора. Коли поточний стан потоку NULL, це викликає фатальну помилку (тому абоненту не потрібно перевіряти NULL).

PyThreadState *PyThreadState_Swap(PyThreadState *tstate)¶: Part of the Stable ABI.
Замінити поточний стан потоку на стан потоку, заданий аргументом tstate, який може бути NULL. Глобальне блокування інтерпретатора має бути утримано та не звільнене.

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

PyGILState_STATE PyGILState_Ensure()¶

Part of the Stable ABI.

Переконайтеся, що поточний потік готовий викликати API Python C незалежно від поточного стану Python або глобального блокування інтерпретатора. Це може бути викликано скільки завгодно разів потоком, якщо кожен виклик відповідає виклику PyGILState_Release(). Загалом, між викликами PyGILState_Ensure() і PyGILState_Release() можна використовувати інші пов’язані з потоками API, якщо стан потоку відновлено до попереднього стану до Release(). Наприклад, нормальне використання макросів Py_BEGIN_ALLOW_THREADS і Py_END_ALLOW_THREADS є прийнятним.

Значення, що повертається, є непрозорим «дескриптором» стану потоку під час виклику PyGILState_Ensure(), і його потрібно передати в PyGILState_Release(), щоб Python залишався в тому самому стані. Незважаючи на те, що рекурсивні виклики дозволені, ці дескриптори не можна спільно використовувати — кожен унікальний виклик PyGILState_Ensure() повинен зберігати дескриптор для свого виклику PyGILState_Release().

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

Примітка

Calling this function from a thread when the runtime is finalizing will terminate the thread, even if the thread was not created by Python. You can use _Py_IsFinalizing() or sys.is_finalizing() to check if the interpreter is in process of being finalized before calling this function to avoid unwanted termination.

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.
Отримати поточний стан потоку для цього потоку. Може повертати NULL, якщо API GILState не використовувався в поточному потоці. Зверніть увагу, що основний потік завжди має такий стан потоку, навіть якщо в основному потоці не було зроблено виклик автоматичного стану потоку. Це в основному допоміжна/діагностична функція.

int PyGILState_Check()¶: Повертає 1, якщо поточний потік містить GIL, і 0 інакше. Цю функцію можна викликати з будь-якого потоку в будь-який час. Лише якщо він ініціалізував стан потоку Python і зараз утримує GIL, він поверне 1. Це в основному допоміжна/діагностична функція. Це може бути корисно, наприклад, у контекстах зворотного виклику або функціях виділення пам’яті, коли знання про те, що GIL заблоковано, може дозволити абоненту виконувати конфіденційні дії або іншим чином поводитися по-іншому.

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() тепер ініціалізує GIL.

PyInterpreterState *PyInterpreterState_New()¶

Part of the Stable ABI.

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

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

void PyInterpreterState_Clear(PyInterpreterState *interp)¶

Part of the Stable ABI.

Скинути всю інформацію в об’єкті стану інтерпретатора. Необхідно утримувати глобальне блокування інтерпретатора.

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

void PyInterpreterState_Delete(PyInterpreterState *interp)¶: Part of the Stable ABI.
Знищити об’єкт стану інтерпретатора. Глобальне блокування інтерпретатора не потрібно утримувати. Стан інтерпретатора має бути скинуто за допомогою попереднього виклику PyInterpreterState_Clear().

PyThreadState *PyThreadState_New(PyInterpreterState *interp)¶: Part of the Stable ABI.
Створіть новий об’єкт стану потоку, що належить даному об’єкту інтерпретатора. Глобальне блокування інтерпретатора не потрібно утримувати, але можна утримувати, якщо необхідно серіалізувати виклики цієї функції.

void PyThreadState_Clear(PyThreadState *tstate)¶: Part of the Stable ABI.
Скинути всю інформацію в об’єкті стану потоку. Необхідно утримувати глобальне блокування інтерпретатора.

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

void PyThreadState_Delete(PyThreadState *tstate)¶: Part of the Stable ABI.
Знищити об’єкт стану потоку. Глобальне блокування інтерпретатора не потрібно утримувати. Стан потоку має бути скинуто попереднім викликом 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.

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

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

tstate не має бути NULL.

Added in version 3.9.

uint64_t PyThreadState_GetID(PyThreadState *tstate)¶

Part of the Stable ABI since version 3.10.

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

tstate не має бути NULL.

Added in version 3.9.

PyInterpreterState *PyThreadState_GetInterpreter(PyThreadState *tstate)¶

Part of the Stable ABI since version 3.10.

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

tstate не має бути 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.

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

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

Абонент повинен тримати GIL.

Added in version 3.9.

int64_t PyInterpreterState_GetID(PyInterpreterState *interp)¶

Part of the Stable ABI since version 3.7.

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

Абонент повинен тримати 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.

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.
Повертає словник, у якому розширення можуть зберігати інформацію про стан потоку. Кожне розширення має використовувати унікальний ключ для збереження стану в словнику. Цю функцію можна викликати, якщо поточний стан потоку недоступний. Якщо ця функція повертає NULL, це означає, що жодного винятку не було викликано, і абонент повинен вважати, що поточний стан потоку недоступний.

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.

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

void PyEval_AcquireThread(PyThreadState *tstate)¶

Part of the Stable ABI.

Отримайте глобальне блокування інтерпретатора та встановіть поточний стан потоку на tstate, який не має бути NULL. Замок повинен бути створений раніше. Якщо цей потік уже має блокування, виникає взаємоблокування.

Примітка

Calling this function from a thread when the runtime is finalizing will terminate the thread, even if the thread was not created by Python. You can use _Py_IsFinalizing() or sys.is_finalizing() to check if the interpreter is in process of being finalized before calling this function to avoid unwanted termination.

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

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

void PyEval_ReleaseThread(PyThreadState *tstate)¶

Part of the Stable ABI.

Скиньте поточний стан потоку на NULL і звільніть глобальне блокування інтерпретатора. Блокування має бути створено раніше та утримуватися поточним потоком. Аргумент tstate, який не має бути NULL, використовується лише для перевірки того, що він представляє поточний стан потоку — якщо це не так, повідомляється про фатальну помилку.

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

void PyEval_AcquireLock()¶: Part of the Stable ABI.
Acquire the global interpreter lock. The lock must have been created earlier. If this thread already has the lock, a deadlock ensues.

Застаріло починаючи з версії 3.2: This function does not update the current thread state. Please use PyEval_RestoreThread() or PyEval_AcquireThread() instead.

Примітка

Calling this function from a thread when the runtime is finalizing will terminate the thread, even if the thread was not created by Python. You can use _Py_IsFinalizing() or sys.is_finalizing() to check if the interpreter is in process of being finalized before calling this function to avoid unwanted termination.

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

void PyEval_ReleaseLock()¶: Part of the Stable ABI.
Release the global interpreter lock. The lock must have been created earlier.

Застаріло починаючи з версії 3.2: This function does not update the current thread state. Please use PyEval_SaveThread() or PyEval_ReleaseThread() instead.

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

Хоча в більшості випадків ви вбудовуєте лише один інтерпретатор 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 = Py_NewInterpreterFromConfig(&config);

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;
з головним потоком, який утримує global interpreter lock (func може використовувати повний C API).

func має повернути 0 у разі успіху або -1 у разі помилки з набором винятків. func не буде перервано для рекурсивного виконання іншого асинхронного сповіщення, але його все одно можна перервати для перемикання потоків, якщо глобальне блокування інтерпретатора звільнено.

Цій функції не потрібен поточний стан потоку для запуску, і їй не потрібне блокування глобального інтерпретатора.

Щоб викликати цю функцію в підінтерпретаторі, абонент, що викликає, повинен мати GIL. В іншому випадку функція func може бути запланована для виклику з неправильного інтерпретатора.

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

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

Added in version 3.1.

Змінено в версії 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`	Завжди `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.

Абонент повинен утримувати 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.

Абонент повинен утримувати 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.

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

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

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.

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

Зауважте, що 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.

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

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

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

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

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

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

Реліз GIL від коду розширення¶

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

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

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

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

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

A Per-Interpreter GIL¶

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

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

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

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

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

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

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

методи¶

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

Table of Contents

Попередній розділ

Наступна тема

Ця сторінка