Об’єкти модуля

PyTypeObject PyModule_Type

Part of the Stable ABI.

Цей екземпляр PyTypeObject представляє тип модуля Python. Це доступно для програм Python як types.ModuleType.

int PyModule_Check(PyObject *p)

Повертає true, якщо p є об’єктом модуля або підтипом об’єкта модуля. Ця функція завжди успішна.

int PyModule_CheckExact(PyObject *p)

Повертає true, якщо p є об’єктом модуля, але не підтипом PyModule_Type. Ця функція завжди успішна.

PyObject *PyModule_NewObject(PyObject *name)

Return value: New reference. Part of the Stable ABI since version 3.7.

Return a new module object with module.__name__ set to name. The module’s __name__, __doc__, __package__ and __loader__ attributes are filled in (all but __name__ are set to None). The caller is responsible for setting a __file__ attribute.

Return NULL with an exception set on error.

Added in version 3.3.

Змінено в версії 3.4: __package__ and __loader__ are now set to None.

PyObject *PyModule_New(const char *name)

Return value: New reference. Part of the Stable ABI.

Подібно до PyModule_NewObject(), але ім’я — це рядок у кодуванні UTF-8, а не об’єкт Unicode.

PyObject *PyModule_GetDict(PyObject *module)

Return value: Borrowed reference. Part of the Stable ABI.

Повертає об’єкт словника, який реалізує простір імен module; цей об’єкт збігається з атрибутом __dict__ об’єкта модуля. Якщо module не є об’єктом модуля (або підтипом об’єкта модуля), виникає SystemError і повертається NULL.

It is recommended extensions use other PyModule_* and PyObject_* functions rather than directly manipulate a module’s __dict__.

PyObject *PyModule_GetNameObject(PyObject *module)

Return value: New reference. Part of the Stable ABI since version 3.7.

Return module’s __name__ value. If the module does not provide one, or if it is not a string, SystemError is raised and NULL is returned.

Added in version 3.3.

const char *PyModule_GetName(PyObject *module)

Part of the Stable ABI.

Подібно до PyModule_GetNameObject(), але повертає назву, закодовану в 'utf-8'.

void *PyModule_GetState(PyObject *module)

Part of the Stable ABI.

Повертає «стан» модуля, тобто вказівник на блок пам’яті, виділений під час створення модуля, або NULL. Перегляньте PyModuleDef.m_size.

PyModuleDef *PyModule_GetDef(PyObject *module)

Part of the Stable ABI.

Повертає вказівник на структуру PyModuleDef, з якої було створено модуль, або NULL, якщо модуль не було створено з визначення.

PyObject *PyModule_GetFilenameObject(PyObject *module)

Return value: New reference. Part of the Stable ABI.

Return the name of the file from which module was loaded using module’s __file__ attribute. If this is not defined, or if it is not a string, raise SystemError and return NULL; otherwise return a reference to a Unicode object.

Added in version 3.2.

const char *PyModule_GetFilename(PyObject *module)

Part of the Stable ABI.

Подібно до PyModule_GetFilenameObject(), але повертає назву файлу, закодовану як „utf-8“.

Застаріло починаючи з версії 3.2: PyModule_GetFilename() raises UnicodeEncodeError on unencodable filenames, use PyModule_GetFilenameObject() instead.

Module definitions

The functions in the previous section work on any module object, including modules imported from Python code.

Modules defined using the C API typically use a module definition, PyModuleDef – a statically allocated, constant “description» of how a module should be created.

The definition is usually used to define an extension’s “main” module object (see Defining extension modules for details). It is also used to create extension modules dynamically.

Unlike PyModule_New(), the definition allows management of module state – a piece of memory that is allocated and cleared together with the module object. Unlike the module’s Python attributes, Python code cannot replace or delete data stored in module state.

type PyModuleDef

Part of the Stable ABI (including all members).

