31.1. imp – Доступ к importвнутренним механизмам¶imp – Access the import internals

Этот модуль предоставляет интерфейс к механизмам, используемым для реализации оператора import. Он определяет следующие константы и функции:

imp.get_magic()¶

Возвращает строку магического значения, используемую для распознавания файлов с байт-кодом (файлы .pyc). (Это значение может отличаться для разных версий Python.)

imp.get_suffixes()¶

Возвращает список кортежей из 3 элементов, каждый из которых описывает определённый тип модуля. Каждый кортеж имеет вид (suffix, mode, type), где suffix – это строка, добавляемая к имени модуля для получения имени файла для поиска, mode – строка режима, передаваемая встроенной функции open() для открытия файла (это может быть 'r' для текстовых файлов или 'rb' для двоичных файлов), а type – тип файла, который может принимать одно из значений PY_SOURCE, PY_COMPILED или C_EXTENSION, описанных ниже.

imp.find_module(name[, path])¶

Пытается найти модуль name. Если path опущен или None, выполняется поиск по списку имён каталогов, указанному в sys.path, но сначала проверяется несколько особых мест: функция пытается найти встроенный модуль с заданным именем (C_BUILTIN), затем замороженный модуль (PY_FROZEN), а на некоторых системах также проверяются другие места (в Windows выполняется поиск в реестре, который может указывать на конкретный файл).

В противном случае path должен быть списком имён каталогов; каждый каталог проверяется на наличие файлов с любым из суффиксов, возвращаемых get_suffixes() выше. Недопустимые имена в списке игнорируются (но все элементы списка должны быть строками).

Если поиск успешен, возвращаемое значение – кортеж из 3 элементов (file, pathname, description):

file – это открытый файловый объект, расположенный в начале, pathname – это путь к найденному файлу, а description – это кортеж из 3 элементов, как содержится в списке, возвращаемом get_suffixes(), описывающий тип найденного модуля.

Если модуль не находится в файле, возвращаемый file равен None, pathname – пустая строка, а кортеж description содержит пустые строки для его suffix и mode; тип модуля указывается так, как приведено в скобках выше. Если поиск неуспешен, возбуждается ImportError. Другие исключения указывают на проблемы с аргументами или окружением.

Если модуль является пакетом, file равен None, pathname – это путь к пакету, а последний элемент кортежа description равен PKG_DIRECTORY.

Эта функция не обрабатывает иерархические имена модулей (имена, содержащие точки). Чтобы найти P.M, то есть подмодуль M пакета P, используйте find_module() и load_module() для поиска и загрузки пакета P, а затем используйте find_module() с аргументом path, установленным в P.__path__. Когда P сам имеет составное имя, применяйте этот рецепт рекурсивно.

imp.load_module(name, file, pathname, description)¶

Загружает модуль, ранее найденный с помощью find_module() (или в результате другого поиска, давшего совместимые результаты). Эта функция делает больше, чем просто импорт модуля: если модуль уже был импортирован, она эквивалентна вызову reload()! Аргумент name указывает полное имя модуля (включая имя пакета, если это подмодуль пакета). Аргумент file – это открытый файл, а pathname – соответствующее имя файла; они могут быть None и '' соответственно, если модуль является пакетом или не загружается из файла. Аргумент description – это кортеж, как возвращаемый get_suffixes(), описывающий, какой именно модуль должен быть загружен.

Если загрузка успешна, возвращается объект модуля; в противном случае возбуждается исключение (обычно ImportError).

Важно: вызывающая сторона обязана закрыть аргумент file, если он не равен None, даже при возникновении исключения. Это лучше всего сделать с помощью оператора try … finally.

imp.new_module(name)¶

Возвращает новый пустой объект модуля с именем name. Этот объект не вставляется в sys.modules.

imp.lock_held()¶

Возвращает True, если блокировка импорта в настоящее время удерживается, иначе False. На платформах без поддержки потоков всегда возвращает False.

На платформах с потоками поток, выполняющий импорт, удерживает внутреннюю блокировку до завершения импорта. Эта блокировка не позволяет другим потокам выполнять импорт, пока исходный импорт не завершится, что, в свою очередь, предотвращает ситуацию, когда другие потоки могут увидеть незавершённые объекты модулей, созданные исходным потоком в процессе завершения его импорта (а также импортов, если таковые были, которые были вызваны этим).

imp.acquire_lock()¶

Захватывает блокировку импорта интерпретатора для текущего потока. Эта блокировка должна использоваться хуками импорта для обеспечения потокобезопасности при импорте модулей.

После того как поток захватил блокировку импорта, тот же поток может захватить её снова без блокировки; поток должен освобождать её один раз за каждый захват.

На платформах без потоков эта функция ничего не делает.

Новое в версии 2.3.

imp.release_lock()¶

Освобождает блокировку импорта интерпретатора. На платформах без потоков эта функция ничего не делает.

Новое в версии 2.3.

Следующие константы целочисленных значений, определённые в этом модуле, используются для обозначения результата поиска find_module().

imp.PY_SOURCE¶

Модуль найден как исходный файл.

imp.PY_COMPILED¶

Модуль найден как файл скомпилированного кода.

imp.C_EXTENSION¶

Модуль найден как динамически загружаемая общая библиотека.

imp.PKG_DIRECTORY¶

Модуль найден как каталог пакета.

