0x1949 Team - FAZEMRX - MANAGER

Edit File: zipfile.html

<!DOCTYPE html>

<title>12.4. zipfile — Work with ZIP archives &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="12.5. tarfile — Read and write tar archive files" href="tarfile.html" />
 <link rel="prev" title="12.3. bz2 — Compression compatible with bzip2" href="bz2.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/zipfile.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/zipfile.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="tarfile.html" title="12.5. tarfile — Read and write tar archive files"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="bz2.html" title="12.3. bz2 — Compression compatible with bzip2"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="archiving.html" accesskey="U">12. Data Compression and Archiving</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">12.4. <code class="xref py py-mod docutils literal notranslate">zipfile</code> — Work with ZIP archives</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-zipfile">
<h1>12.4. <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> — Work with ZIP archives<a class="headerlink" href="#module-zipfile" title="Permalink to this headline">¶</a></h1>
<div class="versionadded">
New in version 1.6.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/zipfile.py">Lib/zipfile.py</a>
<hr class="docutils" />
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 <a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a>.
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:
<dl class="py exception">
<dt class="sig sig-object py" id="zipfile.BadZipfile">
exception zipfile.BadZipfile<a class="headerlink" href="#zipfile.BadZipfile" title="Permalink to this definition">¶</a></dt>
<dd>The error raised for bad ZIP files (old name: <code class="docutils literal notranslate">zipfile.error</code>).
</dd></dl>

<dl class="py exception">
<dt class="sig sig-object py" id="zipfile.LargeZipFile">
exception zipfile.LargeZipFile<a class="headerlink" href="#zipfile.LargeZipFile" title="Permalink to this definition">¶</a></dt>
<dd>The error raised when a ZIP file would require ZIP64 functionality but that has
not been enabled.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py">
class zipfile.ZipFile</dt>
<dd>The class for reading and writing ZIP files. See section
<a class="reference internal" href="#zipfile-objects">ZipFile Objects</a> for constructor details.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zipfile.PyZipFile">
class zipfile.PyZipFile<a class="headerlink" href="#zipfile.PyZipFile" title="Permalink to this definition">¶</a></dt>
<dd>Class for creating ZIP archives containing Python libraries.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="zipfile.ZipInfo">
class zipfile.ZipInfo([filename[, date_time]])<a class="headerlink" href="#zipfile.ZipInfo" title="Permalink to this definition">¶</a></dt>
<dd>Class used to represent information about a member of an archive. Instances
of this class are returned by the <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> and <a class="reference internal" href="#zipfile.ZipFile.infolist" title="zipfile.ZipFile.infolist"><code class="xref py py-meth docutils literal notranslate">infolist()</code></a>
methods of <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects. Most users of the <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> 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
<a class="reference internal" href="#zipinfo-objects">ZipInfo Objects</a>.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="zipfile.is_zipfile">
zipfile.is_zipfile(filename)<a class="headerlink" href="#zipfile.is_zipfile" title="Permalink to this definition">¶</a></dt>
<dd>Returns <code class="docutils literal notranslate">True</code> if filename is a valid ZIP file based on its magic number,
otherwise returns <code class="docutils literal notranslate">False</code>. filename may be a file or file-like object too.
<div class="versionchanged">
Changed in version 2.7: Support for file and file-like objects.
</div>
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_STORED">
zipfile.ZIP_STORED<a class="headerlink" href="#zipfile.ZIP_STORED" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for an uncompressed archive member.
</dd></dl>

