Документация Python неофициальный перевод

imp.md

220 строк · 20.0 КБ · обычная страница · сырой текст · скачать

1> **Источник:** https://python-all.ru/3.1/library/imp.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 29.1. `imp` – Доступ к внутренним механизмам [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import)89Этот модуль предоставляет интерфейс к механизмам, используемым для реализации оператора [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import). Он определяет следующие константы и функции:1011#### `imp.get_magic()`1213Возвращает магическое строковое значение, используемое для распознавания байт-кодовых файлов (файлов `.pyc`). (Это значение может различаться для разных версий Python.)1415#### `imp.get_suffixes()`1617Возвращает список трёхэлементных кортежей, каждый из которых описывает конкретный тип модуля. Каждая тройка имеет вид1819`(suffix, mode, type)`2021, где2223*suffix*2425– строка, добавляемая к имени модуля для формирования имени файла для поиска,2627*mode*2829– строка режима, передаваемая встроенной функции3031[`open()`](https://python-all.ru/3.1/library/functions.html#open)3233для открытия файла (это может быть3435`'r'`3637для текстовых файлов или3839`'rb'`4041для двоичных файлов), а4243*type*4445– тип файла, который принимает одно из значений4647[`PY_SOURCE`](https://python-all.ru/3.1/library/imp.html#imp.PY_SOURCE)4849,5051[`PY_COMPILED`](https://python-all.ru/3.1/library/imp.html#imp.PY_COMPILED)5253или5455[`C_EXTENSION`](https://python-all.ru/3.1/library/imp.html#imp.C_EXTENSION)5657, описанных ниже.5859#### `imp.find_module(name[, path])`6061Пытается найти модуль *name*. Если *path* опущен или равен `None`, выполняется поиск по списку имён каталогов, заданному `sys.path`, но сначала ищется в нескольких особых местах: функция пытается найти встроенный модуль с указанным именем ([`C_BUILTIN`](https://python-all.ru/3.1/library/imp.html#imp.C_BUILTIN)), затем замороженный модуль ([`PY_FROZEN`](https://python-all.ru/3.1/library/imp.html#imp.PY_FROZEN)), а в некоторых системах также проверяются и другие места (в Windows – реестр, который может указывать на конкретный файл).6263В противном случае *path* должен быть списком имён каталогов; в каждом каталоге выполняется поиск файлов с любым из суффиксов, возвращаемых [`get_suffixes()`](https://python-all.ru/3.1/library/imp.html#imp.get_suffixes) выше. Некорректные имена в списке молча игнорируются (но все элементы списка должны быть строками).6465Если поиск успешен, возвращаемое значение – трёхэлементный кортеж `(file, pathname, description)`:6667*file* – открытый [*файловый объект*](https://python-all.ru/3.1/glossary.html#term-file-object), позиционированный на начало; *pathname* – путь к найденному файлу; а *description* – трёхэлементный кортеж, как в списке, возвращаемом [`get_suffixes()`](https://python-all.ru/3.1/library/imp.html#imp.get_suffixes), описывающий тип найденного модуля.6869Если модуль не находится в файле, возвращаемый *file* равен `None`, *pathname* – пустая строка, а кортеж *description* содержит пустые строки для суффикса и режима; тип модуля указывается, как показано выше в скобках. Если поиск неуспешен, возбуждается [`ImportError`](https://python-all.ru/3.1/library/exceptions.html#ImportError). Другие исключения указывают на проблемы с аргументами или окружением.7071Если модуль является пакетом, *file* равен `None`, *pathname* – путь к пакету, а последним элементом кортежа *description* является [`PKG_DIRECTORY`](https://python-all.ru/3.1/library/imp.html#imp.PKG_DIRECTORY).7273Эта функция не работает с иерархическими именами модулей (именами, содержащими точки). Чтобы найти *P*.\*M\*, то есть подмодуль *M* пакета *P*, используйте [`find_module()`](https://python-all.ru/3.1/library/imp.html#imp.find_module) и [`load_module()`](https://python-all.ru/3.1/library/imp.html#imp.load_module) для поиска и загрузки пакета *P*, а затем вызовите [`find_module()`](https://python-all.ru/3.1/library/imp.html#imp.find_module) с аргументом *path*, установленным в `P.__path__`. Если *P* сам содержит точку, применяйте этот рецепт рекурсивно.7475#### `imp.load_module(name, file, pathname, description)`7677Загружает модуль, который ранее был найден с помощью [`find_module()`](https://python-all.ru/3.1/library/imp.html#imp.find_module) (или другого поиска, давшего совместимые результаты). Эта функция делает больше, чем просто импорт модуля: если модуль уже был импортирован, она перезагружает его! Аргумент *name* указывает полное имя модуля (включая имя пакета, если это подмодуль пакета). Аргумент *file* – это открытый файл, а *pathname* – соответствующее имя файла; они могут быть `None` и `''` соответственно, когда модуль является пакетом или не загружается из файла. Аргумент *description* – это кортеж, такой, какой вернула бы [`get_suffixes()`](https://python-all.ru/3.1/library/imp.html#imp.get_suffixes), описывающий, какой тип модуля должен быть загружен.7879Если загрузка успешна, возвращается объект модуля; в противном случае возбуждается исключение (обычно [`ImportError`](https://python-all.ru/3.1/library/exceptions.html#ImportError)).8081**Важно:** вызывающий код отвечает за закрытие аргумента *file*, если он не был `None`, даже при возбуждении исключения. Лучше всего это делать с помощью оператора [`try`](https://python-all.ru/3.1/reference/compound_stmts.html#try) ... [`finally`](https://python-all.ru/3.1/reference/compound_stmts.html#finally).8283#### `imp.new_module(name)`8485Возвращает новый пустой объект модуля с именем8687*name*8889. Этот объект9091*не*9293вставляется в9495`sys.modules`9697.9899#### `imp.lock_held()`100101Возвращает `True`, если блокировка импорта в данный момент удерживается, иначе `False`. На платформах без потоков всегда возвращает `False`.102103На платформах с потоками поток, выполняющий импорт, удерживает внутреннюю блокировку до завершения импорта. Эта блокировка не позволяет другим потокам выполнять импорт, пока исходный импорт не завершится, что, в свою очередь, предотвращает ситуацию, когда другие потоки могут увидеть незавершённые объекты модулей, созданные исходным потоком в процессе завершения его импорта (а также импортов, если таковые были, которые были вызваны этим).104105#### `imp.acquire_lock()`106107Захватывает блокировку импорта интерпретатора для текущего потока. Эта блокировка должна использоваться хуками импорта для обеспечения потокобезопасности при импорте модулей.108109После того как поток захватил блокировку импорта, тот же поток может захватить её снова без блокировки; поток должен освобождать её один раз за каждый захват.110111На платформах без потоков эта функция ничего не делает.112113#### `imp.release_lock()`114115Освобождает блокировку импорта интерпретатора. На платформах без потоков эта функция ничего не делает.116117#### `imp.reload(module)`118119Перезагружает ранее импортированный модуль *module*. Аргумент должен быть объектом модуля, то есть он должен быть успешно импортирован ранее. Это полезно, если вы отредактировали исходный файл модуля во внешнем редакторе и хотите опробовать новую версию, не выходя из интерпретатора Python. Возвращаемое значение – объект модуля (тот же, что и аргумент *module*).120121При выполнении `reload(module)`:122123- Код модулей Python перекомпилируется, и код уровня модуля выполняется заново, определяя новый набор объектов, которые привязываются к именам в словаре модуля. Функция `init` модулей расширения не вызывается второй раз.124- Как и в случае со всеми другими объектами в Python, старые объекты освобождаются только после того, как их счётчики ссылок упадут до нуля.125- Имена в пространстве имён модуля обновляются, чтобы указывать на любые новые или изменённые объекты.126- Другие ссылки на старые объекты (например, имена вне модуля) не перепривязываются для указания на новые объекты и должны быть обновлены в каждом пространстве имён, где они встречаются, если это необходимо.127128Существует ряд других предостережений:129130Если модуль синтаксически корректен, но его инициализация завершается ошибкой, первый оператор [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import) для него не связывает имя локально, но сохраняет (частично инициализированный) объект модуля в `sys.modules`. Чтобы перезагрузить модуль, сначала нужно снова выполнить [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import) (это свяжет имя с частично инициализированным объектом модуля), и только затем можно вызвать для него [`reload()`](https://python-all.ru/3.1/library/imp.html#imp.reload).131132При перезагрузке модуля его словарь (содержащий глобальные переменные модуля) сохраняется. Переопределения имён заменяют старые определения, так что обычно это не проблема. Если новая версия модуля не определяет имя, которое было определено в старой версии, старое определение остаётся. Эту возможность можно использовать в пользу модуля, если он поддерживает глобальную таблицу или кеш объектов – с помощью оператора [`try`](https://python-all.ru/3.1/reference/compound_stmts.html#try) он может проверить наличие таблицы и, если нужно, пропустить её инициализацию:133134```python135try:136    cache137except NameError:138    cache = {}139```140141Перезагрузка встроенных или динамически загружаемых модулей допустима, но обычно не очень полезна, за исключением [`sys`](https://python-all.ru/3.1/library/sys.html#module-sys), [`__main__`](https://python-all.ru/3.1/library/__main__.html#module-__main__) и `__builtin__`. Однако во многих случаях модули расширения не рассчитаны на инициализацию более одного раза и могут произвольно завершаться ошибкой при перезагрузке.142143Если модуль импортирует объекты из другого модуля с помощью [`from`](https://python-all.ru/3.1/reference/simple_stmts.html#from) ... [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import) ..., то вызов [`reload()`](https://python-all.ru/3.1/library/imp.html#imp.reload) для другого модуля не переопределяет импортированные из него объекты. Один из способов обойти это – повторно выполнить оператор [`from`](https://python-all.ru/3.1/reference/simple_stmts.html#from), другой – использовать [`import`](https://python-all.ru/3.1/reference/simple_stmts.html#import) и квалифицированные имена (*module*.\*name\*).144145Если модуль создаёт экземпляры класса, перезагрузка модуля, определяющего класс, не влияет на определения методов экземпляров – они продолжают использовать старое определение класса. То же самое верно для производных классов.146147Следующие константы с целочисленными значениями, определённые в этом модуле, используются для указания результата поиска [`find_module()`](https://python-all.ru/3.1/library/imp.html#imp.find_module).148149#### `imp.PY_SOURCE`150151Модуль найден как исходный файл.152153#### `imp.PY_COMPILED`154155Модуль найден как файл скомпилированного кода.156157#### `imp.C_EXTENSION`158159Модуль найден как динамически загружаемая общая библиотека.160161#### `imp.PKG_DIRECTORY`162163Модуль найден как каталог пакета.164165#### `imp.C_BUILTIN`166167Модуль найден как встроенный модуль.168169#### `imp.PY_FROZEN`170171Модуль был найден как замороженный модуль (см.172173`init_frozen()`174175).176177#### `class imp.NullImporter(path_string)`178179Тип [`NullImporter`](https://python-all.ru/3.1/library/imp.html#imp.NullImporter) – это хук импорта по [**PEP 302**](https://python-all.ru/3.1/library/imp.html), который обрабатывает строки пути, не являющиеся каталогами, возвращая отказ в поиске любых модулей. Вызов этого типа с существующим каталогом или пустой строкой возбуждает [`ImportError`](https://python-all.ru/3.1/library/exceptions.html#ImportError). В противном случае возвращается экземпляр [`NullImporter`](https://python-all.ru/3.1/library/imp.html#imp.NullImporter).180181Python добавляет экземпляры этого типа в `sys.path_importer_cache` для любых записей пути, которые не являются каталогами и не обрабатываются никакими другими хуками пути из `sys.path_hooks`. Экземпляры имеют только один метод:182183#### `find_module(fullname[, path])`184185Этот метод всегда возвращает186187`None`188189, указывая, что запрошенный модуль не найден.190191## 29.1.1. Примеры192193Следующая функция эмулирует то, что было стандартным оператором импорта до Python 1.4 (без иерархических имён модулей). (Эта *реализация* не работала бы в той версии, поскольку [`find_module()`](https://python-all.ru/3.1/library/imp.html#imp.find_module) была расширена, а [`load_module()`](https://python-all.ru/3.1/library/imp.html#imp.load_module) добавлена в версии 1.4.)194195```python196import imp197import sys198199def __import__(name, globals=None, locals=None, fromlist=None):200    # Быстрый путь: проверить, импортирован ли модуль ранее.201    try:202        return sys.modules[name]203    except KeyError:204        pass205206    # Если любой из следующих вызовов вызывает исключение,207    # возникает проблема, которую мы не можем обработать – пусть вызывающий код обработает её.208209    fp, pathname, description = imp.find_module(name)210211    try:212        return imp.load_module(name, fp, pathname, description)213    finally:214        # Так как возможен выход через исключение, необходимо явно закрыть fp.215        if fp:216            fp.close()217```218219Более полный пример, который реализует иерархические имена модулей и содержит функцию [`reload()`](https://python-all.ru/3.1/library/imp.html#imp.reload), можно найти в модуле `knee`. Модуль `knee` находится в каталоге `Demo/imputil/` дистрибутива исходного кода Python.220