The module definition struct, which holds all information needed to create a module object. This structure must be statically allocated (or be otherwise guaranteed to be valid while any modules created from it exist). Usually, there is only one variable of this type for each extension module.

PyModuleDef_Base m_base

Always initialize this member to PyModuleDef_HEAD_INIT.

const char *m_name

Назва для нового модуля.

const char *m_doc

Рядок документації для модуля; зазвичай використовується змінна docstring, створена за допомогою PyDoc_STRVAR.

Py_ssize_t m_size

Стан модуля може зберігатися в області пам’яті для кожного модуля, яку можна отримати за допомогою PyModule_GetState(), а не в статичних глобалах. Це робить модулі безпечними для використання в кількох субінтерпретаторах.

This memory area is allocated based on m_size on module creation, and freed when the module object is deallocated, after the m_free function has been called, if present.

Setting it to a non-negative value means that the module can be re-initialized and specifies the additional amount of memory it requires for its state.

Setting m_size to -1 means that the module does not support sub-interpreters, because it has global state. Negative m_size is only allowed when using legacy single-phase initialization or when creating modules dynamically.

Додаткову інформацію див. PEP 3121.

PyMethodDef *m_methods

Покажчик на таблицю функцій рівня модуля, описану значеннями PyMethodDef. Може бути NULL, якщо функції відсутні.

PyModuleDef_Slot *m_slots

An array of slot definitions for multi-phase initialization, terminated by a {0, NULL} entry. When using legacy single-phase initialization, m_slots must be NULL.

Змінено в версії 3.5: До версії 3.5 цей член завжди мав значення NULL і визначався як:

inquiry m_reload

traverseproc m_traverse

Функція обходу, яка викликається під час обходу GC об’єкта модуля, або NULL, якщо не потрібна.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Змінено в версії 3.9: Більше не викликається до виділення стану модуля.

inquiry m_clear

Очистити функцію для виклику під час очищення GC об’єкта модуля або NULL, якщо не потрібно.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Як і PyTypeObject.tp_clear, ця функція не завжди викликається до того, як модуль буде звільнено. Наприклад, коли підрахунку посилань достатньо, щоб визначити, що об’єкт більше не використовується, циклічний збирач сміття не задіяний і m_free викликається безпосередньо.

Змінено в версії 3.9: Більше не викликається до виділення стану модуля.

freefunc m_free

Функція для виклику під час звільнення об’єкта модуля або NULL, якщо вона не потрібна.

This function is not called if the module state was requested but is not allocated yet. This is the case immediately after the module is created and before the module is executed (Py_mod_exec function). More precisely, this function is not called if m_size is greater than 0 and the module state (as returned by PyModule_GetState()) is NULL.

Змінено в версії 3.9: Більше не викликається до виділення стану модуля.

Module slots

type PyModuleDef_Slot

int slot

Ідентифікатор слота, вибраний із доступних значень, пояснених нижче.

void *value

Значення слота, значення якого залежить від ідентифікатора слота.

Added in version 3.5.

Доступні типи слотів:

Py_mod_create

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

PyObject *create_module(PyObject *spec, PyModuleDef *def)

Функція отримує екземпляр ModuleSpec, як визначено в PEP 451, і визначення модуля. Він має повернути новий об’єкт модуля або встановити помилку та повернути NULL.

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

Кілька слотів Py_mod_create не можуть бути вказані в одному визначенні модуля.

Якщо Py_mod_create не вказано, механізм імпорту створить звичайний об’єкт модуля за допомогою PyModule_New(). Ім’я взято з spec, а не з визначення, щоб дозволити модулям розширення динамічно адаптуватися до свого місця в ієрархії модулів і імпортуватися під різними іменами за допомогою символічних посилань, водночас користуючись єдиним визначенням модуля.

Немає вимоги, щоб повернутий об’єкт був екземпляром PyModule_Type. Можна використовувати будь-який тип, якщо він підтримує встановлення та отримання пов’язаних з імпортом атрибутів. Однак лише екземпляри PyModule_Type можуть повертатися, якщо PyModuleDef має не-NULL m_traverse, m_clear, m_free; ненульовий m_size; або слоти, відмінні від Py_mod_create.