imp.C_BUILTIN¶

Модуль найден как встроенный модуль.

imp.PY_FROZEN¶

Модуль был найден как замороженный модуль (см. init_frozen()).

Следующая константа и функции устарели; их функциональность доступна через find_module() или load_module(). Они сохранены для обратной совместимости:

imp.SEARCH_ERROR¶

Не используется.

imp.init_builtin(name)¶

Инициализирует встроенный модуль с именем name и возвращает его объект-модуль, а также сохраняет его в sys.modules. Если модуль уже был инициализирован, он будет инициализирован заново. Повторная инициализация включает копирование __dict__ встроенного модуля из кэшированного модуля в запись модуля в sys.modules. Если встроенного модуля с именем name не существует, возвращается None.

imp.init_frozen(name)¶

Инициализирует замороженный модуль с именем name и возвращает его объект-модуль. Если модуль уже был инициализирован, он будет инициализирован заново. Если замороженного модуля с именем name не существует, возвращается None. (Замороженные модули – это модули, написанные на Python, чей скомпилированный байт-код встраивается в пользовательскую сборку интерпретатора Python с помощью утилиты freeze. См. Tools/freeze/ для получения дополнительной информации.)

imp.is_builtin(name)¶

Возвращает 1, если существует встроенный модуль с именем name, который можно инициализировать повторно. Возвращает -1, если существует встроенный модуль с именем name, который нельзя инициализировать повторно (см. init_builtin()). Возвращает 0, если встроенного модуля с именем name не существует.

imp.is_frozen(name)¶

Возвращает True, если существует замороженный модуль (см. init_frozen()) с именем name, или False, если такого модуля нет.

imp.load_compiled(name, pathname[, file])¶

Загружает и инициализирует модуль, реализованный как файл с байт-кодом, и возвращает его объект модуля. Если модуль уже был инициализирован, он будет инициализирован заново. Аргумент name используется для создания или доступа к объекту модуля. Аргумент pathname указывает на файл с байт-кодом. Аргумент file – это файл с байт-кодом, открытый для чтения в двоичном режиме с начала. В настоящее время это должен быть реальный файловый объект, а не пользовательский класс, эмулирующий файл.

imp.load_dynamic(name, pathname[, file])¶

Загружает и инициализирует модуль, реализованный как динамически загружаемая разделяемая библиотека, и возвращает его объект-модуль. Если модуль уже был инициализирован, он будет инициализирован заново. Повторная инициализация включает копирование атрибута __dict__ кэшированного экземпляра модуля в значение, используемое в модуле, кэшированном в sys.modules. Аргумент pathname должен указывать на разделяемую библиотеку. Аргумент name используется для построения имени функции инициализации: вызывается внешняя функция C с именем initname() в разделяемой библиотеке. Необязательный аргумент file игнорируется. (Примечание: использование разделяемых библиотек сильно зависит от системы, и не все системы поддерживают это.)

Особенности реализации CPython: Внутренние механизмы импорта идентифицируют модули расширения по имени файла, поэтому выполнение foo = load_dynamic("foo", "mod.so") и bar = load_dynamic("bar", "mod.so") приведёт к тому, что оба foo и bar будут ссылаться на один и тот же модуль, независимо от того, экспортирует ли mod.so функцию initbar. В системах, поддерживающих символьные ссылки, их можно использовать для импорта нескольких модулей из одной разделяемой библиотеки, так как каждая ссылка на модуль будет использовать другое имя файла.

imp.load_source(name, pathname[, file])¶

Загружает и инициализирует модуль, реализованный как исходный файл Python, и возвращает его объект-модуль. Если модуль уже был инициализирован, он будет инициализирован заново. Аргумент name используется для создания или доступа к объекту модуля. Аргумент pathname указывает на исходный файл. Аргумент file – это исходный файл, открытый для чтения как текст, с начала. В настоящее время это должен быть реальный файловый объект, а не определённый пользователем класс, эмулирующий файл. Обратите внимание, что если существует правильно соответствующий скомпилированный файл (с суффиксом .pyc или .pyo), он будет использован вместо разбора данного исходного файла.

class imp.NullImporter(path_string)¶

Тип NullImporter – это хук импорта PEP 302, который обрабатывает строки пути, не являющиеся каталогами, и не находит ни одного модуля. Вызов этого типа с существующим каталогом или пустой строкой вызывает ImportError. В противном случае возвращается экземпляр NullImporter.

Python добавляет экземпляры этого типа в sys.path_importer_cache для любых записей пути, которые не являются каталогами и не обрабатываются никакими другими хуками путей в sys.path_hooks. Экземпляры имеют только один метод:

find_module(fullname[, path])¶

Этот метод всегда возвращает None, указывая, что запрошенный модуль не найден.

Новое в версии 2.5.

import imp
import sys

def __import__(name, globals=None, locals=None, fromlist=None):
    # Быстрый путь: проверить, импортирован ли модуль ранее.
    try:
        return sys.modules[name]
    except KeyError:
        pass

    # Если любой из следующих вызовов вызывает исключение,
    # возникает проблема, которую мы не можем обработать – пусть вызывающий код обработает её.

    fp, pathname, description = imp.find_module(name)

    try:
        return imp.load_module(name, fp, pathname, description)
    finally:
        # Так как возможен выход через исключение, необходимо явно закрыть fp.
        if fp:
            fp.close()