Source code:
———
This module adds the ability to import Python modules (*.py, *.pyc) and packages from ZIP-format archives. It is usually not needed to use the zipimport module explicitly; it is automatically used by the built-in
mechanism for
items that are paths to ZIP archives.
Typically,
is a list of directory names as strings. This module also allows an item of sys.path to be a string naming a ZIP file archive. The ZIP archive can contain a subdirectory structure to support package imports, and a path within the archive can be specified to only import from a subdirectory. For example, the path example.zip/lib/ would only import from the lib/ subdirectory within the archive.
Any files may be present in the ZIP archive, but importers are only invoked for .py and .pyc files. ZIP import of dynamic modules (.pyd, .so) is disallowed. Note that if an archive only contains .py files, Python will not attempt to modify the archive by adding the corresponding .pyc file, meaning that if a ZIP archive doesn’t contain .pyc files, importing may be rather slow.
Changed in version 3.13: ZIP64 is supported
Changed in version 3.8: Previously, ZIP archives with an archive comment were not supported.
See also
Documentation on the ZIP file format by Phil Katz, the creator of the format and algorithms used.
- Import Modules from Zip ArchivesWritten by James C. Ahlstrom, who also provided an implementation. Python 2.3 follows the specification in
, but uses an implementation written by Just van Rossum that uses the import hooks described in
.
- The implementation of the import machineryPackage providing the relevant protocols for all importers to implement.
This module defines an exception:
exceptionzipimport.ZipImportError
Exception raised by zipimporter objects. It’s a subclass of
, so it can be caught as ImportError, too.
zipimporter Objects
is the class for importing ZIP files.
classzipimport.zipimporter(archivepath)
Create a new zipimporter instance. archivepath must be a path to a ZIP file, or to a specific path within a ZIP file. For example, an archivepath of foo/bar.zip/lib will look for modules in the lib directory inside the ZIP file foo/bar.zip (provided that it exists).
is raised if archivepath doesn’t point to a valid ZIP archive.
Changed in version 3.12: Methods find_loader() and find_module(), deprecated in 3.10 are now removed. Use
instead.
create_module(spec)
Implementation of
importlib.abc.Loader.create_module()
that returns
to explicitly request the default semantics.
Added in version 3.10.
exec_module(module)
Implementation of
importlib.abc.Loader.exec_module()
.
Added in version 3.10.
find_spec(fullname, target=None)
An implementation of
importlib.abc.PathEntryFinder.find_spec()
.
Added in version 3.10.
get_code(fullname)
Return the code object for the specified module. Raise
if the module couldn’t be imported.
get_data(pathname)
Return the data associated with pathname. Raise
if the file wasn’t found.
Changed in version 3.3:
used to be raised, it is now an alias of
.
get_filename(fullname)
Return the value __file__ would be set to if the specified module was imported. Raise
if the module couldn’t be imported.
Added in version 3.1.
get_source(fullname)
Return the source code for the specified module. Raise
if the module couldn’t be found, return
if the archive does contain the module, but has no source for it.
is_package(fullname)
Return True if the module specified by fullname is a package. Raise
if the module couldn’t be found.
load_module(fullname)
Load the module specified by fullname. fullname must be the fully qualified (dotted) module name. Returns the imported module on success, raises
on failure.
Deprecated since version 3.10, will be removed in version 3.15: Use
instead.
invalidate_caches()
Clear out the internal cache of information about files found within the ZIP archive.
Added in version 3.10.
archive
The file name of the importer’s associated ZIP file, without a possible subpath.
prefix
The subpath within the ZIP file where modules are searched. This is the empty string for zipimporter objects which point to the root of the ZIP file.
The
and
attributes, when combined with a slash, equal the original archivepath argument given to the zipimporter constructor.
Examples
Here is an example that imports a module from a ZIP archive - note that the zipimport module is not explicitly used.
$ unzip-lexample_archive.zip Archive: example_archive.zip Length Date Time Name -------- ---- ---- ---- 8467 01-01-00 12:30 example.py -------- ------- 8467 1 file>>> importsys>>> # Add the archive to the front of the module search path>>> sys.path.insert(0,'example_archive.zip')>>> importexample>>> example.__file__'example_archive.zip/example.py'