Py_mod_exec

Визначає функцію, яка викликається для виконання модуля. Це еквівалентно виконанню коду модуля Python: зазвичай ця функція додає класи та константи до модуля. Сигнатура функції:

int exec_module(PyObject *module)

Якщо вказано кілька слотів Py_mod_exec, вони обробляються в тому порядку, в якому вони з’являються в масиві m_slots.

Py_mod_multiple_interpreters

Specifies one of the following values:

Py_MOD_MULTIPLE_INTERPRETERS_NOT_SUPPORTED

The module does not support being imported in subinterpreters.

Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED

The module supports being imported in subinterpreters, but only when they share the main interpreter’s GIL. (See Isolating Extension Modules.)

Py_MOD_PER_INTERPRETER_GIL_SUPPORTED

The module supports being imported in subinterpreters, even when they have their own GIL. (See Isolating Extension Modules.)

This slot determines whether or not importing this module in a subinterpreter will fail.

Multiple Py_mod_multiple_interpreters slots may not be specified in one module definition.

If Py_mod_multiple_interpreters is not specified, the import machinery defaults to Py_MOD_MULTIPLE_INTERPRETERS_SUPPORTED.

Added in version 3.12.

Py_mod_gil

Specifies one of the following values:

Py_MOD_GIL_USED

The module depends on the presence of the global interpreter lock (GIL), and may access global state without synchronization.

Py_MOD_GIL_NOT_USED

The module is safe to run without an active GIL.

This slot is ignored by Python builds not configured with --disable-gil. Otherwise, it determines whether or not importing this module will cause the GIL to be automatically enabled. See Free-threaded CPython for more detail.

Multiple Py_mod_gil slots may not be specified in one module definition.

If Py_mod_gil is not specified, the import machinery defaults to Py_MOD_GIL_USED.

Added in version 3.13.

Creating extension modules dynamically

The following functions may be used to create a module outside of an extension’s initialization function. They are also used in single-phase initialization.

PyObject *PyModule_Create(PyModuleDef *def)

Return value: New reference.

Create a new module object, given the definition in def. This is a macro that calls PyModule_Create2() with module_api_version set to PYTHON_API_VERSION, or to PYTHON_ABI_VERSION if using the limited API.

PyObject *PyModule_Create2(PyModuleDef *def, int module_api_version)

Return value: New reference. Part of the Stable ABI.

Створіть новий об’єкт модуля, враховуючи визначення в def, припускаючи версію API module_api_version. Якщо ця версія не збігається з версією запущеного інтерпретатора, видається RuntimeWarning.

Return NULL with an exception set on error.

This function does not support slots. The m_slots member of def must be NULL.

Примітка

Більшість випадків використання цієї функції має використовувати замість неї PyModule_Create(); використовуйте це, лише якщо ви впевнені, що це вам потрібно.

PyObject *PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)

Return value: New reference.

This macro calls PyModule_FromDefAndSpec2() with module_api_version set to PYTHON_API_VERSION, or to PYTHON_ABI_VERSION if using the limited API.

Added in version 3.5.

PyObject *PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)

Return value: New reference. Part of the Stable ABI since version 3.7.

Create a new module object, given the definition in def and the ModuleSpec spec, assuming the API version module_api_version. If that version does not match the version of the running interpreter, a RuntimeWarning is emitted.

Return NULL with an exception set on error.

Note that this does not process execution slots (Py_mod_exec). Both PyModule_FromDefAndSpec and PyModule_ExecDef must be called to fully initialize a module.

Примітка

У більшості випадків використання цієї функції має використовувати PyModule_FromDefAndSpec(); використовуйте це, лише якщо ви впевнені, що це вам потрібно.

Added in version 3.5.

int PyModule_ExecDef(PyObject *module, PyModuleDef *def)

