`module.md`

333 строк · 32.3 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.8/c-api/module.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Объекты модулей89**[PyTypeObject](https://python-all.ru/3.8/c-api/type.html#c.PyTypeObject) `PyModule_Type`**1011Этот экземпляр [`PyTypeObject`](https://python-all.ru/3.8/c-api/type.html#c.PyTypeObject) представляет тип Python-модуля. Он доступен программам Python как `types.ModuleType`.1213#### `int PyModule_Check(PyObject *p)`1415Возвращает истину, если *p* является объектом модуля или подтипом объекта модуля.1617#### `int PyModule_CheckExact(PyObject *p)`1819Возвращает истину, если *p* является объектом модуля, но не подтипом [`PyModule_Type`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_Type).2021#### `PyObject* PyModule_NewObject(PyObject *name)`2223*Возвращаемое значение: новая ссылка.*2425Возвращает новый объект модуля с атрибутом [`__name__`](https://python-all.ru/3.8/reference/import.html#__name__), установленным в *name*. Атрибуты модуля [`__name__`](https://python-all.ru/3.8/reference/import.html#__name__), `__doc__`, [`__package__`](https://python-all.ru/3.8/reference/import.html#__package__) и [`__loader__`](https://python-all.ru/3.8/reference/import.html#__loader__) заполняются (все, кроме [`__name__`](https://python-all.ru/3.8/reference/import.html#__name__), устанавливаются в `None`); вызывающий отвечает за предоставление атрибута [`__file__`](https://python-all.ru/3.8/reference/import.html#__file__).2627Новое в версии 3.3.2829Изменено в версии 3.4: [`__package__`](https://python-all.ru/3.8/reference/import.html#__package__) и [`__loader__`](https://python-all.ru/3.8/reference/import.html#__loader__) устанавливаются в `None`.3031#### `PyObject* PyModule_New(const char *name)`3233*Возвращаемое значение: новая ссылка.*3435Аналогично [`PyModule_NewObject()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_NewObject), но имя – строка в кодировке UTF-8, а не объект Unicode.3637#### `PyObject* PyModule_GetDict(PyObject *module)`3839*Возвращаемое значение: заимствованная ссылка.*4041Возвращает объект словаря, реализующий пространство имён *module*; этот объект совпадает с атрибутом [`__dict__`](https://python-all.ru/3.8/library/stdtypes.html#object.__dict__) объекта модуля. Если *module* не является объектом модуля (или подтипом объекта модуля), возбуждается [`SystemError`](https://python-all.ru/3.8/library/exceptions.html#SystemError) и возвращается `NULL`.4243Расширениям рекомендуется использовать другие функции `PyModule_*()` и `PyObject_*()` вместо прямого манипулирования [`__dict__`](https://python-all.ru/3.8/library/stdtypes.html#object.__dict__) модуля.4445#### `PyObject* PyModule_GetNameObject(PyObject *module)`4647*Возвращаемое значение: новая ссылка.*4849Возвращает значение [`__name__`](https://python-all.ru/3.8/reference/import.html#__name__) *модуля*. Если модуль не предоставляет его или оно не является строкой, возбуждается [`SystemError`](https://python-all.ru/3.8/library/exceptions.html#SystemError) и возвращается `NULL`.5051Новое в версии 3.3.5253#### `const char* PyModule_GetName(PyObject *module)`5455Аналогично [`PyModule_GetNameObject()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetNameObject), но возвращает имя, закодированное в `'utf-8'`.5657#### `void* PyModule_GetState(PyObject *module)`5859Возвращает «состояние» модуля, то есть указатель на блок памяти, выделенный при создании модуля, или `NULL`. См. [`PyModuleDef.m_size`](https://python-all.ru/3.8/c-api/module.html#c.PyModuleDef.m_size).6061#### `PyModuleDef* PyModule_GetDef(PyObject *module)`6263Возвращает указатель на структуру [`PyModuleDef`](https://python-all.ru/3.8/c-api/module.html#c.PyModuleDef), из которой был создан модуль, или `NULL`, если модуль не был создан из определения.6465#### `PyObject* PyModule_GetFilenameObject(PyObject *module)`6667*Возвращаемое значение: новая ссылка.*6869Возвращает имя файла, из которого был загружен *модуль*, используя атрибут [`__file__`](https://python-all.ru/3.8/reference/import.html#__file__) *модуля*. Если он не определён или не является строкой Unicode, возбуждается [`SystemError`](https://python-all.ru/3.8/library/exceptions.html#SystemError) и возвращается `NULL`; в противном случае возвращается ссылка на объект Unicode.7071Новое в версии 3.2.7273#### `const char* PyModule_GetFilename(PyObject *module)`7475Аналогично [`PyModule_GetFilenameObject()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetFilenameObject), но возвращает имя файла, закодированное в 'utf-8'.7677Устарело с версии 3.2: [`PyModule_GetFilename()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetFilename) возбуждает `UnicodeEncodeError` для некодируемых имён файлов; вместо него используйте [`PyModule_GetFilenameObject()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetFilenameObject).7879## Инициализация C-модулей8081Объекты модулей обычно создаются из модулей расширения (общих библиотек,\\nкоторые экспортируют функцию инициализации) или из встраиваемых модулей\\n(где функция инициализации добавляется с помощью [`PyImport_AppendInittab()`](https://python-all.ru/3.8/c-api/import.html#c.PyImport_AppendInittab)).\\nПодробнее см. [Building C and C++ Extensions](https://python-all.ru/3.8/extending/building.html#building) или [Extending Embedded Python](https://python-all.ru/3.8/extending/embedding.html#extending-with-embedding).8283Функция инициализации может либо передать экземпляр определения модуля\\nв [`PyModule_Create()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_Create) и вернуть результирующий объект модуля,\\nлибо запросить «многофазную инициализацию», вернув саму структуру определения.8485**`PyModuleDef`**8687Структура определения модуля, содержащая всю информацию, необходимую для создания\\nобъекта модуля. Обычно для каждого модуля существует только одна статически\\nинициализированная переменная этого типа.8889**PyModuleDef\_Base `m_base`**9091Всегда инициализируйте этот элемент значением `PyModuleDef_HEAD_INIT`.9293**const char \*`m_name`**9495Имя нового модуля.9697**const char \*`m_doc`**9899Докстринг для модуля; обычно используется переменная докстринга, созданная с помощью [`PyDoc_STRVAR`](https://python-all.ru/3.8/c-api/intro.html#c.PyDoc_STRVAR).100101**Py\_ssize\_t `m_size`**102103Состояние модуля может храниться в выделенной под каждый модуль области памяти, доступ к которой можно получить через [`PyModule_GetState()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetState), а не в статических глобальных переменных. Это делает модули безопасными для использования в нескольких под-интерпретаторах.104105Эта область памяти выделяется на основе *m\_size* при создании модуля и освобождается при удалении объекта модуля, после вызова функции `m_free` (если она присутствует).106107Установка `m_size` в `-1` означает, что модуль не поддерживает\\nпод-интерпретаторы, так как имеет глобальное состояние.108109Установка в неотрицательное значение означает, что модуль можно\\nпереинициализировать, и указывает дополнительный объём памяти, необходимый\\nдля его состояния. Неотрицательное значение `m_size` требуется для многофазной\\nинициализации.110111Подробнее см. [**PEP 3121**](https://python-all.ru/3.8/c-api/module.html).112113**[PyMethodDef](https://python-all.ru/3.8/c-api/structures.html#c.PyMethodDef)\* `m_methods`**114115Указатель на таблицу функций уровня модуля, описываемых значениями [`PyMethodDef`](https://python-all.ru/3.8/c-api/structures.html#c.PyMethodDef). Может быть `NULL`, если функции отсутствуют.116117**[PyModuleDef\_Slot](https://python-all.ru/3.8/c-api/module.html#c.PyModuleDef_Slot)\* `m_slots`**118119Массив определений слотов для многофазной инициализации, завершающийся\\nзаписью `{0, NULL}`.\\nПри использовании однофазной инициализации *m\_slots* должен быть `NULL`.120121Изменено в версии 3.5: До версии 3.5 этот элемент всегда устанавливался в `NULL`, и определялся как:122123> **[inquiry](https://python-all.ru/3.8/c-api/gcsupport.html#c.inquiry) `m_reload`**124125**[traverseproc](https://python-all.ru/3.8/c-api/gcsupport.html#c.traverseproc) `m_traverse`**126127Функция обхода, вызываемая во время обхода сборщиком мусора (GC) объекта модуля, или `NULL`, если не требуется. Эта функция может быть вызвана до выделения состояния модуля ([`PyModule_GetState()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetState) может вернуть *NULL*), и до выполнения функции [`Py_mod_exec`](https://python-all.ru/3.8/c-api/module.html#c.Py_mod_exec).128129**[inquiry](https://python-all.ru/3.8/c-api/gcsupport.html#c.inquiry) `m_clear`**130131Функция очистки, вызываемая во время очистки сборщиком мусора (GC) объекта модуля, или `NULL`, если не требуется. Эта функция может быть вызвана до выделения состояния модуля ([`PyModule_GetState()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetState) может вернуть *NULL*), и до выполнения функции [`Py_mod_exec`](https://python-all.ru/3.8/c-api/module.html#c.Py_mod_exec).132133**[freefunc](https://python-all.ru/3.8/c-api/typeobj.html#c.freefunc) `m_free`**134135Функция, вызываемая при освобождении объекта модуля, или `NULL`, если не требуется. Эта функция может быть вызвана до выделения состояния модуля ([`PyModule_GetState()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetState) может вернуть *NULL*), и до выполнения функции [`Py_mod_exec`](https://python-all.ru/3.8/c-api/module.html#c.Py_mod_exec).136137### Однофазная инициализация138139Функция инициализации модуля может напрямую создать и вернуть объект модуля. Это называется «однофазной инициализацией» и использует одну из двух следующих функций создания модуля:140141#### `PyObject* PyModule_Create(PyModuleDef *def)`142143*Возвращаемое значение: новая ссылка.*144145Создаёт новый объект модуля на основе определения в *def*. Ведёт себя как [`PyModule_Create2()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_Create2), когда *module\_api\_version* установлен в `PYTHON_API_VERSION`.146147#### `PyObject* PyModule_Create2(PyModuleDef *def, int module_api_version)`148149*Возвращаемое значение: новая ссылка.*150151Создаёт новый объект модуля на основе определения в *def*, предполагая версию API *module\_api\_version*. Если эта версия не совпадает с версией работающего интерпретатора, генерируется [`RuntimeWarning`](https://python-all.ru/3.8/library/exceptions.html#RuntimeWarning).152153> **Примечание**154>155> В большинстве случаев вместо этой функции следует использовать [`PyModule_Create()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_Create); используйте её, только если точно уверены, что она нужна.156157Перед возвратом из функции инициализации полученный объект модуля обычно заполняется с помощью таких функций, как [`PyModule_AddObject()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_AddObject).158159### Многофазная инициализация160161Альтернативный способ задания расширений – запросить «многофазную инициализацию». Модули расширения, созданные таким образом, ведут себя больше как модули Python: инициализация разделяется на *фазу создания*, когда создаётся объект модуля, и *фазу выполнения*, когда он заполняется. Это различие похоже на методы [`__new__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__new__) и [`__init__()`](https://python-all.ru/3.8/reference/datamodel.html#object.__init__) классов.162163В отличие от модулей, созданных с помощью однофазной инициализации, эти модули не являются синглтонами: если запись *sys.modules* удалена и модуль импортирован заново, создаётся новый объект модуля, а старый модуль подлежит обычной сборке мусора – как и модули Python. По умолчанию несколько модулей, созданных из одного определения, должны быть независимы: изменения в одном не должны влиять на другие. Это означает, что всё состояние должно быть привязано к объекту модуля (например, с помощью [`PyModule_GetState()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_GetState)) или к его содержимому (например, [`__dict__`](https://python-all.ru/3.8/library/stdtypes.html#object.__dict__) модуля или отдельные классы, созданные с помощью [`PyType_FromSpec()`](https://python-all.ru/3.8/c-api/type.html#c.PyType_FromSpec)).164165Все модули, созданные с помощью многофазной инициализации, должны поддерживать [суб-интерпретаторы](https://python-all.ru/3.8/c-api/init.html#sub-interpreter-support). Обычно достаточно обеспечить независимость нескольких модулей, чтобы достичь этого.166167Чтобы запросить многофазную инициализацию, функция инициализации (PyInit\_modulename) возвращает экземпляр [`PyModuleDef`](https://python-all.ru/3.8/c-api/module.html#c.PyModuleDef) с непустым [`m_slots`](https://python-all.ru/3.8/c-api/module.html#c.PyModuleDef.m_slots). Перед возвратом экземпляр `PyModuleDef` должен быть инициализирован следующей функцией:168169#### `PyObject* PyModuleDef_Init(PyModuleDef *def)`170171*Возвращаемое значение: заимствованная ссылка.*172173Гарантирует, что определение модуля является правильно инициализированным объектом Python, который корректно сообщает свой тип и счётчик ссылок.174175Возвращает *def*, приведённый к `PyObject*`, или `NULL`, если произошла ошибка.176177Новое в версии 3.5.178179Член *m\_slots* определения модуля должен указывать на массив структур `PyModuleDef_Slot`:180181**`PyModuleDef_Slot`**182183**int `slot`**184185Идентификатор слота, выбираемый из доступных значений, описанных ниже.186187**void\* `value`**188189Значение слота, смысл которого зависит от идентификатора слота.190191Новое в версии 3.5.192193Массив *m\_slots* должен завершаться слотом с id 0.194195Доступны следующие типы слотов:196197**`Py_mod_create`**198199Задаёт функцию, которая вызывается для создания самого объекта модуля. Указатель *value* этого слота должен указывать на функцию со следующей сигнатурой:200201#### `PyObject* create_module(PyObject *spec, PyModuleDef *def)`202203Функция получает экземпляр [`ModuleSpec`](https://python-all.ru/3.8/library/importlib.html#importlib.machinery.ModuleSpec), как определено в [**PEP 451**](https://python-all.ru/3.8/c-api/module.html), и определение модуля. Она должна вернуть новый объект модуля или установить ошибку и вернуть `NULL`.204205Эта функция должна быть минимальной. В частности, она не должна вызывать произвольный код Python, так как повторная попытка импорта того же модуля может привести к бесконечному циклу.206207В одном определении модуля нельзя задавать несколько слотов `Py_mod_create`.208209Если `Py_mod_create` не указан, механизм импорта создаст обычный объект модуля с помощью [`PyModule_New()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_New). Имя берётся из *spec*, а не из определения, чтобы расширения могли динамически подстраиваться под своё место в иерархии модулей и импортироваться под другими именами через симлинки, оставаясь привязанными к одному определению модуля.210211Возвращаемый объект не обязан быть экземпляром [`PyModule_Type`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_Type). Можно использовать любой тип, если он поддерживает установку и получение атрибутов, связанных с импортом. Однако только экземпляры `PyModule_Type` могут быть возвращены, если `PyModuleDef` содержит ненулевые `NULL` `m_traverse`, `m_clear`, `m_free`; ненулевой `m_size`; или слоты, отличные от `Py_mod_create`.212213**`Py_mod_exec`**214215Задаёт функцию, которая вызывается для *выполнения* модуля. Это эквивалентно выполнению кода модуля Python: обычно эта функция добавляет в модуль классы и константы. Сигнатура функции такова:216217#### `int exec_module(PyObject* module)`218219Если указано несколько слотов `Py_mod_exec`, они обрабатываются в том порядке, в котором расположены в массиве *m\_slots*.220221См. [**PEP 489**](https://python-all.ru/3.8/c-api/module.html) для более подробной информации о многофазной инициализации.222223### Низкоуровневые функции создания модулей224225Следующие функции вызываются «под капотом» при использовании многофазной инициализации. Их можно использовать напрямую, например, при динамическом создании объектов модуля. Обратите внимание, что для полной инициализации модуля необходимо вызвать как `PyModule_FromDefAndSpec`, так и `PyModule_ExecDef`.226227#### `PyObject * PyModule_FromDefAndSpec(PyModuleDef *def, PyObject *spec)`228229*Возвращаемое значение: новая ссылка.*230231Создаёт новый объект модуля на основе определения *module* и спецификации модуля *spec*. Работает как [`PyModule_FromDefAndSpec2()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_FromDefAndSpec2) с *module\_api\_version*, установленным в `PYTHON_API_VERSION`.232233Новое в версии 3.5.234235#### `PyObject * PyModule_FromDefAndSpec2(PyModuleDef *def, PyObject *spec, int module_api_version)`236237*Возвращаемое значение: новая ссылка.*238239Создаёт новый объект модуля на основе определения *module* и спецификации модуля *spec*, предполагая версию API *module\_api\_version*. Если эта версия не совпадает с версией выполняющегося интерпретатора, выдаётся [`RuntimeWarning`](https://python-all.ru/3.8/library/exceptions.html#RuntimeWarning).240241> **Примечание**242>243> В большинстве случаев вместо этой функции следует использовать [`PyModule_FromDefAndSpec()`](https://python-all.ru/3.8/c-api/module.html#c.PyModule_FromDefAndSpec); используйте её, только если точно уверены, что она нужна.244245Новое в версии 3.5.246247#### `int PyModule_ExecDef(PyObject *module, PyModuleDef *def)`248249Обрабатывает любые слоты выполнения ([`Py_mod_exec`](https://python-all.ru/3.8/c-api/module.html#c.Py_mod_exec)), заданные в *def*.250251Новое в версии 3.5.252253#### `int PyModule_SetDocString(PyObject *module, const char *docstring)`254255Устанавливает docstring для *module* равным *docstring*. Эта функция вызывается автоматически при создании модуля из `PyModuleDef` с помощью `PyModule_Create` или `PyModule_FromDefAndSpec`.256257Новое в версии 3.5.258259#### `int PyModule_AddFunctions(PyObject *module, PyMethodDef *functions)`260261Добавляет функции из массива *functions*, завершающегося `NULL`, в *module*. Подробнее об отдельных элементах см. документацию [`PyMethodDef`](https://python-all.ru/3.8/c-api/structures.html#c.PyMethodDef) (из-за отсутствия общего пространства имён модуля «функции» уровня модуля, реализованные на C, обычно получают сам модуль в качестве первого параметра, что делает их похожими на методы экземпляра классов Python). Эта функция вызывается автоматически при создании модуля из `PyModuleDef` с помощью `PyModule_Create` или `PyModule_FromDefAndSpec`.262263Новое в версии 3.5.264265### Вспомогательные функции266267Функция инициализации модуля (при однофазной инициализации) или функция, вызываемая из слота выполнения модуля (при многофазной инициализации), могут использовать следующие функции для инициализации состояния модуля:268269#### `int PyModule_AddObject(PyObject *module, const char *name, PyObject *value)`270271Добавляет объект в *module* под именем *name*. Это удобная функция, которую можно использовать в функции инициализации модуля. При успехе она крадёт ссылку на *value*. Возвращает `-1` при ошибке, `0` при успехе.272273> **Примечание**274>275> В отличие от других функций, похищающих ссылки, `PyModule_AddObject()` только уменьшает счётчик ссылок *value* **при успехе**.276>277> Это означает, что возвращаемое значение необходимо проверять, и в случае ошибки вызывающий код должен [`Py_DECREF()`](https://python-all.ru/3.8/c-api/refcounting.html#c.Py_DECREF) *value* вручную. Пример использования:278>279> ```c280> Py_INCREF(spam);281> if (PyModule_AddObject(module, "spam", spam) < 0) {282>     Py_DECREF(module);283>     Py_DECREF(spam);284>     return NULL;285> }286> ```287288#### `int PyModule_AddIntConstant(PyObject *module, const char *name, long value)`289290Добавляет целочисленную константу в модуль *module* под именем *name*. Эту удобную функцию можно использовать из функции инициализации модуля. Возвращает `-1` в случае ошибки, `0` при успешном выполнении.291292#### `int PyModule_AddStringConstant(PyObject *module, const char *name, const char *value)`293294Добавляет строковую константу в модуль *module* под именем *name*. Эту удобную функцию можно использовать из функции инициализации модуля. Строка *value* должна быть `NULL`-терминированной. Возвращает `-1` в случае ошибки, `0` при успешном выполнении.295296#### `int PyModule_AddIntMacro(PyObject *module, macro)`297298Добавляет целочисленную константу в модуль *module*. Имя и значение берутся из *macro*. Например, `PyModule_AddIntMacro(module, AF_INET)` добавляет целочисленную константу *AF\_INET* со значением *AF\_INET* в модуль *module*. Возвращает `-1` в случае ошибки, `0` при успешном выполнении.299300#### `int PyModule_AddStringMacro(PyObject *module, macro)`301302Добавляет строковую константу в *module*.303304## Поиск модуля305306Однофазная инициализация создаёт модули-одиночки, которые можно найти в контексте текущего интерпретатора. Это позволяет впоследствии получить объект модуля, имея только ссылку на определение модуля.307308Эти функции не будут работать с модулями, созданными с помощью многофазной инициализации, поскольку из одного определения можно создать несколько таких модулей.309310#### `PyObject* PyState_FindModule(PyModuleDef *def)`311312*Возвращаемое значение: заимствованная ссылка.*313314Возвращает объект модуля, созданный из *def* для текущего интерпретатора. Этот метод требует, чтобы объект модуля был предварительно прикреплён к состоянию интерпретатора с помощью [`PyState_AddModule()`](https://python-all.ru/3.8/c-api/module.html#c.PyState_AddModule). Если соответствующий объект модуля не найден или ещё не прикреплён к состоянию интерпретатора, он возвращает `NULL`.315316#### `int PyState_AddModule(PyObject *module, PyModuleDef *def)`317318Прикрепляет объект модуля, переданный функции, к состоянию интерпретатора. Это позволяет обращаться к объекту модуля через [`PyState_FindModule()`](https://python-all.ru/3.8/c-api/module.html#c.PyState_FindModule).319320Действует только на модули, созданные с помощью однофазной инициализации.321322Python автоматически вызывает `PyState_AddModule` после импорта модуля, поэтому её вызов из кода инициализации модуля излишен (но безвреден). Явный вызов требуется только в том случае, если собственный код инициализации модуля впоследствии вызывает `PyState_FindModule`. Функция в основном предназначена для реализации альтернативных механизмов импорта (путём прямого вызова или обращения к её реализации для получения информации о требуемых обновлениях состояния).323324Возвращает 0 в случае успеха или -1 в случае неудачи.325326Новое в версии 3.3.327328#### `int PyState_RemoveModule(PyModuleDef *def)`329330Удаляет объект модуля, созданный из *def*, из состояния интерпретатора. Возвращает 0 в случае успеха или -1 в случае неудачи.331332Новое в версии 3.3.333