`import.md`

295 строк · 27.5 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.14/c-api/import.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# Импорт модулей89#### `PyObject *PyImport_ImportModule(const char *name)`1011*Возвращаемое значение: новая ссылка.*1213*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*1415Это обёртка вокруг [`PyImport_Import()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_Import), которая принимает const char\* в качестве аргумента вместо [PyObject](https://python-all.ru/3.14/c-api/structures.html#c.PyObject)\*.1617#### `PyObject *PyImport_ImportModuleNoBlock(const char *name)`1819*Возвращаемое значение: новая ссылка.*2021*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*2223Эта функция – устаревший псевдоним [`PyImport_ImportModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModule).2425Изменено в версии 3.3: Ранее эта функция немедленно завершалась ошибкой, если блокировка импорта удерживалась другим потоком. Однако в Python 3.3 схема блокировки была изменена на блокировки на уровне модулей для большинства случаев, поэтому специальное поведение этой функции больше не требуется.2627Устарело с версии 3.13, будет удалено в версии 3.15: Вместо этого используйте [`PyImport_ImportModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModule).2829#### `PyObject *PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)`3031*Возвращаемое значение: новая ссылка.*3233Импорт модуля. Лучше всего это описывается через встроенную функцию Python [`__import__()`](https://python-all.ru/3.14/library/functions.html#import__).3435Возвращаемое значение – это новая ссылка на импортированный модуль или пакет верхнего уровня, либо `NULL` с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.14/library/functions.html#import__), возвращаемое значение при запросе подмодуля пакета обычно является пакетом верхнего уровня, если только не был передан непустой *fromlist* .3637Неудачные импорты удаляют неполные объекты модулей, как и [`PyImport_ImportModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModule).3839#### `PyObject *PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)`4041*Возвращаемое значение: новая ссылка.*4243*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.7.*4445Импорт модуля. Наилучшее описание даётся через встроенную функцию Python [`__import__()`](https://python-all.ru/3.14/library/functions.html#import__), поскольку стандартная функция `__import__()` вызывает эту функцию напрямую.4647Возвращаемое значение – это новая ссылка на импортированный модуль или пакет верхнего уровня, либо `NULL` с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.14/library/functions.html#import__), возвращаемое значение при запросе подмодуля пакета обычно является пакетом верхнего уровня, если только не был передан непустой *fromlist*.4849Добавлено в версии 3.3.5051#### `PyObject *PyImport_ImportModuleLevel(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)`5253*Возвращаемое значение: новая ссылка.*5455*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*5657Аналогично [`PyImport_ImportModuleLevelObject()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModuleLevelObject), но имя представляет собой строку в кодировке UTF-8 вместо объекта Unicode.5859Изменено в версии 3.3: Отрицательные значения для *level* больше не принимаются.6061#### `PyObject *PyImport_Import(PyObject *name)`6263*Возвращаемое значение: новая ссылка.*6465*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*6667Это интерфейс более высокого уровня, который вызывает текущую «функцию перехвата импорта» (с явным *level* равным 0, что означает абсолютный импорт). Он вызывает функцию [`__import__()`](https://python-all.ru/3.14/library/functions.html#import__) из `__builtins__` текущих глобальных переменных. Это означает, что импорт выполняется с использованием тех перехватчиков импорта, которые установлены в текущем окружении.6869Эта функция всегда использует абсолютные импорты.7071#### `PyObject *PyImport_ReloadModule(PyObject *m)`7273*Возвращаемое значение: новая ссылка.*7475*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*7677Перезагружает модуль. Возвращает новую ссылку на перезагруженный модуль или `NULL` с установленным исключением в случае ошибки (в этом случае модуль всё ещё существует).7879#### `PyObject *PyImport_AddModuleRef(const char *name)`8081*Возвращаемое значение: новая ссылка.*8283*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.13.*8485Возвращает объект модуля, соответствующий имени модуля.8687Аргумент *name* может быть в форме `package.module`. Сначала проверяется словарь модулей на наличие такого модуля, и если его нет, создаётся новый и вставляется в словарь модулей.8889Возвращает [сильную ссылку](https://python-all.ru/3.14/glossary.html#term-strong-reference) на модуль в случае успеха. Возвращает `NULL` с установленным исключением в случае ошибки.9091Имя модуля *name* декодируется из UTF-8.9293Эта функция не загружает и не импортирует модуль; если модуль ещё не был загружен, будет получен пустой объект модуля. Используйте [`PyImport_ImportModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModule) или один из его вариантов для импорта модуля. Структуры пакетов, подразумеваемые именем с точками для *name*, не создаются, если они ещё не существуют.9495Добавлено в версии 3.13.9697#### `PyObject *PyImport_AddModuleObject(PyObject *name)`9899*Возвращаемое значение: заимствованная ссылка.*100101*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.7.*102103Аналог [`PyImport_AddModuleRef()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_AddModuleRef), но возвращает [заимствованную ссылку](https://python-all.ru/3.14/glossary.html#term-borrowed-reference), а *name* является объектом Python [`str`](https://python-all.ru/3.14/library/stdtypes.html#str).104105Добавлено в версии 3.3.106107#### `PyObject *PyImport_AddModule(const char *name)`108109*Возвращаемое значение: заимствованная ссылка.*110111*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*112113Подобно [`PyImport_AddModuleRef()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_AddModuleRef), но возвращает [заимствованную ссылку](https://python-all.ru/3.14/glossary.html#term-borrowed-reference).114115#### `PyObject *PyImport_ExecCodeModule(const char *name, PyObject *co)`116117*Возвращаемое значение: новая ссылка.*118119*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*120121Принимая имя модуля (возможно, вида `package.module`) и объект кода, прочитанный из файла байткода Python или полученный из встроенной функции [`compile()`](https://python-all.ru/3.14/library/functions.html#compile), загружает модуль. Возвращает новую ссылку на объект модуля или `NULL` с установленным исключением, если произошла ошибка. В случае ошибки *name* удаляется из [`sys.modules`](https://python-all.ru/3.14/library/sys.html#sys.modules), даже если *name* уже был в `sys.modules` на момент входа в [`PyImport_ExecCodeModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModule). Оставлять не полностью инициализированные модули в `sys.modules` опасно, так как импорт таких модулей не может узнать, что объект модуля находится в неизвестном (и, вероятно, повреждённом с точки зрения намерений автора модуля) состоянии.122123[`__spec__`](https://python-all.ru/3.14/reference/datamodel.html#module.__spec__) и [`__loader__`](https://python-all.ru/3.14/reference/datamodel.html#module.__loader__) модуля будут установлены, если ещё не установлены, с соответствующими значениями. Загрузчик спецификации будет установлен на `__loader__` модуля (если установлен) или на экземпляр [`SourceFileLoader`](https://python-all.ru/3.14/library/importlib.html#importlib.machinery.SourceFileLoader) в противном случае.124125Атрибут [`__file__`](https://python-all.ru/3.14/reference/datamodel.html#module.__file__) модуля будет установлен в значение [`co_filename`](https://python-all.ru/3.14/reference/datamodel.html#codeobject.co_filename) объекта кода. Если применимо, [`__cached__`](https://python-all.ru/3.14/reference/datamodel.html#module.__cached__) также будет установлен.126127Эта функция перезагрузит модуль, если он уже был импортирован. См. [`PyImport_ReloadModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ReloadModule) для описания правильного способа перезагрузки модуля.128129Если *name* указывает на имя с точками вида `package.module`, любые структуры пакета, которые ещё не были созданы, по-прежнему не будут созданы.130131См. также [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModuleEx) и [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModuleWithPathnames).132133Изменено в версии 3.12: Установка [`__cached__`](https://python-all.ru/3.14/reference/datamodel.html#module.__cached__) и [`__loader__`](https://python-all.ru/3.14/reference/datamodel.html#module.__loader__) является устаревшей. См. [`ModuleSpec`](https://python-all.ru/3.14/library/importlib.html#importlib.machinery.ModuleSpec) для альтернатив.134135#### `PyObject *PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)`136137*Возвращаемое значение: новая ссылка.*138139*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*140141Как [`PyImport_ExecCodeModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModule), но атрибут [`__file__`](https://python-all.ru/3.14/reference/datamodel.html#module.__file__) объекта модуля устанавливается в *pathname*, если он не равен `NULL`.142143См. также [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModuleWithPathnames).144145#### `PyObject *PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)`146147*Возвращаемое значение: новая ссылка.*148149*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.7.*150151Как и [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModuleEx), но атрибут [`__cached__`](https://python-all.ru/3.14/reference/datamodel.html#module.__cached__) объекта модуля устанавливается в *cpathname*, если он не равен `NULL`. Из трёх функций эта является предпочтительной.152153Добавлено в версии 3.3.154155Изменено в версии 3.12: Установка [`__cached__`](https://python-all.ru/3.14/reference/datamodel.html#module.__cached__) является устаревшей. См. [`ModuleSpec`](https://python-all.ru/3.14/library/importlib.html#importlib.machinery.ModuleSpec) для альтернатив.156157#### `PyObject *PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)`158159*Возвращаемое значение: новая ссылка.*160161*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*162163Как [`PyImport_ExecCodeModuleObject()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExecCodeModuleObject), но *name*, *pathname* и *cpathname* являются строками в кодировке UTF-8. Также предпринимаются попытки выяснить, каким должно быть значение *pathname* из *cpathname*, если первое установлено в `NULL`.164165Добавлено в версии 3.2.166167Изменено в версии 3.3: Использует `imp.source_from_cache()` при вычислении пути к исходному коду, если указан только путь к байткоду.168169Изменено в версии 3.12: Больше не использует удалённый модуль `imp`.170171#### `long PyImport_GetMagicNumber()`172173*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*174175Возвращает магическое число для файлов байткода Python (также известных как файлы `.pyc`). Магическое число должно присутствовать в первых четырёх байтах файла байткода в порядке little-endian. В случае ошибки возвращает `-1`.176177Изменено в версии 3.3: Возвращает `-1` в случае неудачи.178179#### `const char *PyImport_GetMagicTag()`180181*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*182183Возвращает строку магического тега для имён файлов байткода Python в формате [**PEP 3147**](https://python-all.ru/3.14/c-api/import.html). Имейте в виду, что значение в `sys.implementation.cache_tag` является авторитетным и должно использоваться вместо этой функции.184185Добавлено в версии 3.2.186187#### `PyObject *PyImport_GetModuleDict()`188189*Возвращаемое значение: заимствованная ссылка.*190191*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*192193Возвращает словарь, используемый для администрирования модулей (также известный как `sys.modules`). Обратите внимание, что это переменная, отдельная для каждого интерпретатора.194195#### `PyObject *PyImport_GetModule(PyObject *name)`196197*Возвращаемое значение: новая ссылка.*198199*Часть [стабильного ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.8.*200201Возвращает уже импортированный модуль с заданным именем. Если модуль ещё не был импортирован, возвращает `NULL`, но не устанавливает ошибку. Возвращает `NULL` и устанавливает ошибку, если поиск не удался.202203Добавлено в версии 3.7.204205#### `PyObject *PyImport_GetImporter(PyObject *path)`206207*Возвращаемое значение: новая ссылка.*208209*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*210211Возвращает объект поиска для элемента [`sys.path`](https://python-all.ru/3.14/library/sys.html#sys.path)/`pkg.__path__` *path*, возможно, извлекая его из словаря [`sys.path_importer_cache`](https://python-all.ru/3.14/library/sys.html#sys.path_importer_cache). Если он ещё не кэширован, обходит [`sys.path_hooks`](https://python-all.ru/3.14/library/sys.html#sys.path_hooks), пока не будет найден хук, способный обработать элемент пути. Возвращает `None`, если ни один хук не подошёл; это сообщает вызывающей стороне, что [поисковик на основе пути](https://python-all.ru/3.14/glossary.html#term-path-based-finder) не смог найти поисковик для этого элемента пути. Кэширует результат в `sys.path_importer_cache`. Возвращает новую ссылку на объект поисковика.212213#### `int PyImport_ImportFrozenModuleObject(PyObject *name)`214215*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable) начиная с версии 3.7.*216217Загружает замороженный модуль с именем *name*. Возвращает `1` при успехе, `0`, если модуль не найден, и `-1` с установленным исключением, если инициализация не удалась. Чтобы получить доступ к импортированному модулю после успешной загрузки, используйте [`PyImport_ImportModule()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModule). (Обратите внимание на неточность названия – эта функция перезагрузила бы модуль, если он уже был импортирован.)218219Добавлено в версии 3.3.220221Изменено в версии 3.4: Атрибут `__file__` больше не устанавливается в модуле.222223#### `int PyImport_ImportFrozenModule(const char *name)`224225*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*226227Аналогично [`PyImport_ImportFrozenModuleObject()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportFrozenModuleObject), но имя представляет собой строку в кодировке UTF-8 вместо объекта Unicode.228229#### `struct _frozen`230231Это определение типа структуры для дескрипторов замороженных модулей, как сгенерировано утилитой **freeze** (см. `Tools/freeze/` в дистрибутиве исходного кода Python). Её определение находится в `Include/import.h`:232233```c234struct _frozen {235    const char *name;236    const unsigned char *code;237    int size;238    bool is_package;239};240```241242Изменено в версии 3.11: Новое поле `is_package` указывает, является ли модуль пакетом или нет. Это заменяет установку поля `size` в отрицательное значение.243244#### `const struct _frozen *PyImport_FrozenModules`245246Этот указатель инициализируется так, чтобы указывать на массив записей [`_frozen`](https://python-all.ru/3.14/c-api/import.html#c._frozen), завершающийся записью, все члены которой равны `NULL` или нулю. Когда замороженный модуль импортируется, он ищется в этой таблице. Сторонний код может этим воспользоваться, чтобы предоставить динамически создаваемую коллекцию замороженных модулей.247248#### `int PyImport_AppendInittab(const char *name, PyObject *(*initfunc)(void))`249250*Часть [Stable ABI](https://python-all.ru/3.14/c-api/stable.html#stable).*251252Добавляет один модуль в существующую таблицу встроенных модулей. Это удобная обёртка вокруг [`PyImport_ExtendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExtendInittab), возвращающая `-1`, если таблицу не удалось расширить. Новый модуль можно импортировать по имени *name*, и он использует функцию *initfunc* в качестве функции инициализации, вызываемой при первой попытке импорта. Это должно вызываться до [`Py_Initialize()`](https://python-all.ru/3.14/c-api/interp-lifecycle.html#c.Py_Initialize).253254#### `struct _inittab`255256Структура, описывающая одну запись в списке встроенных модулей. Программы, встраивающие Python, могут использовать массив таких структур в сочетании с [`PyImport_ExtendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExtendInittab) для предоставления дополнительных встроенных модулей. Структура состоит из двух членов:257258#### `const char *name`259260Имя модуля в виде строки в кодировке ASCII.261262#### `PyObject *(*initfunc)(void)`263264Функция инициализации для модуля, встроенного в интерпретатор.265266#### `int PyImport_ExtendInittab(struct _inittab *newtab)`267268Добавляет набор модулей в таблицу встроенных модулей. Массив *newtab* должен заканчиваться сторожевой записью, которая содержит `NULL` для поля [`name`](https://python-all.ru/3.14/c-api/import.html#c._inittab.name); отсутствие сторожевого значения может привести к ошибке памяти. Возвращает `0` при успехе или `-1`, если недостаточно памяти для расширения внутренней таблицы. В случае неудачи ни один модуль не добавляется во внутреннюю таблицу. Это должно вызываться до [`Py_Initialize()`](https://python-all.ru/3.14/c-api/interp-lifecycle.html#c.Py_Initialize).269270Если Python инициализируется несколько раз, [`PyImport_AppendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_AppendInittab) или [`PyImport_ExtendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExtendInittab) должны вызываться перед каждой инициализацией Python.271272#### `struct _inittab *PyImport_Inittab`273274Таблица встроенных модулей, используемая при инициализации Python. Не используйте это напрямую; вместо этого используйте [`PyImport_AppendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_AppendInittab) и [`PyImport_ExtendInittab()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ExtendInittab).275276#### `PyObject *PyImport_ImportModuleAttr(PyObject *mod_name, PyObject *attr_name)`277278*Возвращаемое значение: новая ссылка.*279280Импортирует модуль *mod\_name* и получает его атрибут *attr\_name*.281282Имена должны быть объектами Python [`str`](https://python-all.ru/3.14/library/stdtypes.html#str).283284Вспомогательная функция, объединяющая [`PyImport_Import()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_Import) и [`PyObject_GetAttr()`](https://python-all.ru/3.14/c-api/object.html#c.PyObject_GetAttr). Например, она может возбуждать [`ImportError`](https://python-all.ru/3.14/library/exceptions.html#ImportError), если модуль не найден, и [`AttributeError`](https://python-all.ru/3.14/library/exceptions.html#AttributeError), если атрибут не существует.285286Добавлено в версии 3.14.287288#### `PyObject *PyImport_ImportModuleAttrString(const char *mod_name, const char *attr_name)`289290*Возвращаемое значение: новая ссылка.*291292Аналогично [`PyImport_ImportModuleAttr()`](https://python-all.ru/3.14/c-api/import.html#c.PyImport_ImportModuleAttr), но имена передаются в виде строк в кодировке UTF-8 вместо объектов [`str`](https://python-all.ru/3.14/library/stdtypes.html#str).293294Добавлено в версии 3.14.295