zipfile— Work with ZIP archives
New in version 1.6.
Source code: Lib/zipfile.py
The ZIP file format is a common archive and compression standard. This module provides tools to create, read, write, append, and list a ZIP file. Any advanced use of this module will require an understanding of the format, as defined in PKZIP Application Note.
This module does not currently handle multi-disk ZIP files. It can handle ZIP files that use the ZIP64 extensions (that is ZIP files that are more than 4 GByte in size). It supports decryption of encrypted files in ZIP archives, but it currently cannot create an encrypted file. Decryption is extremely slow as it is implemented in native Python rather than C.
The module defines the following items:
ZipFileobjects. Most users of the
zipfilemodule will not need to create these, but only use those created by this module. filename should be the full name of the archive member, and date_time should be a tuple containing six fields which describe the time of the last modification to the file; the fields are described in section ZipInfo Objects.
True if filename is a valid ZIP file based on its magic number,
False. filename may be a file or file-like object too.
Changed in version 2.7: Support for file and file-like objects.
zlibmodule. No other compression methods are currently supported.
ZipFile(file[, mode[, compression[, allowZip64]]])
Open a ZIP file, where file can be either a path to a file (a string) or a
file-like object. The mode parameter should be
'r' to read an existing
'w' to truncate and write a new file, or
'a' to append to an
existing file. If mode is
'a' and file refers to an existing ZIP
file, then additional files are added to it. If file does not refer to a
ZIP file, then a new ZIP archive is appended to the file. This is meant for
adding a ZIP archive to another file (such as
Changed in version 2.6: If mode is
a and the file does not exist at all, it is created.
compression is the ZIP compression method to use when writing the archive,
and should be
values will cause
RuntimeError to be raised. If
is specified but the
zlib module is not available,
is also raised. The default is
ZIP_STORED. If allowZip64 is
True zipfile will create ZIP files that use the ZIP64 extensions when
the zipfile is larger than 2 GB. If it is false (the default)
will raise an exception when the ZIP file would require ZIP64 extensions.
ZIP64 extensions are disabled by default because the default zip
and unzip commands on Unix (the InfoZIP utilities) don’t support
Changed in version 2.7.1: If the file is created with mode
'w' and then
closed without adding any files to the archive, the appropriate
ZIP structures for an empty archive will be written to the file.
with ZipFile('spam.zip', 'w') as myzip: myzip.write('eggs.txt')
New in version 2.7: Added the ability to use
ZipFile as a context manager.
close()before exiting your program or essential records will not be written.
ZipInfoobject with information about the archive member name. Calling
getinfo()for a name not currently contained in the archive will raise a
ZipInfoobject for each member of the archive. The objects are in the same order as their entries in the actual ZIP file on disk if an existing archive was opened.
Return a list of archive members by name.
open(name[, mode[, pwd]])
Extract a member from the archive as a file-like object (ZipExtFile). name is
the name of the file in the archive, or a
ZipInfo object. The mode
parameter, if included, must be one of the following:
'r' (the default),
'rU' will enable
support in the read-only object. pwd is the password used for encrypted files.
open() on a closed ZipFile will raise a
If the ZipFile was created by passing in a file-like object as the first
argument to the constructor, then the object returned by
open() shares the
ZipFile’s file pointer. Under these circumstances, the object returned by
open() should not be used after any additional operations are performed
on the ZipFile object. If the ZipFile was created by passing in a string (the
filename) as the first argument to the constructor, then
create a new file object that will be held by the ZipExtFile, allowing it to
operate independently of the ZipFile.
New in version 2.6.
extract(member[, path[, pwd]])
Extract a member from the archive to the current working directory; member
must be its full name or a
ZipInfo object). Its file information is
extracted as accurately as possible. path specifies a different directory
to extract to. member can be a filename or a
pwd is the password used for encrypted files.
Returns the normalized path created (a directory or new file).
New in version 2.6.
If a member filename is an absolute path, a drive/UNC sharepoint and
leading (back)slashes will be stripped, e.g.:
foo/bar on Unix, and
foo\bar on Windows.
".." components in a member filename will be removed, e.g.:
foo../ba..r. On Windows illegal
replaced by underscore (
extractall([path[, members[, pwd]]])
Extract all members from the archive to the current working directory. path
specifies a different directory to extract to. members is optional and must
be a subset of the list returned by
namelist(). pwd is the password
used for encrypted files.
Never extract archives from untrusted sources without prior inspection.
It is possible that files are created outside of path, e.g. members
that have absolute filenames starting with
"/" or filenames with two
Changed in version 2.7.4: The zipfile module attempts to prevent that. See
New in version 2.6.
Set pwd as default password to extract encrypted files.
New in version 2.6.
Return the bytes of the file name in the archive. name is the name of the
file in the archive, or a
ZipInfo object. The archive must be open for
read or append. pwd is the password used for encrypted files and, if specified,
it will override the default password set with
read() on a closed ZipFile will raise a
Changed in version 2.6: pwd was added, and name can now be a
testzip()on a closed ZipFile will raise a
write(filename[, arcname[, compress_type]])
Write the file named filename to the archive, giving it the archive name
arcname (by default, this will be the same as filename, but without a drive
letter and with leading path separators removed). If given, compress_type
overrides the value given for the compression parameter to the constructor for
the new entry. The archive must be open with mode
'a' – calling
write() on a ZipFile created with mode
'r' will raise a
write() on a closed ZipFile will raise a
There is no official file name encoding for ZIP files. If you have unicode file
names, you must convert them to byte strings in your desired encoding before
passing them to
write(). WinZip interprets all file names as encoded in
CP437, also known as DOS Latin.
Archive names should be relative to the archive root, that is, they should not start with a path separator.
arcname is not given) contains a null
byte, the name of the file in the archive will be truncated at the null byte.
writestr(zinfo_or_arcname, bytes[, compress_type])
Write the string bytes to the archive; zinfo_or_arcname is either the file
name it will be given in the archive, or a
ZipInfo instance. If it’s
an instance, at least the filename, date, and time must be given. If it’s a
name, the date and time is set to the current date and time. The archive must be
opened with mode
'a' – calling
writestr() on a ZipFile
created with mode
'r' will raise a
writestr() on a closed ZipFile will raise a
If given, compress_type overrides the value given for the compression
parameter to the constructor for the new entry, or in the zinfo_or_arcname
(if that is a
When passing a
ZipInfo instance as the zinfo_or_arcname parameter,
the compression method used will be that specified in the compress_type
member of the given
ZipInfo instance. By default, the
ZipInfo constructor sets this member to
Changed in version 2.7: The compress_type argument.
The following data attributes are also available:
0(the default, no output) to
3(the most output). Debugging information is written to
ZipFileinstance created with mode ‘a’ or ‘w’, this should be a string no longer than 65535 bytes. Comments longer than this will be truncated in the written archive when
Search for files
*.py and add the corresponding file to the archive.
The corresponding file is a
*.pyo file if available, else a
*.pyc file, compiling if necessary. If the pathname is a file, the
filename must end with
.py, and just the (corresponding
*.py[co]) file is added at the top level (no path information). If the
pathname is a file that does not end with
will be raised. If it is a directory, and the directory is not a package
directory, then all the files
*.py[co] are added at the top level. If
the directory is a package directory, then all
*.py[co] are added under
the package name as a file path, and if any subdirectories are package
directories, all of these are added recursively. basename is intended for
internal use only. The
writepy() method makes archives with file names
string.pyc # Top level name test/__init__.pyc # Package directory test/test_support.pyc # Module test.test_support test/bogus/__init__.pyc # Subpackage directory test/bogus/myfile.pyc # Submodule test.bogus.myfile
Instances have the following attributes:
The time and date of the last modification to the archive member. This is a tuple of six values:
Year (>= 1980)
Day of month (one-based)
The ZIP file format does not support timestamps before 1980.
zipfile module provides a simple command-line interface to interact
with ZIP archives.
If you want to create a new ZIP archive, specify its name after the
option and then list the filename(s) that should be included:
$ python -m zipfile -c monty.zip spam.txt eggs.txt
Passing a directory is also acceptable:
$ python -m zipfile -c monty.zip life-of-brian_1979/
If you want to extract a ZIP archive into the specified directory, use
$ python -m zipfile -e monty.zip target-dir/
For a list of the files in a ZIP archive, use the
$ python -m zipfile -l monty.zip
<zipfile> <source1> ... <sourceN>