`import.md`

247 строк · 24.7 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.10/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.10/c-api/stable.html#stable).*1415Это упрощённый интерфейс к [`PyImport_ImportModuleEx()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ImportModuleEx) ниже, оставляющий аргументы *globals* и *locals* равными `NULL`, а *level* – равным 0. Когда аргумент *name* содержит точку (то есть указывает на подмодуль пакета), аргумент *fromlist* устанавливается в список `['*']`, чтобы возвращаемое значение было именованным модулем, а не пакетом верхнего уровня, как было бы в противном случае. (К сожалению, это даёт дополнительный побочный эффект, когда *name* на самом деле указывает на подпакет, а не на подмодуль: подмодули, указанные в переменной пакета `__all__`, загружаются.) Возвращает новую ссылку на импортированный модуль или `NULL` с установленным исключением в случае неудачи. Неудачный импорт модуля не оставляет модуль в [`sys.modules`](https://python-all.ru/3.10/library/sys.html#sys.modules).1617Эта функция всегда использует абсолютные импорты.1819#### `PyObject *PyImport_ImportModuleNoBlock(const char *name)`2021*Возвращаемое значение: новая ссылка.*2223*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*2425Эта функция – устаревший псевдоним [`PyImport_ImportModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ImportModule).2627Изменено в версии 3.3: Ранее эта функция немедленно завершалась ошибкой, если блокировка импорта удерживалась другим потоком. Однако в Python 3.3 схема блокировки была изменена на блокировки на уровне модулей для большинства случаев, поэтому специальное поведение этой функции больше не требуется.2829#### `PyObject *PyImport_ImportModuleEx(const char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)`3031*Возвращаемое значение: новая ссылка.*3233Импорт модуля. Лучше всего это описывается через встроенную функцию Python [`__import__()`](https://python-all.ru/3.10/library/functions.html#import__).3435Возвращаемое значение – это новая ссылка на импортированный модуль или пакет верхнего уровня, либо `NULL` с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.10/library/functions.html#import__), возвращаемое значение при запросе подмодуля пакета обычно является пакетом верхнего уровня, если только не был передан непустой *fromlist* .3637Неудачные импорты удаляют неполные объекты модулей, как и [`PyImport_ImportModule()`](https://python-all.ru/3.10/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.10/c-api/stable.html#stable) начиная с версии 3.7.*4445Импорт модуля. Наилучшее описание даётся через встроенную функцию Python [`__import__()`](https://python-all.ru/3.10/library/functions.html#import__), поскольку стандартная функция [`__import__()`](https://python-all.ru/3.10/library/functions.html#import__) вызывает эту функцию напрямую.4647Возвращаемое значение – это новая ссылка на импортированный модуль или пакет верхнего уровня, либо `NULL` с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.10/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.10/c-api/stable.html#stable).*5657Аналогично [`PyImport_ImportModuleLevelObject()`](https://python-all.ru/3.10/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.10/c-api/stable.html#stable).*6667Это интерфейс более высокого уровня, который вызывает текущую «функцию перехвата импорта» (с явным *level* равным 0, что означает абсолютный импорт). Он вызывает функцию [`__import__()`](https://python-all.ru/3.10/library/functions.html#import__) из `__builtins__` текущих глобальных переменных. Это означает, что импорт выполняется с использованием тех перехватчиков импорта, которые установлены в текущем окружении.6869Эта функция всегда использует абсолютные импорты.7071#### `PyObject *PyImport_ReloadModule(PyObject *m)`7273*Возвращаемое значение: новая ссылка.*7475*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*7677Перезагружает модуль. Возвращает новую ссылку на перезагруженный модуль или `NULL` с установленным исключением в случае ошибки (в этом случае модуль всё ещё существует).7879#### `PyObject *PyImport_AddModuleObject(PyObject *name)`8081*Возвращаемое значение: заимствованная ссылка.*8283*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.7.*8485Возвращает объект модуля, соответствующий имени модуля. Аргумент *name* может иметь форму `package.module`. Сначала проверяется словарь modules – если модуль уже есть, он возвращается; если нет, создаётся новый и вставляется в словарь modules. В случае неудачи возвращается `NULL` и устанавливается исключение.8687> **Примечание**88>89> Эта функция не загружает и не импортирует модуль; если модуль ещё не был загружен, возвращается пустой объект модуля. Для импорта модуля используйте [`PyImport_ImportModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ImportModule) или один из его вариантов. Структуры пакетов, подразумеваемые точечным именем для *name*, не создаются, если их ещё нет.9091Новое в версии 3.3.9293#### `PyObject *PyImport_AddModule(const char *name)`9495*Возвращаемое значение: заимствованная ссылка.*9697*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*9899Аналогично [`PyImport_AddModuleObject()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_AddModuleObject), но имя передаётся в виде строки в кодировке UTF-8, а не как объект Unicode.100101#### `PyObject *PyImport_ExecCodeModule(const char *name, PyObject *co)`102103*Возвращаемое значение: новая ссылка.*104105*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*106107Принимая имя модуля (возможно, вида `package.module`) и объект кода, прочитанный из файла байткода Python или полученный из встроенной функции [`compile()`](https://python-all.ru/3.10/library/functions.html#compile), загружает модуль. Возвращает новую ссылку на объект модуля или `NULL` с установленным исключением, если произошла ошибка. В случае ошибки *name* удаляется из [`sys.modules`](https://python-all.ru/3.10/library/sys.html#sys.modules), даже если *name* уже был в [`sys.modules`](https://python-all.ru/3.10/library/sys.html#sys.modules) на момент входа в [`PyImport_ExecCodeModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModule). Оставлять не полностью инициализированные модули в [`sys.modules`](https://python-all.ru/3.10/library/sys.html#sys.modules) опасно, так как импорт таких модулей не может узнать, что объект модуля находится в неизвестном (и, вероятно, повреждённом с точки зрения намерений автора модуля) состоянии.108109Атрибуты [`__spec__`](https://python-all.ru/3.10/reference/import.html#spec__) и [`__loader__`](https://python-all.ru/3.10/reference/import.html#loader__) модуля будут установлены, если ещё не установлены, в соответствующие значения. Загрузчик спецификации будет установлен в `__loader__` модуля (если он задан), в противном случае – в экземпляр `SourceFileLoader`.110111Атрибут [`__file__`](https://python-all.ru/3.10/reference/import.html#file__) модуля будет установлен в значение `co_filename` объекта кода. Если применимо, будет также установлен атрибут [`__cached__`](https://python-all.ru/3.10/reference/import.html#cached__).112113Эта функция перезагрузит модуль, если он уже был импортирован. См. [`PyImport_ReloadModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ReloadModule) для описания правильного способа перезагрузки модуля.114115Если *name* указывает на имя с точками вида `package.module`, любые структуры пакета, которые ещё не были созданы, по-прежнему не будут созданы.116117См. также [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModuleEx) и [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModuleWithPathnames).118119#### `PyObject *PyImport_ExecCodeModuleEx(const char *name, PyObject *co, const char *pathname)`120121*Возвращаемое значение: новая ссылка.*122123*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*124125Как и [`PyImport_ExecCodeModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModule), но атрибут [`__file__`](https://python-all.ru/3.10/reference/import.html#file__) объекта модуля устанавливается в *pathname*, если он не равен `NULL`.126127См. также [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModuleWithPathnames).128129#### `PyObject *PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)`130131*Возвращаемое значение: новая ссылка.*132133*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.7.*134135Как и [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModuleEx), но атрибут [`__cached__`](https://python-all.ru/3.10/reference/import.html#cached__) объекта модуля устанавливается в *cpathname*, если он не равен `NULL`. Из трёх функций эта является предпочтительной.136137Новое в версии 3.3.138139#### `PyObject *PyImport_ExecCodeModuleWithPathnames(const char *name, PyObject *co, const char *pathname, const char *cpathname)`140141*Возвращаемое значение: новая ссылка.*142143*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*144145Как [`PyImport_ExecCodeModuleObject()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExecCodeModuleObject), но *name*, *pathname* и *cpathname* являются строками в кодировке UTF-8. Также предпринимаются попытки выяснить, каким должно быть значение *pathname* из *cpathname*, если первое установлено в `NULL`.146147Новое в версии 3.2.148149Изменено в версии 3.3: Использует [`imp.source_from_cache()`](https://python-all.ru/3.10/library/imp.html#imp.source_from_cache) при вычислении пути к исходному коду, если указан только путь к байткоду.150151#### `long PyImport_GetMagicNumber()`152153*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*154155Возвращает магическое число для файлов байткода Python (также известных как файлы `.pyc`). Магическое число должно присутствовать в первых четырёх байтах файла байткода в порядке little-endian. В случае ошибки возвращает `-1`.156157Изменено в версии 3.3: Возвращает `-1` в случае неудачи.158159#### `const char *PyImport_GetMagicTag()`160161*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*162163Возвращает строку магического тега для имён файлов байткода Python в формате [**PEP 3147**](https://python-all.ru/3.10/c-api/import.html). Имейте в виду, что значение в `sys.implementation.cache_tag` является авторитетным и должно использоваться вместо этой функции.164165Новое в версии 3.2.166167#### `PyObject *PyImport_GetModuleDict()`168169*Возвращаемое значение: заимствованная ссылка.*170171*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*172173Возвращает словарь, используемый для администрирования модулей (также известный как `sys.modules`). Обратите внимание, что это переменная, отдельная для каждого интерпретатора.174175#### `PyObject *PyImport_GetModule(PyObject *name)`176177*Возвращаемое значение: новая ссылка.*178179*Часть [стабильного ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.8.*180181Возвращает уже импортированный модуль с заданным именем. Если модуль ещё не был импортирован, возвращает `NULL`, но не устанавливает ошибку. Возвращает `NULL` и устанавливает ошибку, если поиск не удался.182183Добавлено в версии 3.7.184185#### `PyObject *PyImport_GetImporter(PyObject *path)`186187*Возвращаемое значение: новая ссылка.*188189*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*190191Возвращает объект поиска для элемента [`sys.path`](https://python-all.ru/3.10/library/sys.html#sys.path)/`pkg.__path__` *path*, возможно, извлекая его из словаря [`sys.path_importer_cache`](https://python-all.ru/3.10/library/sys.html#sys.path_importer_cache). Если он ещё не кэширован, обходит [`sys.path_hooks`](https://python-all.ru/3.10/library/sys.html#sys.path_hooks), пока не будет найден хук, способный обработать элемент пути. Возвращает `None`, если ни один хук не подошёл; это сообщает вызывающей стороне, что [поисковик на основе пути](https://python-all.ru/3.10/glossary.html#term-path-based-finder) не смог найти поисковик для этого элемента пути. Кэширует результат в [`sys.path_importer_cache`](https://python-all.ru/3.10/library/sys.html#sys.path_importer_cache). Возвращает новую ссылку на объект поисковика.192193#### `int PyImport_ImportFrozenModuleObject(PyObject *name)`194195*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable) начиная с версии 3.7.*196197Загружает замороженный модуль с именем *name*. Возвращает `1` при успехе, `0`, если модуль не найден, и `-1` с установленным исключением, если инициализация не удалась. Чтобы получить доступ к импортированному модулю после успешной загрузки, используйте [`PyImport_ImportModule()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ImportModule). (Обратите внимание на неточность названия – эта функция перезагрузила бы модуль, если он уже был импортирован.)198199Новое в версии 3.3.200201Изменено в версии 3.4: Атрибут `__file__` больше не устанавливается в модуле.202203#### `int PyImport_ImportFrozenModule(const char *name)`204205*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*206207Аналогично [`PyImport_ImportFrozenModuleObject()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ImportFrozenModuleObject), но имя представляет собой строку в кодировке UTF-8 вместо объекта Unicode.208209#### `struct _frozen`210211Это определение типа структуры для дескрипторов замороженных модулей, как сгенерировано утилитой **freeze** (см. `Tools/freeze/` в дистрибутиве исходного кода Python). Её определение находится в `Include/import.h`:212213```c214struct _frozen {215    const char *name;216    const unsigned char *code;217    int size;218};219```220221#### `const struct _frozen *PyImport_FrozenModules`222223Этот указатель инициализируется так, чтобы указывать на массив записей [`_frozen`](https://python-all.ru/3.10/c-api/import.html#c._frozen), завершающийся записью, все члены которой равны `NULL` или нулю. Когда замороженный модуль импортируется, он ищется в этой таблице. Сторонний код может этим воспользоваться, чтобы предоставить динамически создаваемую коллекцию замороженных модулей.224225#### `int PyImport_AppendInittab(const char *name, PyObject *(*initfunc)(void))`226227*Часть [Stable ABI](https://python-all.ru/3.10/c-api/stable.html#stable).*228229Добавляет один модуль в существующую таблицу встроенных модулей. Это удобная обёртка вокруг [`PyImport_ExtendInittab()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExtendInittab), возвращающая `-1`, если таблицу не удалось расширить. Новый модуль можно импортировать по имени *name*, и он использует функцию *initfunc* в качестве функции инициализации, вызываемой при первой попытке импорта. Это должно вызываться до [`Py_Initialize()`](https://python-all.ru/3.10/c-api/init.html#c.Py_Initialize).230231#### `struct _inittab`232233Структура, описывающая одну запись в списке встроенных модулей. Каждая из этих структур содержит имя и функцию инициализации для модуля, встроенного в интерпретатор. Имя – это строка в кодировке ASCII. Программы, встраивающие Python, могут использовать массив таких структур совместно с [`PyImport_ExtendInittab()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExtendInittab) для добавления дополнительных встроенных модулей. Структура определена в `Include/import.h` следующим образом:234235```c236struct _inittab {237    const char *name;           /* Строка в кодировке ASCII */238    PyObject* (*initfunc)(void);239};240```241242#### `int PyImport_ExtendInittab(struct _inittab *newtab)`243244Добавляет набор модулей в таблицу встроенных модулей. Массив *newtab* должен заканчиваться сторожевой записью, которая содержит `NULL` для поля `name`; отсутствие сторожевого значения может привести к ошибке памяти. Возвращает `0` при успехе или `-1`, если недостаточно памяти для расширения внутренней таблицы. В случае неудачи ни один модуль не добавляется во внутреннюю таблицу. Это должно вызываться до [`Py_Initialize()`](https://python-all.ru/3.10/c-api/init.html#c.Py_Initialize).245246Если Python инициализируется несколько раз, [`PyImport_AppendInittab()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_AppendInittab) или [`PyImport_ExtendInittab()`](https://python-all.ru/3.10/c-api/import.html#c.PyImport_ExtendInittab) должны вызываться перед каждой инициализацией Python.247