Part of the Stable ABI since version 3.7.

Обробити будь-які слоти виконання (Py_mod_exec), указані в def.

Added in version 3.5.

PYTHON_API_VERSION

The C API version. Defined for backwards compatibility.

Currently, this constant is not updated in new Python versions, and is not useful for versioning. This may change in the future.

PYTHON_ABI_VERSION

Defined as 3 for backwards compatibility.

Currently, this constant is not updated in new Python versions, and is not useful for versioning. This may change in the future.

Допоміжні функції

The following functions are provided to help initialize a module state. They are intended for a module’s execution slots (Py_mod_exec), the initialization function for legacy single-phase initialization, or code that creates modules dynamically.

int PyModule_AddObjectRef(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI since version 3.10.

Додайте об’єкт до модуля як ім’я. Це зручна функція, яку можна використовувати з функції ініціалізації модуля.

У разі успіху поверніть 0. У разі помилки викликає виняток і повертає -1.

Приклад використання:

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    if (obj == NULL) {
        return -1;
    }
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_DECREF(obj);
    return res;
 }

To be convenient, the function accepts NULL value with an exception set. In this case, return -1 and just leave the raised exception unchanged.

Приклад також можна написати без явної перевірки, якщо obj має значення NULL:

static int
add_spam(PyObject *module, int value)
{
    PyObject *obj = PyLong_FromLong(value);
    int res = PyModule_AddObjectRef(module, "spam", obj);
    Py_XDECREF(obj);
    return res;
 }

Зверніть увагу, що в цьому випадку слід використовувати Py_XDECREF() замість Py_DECREF(), оскільки obj може бути NULL.

The number of different name strings passed to this function should be kept small, usually by only using statically allocated strings as name. For names that aren’t known at compile time, prefer calling PyUnicode_FromString() and PyObject_SetAttr() directly. For more details, see PyUnicode_InternFromString(), which may be used internally to create a key object.

Added in version 3.10.

int PyModule_Add(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI since version 3.13.

Similar to PyModule_AddObjectRef(), but «steals» a reference to value. It can be called with a result of function that returns a new reference without bothering to check its result or even saving it to a variable.

Приклад використання:

if (PyModule_Add(module, "spam", PyBytes_FromString(value)) < 0) {
    goto error;
}

Added in version 3.13.

int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)

Part of the Stable ABI.

Подібно до PyModule_AddObjectRef(), але в разі успіху викрадає посилання на value (якщо повертає 0).

The new PyModule_Add() or PyModule_AddObjectRef() functions are recommended, since it is easy to introduce reference leaks by misusing the PyModule_AddObject() function.

Примітка

Unlike other functions that steal references, PyModule_AddObject() only releases the reference to value on success.

This means that its return value must be checked, and calling code must Py_XDECREF() value manually on error.

Приклад використання:

PyObject *obj = PyBytes_FromString(value);
if (PyModule_AddObject(module, "spam", obj) < 0) {
    // If 'obj' is not NULL and PyModule_AddObject() failed,
    // 'obj' strong reference must be deleted with Py_XDECREF().
    // If 'obj' is NULL, Py_XDECREF() does nothing.
    Py_XDECREF(obj);
    goto error;
}
// PyModule_AddObject() stole a reference to obj:
// Py_XDECREF(obj) is not needed here.

Застаріло починаючи з версії 3.13: PyModule_AddObject() is soft deprecated.

int PyModule_AddIntConstant(PyObject *module, const char *name, long value)

Part of the Stable ABI.

Add an integer constant to module as name. This convenience function can be used from the module’s initialization function. Return -1 with an exception set on error, 0 on success.

This is a convenience function that calls PyLong_FromLong() and PyModule_AddObjectRef(); see their documentation for details.

int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)

Part of the Stable ABI.

Add a string constant to module as name. This convenience function can be used from the module’s initialization function. The string value must be NULL-terminated. Return -1 with an exception set on error, 0 on success.

