Name	Size	Mode	Actions
2to3.rst.txt	15898	0644	editdlrm
abc.rst.txt	11805	0644	editdlrm
aifc.rst.txt	7503	0644	editdlrm
allos.rst.txt	678	0644	editdlrm
archiving.rst.txt	440	0644	editdlrm
argparse.rst.txt	77480	0644	editdlrm
array.rst.txt	10812	0644	editdlrm
ast.rst.txt	10159	0644	editdlrm
asynchat.rst.txt	8528	0644	editdlrm
asyncio-dev.rst.txt	13398	0644	editdlrm
asyncio-eventloop.rst.txt	33701	0644	editdlrm
asyncio-eventloops.rst.txt	7660	0644	editdlrm
asyncio-protocol.rst.txt	25170	0644	editdlrm
asyncio-queue.rst.txt	4328	0644	editdlrm
asyncio-stream.rst.txt	14363	0644	editdlrm
asyncio-subprocess.rst.txt	15544	0644	editdlrm
asyncio-sync.rst.txt	9078	0644	editdlrm
asyncio-task.rst.txt	25406	0644	editdlrm
asyncio.rst.txt	2272	0644	editdlrm
asyncore.rst.txt	13624	0644	editdlrm
atexit.rst.txt	3669	0644	editdlrm
audioop.rst.txt	10712	0644	editdlrm
base64.rst.txt	10371	0644	editdlrm
bdb.rst.txt	12985	0644	editdlrm
binary.rst.txt	654	0644	editdlrm
binascii.rst.txt	6539	0644	editdlrm
binhex.rst.txt	1709	0644	editdlrm
bisect.rst.txt	5398	0644	editdlrm
builtins.rst.txt	1465	0644	editdlrm
bz2.rst.txt	8825	0644	editdlrm
calendar.rst.txt	10988	0644	editdlrm
cgi.rst.txt	22650	0644	editdlrm
cgitb.rst.txt	2918	0644	editdlrm
chunk.rst.txt	5094	0644	editdlrm
cmath.rst.txt	9326	0644	editdlrm
cmd.rst.txt	13795	0644	editdlrm
code.rst.txt	7817	0644	editdlrm
codecs.rst.txt	75564	0644	editdlrm
codeop.rst.txt	3021	0644	editdlrm
collections.abc.rst.txt	12861	0644	editdlrm
collections.rst.txt	46063	0644	editdlrm
colorsys.rst.txt	1820	0644	editdlrm
compileall.rst.txt	8975	0644	editdlrm
concurrency.rst.txt	673	0644	editdlrm
concurrent.futures.rst.txt	16910	0644	editdlrm
concurrent.rst.txt	171	0644	editdlrm
configparser.rst.txt	48756	0644	editdlrm
constants.rst.txt	3331	0644	editdlrm
contextlib.rst.txt	28175	0644	editdlrm
copy.rst.txt	3378	0644	editdlrm
copyreg.rst.txt	2182	0644	editdlrm
crypt.rst.txt	5122	0644	editdlrm
crypto.rst.txt	411	0644	editdlrm
csv.rst.txt	19902	0644	editdlrm
ctypes.rst.txt	88613	0644	editdlrm
curses.ascii.rst.txt	8920	0644	editdlrm
curses.panel.rst.txt	2764	0644	editdlrm
curses.rst.txt	76397	0644	editdlrm
custominterp.rst.txt	569	0644	editdlrm
datatypes.rst.txt	751	0644	editdlrm
datetime.rst.txt	90524	0644	editdlrm
dbm.rst.txt	14293	0644	editdlrm
debug.rst.txt	471	0644	editdlrm
decimal.rst.txt	74869	0644	editdlrm
development.rst.txt	704	0644	editdlrm
difflib.rst.txt	29861	0644	editdlrm
dis.rst.txt	32567	0644	editdlrm
distribution.rst.txt	452	0644	editdlrm
distutils.rst.txt	1974	0644	editdlrm
doctest.rst.txt	71743	0644	editdlrm
dummy_threading.rst.txt	784	0644	editdlrm
email.charset.rst.txt	9293	0644	editdlrm
email.compat32-message.rst.txt	33493	0644	editdlrm
email.contentmanager.rst.txt	9112	0644	editdlrm
email.encoders.rst.txt	2715	0644	editdlrm
email.errors.rst.txt	4792	0644	editdlrm
email.examples.rst.txt	1915	0644	editdlrm
email.generator.rst.txt	13637	0644	editdlrm
email.header.rst.txt	9188	0644	editdlrm
email.headerregistry.rst.txt	17957	0644	editdlrm
email.iterators.rst.txt	2795	0644	editdlrm
email.message.rst.txt	33008	0644	editdlrm
email.mime.rst.txt	11721	0644	editdlrm
email.parser.rst.txt	14092	0644	editdlrm
email.policy.rst.txt	27022	0644	editdlrm
email.rst.txt	6785	0644	editdlrm
email.util.rst.txt	9214	0644	editdlrm
ensurepip.rst.txt	4987	0644	editdlrm
enum.rst.txt	32751	0644	editdlrm
errno.rst.txt	6811	0644	editdlrm
exceptions.rst.txt	25570	0644	editdlrm
faulthandler.rst.txt	6136	0644	editdlrm
fcntl.rst.txt	7152	0644	editdlrm
filecmp.rst.txt	5623	0644	editdlrm
fileformats.rst.txt	287	0644	editdlrm
fileinput.rst.txt	8051	0644	editdlrm
filesys.rst.txt	961	0644	editdlrm
fnmatch.rst.txt	3103	0644	editdlrm
formatter.rst.txt	13242	0644	editdlrm
fpectl.rst.txt	4180	0644	editdlrm
fractions.rst.txt	6364	0644	editdlrm
frameworks.rst.txt	391	0644	editdlrm
ftplib.rst.txt	17552	0644	editdlrm
functional.rst.txt	365	0644	editdlrm
functions.rst.txt	71621	0644	editdlrm
functools.rst.txt	18503	0644	editdlrm
gc.rst.txt	9694	0644	editdlrm
getopt.rst.txt	6557	0644	editdlrm
getpass.rst.txt	1882	0644	editdlrm
gettext.rst.txt	25588	0644	editdlrm
glob.rst.txt	3508	0644	editdlrm
grp.rst.txt	2417	0644	editdlrm
gzip.rst.txt	8301	0644	editdlrm
hashlib.rst.txt	26523	0644	editdlrm
heapq.rst.txt	13402	0644	editdlrm
hmac.rst.txt	4020	0644	editdlrm
html.entities.rst.txt	1319	0644	editdlrm
html.parser.rst.txt	11275	0644	editdlrm
html.rst.txt	1304	0644	editdlrm
http.client.rst.txt	18870	0644	editdlrm
http.cookiejar.rst.txt	27832	0644	editdlrm
http.cookies.rst.txt	8645	0644	editdlrm
http.rst.txt	7096	0644	editdlrm
http.server.rst.txt	17639	0644	editdlrm
i18n.rst.txt	408	0644	editdlrm
idle.rst.txt	25834	0644	editdlrm
imaplib.rst.txt	20367	0644	editdlrm
imghdr.rst.txt	2938	0644	editdlrm
imp.rst.txt	15548	0644	editdlrm
importlib.rst.txt	53563	0644	editdlrm
index.rst.txt	2258	0644	editdlrm
inspect.rst.txt	53928	0644	editdlrm
internet.rst.txt	992	0644	editdlrm
intro.rst.txt	2645	0644	editdlrm
io.rst.txt	40328	0644	editdlrm
ipaddress.rst.txt	32340	0644	editdlrm
ipc.rst.txt	649	0644	editdlrm
itertools.rst.txt	38459	0644	editdlrm
json.rst.txt	27876	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	522	0644	editdlrm
linecache.rst.txt	2408	0644	editdlrm
locale.rst.txt	25470	0644	editdlrm
logging.config.rst.txt	33886	0644	editdlrm
logging.handlers.rst.txt	42497	0644	editdlrm
logging.rst.txt	60479	0644	editdlrm
lzma.rst.txt	17361	0644	editdlrm
macpath.rst.txt	707	0644	editdlrm
mailbox.rst.txt	63055	0644	editdlrm
mailcap.rst.txt	3691	0644	editdlrm
markup.rst.txt	679	0644	editdlrm
marshal.rst.txt	4855	0644	editdlrm
math.rst.txt	14375	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
misc.rst.txt	247	0644	editdlrm
mm.rst.txt	431	0644	editdlrm
mmap.rst.txt	11232	0644	editdlrm
modulefinder.rst.txt	3240	0644	editdlrm
modules.rst.txt	355	0644	editdlrm
msilib.rst.txt	18612	0644	editdlrm
msvcrt.rst.txt	4392	0644	editdlrm
multiprocessing.rst.txt	104494	0644	editdlrm
netdata.rst.txt	339	0644	editdlrm
netrc.rst.txt	3007	0644	editdlrm
nis.rst.txt	1993	0644	editdlrm
nntplib.rst.txt	21821	0644	editdlrm
numbers.rst.txt	8089	0644	editdlrm
numeric.rst.txt	696	0644	editdlrm
operator.rst.txt	18989	0644	editdlrm
optparse.rst.txt	76996	0644	editdlrm
os.path.rst.txt	16419	0644	editdlrm
os.rst.txt	137534	0644	editdlrm
ossaudiodev.rst.txt	17845	0644	editdlrm
othergui.rst.txt	2822	0644	editdlrm
parser.rst.txt	15148	0644	editdlrm
pathlib.rst.txt	30045	0644	editdlrm
pdb.rst.txt	19454	0644	editdlrm
persistence.rst.txt	591	0644	editdlrm
pickle.rst.txt	37440	0644	editdlrm
pickletools.rst.txt	3729	0644	editdlrm
pipes.rst.txt	2557	0644	editdlrm
pkgutil.rst.txt	8730	0644	editdlrm
platform.rst.txt	9624	0644	editdlrm
plistlib.rst.txt	7398	0644	editdlrm
poplib.rst.txt	8197	0644	editdlrm
posix.rst.txt	3694	0644	editdlrm
pprint.rst.txt	14274	0644	editdlrm
profile.rst.txt	27969	0644	editdlrm
pty.rst.txt	3123	0644	editdlrm
pwd.rst.txt	2739	0644	editdlrm
pyclbr.rst.txt	3297	0644	editdlrm
pydoc.rst.txt	4688	0644	editdlrm
pyexpat.rst.txt	28620	0644	editdlrm
python.rst.txt	475	0644	editdlrm
py_compile.rst.txt	3851	0644	editdlrm
queue.rst.txt	7268	0644	editdlrm
quopri.rst.txt	2571	0644	editdlrm
random.rst.txt	18503	0644	editdlrm
re.rst.txt	64936	0644	editdlrm
readline.rst.txt	11943	0644	editdlrm
reprlib.rst.txt	5162	0644	editdlrm
resource.rst.txt	12291	0644	editdlrm
rlcompleter.rst.txt	2294	0644	editdlrm
runpy.rst.txt	8285	0644	editdlrm
sched.rst.txt	4842	0644	editdlrm
secrets.rst.txt	5930	0644	editdlrm
select.rst.txt	28175	0644	editdlrm
selectors.rst.txt	8925	0644	editdlrm
shelve.rst.txt	8390	0644	editdlrm
shlex.rst.txt	16441	0644	editdlrm
shutil.rst.txt	26014	0644	editdlrm
signal.rst.txt	17218	0644	editdlrm
site.rst.txt	9628	0644	editdlrm
smtpd.rst.txt	10806	0644	editdlrm
smtplib.rst.txt	23439	0644	editdlrm
sndhdr.rst.txt	1994	0644	editdlrm
socket.rst.txt	68202	0644	editdlrm
socketserver.rst.txt	23712	0644	editdlrm
spwd.rst.txt	2958	0644	editdlrm
sqlite3.rst.txt	39215	0644	editdlrm
ssl.rst.txt	96021	0644	editdlrm
stat.rst.txt	9805	0644	editdlrm
statistics.rst.txt	15301	0644	editdlrm
stdtypes.rst.txt	179240	0644	editdlrm
string.rst.txt	35374	0644	editdlrm
stringprep.rst.txt	4279	0644	editdlrm
struct.rst.txt	19581	0644	editdlrm
subprocess.rst.txt	45793	0644	editdlrm
sunau.rst.txt	7390	0644	editdlrm
superseded.rst.txt	258	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	4964	0644	editdlrm
sys.rst.txt	58273	0644	editdlrm
sysconfig.rst.txt	8749	0644	editdlrm
syslog.rst.txt	4302	0644	editdlrm
tabnanny.rst.txt	2007	0644	editdlrm
tarfile.rst.txt	31749	0644	editdlrm
telnetlib.rst.txt	7899	0644	editdlrm
tempfile.rst.txt	13857	0644	editdlrm
termios.rst.txt	3751	0644	editdlrm
test.rst.txt	25764	0644	editdlrm
text.rst.txt	584	0644	editdlrm
textwrap.rst.txt	10519	0644	editdlrm
threading.rst.txt	39257	0644	editdlrm
time.rst.txt	32967	0644	editdlrm
timeit.rst.txt	13000	0644	editdlrm
tk.rst.txt	1639	0644	editdlrm
tkinter.rst.txt	33027	0644	editdlrm
tkinter.scrolledtext.rst.txt	1255	0644	editdlrm
tkinter.tix.rst.txt	22653	0644	editdlrm
tkinter.ttk.rst.txt	58489	0644	editdlrm
token.rst.txt	2607	0644	editdlrm
tokenize.rst.txt	10002	0644	editdlrm
trace.rst.txt	6914	0644	editdlrm
traceback.rst.txt	17854	0644	editdlrm
tracemalloc.rst.txt	22089	0644	editdlrm
tty.rst.txt	1097	0644	editdlrm
turtle.rst.txt	71221	0644	editdlrm
types.rst.txt	9999	0644	editdlrm
typing.rst.txt	34332	0644	editdlrm
undoc.rst.txt	780	0644	editdlrm
unicodedata.rst.txt	5762	0644	editdlrm
unittest.mock-examples.rst.txt	46206	0644	editdlrm
unittest.mock.rst.txt	85991	0644	editdlrm
unittest.rst.txt	93304	0644	editdlrm
unix.rst.txt	446	0644	editdlrm
urllib.error.rst.txt	2199	0644	editdlrm
urllib.parse.rst.txt	27332	0644	editdlrm
urllib.request.rst.txt	59360	0644	editdlrm
urllib.robotparser.rst.txt	2969	0644	editdlrm
urllib.rst.txt	466	0644	editdlrm
uu.rst.txt	2387	0644	editdlrm
uuid.rst.txt	8760	0644	editdlrm
venv.rst.txt	20621	0644	editdlrm
warnings.rst.txt	20152	0644	editdlrm
wave.rst.txt	6870	0644	editdlrm
weakref.rst.txt	21328	0644	editdlrm
webbrowser.rst.txt	9783	0644	editdlrm
windows.rst.txt	272	0644	editdlrm
winreg.rst.txt	24073	0644	editdlrm
winsound.rst.txt	5134	0644	editdlrm
wsgiref.rst.txt	33047	0644	editdlrm
xdrlib.rst.txt	8078	0644	editdlrm
xml.dom.minidom.rst.txt	10198	0644	editdlrm
xml.dom.pulldom.rst.txt	5186	0644	editdlrm
xml.dom.rst.txt	39507	0644	editdlrm
xml.etree.elementtree.rst.txt	43871	0644	editdlrm
xml.rst.txt	6071	0644	editdlrm
xml.sax.handler.rst.txt	15399	0644	editdlrm
xml.sax.reader.rst.txt	12133	0644	editdlrm
xml.sax.rst.txt	7159	0644	editdlrm
xml.sax.utils.rst.txt	3901	0644	editdlrm
xmlrpc.client.rst.txt	23071	0644	editdlrm
xmlrpc.rst.txt	475	0644	editdlrm
xmlrpc.server.rst.txt	14990	0644	editdlrm
zipapp.rst.txt	17392	0644	editdlrm
zipfile.rst.txt	24005	0644	editdlrm
zipimport.rst.txt	5805	0644	editdlrm
zlib.rst.txt	13912	0644	editdlrm
_dummy_thread.rst.txt	762	0644	editdlrm
_thread.rst.txt	6886	0644	editdlrm
__future__.rst.txt	5245	0644	editdlrm
__main__.rst.txt	904	0644	editdlrm

