Содержание страницы

Конфигурация инициализации Python¶Python Initialization Configuration

Новое в версии 3.8.

Структуры:

PyConfig
PyPreConfig
PyStatus
PyWideStringList

Функции:

Предварительная конфигурация (тип PyPreConfig) хранится в _PyRuntime.preconfig, а конфигурация (тип PyConfig) – в PyInterpreterState.config.

См. также Инициализация, финализация и потоки.

См. также

PEP 587 “Конфигурация инициализации Python”.

PyWideStringList¶

PyWideStringList¶

Список строк wchar_t*.

Если length не равно нулю, items должен быть не NULL, а все строки должны быть\nне NULL.

Методы:

PyStatus PyWideStringList_Append(PyWideStringList *list, const wchar_t *item)¶

Добавляет item в list.

Для вызова этой функции Python должен быть предварительно инициализирован.

PyStatus PyWideStringList_Insert(PyWideStringList *list, Py_ssize_t index, const wchar_t *item)¶

Вставляет item в list по индексу index.

Если index больше или равен длине list, добавляет item в\nlist.

index должен быть больше или равен 0.

Для вызова этой функции Python должен быть предварительно инициализирован.

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

Py_ssize_t length¶: Длина списка.

wchar_t** items¶: Элементы списка.

PyStatus¶

PyStatus¶

Структура для хранения состояния функции инициализации: успех, ошибка\nили завершение.

В случае ошибки может хранить имя C-функции, вызвавшей ошибку.

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

int exitcode¶: Код выхода. Аргумент, передаваемый в exit().

const char *err_msg¶: Сообщение об ошибке.

const char *func¶: Имя функции, создавшей ошибку, может быть NULL.

Функции создания статуса:

PyStatus PyStatus_Ok(void)¶: Успех.

PyStatus PyStatus_Error(const char *err_msg)¶: Ошибка инициализации с сообщением.

PyStatus PyStatus_NoMemory(void)¶: Сбой выделения памяти (не хватает памяти).

PyStatus PyStatus_Exit(int exitcode)¶: Завершить Python с указанным кодом выхода.

Функции обработки статуса:

int PyStatus_Exception(PyStatus status)¶: Является ли статус ошибкой или выходом? Если да, исключение должно быть обработано, например, вызовом Py_ExitStatusException().

int PyStatus_IsError(PyStatus status)¶: Является ли результат ошибкой?

int PyStatus_IsExit(PyStatus status)¶: Является ли результат выходом?

void Py_ExitStatusException(PyStatus status)¶: Вызвать exit(exitcode), если status – это выход. Вывести сообщение об ошибке и завершиться с ненулевым кодом выхода, если status – это ошибка. Должна вызываться, только если PyStatus_Exception(status) не равен нулю.

Примечание

Внутренне Python использует макросы, которые устанавливают PyStatus.func, тогда как функции создания статуса устанавливают func в NULL.

Пример:

PyStatus alloc(void **ptr, size_t size)
{
    *ptr = PyMem_RawMalloc(size);
    if (*ptr == NULL) {
        return PyStatus_NoMemory();
    }
    return PyStatus_Ok();
}

int main(int argc, char **argv)
{
    void *ptr;
    PyStatus status = alloc(&ptr, 16);
    if (PyStatus_Exception(status)) {
        Py_ExitStatusException(status);
    }
    PyMem_Free(ptr);
    return 0;
}

PyPreConfig¶

PyPreConfig¶

Структура, используемая для предварительной инициализации Python:

Установка распределителя памяти Python
Настройка локали LC_CTYPE
Установка режима UTF-8

Функция инициализации предварительной конфигурации:

void PyPreConfig_InitPythonConfig(PyPreConfig *preconfig)¶: Инициализировать предварительную конфигурацию с Конфигурацией Python.

void PyPreConfig_InitIsolatedConfig(PyPreConfig *preconfig)¶: Инициализировать предварительную конфигурацию с Изолированной конфигурацией.

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

int allocator¶

Имя аллокатора памяти:

PYMEM_ALLOCATOR_NOT_SET (0): не менять распределители памяти (использовать по умолчанию)
PYMEM_ALLOCATOR_DEFAULT (1): распределители памяти по умолчанию
PYMEM_ALLOCATOR_DEBUG (2): распределители памяти по умолчанию с отладочными хуками
PYMEM_ALLOCATOR_MALLOC (3): принудительно использовать malloc()
PYMEM_ALLOCATOR_MALLOC_DEBUG (4): принудительно использовать malloc() с отладочными хуками
PYMEM_ALLOCATOR_PYMALLOC (5): аллокатор памяти Python pymalloc
PYMEM_ALLOCATOR_PYMALLOC_DEBUG (6): Python pymalloc аллокатор памяти с отладочными хуками