This is a convenience function that calls PyUnicode_InternFromString() and PyModule_AddObjectRef(); see their documentation for details.

PyModule_AddIntMacro(module, macro)

Add an int constant to module. The name and the value are taken from macro. For example PyModule_AddIntMacro(module, AF_INET) adds the int constant AF_INET with the value of AF_INET to module. Return -1 with an exception set on error, 0 on success.

PyModule_AddStringMacro(module, macro)

Додайте рядкову константу до module.

int PyModule_AddType(PyObject *module, PyTypeObject *type)

Part of the Stable ABI since version 3.10.

Add a type object to module. The type object is finalized by calling internally PyType_Ready(). The name of the type object is taken from the last component of tp_name after dot. Return -1 with an exception set on error, 0 on success.

Added in version 3.9.

int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)

Part of the Stable ABI since version 3.7.

Add the functions from the NULL terminated functions array to module. Refer to the PyMethodDef documentation for details on individual entries (due to the lack of a shared module namespace, module level «functions» implemented in C typically receive the module as their first parameter, making them similar to instance methods on Python classes).

This function is called automatically when creating a module from PyModuleDef (such as when using Multi-phase initialization, PyModule_Create, or PyModule_FromDefAndSpec). Some module authors may prefer defining functions in multiple PyMethodDef arrays; in that case they should call this function directly.

Added in version 3.5.

int PyModule_SetDocString(PyObject *module, const char *docstring)

Part of the Stable ABI since version 3.7.

Set the docstring for module to docstring. This function is called automatically when creating a module from PyModuleDef (such as when using Multi-phase initialization, PyModule_Create, or PyModule_FromDefAndSpec).

Added in version 3.5.

int PyUnstable_Module_SetGIL(PyObject *module, void *gil)

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

Indicate that module does or does not support running without the global interpreter lock (GIL), using one of the values from Py_mod_gil. It must be called during module’s initialization function when using Legacy single-phase initialization. If this function is not called during module initialization, the import machinery assumes the module does not support running without the GIL. This function is only available in Python builds configured with --disable-gil. Return -1 with an exception set on error, 0 on success.

Added in version 3.13.

Module lookup (single-phase initialization)

The legacy single-phase initialization initialization scheme creates singleton modules that can be looked up in the context of the current interpreter. This allows the module object to be retrieved later with only a reference to the module definition.

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

PyObject *PyState_FindModule(PyModuleDef *def)

Return value: Borrowed reference. Part of the Stable ABI.

Повертає об’єкт модуля, який було створено з def для поточного інтерпретатора. Цей метод вимагає, щоб об’єкт модуля був прикріплений до стану інтерпретатора за допомогою PyState_AddModule() заздалегідь. Якщо відповідний об’єкт модуля не знайдено або ще не приєднано до стану інтерпретатора, він повертає NULL.

int PyState_AddModule(PyObject *module, PyModuleDef *def)

Part of the Stable ABI since version 3.3.

Приєднує об’єкт модуля, переданий у функцію, до стану інтерпретатора. Це дозволяє об’єкту модуля бути доступним через PyState_FindModule().

Діє лише для модулів, створених за допомогою однофазної ініціалізації.

Python calls PyState_AddModule automatically after importing a module that uses single-phase initialization, so it is unnecessary (but harmless) to call it from module initialization code. An explicit call is needed only if the module’s own init code subsequently calls PyState_FindModule. The function is mainly intended for implementing alternative import mechanisms (either by calling it directly, or by referring to its implementation for details of the required state updates).

If a module was attached previously using the same def, it is replaced by the new module.

The caller must have an attached thread state.

Return -1 with an exception set on error, 0 on success.

Added in version 3.3.

int PyState_RemoveModule(PyModuleDef *def)

Part of the Stable ABI since version 3.3.

Removes the module object created from def from the interpreter state. Return -1 with an exception set on error, 0 on success.

The caller must have an attached thread state.

Added in version 3.3.