:mod:`zipfile` --- Work with ZIP archives ========================================= .. module:: zipfile :synopsis: Read and write ZIP-format archive files. .. moduleauthor:: James C. Ahlstrom .. sectionauthor:: James C. Ahlstrom **Source code:** :source:`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 GiB 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: .. exception:: BadZipFile The error raised for bad ZIP files. .. versionadded:: 3.2 .. exception:: BadZipfile Alias of :exc:`BadZipFile`, for compatibility with older Python versions. .. deprecated:: 3.2 .. exception:: LargeZipFile The error raised when a ZIP file would require ZIP64 functionality but that has not been enabled. .. class:: ZipFile :noindex: The class for reading and writing ZIP files. See section :ref:`zipfile-objects` for constructor details. .. class:: PyZipFile :noindex: Class for creating ZIP archives containing Python libraries. .. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0)) Class used to represent information about a member of an archive. Instances of this class are returned by the :meth:`.getinfo` and :meth:`.infolist` methods of :class:`ZipFile` objects. Most users of the :mod:`zipfile` module 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 :ref:`zipinfo-objects`. .. function:: is_zipfile(filename) Returns ``True`` if *filename* is a valid ZIP file based on its magic number, otherwise returns ``False``. *filename* may be a file or file-like object too. .. versionchanged:: 3.1 Support for file and file-like objects. .. data:: ZIP_STORED The numeric constant for an uncompressed archive member. .. data:: ZIP_DEFLATED The numeric constant for the usual ZIP compression method. This requires the :mod:`zlib` module. .. data:: ZIP_BZIP2 The numeric constant for the BZIP2 compression method. This requires the :mod:`bz2` module. .. versionadded:: 3.3 .. data:: ZIP_LZMA The numeric constant for the LZMA compression method. This requires the :mod:`lzma` module. .. versionadded:: 3.3 .. note:: The ZIP file format specification has included support for bzip2 compression since 2001, and for LZMA compression since 2006. However, some tools (including older Python releases) do not support these compression methods, and may either refuse to process the ZIP file altogether, or fail to extract individual files. .. seealso:: `PKZIP Application Note`_ Documentation on the ZIP file format by Phil Katz, the creator of the format and algorithms used. `Info-ZIP Home Page `_ Information about the Info-ZIP project's ZIP archive programs and development libraries. .. _zipfile-objects: ZipFile Objects --------------- .. class:: ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True) Open a ZIP file, where *file* can be a path to a file (a string), a file-like object or a :term:`path-like object`. The *mode* parameter should be ``'r'`` to read an existing file, ``'w'`` to truncate and write a new file, ``'a'`` to append to an existing file, or ``'x'`` to exclusively create and write a new file. If *mode* is ``'x'`` and *file* refers to an existing file, a :exc:`FileExistsError` will be raised. 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 :file:`python.exe`). If *mode* is ``'a'`` and the file does not exist at all, it is created. If *mode* is ``'r'`` or ``'a'``, the file should be seekable. *compression* is the ZIP compression method to use when writing the archive, and should be :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or :const:`ZIP_LZMA`; unrecognized values will cause :exc:`NotImplementedError` to be raised. If :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or :const:`ZIP_LZMA` is specified but the corresponding module (:mod:`zlib`, :mod:`bz2` or :mod:`lzma`) is not available, :exc:`RuntimeError` is raised. The default is :const:`ZIP_STORED`. If *allowZip64* is ``True`` (the default) zipfile will create ZIP files that use the ZIP64 extensions when the zipfile is larger than 4 GiB. If it is false :mod:`zipfile` will raise an exception when the ZIP file would require ZIP64 extensions. If the file is created with mode ``'w'``, ``'x'`` or ``'a'`` and then :meth:`closed ` without adding any files to the archive, the appropriate ZIP structures for an empty archive will be written to the file. ZipFile is also a context manager and therefore supports the :keyword:`with` statement. In the example, *myzip* is closed after the :keyword:`with` statement's suite is finished---even if an exception occurs:: with ZipFile('spam.zip', 'w') as myzip: myzip.write('eggs.txt') .. versionadded:: 3.2 Added the ability to use :class:`ZipFile` as a context manager. .. versionchanged:: 3.3 Added support for :mod:`bzip2 ` and :mod:`lzma` compression. .. versionchanged:: 3.4 ZIP64 extensions are enabled by default. .. versionchanged:: 3.5 Added support for writing to unseekable streams. Added support for the ``'x'`` mode. .. versionchanged:: 3.6 Previously, a plain :exc:`RuntimeError` was raised for unrecognized compression values. .. versionchanged:: 3.6.2 The *file* parameter accepts a :term:`path-like object`. .. method:: ZipFile.close() Close the archive file. You must call :meth:`close` before exiting your program or essential records will not be written. .. method:: ZipFile.getinfo(name) Return a :class:`ZipInfo` object with information about the archive member *name*. Calling :meth:`getinfo` for a name not currently contained in the archive will raise a :exc:`KeyError`. .. method:: ZipFile.infolist() Return a list containing a :class:`ZipInfo` object 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. .. method:: ZipFile.namelist() Return a list of archive members by name. .. method:: ZipFile.open(name, mode='r', pwd=None, *, force_zip64=False) Access a member of the archive as a binary file-like object. *name* can be either the name of a file within the archive or a :class:`ZipInfo` object. The *mode* parameter, if included, must be ``'r'`` (the default) or ``'w'``. *pwd* is the password used to decrypt encrypted ZIP files. :meth:`~ZipFile.open` is also a context manager and therefore supports the :keyword:`with` statement:: with ZipFile('spam.zip') as myzip: with myzip.open('eggs.txt') as myfile: print(myfile.read()) With *mode* ``'r'`` the file-like object (``ZipExtFile``) is read-only and provides the following methods: :meth:`~io.BufferedIOBase.read`, :meth:`~io.IOBase.readline`, :meth:`~io.IOBase.readlines`, :meth:`__iter__`, :meth:`~iterator.__next__`. These objects can operate independently of the ZipFile. With ``mode='w'``, a writable file handle is returned, which supports the :meth:`~io.BufferedIOBase.write` method. While a writable file handle is open, attempting to read or write other files in the ZIP file will raise a :exc:`ValueError`. When writing a file, if the file size is not known in advance but may exceed 2 GiB, pass ``force_zip64=True`` to ensure that the header format is capable of supporting large files. If the file size is known in advance, construct a :class:`ZipInfo` object with :attr:`~ZipInfo.file_size` set, and use that as the *name* parameter. .. note:: The :meth:`.open`, :meth:`read` and :meth:`extract` methods can take a filename or a :class:`ZipInfo` object. You will appreciate this when trying to read a ZIP file that contains members with duplicate names. .. versionchanged:: 3.6 Removed support of ``mode='U'``. Use :class:`io.TextIOWrapper` for reading compressed text files in :term:`universal newlines` mode. .. versionchanged:: 3.6 :meth:`open` can now be used to write files into the archive with the ``mode='w'`` option. .. versionchanged:: 3.6 Calling :meth:`.open` on a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. method:: ZipFile.extract(member, path=None, pwd=None) Extract a member from the archive to the current working directory; *member* must be its full name or a :class:`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 :class:`ZipInfo` object. *pwd* is the password used for encrypted files. Returns the normalized path created (a directory or new file). .. note:: If a member filename is an absolute path, a drive/UNC sharepoint and leading (back)slashes will be stripped, e.g.: ``///foo/bar`` becomes ``foo/bar`` on Unix, and ``C:\foo\bar`` becomes ``foo\bar`` on Windows. And all ``".."`` components in a member filename will be removed, e.g.: ``../../foo../../ba..r`` becomes ``foo../ba..r``. On Windows illegal characters (``:``, ``<``, ``>``, ``|``, ``"``, ``?``, and ``*``) replaced by underscore (``_``). .. versionchanged:: 3.6 Calling :meth:`extract` on a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. versionchanged:: 3.6.2 The *path* parameter accepts a :term:`path-like object`. .. method:: ZipFile.extractall(path=None, members=None, pwd=None) 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 :meth:`namelist`. *pwd* is the password used for encrypted files. .. warning:: 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 dots ``".."``. This module attempts to prevent that. See :meth:`extract` note. .. versionchanged:: 3.6 Calling :meth:`extractall` on a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. versionchanged:: 3.6.2 The *path* parameter accepts a :term:`path-like object`. .. method:: ZipFile.printdir() Print a table of contents for the archive to ``sys.stdout``. .. method:: ZipFile.setpassword(pwd) Set *pwd* as default password to extract encrypted files. .. method:: ZipFile.read(name, pwd=None) Return the bytes of the file *name* in the archive. *name* is the name of the file in the archive, or a :class:`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 :meth:`setpassword`. Calling :meth:`read` on a ZipFile that uses a compression method other than :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or :const:`ZIP_LZMA` will raise a :exc:`NotImplementedError`. An error will also be raised if the corresponding compression module is not available. .. versionchanged:: 3.6 Calling :meth:`read` on a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. method:: ZipFile.testzip() Read all the files in the archive and check their CRC's and file headers. Return the name of the first bad file, or else return ``None``. .. versionchanged:: 3.6 Calling :meth:`testfile` on a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. method:: ZipFile.write(filename, arcname=None, compress_type=None) 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 ``'w'``, ``'x'`` or ``'a'``. .. note:: 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 :meth:`write`. WinZip interprets all file names as encoded in CP437, also known as DOS Latin. .. note:: Archive names should be relative to the archive root, that is, they should not start with a path separator. .. note:: If ``arcname`` (or ``filename``, if ``arcname`` is not given) contains a null byte, the name of the file in the archive will be truncated at the null byte. .. versionchanged:: 3.6 Calling :meth:`write` on a ZipFile created with mode ``'r'`` or a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. .. method:: ZipFile.writestr(zinfo_or_arcname, data[, compress_type]) Write the string *data* to the archive; *zinfo_or_arcname* is either the file name it will be given in the archive, or a :class:`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 ``'w'``, ``'x'`` or ``'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 :class:`ZipInfo` instance). .. note:: When passing a :class:`ZipInfo` instance as the *zinfo_or_arcname* parameter, the compression method used will be that specified in the *compress_type* member of the given :class:`ZipInfo` instance. By default, the :class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`. .. versionchanged:: 3.2 The *compress_type* argument. .. versionchanged:: 3.6 Calling :meth:`writestr` on a ZipFile created with mode ``'r'`` or a closed ZipFile will raise a :exc:`ValueError`. Previously, a :exc:`RuntimeError` was raised. The following data attributes are also available: .. attribute:: ZipFile.filename Name of the ZIP file. .. attribute:: ZipFile.debug The level of debug output to use. This may be set from ``0`` (the default, no output) to ``3`` (the most output). Debugging information is written to ``sys.stdout``. .. attribute:: ZipFile.comment The comment text associated with the ZIP file. If assigning a comment to a :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, this should be a string no longer than 65535 bytes. Comments longer than this will be truncated in the written archive when :meth:`close` is called. .. _pyzipfile-objects: PyZipFile Objects ----------------- The :class:`PyZipFile` constructor takes the same parameters as the :class:`ZipFile` constructor, and one additional parameter, *optimize*. .. class:: PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, \ optimize=-1) .. versionadded:: 3.2 The *optimize* parameter. .. versionchanged:: 3.4 ZIP64 extensions are enabled by default. Instances have one method in addition to those of :class:`ZipFile` objects: .. method:: PyZipFile.writepy(pathname, basename='', filterfunc=None) Search for files :file:`\*.py` and add the corresponding file to the archive. If the *optimize* parameter to :class:`PyZipFile` was not given or ``-1``, the corresponding file is a :file:`\*.pyc` file, compiling if necessary. If the *optimize* parameter to :class:`PyZipFile` was ``0``, ``1`` or ``2``, only files with that optimization level (see :func:`compile`) are added to the archive, compiling if necessary. If *pathname* is a file, the filename must end with :file:`.py`, and just the (corresponding :file:`\*.pyc`) file is added at the top level (no path information). If *pathname* is a file that does not end with :file:`.py`, a :exc:`RuntimeError` will be raised. If it is a directory, and the directory is not a package directory, then all the files :file:`\*.pyc` are added at the top level. If the directory is a package directory, then all :file:`\*.pyc` 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. *filterfunc*, if given, must be a function taking a single string argument. It will be passed each path (including each individual full file path) before it is added to the archive. If *filterfunc* returns a false value, the path will not be added, and if it is a directory its contents will be ignored. For example, if our test files are all either in ``test`` directories or start with the string ``test_``, we can use a *filterfunc* to exclude them:: >>> zf = PyZipFile('myprog.zip') >>> def notests(s): ... fn = os.path.basename(s) ... return (not (fn == 'test' or fn.startswith('test_'))) >>> zf.writepy('myprog', filterfunc=notests) The :meth:`writepy` method makes archives with file names like this:: string.pyc # Top level name test/__init__.pyc # Package directory test/testall.pyc # Module test.testall test/bogus/__init__.pyc # Subpackage directory test/bogus/myfile.pyc # Submodule test.bogus.myfile .. versionadded:: 3.4 The *filterfunc* parameter. .. versionchanged:: 3.6.2 The *pathname* parameter accepts a :term:`path-like object`. .. _zipinfo-objects: ZipInfo Objects --------------- Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` and :meth:`.infolist` methods of :class:`ZipFile` objects. Each object stores information about a single member of the ZIP archive. There is one classmethod to make a :class:`ZipInfo` instance for a filesystem file: .. classmethod:: ZipInfo.from_file(filename, arcname=None) Construct a :class:`ZipInfo` instance for a file on the filesystem, in preparation for adding it to a zip file. *filename* should be the path to a file or directory on the filesystem. If *arcname* is specified, it is used as the name within the archive. If *arcname* is not specified, the name will be the same as *filename*, but with any drive letter and leading path separators removed. .. versionadded:: 3.6 .. versionchanged:: 3.6.2 The *filename* parameter accepts a :term:`path-like object`. Instances have the following methods and attributes: .. method:: ZipInfo.is_dir() Return ``True`` if this archive member is a directory. This uses the entry's name: directories should always end with ``/``. .. versionadded:: 3.6 .. attribute:: ZipInfo.filename Name of the file in the archive. .. attribute:: ZipInfo.date_time The time and date of the last modification to the archive member. This is a tuple of six values: +-------+--------------------------+ | Index | Value | +=======+==========================+ | ``0`` | Year (>= 1980) | +-------+--------------------------+ | ``1`` | Month (one-based) | +-------+--------------------------+ | ``2`` | Day of month (one-based) | +-------+--------------------------+ | ``3`` | Hours (zero-based) | +-------+--------------------------+ | ``4`` | Minutes (zero-based) | +-------+--------------------------+ | ``5`` | Seconds (zero-based) | +-------+--------------------------+ .. note:: The ZIP file format does not support timestamps before 1980. .. attribute:: ZipInfo.compress_type Type of compression for the archive member. .. attribute:: ZipInfo.comment Comment for the individual archive member. .. attribute:: ZipInfo.extra Expansion field data. The `PKZIP Application Note`_ contains some comments on the internal structure of the data contained in this string. .. attribute:: ZipInfo.create_system System which created ZIP archive. .. attribute:: ZipInfo.create_version PKZIP version which created ZIP archive. .. attribute:: ZipInfo.extract_version PKZIP version needed to extract archive. .. attribute:: ZipInfo.reserved Must be zero. .. attribute:: ZipInfo.flag_bits ZIP flag bits. .. attribute:: ZipInfo.volume Volume number of file header. .. attribute:: ZipInfo.internal_attr Internal attributes. .. attribute:: ZipInfo.external_attr External file attributes. .. attribute:: ZipInfo.header_offset Byte offset to the file header. .. attribute:: ZipInfo.CRC CRC-32 of the uncompressed file. .. attribute:: ZipInfo.compress_size Size of the compressed data. .. attribute:: ZipInfo.file_size Size of the uncompressed file. .. _zipfile-commandline: .. program:: zipfile Command-Line Interface ---------------------- The :mod:`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:`-c` option and then list the filename(s) that should be included: .. code-block:: shell-session $ python -m zipfile -c monty.zip spam.txt eggs.txt Passing a directory is also acceptable: .. code-block:: shell-session $ python -m zipfile -c monty.zip life-of-brian_1979/ If you want to extract a ZIP archive into the specified directory, use the :option:`-e` option: .. code-block:: shell-session $ python -m zipfile -e monty.zip target-dir/ For a list of the files in a ZIP archive, use the :option:`-l` option: .. code-block:: shell-session $ python -m zipfile -l monty.zip Command-line options ~~~~~~~~~~~~~~~~~~~~ .. cmdoption:: -l List files in a zipfile. .. cmdoption:: -c ... Create zipfile from source files. .. cmdoption:: -e Extract zipfile into target directory. .. cmdoption:: -t Test whether the zipfile is valid or not. .. _PKZIP Application Note: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT