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

Нове в версії 3.8.

Structures:

PyConfig
PyPreConfig
PyStatus
PyWideStringList

Functions:

The preconfiguration (PyPreConfig type) is stored in _PyRuntime.preconfig and the configuration (PyConfig type) is stored in PyInterpreterState.config.

Дивіться також Ініціалізація, фіналізація та потоки.

Дивись також

PEP 587 «Конфігурація ініціалізації Python».

PyWideStringList¶

PyWideStringList¶

Список рядків wchar_t*.

Якщо length не дорівнює нулю, items не мають бути NULL, а всі рядки мають бути не NULL.

Методи:

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

Додайте елемент до списку.

Щоб викликати цю функцію, Python має бути попередньо ініціалізований.

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

Вставте елемент у список за індексом.

Якщо index більше або дорівнює довжині list, додайте item до list.

index must be greater than or equal to 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)¶: Статус помилка чи вихід? Якщо істина, виняток потрібно обробити; наприклад, викликом Py_ExitStatusException().

int PyStatus_IsError(PyStatus status)¶: Чи є результат помилкою?

int PyStatus_IsExit(PyStatus status)¶: Результат – це вихід?

void Py_ExitStatusException(PyStatus status)¶: Викличте exit(exitcode), якщо 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¶

Structure used to preinitialize Python:

Set the Python memory allocator
Configure the LC_CTYPE locale
Set the UTF-8 mode

Функція ініціалізації попередньої конфігурації:

void PyPreConfig_InitPythonConfig(PyPreConfig *preconfig)¶: Ініціалізуйте попередню конфігурацію за допомогою Налаштування Python.

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

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

int allocator¶

Name of the memory allocator:

PYMEM_ALLOCATOR_NOT_SET (0): don’t change memory allocators (use defaults)
PYMEM_ALLOCATOR_DEFAULT (1): default memory allocators
PYMEM_ALLOCATOR_DEBUG (2): default memory allocators with debug hooks
PYMEM_ALLOCATOR_MALLOC (3): force usage of malloc()
PYMEM_ALLOCATOR_MALLOC_DEBUG (4): force usage of malloc() with debug hooks
PYMEM_ALLOCATOR_PYMALLOC (5): Python pymalloc memory allocator
PYMEM_ALLOCATOR_PYMALLOC_DEBUG (6): Python pymalloc memory allocator with debug hooks

PYMEM_ALLOCATOR_PYMALLOC and PYMEM_ALLOCATOR_PYMALLOC_DEBUG are not supported if Python is configured using --without-pymalloc

Перегляньте Керування пам’яттю.

int configure_locale¶: Set the LC_CTYPE locale to the user preferred locale? If equals to 0, set coerce_c_locale and coerce_c_locale_warn to 0.

int coerce_c_locale¶: If equals to 2, coerce the C locale; if equals to 1, read the LC_CTYPE locale to decide if it should be coerced.

int coerce_c_locale_warn¶: Якщо значення відмінне від нуля, видати попередження, якщо локаль C виведена примусово.

int dev_mode¶: See PyConfig.dev_mode.

int isolated¶: See PyConfig.isolated.

int legacy_windows_fs_encoding(Windows only)¶

If non-zero, disable UTF-8 Mode, set the Python filesystem encoding to mbcs, set the filesystem error handler to replace.

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

int parse_argv¶: Якщо значення відмінне від нуля, Py_PreInitializeFromArgs() і Py_PreInitializeFromBytesArgs() аналізують свій аргумент argv так само, як звичайний Python аналізує аргументи командного рядка: див. Аргументи командного рядка.

int use_environment¶: See PyConfig.use_environment.

int utf8_mode¶: If non-zero, enable the UTF-8 mode.

Preinitialization with PyPreConfig¶

Функції для попередньої ініціалізації Python:

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

PyStatus Py_PreInitializeFromBytesArgs(const PyPreConfig *preconfig, int argc, char * const *argv)¶: Preinitialize Python from preconfig preconfiguration and command line arguments (bytes strings).

PyStatus Py_PreInitializeFromArgs(const PyPreConfig *preconfig, int argc, wchar_t * const * argv)¶: Preinitialize Python from preconfig preconfiguration and command line arguments (wide strings).

Виклик відповідає за обробку винятків (помилка або вихід) за допомогою PyStatus_Exception() і Py_ExitStatusException().

For Python Configuration (PyPreConfig_InitPythonConfig()), if Python is initialized with command line arguments, the command line arguments must also be passed to preinitialize Python, since they have an effect on the pre-configuration like encodings. For example, the -X utf8 command line option enables the UTF-8 Mode.

PyMem_SetAllocator() можна викликати після Py_PreInitialize() і перед Py_InitializeFromConfig(), щоб встановити спеціальний розподільник пам’яті. Його можна викликати перед Py_PreInitialize(), якщо PyPreConfig.allocator має значення PYMEM_ALLOCATOR_NOT_SET.

Python memory allocation functions like PyMem_RawMalloc() must not be used before Python preinitialization, whereas calling directly malloc() and free() is always safe. Py_DecodeLocale() must not be called before the preinitialization.

Example using the preinitialization to enable the UTF-8 Mode:

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

preconfig.utf8_mode = 1;

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

/* at this point, Python will speak UTF-8 */

Py_Initialize();
/* ... use Python API here ... */
Py_Finalize();

PyConfig¶

PyConfig¶

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

Методи будови:

void PyConfig_InitPythonConfig(PyConfig *config)¶: Initialize configuration with Python Configuration.

void PyConfig_InitIsolatedConfig(PyConfig *config)¶: Initialize configuration with Isolated Configuration.

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

Скопіюйте широкий символьний рядок str у *config_str.