.. class:: zipimporter(archivepath)
- Create a new zipimporter instance. *archivepath* must be a path to a ZIP file.
+ 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 :file:`foo/bar.zip/lib` will look for modules in the :file:`lib` directory
+ inside the ZIP file :file:`foo/bar.zip` (provided that it exists).
+
:exc:`ZipImportError` is raised if *archivepath* doesn't point to a valid ZIP
archive.
- *archivepath* can also contain a path within the ZIP file -- the importer
- object will then look under that path instead of the ZIP file root. For
- example, an *archivepath* of :file:`foo/bar.zip/lib` will look for modules
- in the :file:`lib` directory inside the ZIP file :file:`foo/bar.zip`
- (provided that it exists).
-
-
.. method:: find_module(fullname[, path])
Search for a module specified by *fullname*. *fullname* must be the fully
.. attribute:: archive
- The file name of the importer's associated ZIP file.
+ The file name of the importer's associated ZIP file, without a possible
+ subpath.
.. attribute:: prefix
- The path within the ZIP file where modules are searched; see
- :class:`zipimporter` for details.
+ 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 :attr:`archive` and :attr:`prefix` attributes, when combined with a
+ slash, equal the original *archivepath* argument given to the
+ :class:`zipimporter` constructor.
.. _zipimport-examples:
z.close()
zi = zipimport.zipimporter(TEMP_ZIP)
+ self.assertEquals(zi.archive, TEMP_ZIP)
self.assertEquals(zi.is_package(TESTPACK), True)
zi.load_module(TESTPACK)
z.close()
os.remove(TEMP_ZIP)
+ def testZipImporterMethodsInSubDirectory(self):
+ packdir = TESTPACK + os.sep
+ packdir2 = packdir + TESTPACK2 + os.sep
+ files = {packdir2 + "__init__" + pyc_ext: (NOW, test_pyc),
+ packdir2 + TESTMOD + pyc_ext: (NOW, test_pyc)}
+
+ z = ZipFile(TEMP_ZIP, "w")
+ try:
+ for name, (mtime, data) in files.items():
+ zinfo = ZipInfo(name, time.localtime(mtime))
+ zinfo.compress_type = self.compression
+ z.writestr(zinfo, data)
+ z.close()
+
+ zi = zipimport.zipimporter(TEMP_ZIP + os.sep + packdir)
+ self.assertEquals(zi.archive, TEMP_ZIP)
+ self.assertEquals(zi.prefix, packdir)
+ self.assertEquals(zi.is_package(TESTPACK2), True)
+ zi.load_module(TESTPACK2)
+
+ self.assertEquals(zi.is_package(TESTPACK2 + os.sep + '__init__'), False)
+ self.assertEquals(zi.is_package(TESTPACK2 + os.sep + TESTMOD), False)
+
+ mod_name = TESTPACK2 + os.sep + TESTMOD
+ mod = __import__(module_path_to_dotted_name(mod_name))
+ self.assertEquals(zi.get_source(TESTPACK2), None)
+ self.assertEquals(zi.get_source(mod_name), None)
+ finally:
+ z.close()
+ os.remove(TEMP_ZIP)
+
def testGetData(self):
z = ZipFile(TEMP_ZIP, "w")
z.compression = self.compression
"zipimporter(archivepath) -> zipimporter object\n\
\n\
Create a new zipimporter instance. 'archivepath' must be a path to\n\
-a zipfile. ZipImportError is raised if 'archivepath' doesn't point to\n\
-a valid Zip archive.");
+a zipfile, or to a specific path inside a zipfile. For example, it can be\n\
+'/tmp/myimport.zip', or '/tmp/myimport.zip/mydirectory', if mydirectory is a\n\
+valid directory inside the archive.\n\
+\n\
+'ZipImportError is raised if 'archivepath' doesn't point to a valid Zip\n\
+archive.\n\
+\n\
+The 'archive' attribute of zipimporter objects contains the name of the\n\
+zipfile targeted.");
#define DEFERRED_ADDRESS(ADDR) 0