zipimport — Импорт модулей из архивов ZIP

Исходный код: Lib/zipimport.py

Этот модуль добавляет возможность импортировать модули Python (*.py, *.pyc) и пакеты из архивов в формате ZIP. Обычно нет необходимости явно использовать модуль zipimport; он автоматически используется встроенным механизмом import для элементов sys.path, которые являются путями к архивам ZIP.

Обычно sys.path представляет собой список имён каталогов в виде строк. Этот модуль также позволяет элементу sys.path быть строкой, обозначающей архив ZIP. Архив ZIP может содержать структуру подкаталогов для поддержки импорта пакетов, и путь внутри архива может быть указан для импорта только из подкаталога. Например, путь example.zip/lib/ будет импортировать только из подкаталога lib/ внутри архива.

В архиве ZIP могут быть любые файлы, но импортеры вызываются только для файлов .py и .pyc. Импорт динамических модулей (.pyd, .so) из ZIP запрещён. Обратите внимание, что если архив содержит только .py файлы, Python не будет пытаться изменить архив, добавив соответствующий .pyc файл, что означает, что если архив ZIP не содержит .pyc файлы, импорт может быть довольно медленным.

Изменено в версии 3.8: Ранее архивы ZIP с комментариями не поддерживались.

См. также

PKZIP Application Note: Документация по формату файлов ZIP от Фила Кэтца, создателя формата и алгоритмов, используемых в нём.
PEP 273 — Импорт модулей из архивов ZIP: Написано Джеймсом К. Элстромом, который также предоставил реализацию. Python 2.3 следует спецификации в PEP 273, но использует реализацию, написанную Джастом ван Россумом, которая использует механизмы импорта, описанные в PEP 302.
PEP 302 — Новые механизмы импорта: PEP, добавивший механизмы импорта, которые помогают этому модулю работать.

Этот модуль определяет исключение:

exception zipimport.ZipImportError: Исключение, генерируемое объектами zipimporter. Это подкласс ImportError, поэтому его также можно перехватывать как ImportError.

Объекты zipimporter

zipimporter — класс для импорта файлов ZIP.

class zipimport.zipimporter(archivepath)

Создаёт новый экземпляр zipimporter. archivepath должен быть путём к файлу ZIP или к определённому пути внутри файла ZIP. Например, archivepath foo/bar.zip/lib будет искать модули в каталоге lib внутри файла ZIP foo/bar.zip (при условии, что он существует).

ZipImportError генерируется, если archivepath не указывает на действительный архив ZIP.

find_module(fullname[, path]): Ищет модуль, указанный параметром fullname. fullname должен быть полным (точкой разделяемым) именем модуля. Возвращает сам объект zipimporter, если модуль был найден, или None, если он не был найден. Дополнительный аргумент path игнорируется — он здесь для совместимости с протоколом импортера.

get_code(fullname): Возвращает объект кода для указанного модуля. Генерирует ZipImportError, если модуль не найден.

get_data(pathname): Возвращает данные, связанные с pathname. Генерирует OSError, если файл не найден.

Изменено в версии 3.3: IOError раньше генерировалось вместо OSError.

get_filename(fullname): Возвращает значение, которое __file__ будет установлено, если указанный модуль был импортирован. Генерирует ZipImportError, если модуль не найден.

Добавлена в версии 3.1.

get_source(fullname): Возвращает исходный код указанного модуля. Генерирует ZipImportError, если модуль не найден; возвращает None, если архив содержит модуль, но не содержит исходный код для него.

is_package(fullname): Возвращает True, если модуль, указанный параметром fullname, является пакетом. Генерирует ZipImportError, если модуль не найден.

load_module(fullname): Загружает модуль, указанный параметром fullname. fullname должен быть полным (точкой разделяемым) именем модуля. Возвращает импортированный модуль или генерирует ZipImportError, если он не был найден.

archive: Имя файла ZIP, связанного с импортером, без возможного подпути.

prefix: Подпуть внутри файла ZIP, в котором ищутся модули. Для объектов zipimporter, указывающих на корень файла ZIP, он пустой строкой.

Атрибуты archive и prefix, соединённые слешем, равны исходному аргументу archivepath, переданному конструктору zipimporter.

Примеры

Вот пример импорта модуля из архива ZIP — обратите внимание, что модуль zipimport не используется явно.

$ unzip -l example.zip
Archive:  example.zip
  Length     Date   Time    Name
 --------    ----   ----    ----
     8467  11-26-02 22:30   jwzthreading.py
 --------                   -------
     8467                   1 file
$ ./python
Python 2.3 (#1, Aug 1 2003, 19:54:32)
>>> import sys
>>> sys.path.insert(0, 'example.zip')  # Add .zip file to front of path
>>> import jwzthreading
>>> jwzthreading.__file__
'example.zip/jwzthreading.py'

© 2001–2022 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.9/library/zipimport.html