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

Добавлено в версии 3.8.

Структуры:

Функции:

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

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

См.также

PEP 587 «Инициализация конфигурации Python».

PyWideStringList¶

PyWideStringList¶

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

Если length не равно нулю, items должен быть не-NULL, а все строки должны быть не-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 к list.

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

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

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

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

wchar_t** items¶: Перечислить элементы.

PyStatus¶

PyStatus¶

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

Для ошибки она может сохранить имя функции 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)¶: Статус ошибки или выход? Если true, исключение должно быть обработано; путем вызова 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 распределитель Python распределитель с хуками отладки

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

Если отличный от нуля, отключить режим 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¶

Функции для предварительной инициализации 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.