PYMEM_ALLOCATOR_PYMALLOC и PYMEM_ALLOCATOR_PYMALLOC_DEBUG не поддерживаются, если Python сконфигурирован с помощью --without-pymalloc

См. Управление памятью.

int configure_locale¶: Установить локаль LC_CTYPE в предпочтительную пользователем локаль? Если равно 0, установить coerce_c_locale и coerce_c_locale_warn в 0.

int coerce_c_locale¶: Если равно 2, принудительно изменить локаль C; если равно 1, считать локаль LC_CTYPE, чтобы решить, нужно ли её принудительно изменять.

int coerce_c_locale_warn¶: Если не равно нулю, выводит предупреждение при принудительном переключении локали C.

int dev_mode¶: См. PyConfig.dev_mode.

int isolated¶: См. PyConfig.isolated.

int legacy_windows_fs_encoding(Windows only)¶

Если не равно нулю, отключить режим UTF-8, установить файловую кодировку Python в mbcs, установить обработчик ошибок файловой системы в replace.

Доступно только в Windows. Макрос #ifdef MS_WINDOWS можно использовать для кода, зависящего от Windows.

int parse_argv¶: Если не равно нулю, Py_PreInitializeFromArgs() и Py_PreInitializeFromBytesArgs() обрабатывают свой аргумент argv так же, как обычный Python обрабатывает аргументы командной строки: см. Аргументы командной строки.

int use_environment¶: См. PyConfig.use_environment.

int utf8_mode¶: Если не равно нулю, включить режим UTF-8.

Предварительная инициализация с PyPreConfig¶Preinitialization with PyPreConfig

Функции для предварительной инициализации Python:

PyStatus Py_PreInitialize(const PyPreConfig *preconfig)¶: Преинициализировать Python из предварительной конфигурации preconfig.

PyStatus Py_PreInitializeFromBytesArgs(const PyPreConfig *preconfig, int argc, char * const *argv)¶: Предварительно инициализировать Python из предварительной конфигурации preconfig и аргументов командной строки (байтовые строки).

PyStatus Py_PreInitializeFromArgs(const PyPreConfig *preconfig, int argc, wchar_t * const * argv)¶: Предварительно инициализировать Python из предварительной конфигурации preconfig и аргументов командной строки (широкие строки).

Вызывающий код отвечает за обработку исключений (ошибка или выход) с помощью PyStatus_Exception() и Py_ExitStatusException().

Для конфигурации Python (PyPreConfig_InitPythonConfig()), если Python инициализируется с аргументами командной строки, эти аргументы также должны быть переданы для предварительной инициализации Python, поскольку они влияют на предварительную конфигурацию, например, на кодировки. Например, опция командной строки -X utf8 включает режим UTF-8.

PyMem_SetAllocator() можно вызывать после Py_PreInitialize() и до Py_InitializeFromConfig(), чтобы установить собственный распределитель памяти. Его можно вызывать до Py_PreInitialize(), если PyPreConfig.allocator установлен в PYMEM_ALLOCATOR_NOT_SET.

Функции распределения памяти Python, такие как PyMem_RawMalloc(), не должны использоваться до предварительной инициализации Python, в то время как прямой вызов malloc() и free() всегда безопасен. Py_DecodeLocale() не должна вызываться до предварительной инициализации.

Пример использования предварительной инициализации для включения режима UTF-8:

PyStatus status;
PyPreConfig preconfig;
PyPreConfig_InitPythonConfig(&preconfig);

preconfig.utf8_mode = 1;

status = Py_PreInitialize(&preconfig);
if (PyStatus_Exception(status)) {
    Py_ExitStatusException(status);
}

/* на этом этапе Python будет использовать UTF-8 */

Py_Initialize();
/* ... использовать Python API здесь ... */
Py_Finalize();

PyConfig¶

PyConfig¶

Структура, содержащая большинство параметров для настройки Python.

Методы структуры:

void PyConfig_InitPythonConfig(PyConfig *config)¶: Инициализирует конфигурацию с помощью Конфигурации Python.

void PyConfig_InitIsolatedConfig(PyConfig *config)¶: Инициализирует конфигурацию с помощью Изолированной конфигурации.

PyStatus PyConfig_SetString(PyConfig *config, wchar_t * const *config_str, const wchar_t *str)¶

Копировать широкую строку str в *config_str.