<dl class="py data">
<dt class="sig sig-object py" id="zipfile.ZIP_DEFLATED">
zipfile.ZIP_DEFLATED<a class="headerlink" href="#zipfile.ZIP_DEFLATED" title="Permalink to this definition">¶</a></dt>
<dd>The numeric constant for the usual ZIP compression method. This requires the
<a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module. No other compression methods are currently supported.
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a></dt><dd>Documentation on the ZIP file format by Phil Katz, the creator of the format and
algorithms used.
</dd>
<dt><a class="reference external" href="http://www.info-zip.org/">Info-ZIP Home Page</a></dt><dd>Information about the Info-ZIP project’s ZIP archive programs and development
libraries.
</dd>
</dl>
</div>
<section id="zipfile-objects">
<h2>12.4.1. ZipFile Objects<a class="headerlink" href="#zipfile-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="zipfile.ZipFile">
class zipfile.ZipFile(file[, mode[, compression[, allowZip64]]])<a class="headerlink" href="#zipfile.ZipFile" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="docutils literal notranslate">'r'</code> to read an existing
file, <code class="docutils literal notranslate">'w'</code> to truncate and write a new file, or <code class="docutils literal notranslate">'a'</code> to append to an
existing file. If mode is <code class="docutils literal notranslate">'a'</code> 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 <code class="file docutils literal notranslate">python.exe</code>).
<div class="versionchanged">
Changed in version 2.6: If mode is <code class="docutils literal notranslate">a</code> and the file does not exist at all, it is created.
</div>
compression is the ZIP compression method to use when writing the archive,
and should be <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a> or <a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a>; unrecognized
values will cause <code class="xref py py-exc docutils literal notranslate">RuntimeError</code> to be raised. If <a class="reference internal" href="#zipfile.ZIP_DEFLATED" title="zipfile.ZIP_DEFLATED"><code class="xref py py-const docutils literal notranslate">ZIP_DEFLATED</code></a>
is specified but the <a class="reference internal" href="zlib.html#module-zlib" title="zlib: Low-level interface to compression and decompression routines compatible with gzip."><code class="xref py py-mod docutils literal notranslate">zlib</code></a> module is not available, <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>
is also raised. The default is <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>. If allowZip64 is
<code class="docutils literal notranslate">True</code> zipfile will create ZIP files that use the ZIP64 extensions when
the zipfile is larger than 2 GB. If it is false (the default) <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a>
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
these extensions.
<div class="versionchanged">
Changed in version 2.7.1: If the file is created with mode <code class="docutils literal notranslate">'a'</code> or <code class="docutils literal notranslate">'w'</code> and then
<a class="reference internal" href="#zipfile.ZipFile.close" title="zipfile.ZipFile.close"><code class="xref py py-meth docutils literal notranslate">closed</code></a> without adding any files to the archive, the appropriate
ZIP structures for an empty archive will be written to the file.
</div>
ZipFile is also a context manager and therefore supports the
<a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement. In the example, myzip is closed after the
<a class="reference internal" href="../reference/compound_stmts.html#with"><code class="xref std std-keyword docutils literal notranslate">with</code></a> statement’s suite is finished—even if an exception occurs:
<div class="highlight-default notranslate"><div class="highlight"><pre>with ZipFile(&#39;spam.zip&#39;, &#39;w&#39;) as myzip:
 myzip.write(&#39;eggs.txt&#39;)
</pre></div>
</div>
<div class="versionadded">
New in version 2.7: Added the ability to use <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> as a context manager.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.close">
ZipFile.close()<a class="headerlink" href="#zipfile.ZipFile.close" title="Permalink to this definition">¶</a></dt>
<dd>Close the archive file. You must call <a class="reference internal" href="#zipfile.ZipFile.close" title="zipfile.ZipFile.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> before exiting your program
or essential records will not be written.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.getinfo">
ZipFile.getinfo(name)<a class="headerlink" href="#zipfile.ZipFile.getinfo" title="Permalink to this definition">¶</a></dt>
<dd>Return a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object with information about the archive member
name. Calling <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> for a name not currently contained in the
archive will raise a <code class="xref py py-exc docutils literal notranslate">KeyError</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.infolist">
ZipFile.infolist()<a class="headerlink" href="#zipfile.ZipFile.infolist" title="Permalink to this definition">¶</a></dt>
<dd>Return a list containing a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> 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.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.namelist">
ZipFile.namelist()<a class="headerlink" href="#zipfile.ZipFile.namelist" title="Permalink to this definition">¶</a></dt>
<dd>Return a list of archive members by name.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.open">
ZipFile.open(name[, mode[, pwd]])<a class="headerlink" href="#zipfile.ZipFile.open" title="Permalink to this definition">¶</a></dt>
<dd>Extract a member from the archive as a file-like object (ZipExtFile). name is
the name of the file in the archive, or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object. The mode
parameter, if included, must be one of the following: <code class="docutils literal notranslate">'r'</code> (the default),
<code class="docutils literal notranslate">'U'</code>, or <code class="docutils literal notranslate">'rU'</code>. Choosing <code class="docutils literal notranslate">'U'</code> or <code class="docutils literal notranslate">'rU'</code> will enable
<a class="reference internal" href="../glossary.html#term-universal-newlines">universal newline</a>
support in the read-only object. pwd is the password used for encrypted files.
Calling <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> on a closed ZipFile will raise a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>.
<div class="admonition note">
Note
The file-like object is read-only and provides the following methods:
<a class="reference internal" href="stdtypes.html#file.read" title="file.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a>, <a class="reference internal" href="stdtypes.html#file.readline" title="file.readline"><code class="xref py py-meth docutils literal notranslate">readline()</code></a>,
<a class="reference internal" href="stdtypes.html#file.readlines" title="file.readlines"><code class="xref py py-meth docutils literal notranslate">readlines()</code></a>, <code class="xref py py-meth docutils literal notranslate">__iter__()</code>,
<code class="xref py py-meth docutils literal notranslate">next()</code>.
</div>
<div class="admonition note">
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 <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> shares the
ZipFile’s file pointer. Under these circumstances, the object returned by
<a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> 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 <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a> will
create a new file object that will be held by the ZipExtFile, allowing it to
operate independently of the ZipFile.
</div>
<div class="admonition note">
Note
The <a class="reference internal" href="#zipfile.ZipFile.open" title="zipfile.ZipFile.open"><code class="xref py py-meth docutils literal notranslate">open()</code></a>, <a class="reference internal" href="#zipfile.ZipFile.read" title="zipfile.ZipFile.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> and <a class="reference internal" href="#zipfile.ZipFile.extract" title="zipfile.ZipFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> methods can take a filename
or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object. You will appreciate this when trying to read a
ZIP file that contains members with duplicate names.
</div>
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.extract">
ZipFile.extract(member[, path[, pwd]])<a class="headerlink" href="#zipfile.ZipFile.extract" title="Permalink to this definition">¶</a></dt>
<dd>Extract a member from the archive to the current working directory; member
must be its full name or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> 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 <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object.
pwd is the password used for encrypted files.
Returns the normalized path created (a directory or new file).
<div class="versionadded">
New in version 2.6.
</div>
<div class="admonition note">
Note
If a member filename is an absolute path, a drive/UNC sharepoint and
leading (back)slashes will be stripped, e.g.: <code class="docutils literal notranslate">///foo/bar</code> becomes
<code class="docutils literal notranslate">foo/bar</code> on Unix, and <code class="docutils literal notranslate">C:\foo\bar</code> becomes <code class="docutils literal notranslate">foo\bar</code> on Windows.
And all <code class="docutils literal notranslate">&quot;..&quot;</code> components in a member filename will be removed, e.g.:
<code class="docutils literal notranslate">../../foo../../ba..r</code> becomes <code class="docutils literal notranslate">foo../ba..r</code>. On Windows illegal
characters (<code class="docutils literal notranslate">:</code>, <code class="docutils literal notranslate">&lt;</code>, <code class="docutils literal notranslate">&gt;</code>, <code class="docutils literal notranslate">|</code>, <code class="docutils literal notranslate">&quot;</code>, <code class="docutils literal notranslate">?</code>, and <code class="docutils literal notranslate">*</code>)
replaced by underscore (<code class="docutils literal notranslate">_</code>).
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.extractall">
ZipFile.extractall([path[, members[, pwd]]])<a class="headerlink" href="#zipfile.ZipFile.extractall" title="Permalink to this definition">¶</a></dt>
<dd>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 <a class="reference internal" href="#zipfile.ZipFile.namelist" title="zipfile.ZipFile.namelist"><code class="xref py py-meth docutils literal notranslate">namelist()</code></a>. pwd is the password
used for encrypted files.
<div class="admonition warning">
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 <code class="docutils literal notranslate">&quot;/&quot;</code> or filenames with two
dots <code class="docutils literal notranslate">&quot;..&quot;</code>.
</div>
<div class="versionchanged">
Changed in version 2.7.4: The zipfile module attempts to prevent that. See <a class="reference internal" href="#zipfile.ZipFile.extract" title="zipfile.ZipFile.extract"><code class="xref py py-meth docutils literal notranslate">extract()</code></a> note.
</div>
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.printdir">
ZipFile.printdir()<a class="headerlink" href="#zipfile.ZipFile.printdir" title="Permalink to this definition">¶</a></dt>
<dd>Print a table of contents for the archive to <code class="docutils literal notranslate">sys.stdout</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.setpassword">
ZipFile.setpassword(pwd)<a class="headerlink" href="#zipfile.ZipFile.setpassword" title="Permalink to this definition">¶</a></dt>
<dd>Set pwd as default password to extract encrypted files.
<div class="versionadded">
New in version 2.6.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.read">
ZipFile.read(name[, pwd])<a class="headerlink" href="#zipfile.ZipFile.read" title="Permalink to this definition">¶</a></dt>
<dd>Return the bytes of the file name in the archive. name is the name of the
file in the archive, or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> 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 <a class="reference internal" href="#zipfile.ZipFile.setpassword" title="zipfile.ZipFile.setpassword"><code class="xref py py-meth docutils literal notranslate">setpassword()</code></a>. Calling
<a class="reference internal" href="#zipfile.ZipFile.read" title="zipfile.ZipFile.read"><code class="xref py py-meth docutils literal notranslate">read()</code></a> on a closed ZipFile will raise a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>.
<div class="versionchanged">
Changed in version 2.6: pwd was added, and name can now be a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> object.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.testzip">
ZipFile.testzip()<a class="headerlink" href="#zipfile.ZipFile.testzip" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="docutils literal notranslate">None</code>. Calling
<a class="reference internal" href="#zipfile.ZipFile.testzip" title="zipfile.ZipFile.testzip"><code class="xref py py-meth docutils literal notranslate">testzip()</code></a> on a closed ZipFile will raise a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.write">
ZipFile.write(filename[, arcname[, compress_type]])<a class="headerlink" href="#zipfile.ZipFile.write" title="Permalink to this definition">¶</a></dt>
<dd>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 <code class="docutils literal notranslate">'w'</code> or <code class="docutils literal notranslate">'a'</code> – calling
<a class="reference internal" href="#zipfile.ZipFile.write" title="zipfile.ZipFile.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> on a ZipFile created with mode <code class="docutils literal notranslate">'r'</code> will raise a
<code class="xref py py-exc docutils literal notranslate">RuntimeError</code>. Calling <a class="reference internal" href="#zipfile.ZipFile.write" title="zipfile.ZipFile.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a> on a closed ZipFile will raise a
<code class="xref py py-exc docutils literal notranslate">RuntimeError</code>.
<div class="admonition note">
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 <a class="reference internal" href="#zipfile.ZipFile.write" title="zipfile.ZipFile.write"><code class="xref py py-meth docutils literal notranslate">write()</code></a>. WinZip interprets all file names as encoded in
CP437, also known as DOS Latin.
</div>
<div class="admonition note">
Note
Archive names should be relative to the archive root, that is, they should not
start with a path separator.
</div>
<div class="admonition note">
Note
If <code class="docutils literal notranslate">arcname</code> (or <code class="docutils literal notranslate">filename</code>, if <code class="docutils literal notranslate">arcname</code> is not given) contains a null
byte, the name of the file in the archive will be truncated at the null byte.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="zipfile.ZipFile.writestr">
ZipFile.writestr(zinfo_or_arcname, bytes[, compress_type])<a class="headerlink" href="#zipfile.ZipFile.writestr" title="Permalink to this definition">¶</a></dt>
<dd>Write the string bytes to the archive; zinfo_or_arcname is either the file
name it will be given in the archive, or a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> 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 <code class="docutils literal notranslate">'w'</code> or <code class="docutils literal notranslate">'a'</code> – calling <a class="reference internal" href="#zipfile.ZipFile.writestr" title="zipfile.ZipFile.writestr"><code class="xref py py-meth docutils literal notranslate">writestr()</code></a> on a ZipFile
created with mode <code class="docutils literal notranslate">'r'</code> will raise a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>. Calling
<a class="reference internal" href="#zipfile.ZipFile.writestr" title="zipfile.ZipFile.writestr"><code class="xref py py-meth docutils literal notranslate">writestr()</code></a> on a closed ZipFile will raise a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>.
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 <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance).
<div class="admonition note">
Note
When passing a <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance as the zinfo_or_arcname parameter,
the compression method used will be that specified in the compress_type
member of the given <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> instance. By default, the
<a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> constructor sets this member to <a class="reference internal" href="#zipfile.ZIP_STORED" title="zipfile.ZIP_STORED"><code class="xref py py-const docutils literal notranslate">ZIP_STORED</code></a>.
</div>
<div class="versionchanged">
Changed in version 2.7: The compress_type argument.
</div>
</dd></dl>

The following data attributes are also available:
<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipFile.debug">
ZipFile.debug<a class="headerlink" href="#zipfile.ZipFile.debug" title="Permalink to this definition">¶</a></dt>
<dd>The level of debug output to use. This may be set from <code class="docutils literal notranslate">0</code> (the default, no
output) to <code class="docutils literal notranslate">3</code> (the most output). Debugging information is written to
<code class="docutils literal notranslate">sys.stdout</code>.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipFile.comment">
ZipFile.comment<a class="headerlink" href="#zipfile.ZipFile.comment" title="Permalink to this definition">¶</a></dt>
<dd>The comment text associated with the ZIP file. If assigning a comment to a
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> 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 <a class="reference internal" href="#zipfile.ZipFile.close" title="zipfile.ZipFile.close"><code class="xref py py-meth docutils literal notranslate">close()</code></a> is called.
</dd></dl>

</section>
<section id="pyzipfile-objects">
<h2>12.4.2. PyZipFile Objects<a class="headerlink" href="#pyzipfile-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#zipfile.PyZipFile" title="zipfile.PyZipFile"><code class="xref py py-class docutils literal notranslate">PyZipFile</code></a> constructor takes the same parameters as the
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> constructor. Instances have one method in addition to those of
<a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects.
<dl class="py method">
<dt class="sig sig-object py" id="zipfile.PyZipFile.writepy">
PyZipFile.writepy(pathname[, basename])<a class="headerlink" href="#zipfile.PyZipFile.writepy" title="Permalink to this definition">¶</a></dt>
<dd>Search for files <code class="file docutils literal notranslate">*.py</code> and add the corresponding file to the archive.
The corresponding file is a <code class="file docutils literal notranslate">*.pyo</code> file if available, else a
<code class="file docutils literal notranslate">*.pyc</code> file, compiling if necessary. If the pathname is a file, the
filename must end with <code class="file docutils literal notranslate">.py</code>, and just the (corresponding
<code class="file docutils literal notranslate">*.py[co]</code>) file is added at the top level (no path information). If the
pathname is a file that does not end with <code class="file docutils literal notranslate">.py</code>, a <code class="xref py py-exc docutils literal notranslate">RuntimeError</code>
will be raised. If it is a directory, and the directory is not a package
directory, then all the files <code class="file docutils literal notranslate">*.py[co]</code> are added at the top level. If
the directory is a package directory, then all <code class="file docutils literal notranslate">*.py[co]</code> 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 <a class="reference internal" href="#zipfile.PyZipFile.writepy" title="zipfile.PyZipFile.writepy"><code class="xref py py-meth docutils literal notranslate">writepy()</code></a> method makes archives with file names
like this:
<div class="highlight-default notranslate"><div class="highlight"><pre>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
</pre></div>
</div>
</dd></dl>

</section>
<section id="zipinfo-objects">
<h2>12.4.3. ZipInfo Objects<a class="headerlink" href="#zipinfo-objects" title="Permalink to this headline">¶</a></h2>
Instances of the <a class="reference internal" href="#zipfile.ZipInfo" title="zipfile.ZipInfo"><code class="xref py py-class docutils literal notranslate">ZipInfo</code></a> class are returned by the <a class="reference internal" href="#zipfile.ZipFile.getinfo" title="zipfile.ZipFile.getinfo"><code class="xref py py-meth docutils literal notranslate">getinfo()</code></a> and
<a class="reference internal" href="#zipfile.ZipFile.infolist" title="zipfile.ZipFile.infolist"><code class="xref py py-meth docutils literal notranslate">infolist()</code></a> methods of <a class="reference internal" href="#zipfile.ZipFile" title="zipfile.ZipFile"><code class="xref py py-class docutils literal notranslate">ZipFile</code></a> objects. Each object stores
information about a single member of the ZIP archive.
Instances have the following attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.filename">
ZipInfo.filename<a class="headerlink" href="#zipfile.ZipInfo.filename" title="Permalink to this definition">¶</a></dt>
<dd>Name of the file in the archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.date_time">
ZipInfo.date_time<a class="headerlink" href="#zipfile.ZipInfo.date_time" title="Permalink to this definition">¶</a></dt>
<dd>The time and date of the last modification to the archive member. This is a
tuple of six values:
<table class="docutils align-default">
<colgroup>
<col style="width: 21%" />
<col style="width: 79%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">Index</th>
<th class="head">Value</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">0</code></td>
<td>Year (&gt;= 1980)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">1</code></td>
<td>Month (one-based)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">2</code></td>
<td>Day of month (one-based)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">3</code></td>
<td>Hours (zero-based)</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">4</code></td>
<td>Minutes (zero-based)</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">5</code></td>
<td>Seconds (zero-based)</td>
</tr>
</tbody>
</table>
<div class="admonition note">
Note
The ZIP file format does not support timestamps before 1980.
</div>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.compress_type">
ZipInfo.compress_type<a class="headerlink" href="#zipfile.ZipInfo.compress_type" title="Permalink to this definition">¶</a></dt>
<dd>Type of compression for the archive member.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.comment">
ZipInfo.comment<a class="headerlink" href="#zipfile.ZipInfo.comment" title="Permalink to this definition">¶</a></dt>
<dd>Comment for the individual archive member.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.extra">
ZipInfo.extra<a class="headerlink" href="#zipfile.ZipInfo.extra" title="Permalink to this definition">¶</a></dt>
<dd>Expansion field data. The <a class="reference external" href="https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT">PKZIP Application Note</a> contains
some comments on the internal structure of the data contained in this string.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.create_system">
ZipInfo.create_system<a class="headerlink" href="#zipfile.ZipInfo.create_system" title="Permalink to this definition">¶</a></dt>
<dd>System which created ZIP archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.create_version">
ZipInfo.create_version<a class="headerlink" href="#zipfile.ZipInfo.create_version" title="Permalink to this definition">¶</a></dt>
<dd>PKZIP version which created ZIP archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.extract_version">
ZipInfo.extract_version<a class="headerlink" href="#zipfile.ZipInfo.extract_version" title="Permalink to this definition">¶</a></dt>
<dd>PKZIP version needed to extract archive.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.reserved">
ZipInfo.reserved<a class="headerlink" href="#zipfile.ZipInfo.reserved" title="Permalink to this definition">¶</a></dt>
<dd>Must be zero.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.flag_bits">
ZipInfo.flag_bits<a class="headerlink" href="#zipfile.ZipInfo.flag_bits" title="Permalink to this definition">¶</a></dt>
<dd>ZIP flag bits.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.volume">
ZipInfo.volume<a class="headerlink" href="#zipfile.ZipInfo.volume" title="Permalink to this definition">¶</a></dt>
<dd>Volume number of file header.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.internal_attr">
ZipInfo.internal_attr<a class="headerlink" href="#zipfile.ZipInfo.internal_attr" title="Permalink to this definition">¶</a></dt>
<dd>Internal attributes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.external_attr">
ZipInfo.external_attr<a class="headerlink" href="#zipfile.ZipInfo.external_attr" title="Permalink to this definition">¶</a></dt>
<dd>External file attributes.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.header_offset">
ZipInfo.header_offset<a class="headerlink" href="#zipfile.ZipInfo.header_offset" title="Permalink to this definition">¶</a></dt>
<dd>Byte offset to the file header.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.CRC">
ZipInfo.CRC<a class="headerlink" href="#zipfile.ZipInfo.CRC" title="Permalink to this definition">¶</a></dt>
<dd>CRC-32 of the uncompressed file.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.compress_size">
ZipInfo.compress_size<a class="headerlink" href="#zipfile.ZipInfo.compress_size" title="Permalink to this definition">¶</a></dt>
<dd>Size of the compressed data.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="zipfile.ZipInfo.file_size">
ZipInfo.file_size<a class="headerlink" href="#zipfile.ZipInfo.file_size" title="Permalink to this definition">¶</a></dt>
<dd>Size of the uncompressed file.
</dd></dl>

</section>
<section id="command-line-interface">
<h2>12.4.4. Command-Line Interface<a class="headerlink" href="#command-line-interface" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#module-zipfile" title="zipfile: Read and write ZIP-format archive files."><code class="xref py py-mod docutils literal notranslate">zipfile</code></a> 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 <a class="reference internal" href="#cmdoption-zipfile-c"><code class="xref std std-option docutils literal notranslate">-c</code></a>
option and then list the filename(s) that should be included:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m zipfile -c monty.zip spam.txt eggs.txt
</pre></div>
</div>
Passing a directory is also acceptable:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m zipfile -c monty.zip life-of-brian_1979/
</pre></div>
</div>
If you want to extract a ZIP archive into the specified directory, use
the <a class="reference internal" href="#cmdoption-zipfile-e"><code class="xref std std-option docutils literal notranslate">-e</code></a> option:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m zipfile -e monty.zip target-dir/
</pre></div>
</div>
For a list of the files in a ZIP archive, use the <a class="reference internal" href="#cmdoption-zipfile-l"><code class="xref std std-option docutils literal notranslate">-l</code></a> option:
<div class="highlight-shell-session notranslate"><div class="highlight"><pre>$ python -m zipfile -l monty.zip
</pre></div>
</div>
<section id="command-line-options">
<h3>12.4.4.1. Command-line options<a class="headerlink" href="#command-line-options" title="Permalink to this headline">¶</a></h3>
<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-zipfile-l">
-l &lt;zipfile&gt;<a class="headerlink" href="#cmdoption-zipfile-l" title="Permalink to this definition">¶</a></dt>
<dd>List files in a zipfile.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-zipfile-c">
-c &lt;zipfile&gt; &lt;source1&gt; ... &lt;sourceN&gt;<a class="headerlink" href="#cmdoption-zipfile-c" title="Permalink to this definition">¶</a></dt>
<dd>Create zipfile from source files.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-zipfile-e">
-e &lt;zipfile&gt; &lt;output_dir&gt;<a class="headerlink" href="#cmdoption-zipfile-e" title="Permalink to this definition">¶</a></dt>
<dd>Extract zipfile into target directory.
</dd></dl>

<dl class="std cmdoption">
<dt class="sig sig-object std" id="cmdoption-zipfile-t">
-t &lt;zipfile&gt;<a class="headerlink" href="#cmdoption-zipfile-t" title="Permalink to this definition">¶</a></dt>
<dd>Test whether the zipfile is valid or not.
</dd></dl>

</section>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">12.4. <code class="xref py py-mod docutils literal notranslate">zipfile</code> — Work with ZIP archives</a><ul>
<li><a class="reference internal" href="#zipfile-objects">12.4.1. ZipFile Objects</a></li>
<li><a class="reference internal" href="#pyzipfile-objects">12.4.2. PyZipFile Objects</a></li>
<li><a class="reference internal" href="#zipinfo-objects">12.4.3. ZipInfo Objects</a></li>
<li><a class="reference internal" href="#command-line-interface">12.4.4. Command-Line Interface</a><ul>
<li><a class="reference internal" href="#command-line-options">12.4.4.1. Command-line options</a></li>
</ul>
</li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="bz2.html"
 title="previous chapter">12.3. <code class="xref py py-mod docutils literal notranslate">bz2</code> — Compression compatible with bzip2</a>
 <h4>Next topic</h4>
 <a href="tarfile.html"
 title="next chapter">12.5. <code class="xref py py-mod docutils literal notranslate">tarfile</code> — Read and write tar archive files</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/zipfile.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="tarfile.html" title="12.5. tarfile — Read and write tar archive files"
 >next</a> |</li>
 <li class="right" >
 <a href="bz2.html" title="12.3. bz2 — Compression compatible with bzip2"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="archiving.html" >12. Data Compression and Archiving</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">12.4. <code class="xref py py-mod docutils literal notranslate">zipfile</code> — Work with ZIP archives</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on November 21, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>