`import.md`

201 строк · 21.0 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.3/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Это упрощённый интерфейс к [`PyImport_ImportModuleEx()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModuleEx) (см. ниже), при этом аргументы *globals* и *locals* принимают значение *NULL*, а *level* – 0. Когда аргумент *name* содержит точку (то есть указывает на подмодуль пакета), аргумент *fromlist* устанавливается в список `['*']`, чтобы возвращаемым значением был указанный модуль, а не содержащий его пакет верхнего уровня, как было бы в противном случае. (К сожалению, у этого есть дополнительный побочный эффект, когда *name* на самом деле указывает на подпакет, а не на подмодуль: загружаются подмодули, указанные в переменной `__all__` пакета.) Возвращает новую ссылку на импортированный модуль или *NULL* с установленным исключением в случае ошибки. Неудачный импорт модуля не оставляет модуль в [`sys.modules`](https://python-all.ru/3.3/library/sys.html#sys.modules).1415Эта функция всегда использует абсолютные импорты.1617#### `PyObject* PyImport_ImportModuleNoBlock(const char *name)`1819Эта функция является устаревшим псевдонимом [`PyImport_ImportModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModule).2021Изменено в версии 3.3: Ранее эта функция немедленно завершалась ошибкой, если блокировка импорта удерживалась другим потоком. Однако в Python 3.3 схема блокировки была изменена на блокировки на уровне модулей для большинства случаев, поэтому специальное поведение этой функции больше не требуется.2223#### `PyObject* PyImport_ImportModuleEx(char *name, PyObject *globals, PyObject *locals, PyObject *fromlist)`2425*Возвращаемое значение: новая ссылка.*2627Импортирует модуль. Лучше всего это описывается встроенной функцией Python [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__).2829Возвращаемое значение – новая ссылка на импортированный модуль или пакет верхнего уровня, или *NULL* с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__), возвращаемое значение при запросе подмодуля пакета обычно является пакетом верхнего уровня, если только не был передан непустой *fromlist*.3031Неудачные импорты удаляют неполные объекты модулей, как и в [`PyImport_ImportModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModule).3233#### `PyObject* PyImport_ImportModuleLevelObject(PyObject *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)`3435Импортирует модуль. Лучше всего это описывается встроенной функцией Python [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__), поскольку стандартная функция [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__) напрямую вызывает эту функцию.3637Возвращаемое значение – новая ссылка на импортированный модуль или пакет верхнего уровня, или *NULL* с установленным исключением в случае ошибки. Как и для [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__), возвращаемое значение при запросе подмодуля пакета обычно является пакетом верхнего уровня, если только не был передан непустой *fromlist*.3839Новое в версии 3.3.4041#### `PyObject* PyImport_ImportModuleLevel(char *name, PyObject *globals, PyObject *locals, PyObject *fromlist, int level)`4243*Возвращаемое значение: новая ссылка.*4445Аналогична [`PyImport_ImportModuleLevelObject()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModuleLevelObject), но name представляет собой строку в кодировке UTF-8 вместо объекта Unicode.4647Изменено в версии 3.3: Отрицательные значения для *level* больше не принимаются.4849#### `PyObject* PyImport_Import(PyObject *name)`5051*Возвращаемое значение: новая ссылка.*5253Это интерфейс более высокого уровня, который вызывает текущую «функцию перехвата импорта» (с явным *level*, равным 0, что означает абсолютный импорт). Он вызывает функцию [`__import__()`](https://python-all.ru/3.3/library/functions.html#__import__) из `__builtins__` текущих globals. Это означает, что импорт выполняется с использованием тех перехватчиков импорта, которые установлены в текущем окружении.5455Эта функция всегда использует абсолютные импорты.5657#### `PyObject* PyImport_ReloadModule(PyObject *m)`5859*Возвращаемое значение: новая ссылка.*6061Перезагружает модуль. Возвращает новую ссылку на перезагруженный модуль или *NULL* с установленным исключением в случае неудачи (в этом случае модуль всё ещё существует).6263#### `PyObject* PyImport_AddModuleObject(PyObject *name)`6465Возвращает объект модуля, соответствующий имени модуля. Аргумент *name* может иметь вид `package.module`. Сначала проверяется словарь модулей, есть ли там такой модуль; если нет, создаётся новый и вставляется в словарь модулей. Возвращает *NULL* с установленным исключением в случае ошибки.6667> **Примечание**68>69> Эта функция не загружает и не импортирует модуль; если модуль ещё не был загружен, будет получен пустой объект модуля. Используйте [`PyImport_ImportModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModule) или один из его вариантов для импорта модуля. Структуры пакетов, подразумеваемые составным именем для *name*, не создаются, если их ещё нет.7071Новое в версии 3.3.7273#### `PyObject* PyImport_AddModule(const char *name)`7475*Возвращаемое значение: заимствованная ссылка.*7677Аналогична [`PyImport_AddModuleObject()`](https://python-all.ru/3.3/c-api/import.html#PyImport_AddModuleObject), но name представляет собой строку в кодировке UTF-8 вместо объекта Unicode.7879#### `PyObject* PyImport_ExecCodeModule(char *name, PyObject *co)`8081*Возвращаемое значение: новая ссылка.*8283Получая имя модуля (возможно, вида `package.module`) и объект кода, прочитанный из файла байт-кода Python или полученный от встроенной функции [`compile()`](https://python-all.ru/3.3/library/functions.html#compile), загружает модуль. Возвращает новую ссылку на объект модуля или *NULL* с установленным исключением, если произошла ошибка. *name* удаляется из [`sys.modules`](https://python-all.ru/3.3/library/sys.html#sys.modules) в случае ошибки, даже если *name* уже был в [`sys.modules`](https://python-all.ru/3.3/library/sys.html#sys.modules) на момент входа в [`PyImport_ExecCodeModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModule). Оставлять не полностью инициализированные модули в [`sys.modules`](https://python-all.ru/3.3/library/sys.html#sys.modules) опасно, так как импорты таких модулей не могут узнать, что объект модуля находится в неизвестном (и, вероятно, повреждённом относительно замысла автора модуля) состоянии.8485Атрибут `__file__` модуля будет установлен в `co_filename` объекта кода.8687Эта функция перезагрузит модуль, если он уже был импортирован. См. [`PyImport_ReloadModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ReloadModule) – это предназначенный способ перезагрузки модуля.8889Если *name* указывает на составное имя вида `package.module`, любые структуры пакетов, которые ещё не были созданы, по-прежнему не будут созданы.9091См. также [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModuleEx) и [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModuleWithPathnames).9293#### `PyObject* PyImport_ExecCodeModuleEx(char *name, PyObject *co, char *pathname)`9495*Возвращаемое значение: новая ссылка.*9697Как и [`PyImport_ExecCodeModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModule), но атрибут `__file__` объекта модуля устанавливается в *pathname*, если он не равен `NULL`.9899См. также [`PyImport_ExecCodeModuleWithPathnames()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModuleWithPathnames).100101#### `PyObject* PyImport_ExecCodeModuleObject(PyObject *name, PyObject *co, PyObject *pathname, PyObject *cpathname)`102103Как и [`PyImport_ExecCodeModuleEx()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModuleEx), но атрибут `__cached__` объекта модуля устанавливается в *cpathname*, если он не равен `NULL`. Из трёх функций это предпочтительная.104105Новое в версии 3.3.106107#### `PyObject* PyImport_ExecCodeModuleWithPathnames(char *name, PyObject *co, char *pathname, char *cpathname)`108109Подобно [`PyImport_ExecCodeModuleObject()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExecCodeModuleObject), но *name*, *pathname* и *cpathname* являются строками в кодировке UTF-8. Также предпринимаются попытки определить значение *pathname* из *cpathname*, если первая установлена в `NULL`.110111Новое в версии 3.2.112113Изменено в версии 3.3: Использует [`imp.source_from_cache()`](https://python-all.ru/3.3/library/imp.html#imp.source_from_cache) при вычислении пути к исходному файлу, если указан только путь к байт-коду.114115#### `long PyImport_GetMagicNumber()`116117Возвращает магическое число для файлов байт-кода Python (также известных как файлы `.pyc` и `.pyo`). Магическое число должно находиться в первых четырёх байтах файла байт-кода в порядке little-endian. Возвращает -1 при ошибке.118119Изменено в версии 3.3: Возвращаемое значение -1 в случае ошибки.120121#### `const char * PyImport_GetMagicTag()`122123Возвращает строку магического тега для имён файлов байт-кода Python в формате [**PEP 3147**](https://python-all.ru/3.3/c-api/import.html). Имейте в виду, что значение `sys.implementation.cache_tag` является авторитетным и должно использоваться вместо этой функции.124125Новое в версии 3.2.126127#### `PyObject* PyImport_GetModuleDict()`128129*Возвращаемое значение: заимствованная ссылка.*130131Возвращает словарь, используемый для управления модулями (также известный как `sys.modules`). Обратите внимание, что это переменная на интерпретатор.132133#### `PyObject* PyImport_GetImporter(PyObject *path)`134135Возвращает объект импортёра для элемента [`sys.path`](https://python-all.ru/3.3/library/sys.html#sys.path)/`pkg.__path__` *path*, возможно получая его из словаря [`sys.path_importer_cache`](https://python-all.ru/3.3/library/sys.html#sys.path_importer_cache). Если он ещё не кэширован, проходит по [`sys.path_hooks`](https://python-all.ru/3.3/library/sys.html#sys.path_hooks), пока не будет найден хук, способный обработать данный элемент пути. Возвращает `None`, если ни один хук не подошёл; это сообщает вызывающему коду, что следует вернуться к встроенному механизму импорта. Кэширует результат в [`sys.path_importer_cache`](https://python-all.ru/3.3/library/sys.html#sys.path_importer_cache). Возвращает новую ссылку на объект импортёра.136137#### `void _PyImport_Init()`138139Инициализирует механизм импорта. Только для внутреннего использования.140141#### `void PyImport_Cleanup()`142143Очищает таблицу модулей. Только для внутреннего использования.144145#### `void _PyImport_Fini()`146147Завершает работу механизма импорта. Только для внутреннего использования.148149#### `PyObject* _PyImport_FindExtension(char *, char *)`150151Только для внутреннего использования.152153#### `PyObject* _PyImport_FixupExtension(char *, char *)`154155Только для внутреннего использования.156157#### `int PyImport_ImportFrozenModuleObject(PyObject *name)`158159Загружает замороженный модуль с именем *name*. Возвращает `1` в случае успеха, `0` если модуль не найден и `-1` с установленным исключением, если инициализация не удалась. Для доступа к импортированному модулю после успешной загрузки используйте [`PyImport_ImportModule()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportModule). (Обратите внимание на неточность в названии – эта функция перезагрузила бы модуль, если бы он уже был импортирован.)160161Новое в версии 3.3.162163#### `int PyImport_ImportFrozenModule(char *name)`164165Аналогична [`PyImport_ImportFrozenModuleObject()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ImportFrozenModuleObject), но имя является строкой в кодировке UTF-8 вместо объекта Unicode.166167**struct `_frozen`**168169Это определение типа структуры для дескрипторов замороженных модулей, создаваемое утилитой **freeze** (см. `Tools/freeze/` в дистрибутиве исходного кода Python). Её определение находится в `Include/import.h`:170171```c172struct _frozen {173    char *name;174    unsigned char *code;175    int size;176};177```178179**struct [\_frozen](https://python-all.ru/3.3/c-api/import.html#_frozen)\* `PyImport_FrozenModules`**180181Этот указатель инициализируется так, чтобы указывать на массив записей `struct _frozen`, заканчивающийся записью, все члены которой равны *NULL* или нулю. Когда замороженный модуль импортируется, он ищется в этой таблице. Сторонний код может использовать это для предоставления динамически созданной коллекции замороженных модулей.182183#### `int PyImport_AppendInittab(const char *name, PyObject* (*initfunc)(void))`184185Добавляет один модуль в существующую таблицу встроенных модулей. Это удобная обёртка вокруг [`PyImport_ExtendInittab()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExtendInittab), возвращающая `-1`, если таблицу не удалось расширить. Новый модуль может быть импортирован под именем *name* и использует функцию *initfunc* в качестве функции инициализации, вызываемой при первой попытке импорта. Это должно быть вызвано до [`Py_Initialize()`](https://python-all.ru/3.3/c-api/init.html#Py_Initialize).186187**struct `_inittab`**188189Структура, описывающая одну запись в списке встроенных модулей. Каждая из этих структур задаёт имя и функцию инициализации для модуля, встроенного в интерпретатор. Имя является строкой в кодировке ASCII. Программы, встраивающие Python, могут использовать массив таких структур совместно с [`PyImport_ExtendInittab()`](https://python-all.ru/3.3/c-api/import.html#PyImport_ExtendInittab) для предоставления дополнительных встроенных модулей. Структура определена в `Include/import.h` как:190191```c192struct _inittab {193    char *name;                 /* Строка в кодировке ASCII */194    PyObject* (*initfunc)(void);195};196```197198#### `int PyImport_ExtendInittab(struct _inittab *newtab)`199200Добавляет набор модулей в таблицу встроенных модулей. Массив *newtab* должен заканчиваться сторожевой записью, содержащей *NULL* в поле `name`; отсутствие сторожевого значения может привести к ошибке памяти. Возвращает `0` в случае успеха или `-1`, если недостаточно памяти для расширения внутренней таблицы. В случае неудачи модули не добавляются во внутреннюю таблицу. Этот вызов должен быть выполнен до [`Py_Initialize()`](https://python-all.ru/3.3/c-api/init.html#Py_Initialize).201