Name	Size	Mode	Actions
2to3.rst.txt	14647	0644	editdlrm
abc.rst.txt	7219	0644	editdlrm
aepack.rst.txt	4257	0644	editdlrm
aetools.rst.txt	3532	0644	editdlrm
aetypes.rst.txt	4257	0644	editdlrm
aifc.rst.txt	7086	0644	editdlrm
al.rst.txt	5309	0644	editdlrm
allos.rst.txt	695	0644	editdlrm
anydbm.rst.txt	4111	0644	editdlrm
archiving.rst.txt	424	0644	editdlrm
argparse.rst.txt	74685	0644	editdlrm
array.rst.txt	10524	0644	editdlrm
ast.rst.txt	10111	0644	editdlrm
asynchat.rst.txt	9206	0644	editdlrm
asyncore.rst.txt	12937	0644	editdlrm
atexit.rst.txt	3910	0644	editdlrm
audioop.rst.txt	10395	0644	editdlrm
autogil.rst.txt	1015	0644	editdlrm
base64.rst.txt	6252	0644	editdlrm
basehttpserver.rst.txt	10404	0644	editdlrm
bastion.rst.txt	2611	0644	editdlrm
bdb.rst.txt	12456	0644	editdlrm
binascii.rst.txt	6508	0644	editdlrm
binhex.rst.txt	1910	0644	editdlrm
bisect.rst.txt	5415	0644	editdlrm
bsddb.rst.txt	7575	0644	editdlrm
bz2.rst.txt	8064	0644	editdlrm
calendar.rst.txt	11282	0644	editdlrm
carbon.rst.txt	15956	0644	editdlrm
cd.rst.txt	11974	0644	editdlrm
cgi.rst.txt	22853	0644	editdlrm
cgihttpserver.rst.txt	2788	0644	editdlrm
cgitb.rst.txt	2874	0644	editdlrm
chunk.rst.txt	4955	0644	editdlrm
cmath.rst.txt	7647	0644	editdlrm
cmd.rst.txt	8565	0644	editdlrm
code.rst.txt	7115	0644	editdlrm
codecs.rst.txt	66966	0644	editdlrm
codeop.rst.txt	3774	0644	editdlrm
collections.rst.txt	41448	0644	editdlrm
colorpicker.rst.txt	913	0644	editdlrm
colorsys.rst.txt	1819	0644	editdlrm
commands.rst.txt	2595	0644	editdlrm
compileall.rst.txt	4678	0644	editdlrm
compiler.rst.txt	37464	0644	editdlrm
configparser.rst.txt	19607	0644	editdlrm
constants.rst.txt	2328	0644	editdlrm
contextlib.rst.txt	6012	0644	editdlrm
cookie.rst.txt	9543	0644	editdlrm
cookielib.rst.txt	27875	0644	editdlrm
copy.rst.txt	3351	0644	editdlrm
copy_reg.rst.txt	2329	0644	editdlrm
crypt.rst.txt	2292	0644	editdlrm
crypto.rst.txt	355	0644	editdlrm
csv.rst.txt	22757	0644	editdlrm
ctypes.rst.txt	90513	0644	editdlrm
curses.ascii.rst.txt	9046	0644	editdlrm
curses.panel.rst.txt	2740	0644	editdlrm
curses.rst.txt	74877	0644	editdlrm
custominterp.rst.txt	570	0644	editdlrm
datatypes.rst.txt	864	0644	editdlrm
datetime.rst.txt	74679	0644	editdlrm
dbhash.rst.txt	3865	0644	editdlrm
dbm.rst.txt	3117	0644	editdlrm
debug.rst.txt	446	0644	editdlrm
decimal.rst.txt	70926	0644	editdlrm
development.rst.txt	640	0644	editdlrm
difflib.rst.txt	30716	0644	editdlrm
dircache.rst.txt	1813	0644	editdlrm
dis.rst.txt	23248	0644	editdlrm
distribution.rst.txt	426	0644	editdlrm
distutils.rst.txt	1958	0644	editdlrm
dl.rst.txt	3392	0644	editdlrm
doctest.rst.txt	73985	0644	editdlrm
docxmlrpcserver.rst.txt	3802	0644	editdlrm
dumbdbm.rst.txt	2841	0644	editdlrm
dummy_thread.rst.txt	1058	0644	editdlrm
dummy_threading.rst.txt	799	0644	editdlrm
easydialogs.rst.txt	10346	0644	editdlrm
email-examples.rst.txt	1271	0644	editdlrm
email.charset.rst.txt	9654	0644	editdlrm
email.encoders.rst.txt	2376	0644	editdlrm
email.errors.rst.txt	4006	0644	editdlrm
email.generator.rst.txt	6132	0644	editdlrm
email.header.rst.txt	7531	0644	editdlrm
email.iterators.rst.txt	2421	0644	editdlrm
email.message.rst.txt	25217	0644	editdlrm
email.mime.rst.txt	9917	0644	editdlrm
email.parser.rst.txt	10327	0644	editdlrm
email.rst.txt	16111	0644	editdlrm
email.utils.rst.txt	6475	0644	editdlrm
ensurepip.rst.txt	5022	0644	editdlrm
errno.rst.txt	6708	0644	editdlrm
exceptions.rst.txt	18343	0644	editdlrm
fcntl.rst.txt	7361	0644	editdlrm
filecmp.rst.txt	5348	0644	editdlrm
fileformats.rst.txt	302	0644	editdlrm
fileinput.rst.txt	7417	0644	editdlrm
filesys.rst.txt	806	0644	editdlrm
fl.rst.txt	17646	0644	editdlrm
fm.rst.txt	2699	0644	editdlrm
fnmatch.rst.txt	3104	0644	editdlrm
formatter.rst.txt	13245	0644	editdlrm
fpectl.rst.txt	4171	0644	editdlrm
fpformat.rst.txt	1747	0644	editdlrm
fractions.rst.txt	5297	0644	editdlrm
framework.rst.txt	11444	0644	editdlrm
frameworks.rst.txt	378	0644	editdlrm
ftplib.rst.txt	15720	0644	editdlrm
functions.rst.txt	75554	0644	editdlrm
functools.rst.txt	7448	0644	editdlrm
future_builtins.rst.txt	2010	0644	editdlrm
gc.rst.txt	9014	0644	editdlrm
gdbm.rst.txt	4882	0644	editdlrm
gensuitemodule.rst.txt	3113	0644	editdlrm
getopt.rst.txt	6670	0644	editdlrm
getpass.rst.txt	1876	0644	editdlrm
gettext.rst.txt	29040	0644	editdlrm
gl.rst.txt	6009	0644	editdlrm
glob.rst.txt	2414	0644	editdlrm
grp.rst.txt	2256	0644	editdlrm
gzip.rst.txt	4828	0644	editdlrm
hashlib.rst.txt	7379	0644	editdlrm
heapq.rst.txt	13185	0644	editdlrm
hmac.rst.txt	3073	0644	editdlrm
hotshot.rst.txt	4289	0644	editdlrm
htmllib.rst.txt	7379	0644	editdlrm
htmlparser.rst.txt	11640	0644	editdlrm
httplib.rst.txt	37454	0644	editdlrm
i18n.rst.txt	409	0644	editdlrm
ic.rst.txt	5005	0644	editdlrm
idle.rst.txt	22182	0644	editdlrm
imageop.rst.txt	4001	0644	editdlrm
imaplib.rst.txt	17221	0644	editdlrm
imgfile.rst.txt	2765	0644	editdlrm
imghdr.rst.txt	2635	0644	editdlrm
imp.rst.txt	12593	0644	editdlrm
importlib.rst.txt	1126	0644	editdlrm
imputil.rst.txt	7023	0644	editdlrm
index.rst.txt	2287	0644	editdlrm
inspect.rst.txt	28151	0644	editdlrm
internet.rst.txt	950	0644	editdlrm
intro.rst.txt	2803	0644	editdlrm
io.rst.txt	39015	0644	editdlrm
ipc.rst.txt	630	0644	editdlrm
itertools.rst.txt	36324	0644	editdlrm
jpeg.rst.txt	3858	0644	editdlrm
json.rst.txt	25545	0644	editdlrm
keyword.rst.txt	617	0644	editdlrm
language.rst.txt	523	0644	editdlrm
linecache.rst.txt	1887	0644	editdlrm
locale.rst.txt	24975	0644	editdlrm
logging.config.rst.txt	31560	0644	editdlrm
logging.handlers.rst.txt	28153	0644	editdlrm
logging.rst.txt	46882	0644	editdlrm
mac.rst.txt	791	0644	editdlrm
macos.rst.txt	3824	0644	editdlrm
macosa.rst.txt	3964	0644	editdlrm
macostools.rst.txt	4017	0644	editdlrm
macpath.rst.txt	650	0644	editdlrm
mailbox.rst.txt	68129	0644	editdlrm
mailcap.rst.txt	3675	0644	editdlrm
markup.rst.txt	1249	0644	editdlrm
marshal.rst.txt	5689	0644	editdlrm
math.rst.txt	10920	0644	editdlrm
md5.rst.txt	2815	0644	editdlrm
mhlib.rst.txt	3966	0644	editdlrm
mimetools.rst.txt	4504	0644	editdlrm
mimetypes.rst.txt	9839	0644	editdlrm
mimewriter.rst.txt	3360	0644	editdlrm
mimify.rst.txt	3519	0644	editdlrm
miniaeframe.rst.txt	2564	0644	editdlrm
misc.rst.txt	248	0644	editdlrm
mm.rst.txt	447	0644	editdlrm
mmap.rst.txt	10481	0644	editdlrm
modulefinder.rst.txt	3380	0644	editdlrm
modules.rst.txt	382	0644	editdlrm
msilib.rst.txt	19062	0644	editdlrm
msvcrt.rst.txt	4346	0644	editdlrm
multifile.rst.txt	6613	0644	editdlrm
multiprocessing.rst.txt	92621	0644	editdlrm
mutex.rst.txt	1939	0644	editdlrm
netdata.rst.txt	432	0644	editdlrm
netrc.rst.txt	3119	0644	editdlrm
new.rst.txt	2653	0644	editdlrm
nis.rst.txt	2108	0644	editdlrm
nntplib.rst.txt	14531	0644	editdlrm
numbers.rst.txt	8007	0644	editdlrm
numeric.rst.txt	751	0644	editdlrm
operator.rst.txt	22092	0644	editdlrm
optparse.rst.txt	77101	0644	editdlrm
os.path.rst.txt	13094	0644	editdlrm
os.rst.txt	82580	0644	editdlrm
ossaudiodev.rst.txt	17309	0644	editdlrm
othergui.rst.txt	2721	0644	editdlrm
parser.rst.txt	15385	0644	editdlrm
pdb.rst.txt	16043	0644	editdlrm
persistence.rst.txt	826	0644	editdlrm
pickle.rst.txt	37262	0644	editdlrm
pickletools.rst.txt	1997	0644	editdlrm
pipes.rst.txt	3786	0644	editdlrm
pkgutil.rst.txt	7714	0644	editdlrm
platform.rst.txt	9554	0644	editdlrm
plistlib.rst.txt	4134	0644	editdlrm
popen2.rst.txt	7022	0644	editdlrm
poplib.rst.txt	6220	0644	editdlrm
posix.rst.txt	3630	0644	editdlrm
posixfile.rst.txt	7200	0644	editdlrm
pprint.rst.txt	9071	0644	editdlrm
profile.rst.txt	28666	0644	editdlrm
pty.rst.txt	1762	0644	editdlrm
pwd.rst.txt	2725	0644	editdlrm
pyclbr.rst.txt	3296	0644	editdlrm
pydoc.rst.txt	4083	0644	editdlrm
pyexpat.rst.txt	28891	0644	editdlrm
python.rst.txt	514	0644	editdlrm
py_compile.rst.txt	2479	0644	editdlrm
queue.rst.txt	7034	0644	editdlrm
quopri.rst.txt	2670	0644	editdlrm
random.rst.txt	13319	0644	editdlrm
re.rst.txt	55102	0644	editdlrm
readline.rst.txt	10513	0644	editdlrm
repr.rst.txt	4718	0644	editdlrm
resource.rst.txt	9595	0644	editdlrm
restricted.rst.txt	3327	0644	editdlrm
rexec.rst.txt	11742	0644	editdlrm
rfc822.rst.txt	14037	0644	editdlrm
rlcompleter.rst.txt	2494	0644	editdlrm
robotparser.rst.txt	2190	0644	editdlrm
runpy.rst.txt	6938	0644	editdlrm
sched.rst.txt	4644	0644	editdlrm
scrolledtext.rst.txt	1379	0644	editdlrm
select.rst.txt	20705	0644	editdlrm
sets.rst.txt	14973	0644	editdlrm
sgi.rst.txt	322	0644	editdlrm
sgmllib.rst.txt	10664	0644	editdlrm
sha.rst.txt	2807	0644	editdlrm
shelve.rst.txt	8319	0644	editdlrm
shlex.rst.txt	11313	0644	editdlrm
shutil.rst.txt	13491	0644	editdlrm
signal.rst.txt	10719	0644	editdlrm
simplehttpserver.rst.txt	4559	0644	editdlrm
simplexmlrpcserver.rst.txt	10881	0644	editdlrm
site.rst.txt	7880	0644	editdlrm
smtpd.rst.txt	2464	0644	editdlrm
smtplib.rst.txt	14906	0644	editdlrm
sndhdr.rst.txt	1759	0644	editdlrm
socket.rst.txt	40765	0644	editdlrm
socketserver.rst.txt	22512	0644	editdlrm
someos.rst.txt	599	0644	editdlrm
spwd.rst.txt	2825	0644	editdlrm
sqlite3.rst.txt	35448	0644	editdlrm
ssl.rst.txt	76554	0644	editdlrm
stat.rst.txt	7778	0644	editdlrm
statvfs.rst.txt	1300	0644	editdlrm
stdtypes.rst.txt	122668	0644	editdlrm
string.rst.txt	44085	0644	editdlrm
stringio.rst.txt	4166	0644	editdlrm
stringprep.rst.txt	4238	0644	editdlrm
strings.rst.txt	746	0644	editdlrm
struct.rst.txt	17100	0644	editdlrm
subprocess.rst.txt	33648	0644	editdlrm
sun.rst.txt	249	0644	editdlrm
sunau.rst.txt	7124	0644	editdlrm
sunaudio.rst.txt	5849	0644	editdlrm
symbol.rst.txt	975	0644	editdlrm
symtable.rst.txt	5064	0644	editdlrm
sys.rst.txt	47520	0644	editdlrm
sysconfig.rst.txt	7639	0644	editdlrm
syslog.rst.txt	3931	0644	editdlrm
tabnanny.rst.txt	1999	0644	editdlrm
tarfile.rst.txt	28214	0644	editdlrm
telnetlib.rst.txt	7482	0644	editdlrm
tempfile.rst.txt	10504	0644	editdlrm
termios.rst.txt	3733	0644	editdlrm
test.rst.txt	17659	0644	editdlrm
textwrap.rst.txt	8552	0644	editdlrm
thread.rst.txt	6588	0644	editdlrm
threading.rst.txt	32468	0644	editdlrm
time.rst.txt	26020	0644	editdlrm
timeit.rst.txt	11598	0644	editdlrm
tix.rst.txt	22693	0644	editdlrm
tk.rst.txt	1612	0644	editdlrm
tkinter.rst.txt	33456	0644	editdlrm
token.rst.txt	2451	0644	editdlrm
tokenize.rst.txt	5570	0644	editdlrm
trace.rst.txt	6724	0644	editdlrm
traceback.rst.txt	10711	0644	editdlrm
ttk.rst.txt	57411	0644	editdlrm
tty.rst.txt	1011	0644	editdlrm
turtle.rst.txt	64097	0644	editdlrm
types.rst.txt	6200	0644	editdlrm
undoc.rst.txt	6550	0644	editdlrm
unicodedata.rst.txt	5736	0644	editdlrm
unittest.rst.txt	82952	0644	editdlrm
unix.rst.txt	490	0644	editdlrm
urllib.rst.txt	24960	0644	editdlrm
urllib2.rst.txt	35211	0644	editdlrm
urlparse.rst.txt	16071	0644	editdlrm
user.rst.txt	2748	0644	editdlrm
userdict.rst.txt	9290	0644	editdlrm
uu.rst.txt	2369	0644	editdlrm
uuid.rst.txt	8378	0644	editdlrm
warnings.rst.txt	19815	0644	editdlrm
wave.rst.txt	5047	0644	editdlrm
weakref.rst.txt	12926	0644	editdlrm
webbrowser.rst.txt	9863	0644	editdlrm
whichdb.rst.txt	931	0644	editdlrm
windows.rst.txt	273	0644	editdlrm
winsound.rst.txt	5066	0644	editdlrm
wsgiref.rst.txt	30567	0644	editdlrm
xdrlib.rst.txt	8077	0644	editdlrm
xml.dom.minidom.rst.txt	11208	0644	editdlrm
xml.dom.pulldom.rst.txt	1571	0644	editdlrm
xml.dom.rst.txt	40182	0644	editdlrm
xml.etree.elementtree.rst.txt	35707	0644	editdlrm
xml.rst.txt	6090	0644	editdlrm
xml.sax.handler.rst.txt	15371	0644	editdlrm
xml.sax.reader.rst.txt	12257	0644	editdlrm
xml.sax.rst.txt	6460	0644	editdlrm
xml.sax.utils.rst.txt	3560	0644	editdlrm
xmlrpclib.rst.txt	22559	0644	editdlrm
zipfile.rst.txt	18871	0644	editdlrm
zipimport.rst.txt	5957	0644	editdlrm
zlib.rst.txt	12766	0644	editdlrm
_winreg.rst.txt	23305	0644	editdlrm
__builtin__.rst.txt	1494	0644	editdlrm
__future__.rst.txt	4952	0644	editdlrm
__main__.rst.txt	535	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 .. versionadded:: 1.6 **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 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: .. exception:: BadZipfile The error raised for bad ZIP files (old name: ``zipfile.error``). .. 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 Class for creating ZIP archives containing Python libraries. .. class:: ZipInfo([filename[, date_time]]) 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:: 2.7 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. No other compression methods are currently supported. .. 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[, 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 file, ``'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 :file:`python.exe`). .. versionchanged:: 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 :const:`ZIP_STORED` or :const:`ZIP_DEFLATED`; unrecognized values will cause :exc:`RuntimeError` to be raised. If :const:`ZIP_DEFLATED` is specified but the :mod:`zlib` module is not available, :exc:`RuntimeError` is also raised. The default is :const:`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) :mod:`zipfile` will raise an exception when the ZIP file would require ZIP64 extensions. ZIP64 extensions are disabled by default because the default :program:`zip` and :program:`unzip` commands on Unix (the InfoZIP utilities) don't support these extensions. .. versionchanged:: 2.7.1 If the file is created with mode ``'a'`` or ``'w'`` 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:: 2.7 Added the ability to use :class:`ZipFile` as a context manager. .. 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. .. index:: single: universal newlines; zipfile.ZipFile.open method .. method:: ZipFile.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 :class:`ZipInfo` object. The *mode* parameter, if included, must be one of the following: ``'r'`` (the default), ``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable :term:`universal newline ` support in the read-only object. *pwd* is the password used for encrypted files. Calling :meth:`.open` on a closed ZipFile will raise a :exc:`RuntimeError`. .. note:: The file-like object is read-only and provides the following methods: :meth:`~file.read`, :meth:`~file.readline`, :meth:`~file.readlines`, :meth:`__iter__`, :meth:`~object.next`. .. note:: If the ZipFile was created by passing in a file-like object as the first argument to the constructor, then the object returned by :meth:`.open` shares the ZipFile's file pointer. Under these circumstances, the object returned by :meth:`.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 :meth:`.open` will create a new file object that will be held by the ZipExtFile, allowing it to operate independently of the ZipFile. .. 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. .. versionadded:: 2.6 .. method:: ZipFile.extract(member[, path[, pwd]]) 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). .. versionadded:: 2.6 .. 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 (``_``). .. method:: ZipFile.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 :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 ``".."``. .. versionchanged:: 2.7.4 The zipfile module attempts to prevent that. See :meth:`extract` note. .. versionadded:: 2.6 .. 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. .. versionadded:: 2.6 .. method:: ZipFile.read(name[, pwd]) 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 closed ZipFile will raise a :exc:`RuntimeError`. .. versionchanged:: 2.6 *pwd* was added, and *name* can now be a :class:`ZipInfo` object. .. 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``. Calling :meth:`testzip` on a closed ZipFile will raise a :exc:`RuntimeError`. .. method:: ZipFile.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 ``'w'`` or ``'a'`` -- calling :meth:`write` on a ZipFile created with mode ``'r'`` will raise a :exc:`RuntimeError`. Calling :meth:`write` on a closed ZipFile will raise a :exc:`RuntimeError`. .. 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. .. method:: ZipFile.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 :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'`` or ``'a'`` -- calling :meth:`writestr` on a ZipFile created with mode ``'r'`` will raise a :exc:`RuntimeError`. Calling :meth:`writestr` on a closed ZipFile will raise a :exc:`RuntimeError`. 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:: 2.7 The *compress_type* argument. The following data attributes are also available: .. 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 '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 :meth:`.close` is called. .. _pyzipfile-objects: PyZipFile Objects ----------------- The :class:`PyZipFile` constructor takes the same parameters as the :class:`ZipFile` constructor. Instances have one method in addition to those of :class:`ZipFile` objects. .. method:: PyZipFile.writepy(pathname[, basename]) Search for files :file:`\*.py` and add the corresponding file to the archive. The corresponding file is a :file:`\*.pyo` file if available, else a :file:`\*.pyc` file, compiling if necessary. If the pathname is a file, the filename must end with :file:`.py`, and just the (corresponding :file:`\*.py[co]`) file is added at the top level (no path information). If the 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:`\*.py[co]` are added at the top level. If the directory is a package directory, then all :file:`\*.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 :meth:`writepy` method makes archives with file names like this:: 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 .. _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. Instances have the following attributes: .. 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