Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 1 | :mod:`zipfile` --- Work with ZIP archives |
| 2 | ========================================= |
| 3 | |
| 4 | .. module:: zipfile |
| 5 | :synopsis: Read and write ZIP-format archive files. |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 7 | .. moduleauthor:: James C. Ahlstrom <jim@interet.com> |
| 8 | .. sectionauthor:: James C. Ahlstrom <jim@interet.com> |
| 9 | |
Raymond Hettinger | 469271d | 2011-01-27 20:38:46 +0000 | [diff] [blame] | 10 | **Source code:** :source:`Lib/zipfile.py` |
| 11 | |
| 12 | -------------- |
| 13 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 14 | The ZIP file format is a common archive and compression standard. This module |
| 15 | provides tools to create, read, write, append, and list a ZIP file. Any |
| 16 | advanced use of this module will require an understanding of the format, as |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 17 | defined in `PKZIP Application Note`_. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 18 | |
Georg Brandl | 98be996 | 2010-08-02 20:52:10 +0000 | [diff] [blame] | 19 | This module does not currently handle multi-disk ZIP files. |
| 20 | It can handle ZIP files that use the ZIP64 extensions |
Serhiy Storchaka | f8def28 | 2013-02-16 17:29:56 +0200 | [diff] [blame] | 21 | (that is ZIP files that are more than 4 GiB in size). It supports |
Guido van Rossum | 7767711 | 2007-11-05 19:43:04 +0000 | [diff] [blame] | 22 | decryption of encrypted files in ZIP archives, but it currently cannot |
Christian Heimes | fdab48e | 2008-01-20 09:06:41 +0000 | [diff] [blame] | 23 | create an encrypted file. Decryption is extremely slow as it is |
Benjamin Peterson | 2021100 | 2009-11-25 18:34:42 +0000 | [diff] [blame] | 24 | implemented in native Python rather than C. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 25 | |
Guido van Rossum | 7767711 | 2007-11-05 19:43:04 +0000 | [diff] [blame] | 26 | The module defines the following items: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 27 | |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 28 | .. exception:: BadZipFile |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 29 | |
Éric Araujo | d001ffe | 2011-08-19 00:44:31 +0200 | [diff] [blame] | 30 | The error raised for bad ZIP files. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 31 | |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 32 | .. versionadded:: 3.2 |
| 33 | |
| 34 | |
| 35 | .. exception:: BadZipfile |
| 36 | |
Éric Araujo | d001ffe | 2011-08-19 00:44:31 +0200 | [diff] [blame] | 37 | Alias of :exc:`BadZipFile`, for compatibility with older Python versions. |
| 38 | |
| 39 | .. deprecated:: 3.2 |
Georg Brandl | 4d54088 | 2010-10-28 06:42:33 +0000 | [diff] [blame] | 40 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 41 | |
| 42 | .. exception:: LargeZipFile |
| 43 | |
| 44 | The error raised when a ZIP file would require ZIP64 functionality but that has |
| 45 | not been enabled. |
| 46 | |
| 47 | |
| 48 | .. class:: ZipFile |
Georg Brandl | 5e92a50 | 2010-11-12 06:20:12 +0000 | [diff] [blame] | 49 | :noindex: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 50 | |
| 51 | The class for reading and writing ZIP files. See section |
| 52 | :ref:`zipfile-objects` for constructor details. |
| 53 | |
| 54 | |
| 55 | .. class:: PyZipFile |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 56 | :noindex: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 57 | |
| 58 | Class for creating ZIP archives containing Python libraries. |
| 59 | |
| 60 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 61 | .. class:: ZipInfo(filename='NoName', date_time=(1980,1,1,0,0,0)) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 62 | |
| 63 | Class used to represent information about a member of an archive. Instances |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 64 | of this class are returned by the :meth:`.getinfo` and :meth:`.infolist` |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 65 | methods of :class:`ZipFile` objects. Most users of the :mod:`zipfile` module |
| 66 | will not need to create these, but only use those created by this |
| 67 | module. *filename* should be the full name of the archive member, and |
| 68 | *date_time* should be a tuple containing six fields which describe the time |
| 69 | of the last modification to the file; the fields are described in section |
| 70 | :ref:`zipinfo-objects`. |
| 71 | |
| 72 | |
| 73 | .. function:: is_zipfile(filename) |
| 74 | |
| 75 | Returns ``True`` if *filename* is a valid ZIP file based on its magic number, |
Antoine Pitrou | db5fe66 | 2008-12-27 15:50:40 +0000 | [diff] [blame] | 76 | otherwise returns ``False``. *filename* may be a file or file-like object too. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 77 | |
Georg Brandl | 277a150 | 2009-01-04 00:28:14 +0000 | [diff] [blame] | 78 | .. versionchanged:: 3.1 |
| 79 | Support for file and file-like objects. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 80 | |
Georg Brandl | 67b21b7 | 2010-08-17 15:07:14 +0000 | [diff] [blame] | 81 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 82 | .. data:: ZIP_STORED |
| 83 | |
| 84 | The numeric constant for an uncompressed archive member. |
| 85 | |
| 86 | |
| 87 | .. data:: ZIP_DEFLATED |
| 88 | |
| 89 | The numeric constant for the usual ZIP compression method. This requires the |
Andrew Svetlov | 5061a34 | 2012-10-06 18:10:01 +0300 | [diff] [blame] | 90 | :mod:`zlib` module. |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 91 | |
| 92 | |
| 93 | .. data:: ZIP_BZIP2 |
| 94 | |
| 95 | The numeric constant for the BZIP2 compression method. This requires the |
Andrew Svetlov | 5061a34 | 2012-10-06 18:10:01 +0300 | [diff] [blame] | 96 | :mod:`bz2` module. |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 97 | |
| 98 | .. versionadded:: 3.3 |
| 99 | |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 100 | .. data:: ZIP_LZMA |
| 101 | |
| 102 | The numeric constant for the LZMA compression method. This requires the |
Andrew Svetlov | 5061a34 | 2012-10-06 18:10:01 +0300 | [diff] [blame] | 103 | :mod:`lzma` module. |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 104 | |
| 105 | .. versionadded:: 3.3 |
| 106 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 107 | .. note:: |
| 108 | |
| 109 | The ZIP file format specification has included support for bzip2 compression |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 110 | since 2001, and for LZMA compression since 2006. However, some tools |
| 111 | (including older Python releases) do not support these compression |
| 112 | methods, and may either refuse to process the ZIP file altogether, |
| 113 | or fail to extract individual files. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 114 | |
| 115 | |
| 116 | .. seealso:: |
| 117 | |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 118 | `PKZIP Application Note`_ |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 119 | Documentation on the ZIP file format by Phil Katz, the creator of the format and |
| 120 | algorithms used. |
| 121 | |
| 122 | `Info-ZIP Home Page <http://www.info-zip.org/>`_ |
| 123 | Information about the Info-ZIP project's ZIP archive programs and development |
| 124 | libraries. |
| 125 | |
| 126 | |
| 127 | .. _zipfile-objects: |
| 128 | |
| 129 | ZipFile Objects |
| 130 | --------------- |
| 131 | |
| 132 | |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 133 | .. class:: ZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 134 | |
| 135 | Open a ZIP file, where *file* can be either a path to a file (a string) or a |
| 136 | file-like object. The *mode* parameter should be ``'r'`` to read an existing |
Senthil Kumaran | e5c05cc | 2016-01-21 21:06:47 -0800 | [diff] [blame] | 137 | file, ``'w'`` to truncate and write a new file, ``'a'`` to append to an |
| 138 | existing file, or ``'x'`` to exclusively create and write a new file. |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 139 | If *mode* is ``'x'`` and *file* refers to an existing file, |
| 140 | a :exc:`FileExistsError` will be raised. |
| 141 | If *mode* is ``'a'`` and *file* refers to an existing ZIP |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 142 | file, then additional files are added to it. If *file* does not refer to a |
| 143 | ZIP file, then a new ZIP archive is appended to the file. This is meant for |
| 144 | adding a ZIP archive to another file (such as :file:`python.exe`). If |
| 145 | *mode* is ``a`` and the file does not exist at all, it is created. |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 146 | If *mode* is ``r`` or ``a``, the file should be seekable. |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 147 | *compression* is the ZIP compression method to use when writing the archive, |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 148 | and should be :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, |
| 149 | :const:`ZIP_BZIP2` or :const:`ZIP_LZMA`; unrecognized |
| 150 | values will cause :exc:`RuntimeError` to be raised. If :const:`ZIP_DEFLATED`, |
Brett Cannon | 8dd8233 | 2013-06-17 19:58:57 -0400 | [diff] [blame] | 151 | :const:`ZIP_BZIP2` or :const:`ZIP_LZMA` is specified but the corresponding module |
Martin v. Löwis | 7fb79fc | 2012-05-13 10:06:36 +0200 | [diff] [blame] | 152 | (:mod:`zlib`, :mod:`bz2` or :mod:`lzma`) is not available, :exc:`RuntimeError` |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 153 | is also raised. The default is :const:`ZIP_STORED`. If *allowZip64* is |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 154 | ``True`` (the default) zipfile will create ZIP files that use the ZIP64 |
| 155 | extensions when the zipfile is larger than 2 GiB. If it is false :mod:`zipfile` |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 156 | will raise an exception when the ZIP file would require ZIP64 extensions. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 157 | |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 158 | If the file is created with mode ``'w'``, ``'x'`` or ``'a'`` and then |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 159 | :meth:`closed <close>` without adding any files to the archive, the appropriate |
Georg Brandl | 268e4d4 | 2010-10-14 06:59:45 +0000 | [diff] [blame] | 160 | ZIP structures for an empty archive will be written to the file. |
| 161 | |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 162 | ZipFile is also a context manager and therefore supports the |
| 163 | :keyword:`with` statement. In the example, *myzip* is closed after the |
| 164 | :keyword:`with` statement's suite is finished---even if an exception occurs:: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 165 | |
Ezio Melotti | faa6b7f | 2009-12-30 12:34:59 +0000 | [diff] [blame] | 166 | with ZipFile('spam.zip', 'w') as myzip: |
| 167 | myzip.write('eggs.txt') |
| 168 | |
| 169 | .. versionadded:: 3.2 |
| 170 | Added the ability to use :class:`ZipFile` as a context manager. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 171 | |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 172 | .. versionchanged:: 3.3 |
Andrew Svetlov | 5061a34 | 2012-10-06 18:10:01 +0300 | [diff] [blame] | 173 | Added support for :mod:`bzip2 <bz2>` and :mod:`lzma` compression. |
Martin v. Löwis | f6b16a4 | 2012-05-01 07:58:44 +0200 | [diff] [blame] | 174 | |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 175 | .. versionchanged:: 3.4 |
| 176 | ZIP64 extensions are enabled by default. |
| 177 | |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 178 | .. versionchanged:: 3.5 |
| 179 | Added support for writing to unseekable streams. |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 180 | Added support for the ``'x'`` mode. |
Serhiy Storchaka | 77d8997 | 2015-03-23 01:09:35 +0200 | [diff] [blame] | 181 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 182 | |
| 183 | .. method:: ZipFile.close() |
| 184 | |
| 185 | Close the archive file. You must call :meth:`close` before exiting your program |
| 186 | or essential records will not be written. |
| 187 | |
| 188 | |
| 189 | .. method:: ZipFile.getinfo(name) |
| 190 | |
| 191 | Return a :class:`ZipInfo` object with information about the archive member |
| 192 | *name*. Calling :meth:`getinfo` for a name not currently contained in the |
| 193 | archive will raise a :exc:`KeyError`. |
| 194 | |
| 195 | |
| 196 | .. method:: ZipFile.infolist() |
| 197 | |
| 198 | Return a list containing a :class:`ZipInfo` object for each member of the |
| 199 | archive. The objects are in the same order as their entries in the actual ZIP |
| 200 | file on disk if an existing archive was opened. |
| 201 | |
| 202 | |
| 203 | .. method:: ZipFile.namelist() |
| 204 | |
| 205 | Return a list of archive members by name. |
| 206 | |
| 207 | |
R David Murray | 1b00f25 | 2012-08-15 10:43:58 -0400 | [diff] [blame] | 208 | .. index:: |
| 209 | single: universal newlines; zipfile.ZipFile.open method |
| 210 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 211 | .. method:: ZipFile.open(name, mode='r', pwd=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 212 | |
R David Murray | ee0a945 | 2012-08-15 11:05:36 -0400 | [diff] [blame] | 213 | Extract a member from the archive as a file-like object (ZipExtFile). *name* |
| 214 | is the name of the file in the archive, or a :class:`ZipInfo` object. The |
| 215 | *mode* parameter, if included, must be one of the following: ``'r'`` (the |
| 216 | default), ``'U'``, or ``'rU'``. Choosing ``'U'`` or ``'rU'`` will enable |
| 217 | :term:`universal newlines` support in the read-only object. *pwd* is the |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 218 | password used for encrypted files. Calling :meth:`.open` on a closed |
R David Murray | ee0a945 | 2012-08-15 11:05:36 -0400 | [diff] [blame] | 219 | ZipFile will raise a :exc:`RuntimeError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 220 | |
Benjamin Peterson | f0f14f7 | 2015-03-12 22:41:06 -0500 | [diff] [blame] | 221 | :meth:`~ZipFile.open` is also a context manager and therefore supports the |
Berker Peksag | ce77ee9 | 2015-03-13 02:29:54 +0200 | [diff] [blame] | 222 | :keyword:`with` statement:: |
| 223 | |
| 224 | with ZipFile('spam.zip') as myzip: |
| 225 | with myzip.open('eggs.txt') as myfile: |
| 226 | print(myfile.read()) |
| 227 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 228 | .. note:: |
| 229 | |
| 230 | The file-like object is read-only and provides the following methods: |
Serhiy Storchaka | bfdcd43 | 2013-10-13 23:09:14 +0300 | [diff] [blame] | 231 | :meth:`~io.BufferedIOBase.read`, :meth:`~io.IOBase.readline`, |
| 232 | :meth:`~io.IOBase.readlines`, :meth:`__iter__`, |
| 233 | :meth:`~iterator.__next__`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 234 | |
| 235 | .. note:: |
| 236 | |
Serhiy Storchaka | 1ad088f | 2014-12-03 09:11:57 +0200 | [diff] [blame] | 237 | Objects returned by :meth:`.open` can operate independently of the |
| 238 | ZipFile. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 239 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 240 | .. note:: |
| 241 | |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 242 | The :meth:`.open`, :meth:`read` and :meth:`extract` methods can take a filename |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 243 | or a :class:`ZipInfo` object. You will appreciate this when trying to read a |
| 244 | ZIP file that contains members with duplicate names. |
| 245 | |
Serhiy Storchaka | 6787a38 | 2013-11-23 22:12:06 +0200 | [diff] [blame] | 246 | .. deprecated-removed:: 3.4 3.6 |
| 247 | The ``'U'`` or ``'rU'`` mode. Use :class:`io.TextIOWrapper` for reading |
| 248 | compressed text files in :term:`universal newlines` mode. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 249 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 250 | .. method:: ZipFile.extract(member, path=None, pwd=None) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 251 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 252 | Extract a member from the archive to the current working directory; *member* |
Berker Peksag | a064382 | 2016-06-24 12:56:50 +0300 | [diff] [blame^] | 253 | must be its full name or a :class:`ZipInfo` object. Its file information is |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 254 | extracted as accurately as possible. *path* specifies a different directory |
| 255 | to extract to. *member* can be a filename or a :class:`ZipInfo` object. |
| 256 | *pwd* is the password used for encrypted files. |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 257 | |
Zachary Ware | ae9f0fe | 2015-04-13 16:40:49 -0500 | [diff] [blame] | 258 | Returns the normalized path created (a directory or new file). |
| 259 | |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 260 | .. note:: |
| 261 | |
| 262 | If a member filename is an absolute path, a drive/UNC sharepoint and |
| 263 | leading (back)slashes will be stripped, e.g.: ``///foo/bar`` becomes |
Serhiy Storchaka | 44b8cbf | 2013-02-02 13:27:30 +0200 | [diff] [blame] | 264 | ``foo/bar`` on Unix, and ``C:\foo\bar`` becomes ``foo\bar`` on Windows. |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 265 | And all ``".."`` components in a member filename will be removed, e.g.: |
| 266 | ``../../foo../../ba..r`` becomes ``foo../ba..r``. On Windows illegal |
| 267 | characters (``:``, ``<``, ``>``, ``|``, ``"``, ``?``, and ``*``) |
| 268 | replaced by underscore (``_``). |
| 269 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 270 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 271 | .. method:: ZipFile.extractall(path=None, members=None, pwd=None) |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 272 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 273 | Extract all members from the archive to the current working directory. *path* |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 274 | specifies a different directory to extract to. *members* is optional and must |
| 275 | be a subset of the list returned by :meth:`namelist`. *pwd* is the password |
| 276 | used for encrypted files. |
| 277 | |
Gregory P. Smith | f1319d8 | 2013-02-07 22:15:04 -0800 | [diff] [blame] | 278 | .. warning:: |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 279 | |
Gregory P. Smith | f1319d8 | 2013-02-07 22:15:04 -0800 | [diff] [blame] | 280 | Never extract archives from untrusted sources without prior inspection. |
| 281 | It is possible that files are created outside of *path*, e.g. members |
| 282 | that have absolute filenames starting with ``"/"`` or filenames with two |
Gregory P. Smith | 1d824ec | 2013-02-07 22:17:21 -0800 | [diff] [blame] | 283 | dots ``".."``. This module attempts to prevent that. |
Gregory P. Smith | b47acbf | 2013-02-01 11:22:43 -0800 | [diff] [blame] | 284 | See :meth:`extract` note. |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 285 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 286 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 287 | .. method:: ZipFile.printdir() |
| 288 | |
| 289 | Print a table of contents for the archive to ``sys.stdout``. |
| 290 | |
| 291 | |
| 292 | .. method:: ZipFile.setpassword(pwd) |
| 293 | |
| 294 | Set *pwd* as default password to extract encrypted files. |
| 295 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 296 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 297 | .. method:: ZipFile.read(name, pwd=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 298 | |
Georg Brandl | b533e26 | 2008-05-25 18:19:30 +0000 | [diff] [blame] | 299 | Return the bytes of the file *name* in the archive. *name* is the name of the |
| 300 | file in the archive, or a :class:`ZipInfo` object. The archive must be open for |
| 301 | read or append. *pwd* is the password used for encrypted files and, if specified, |
| 302 | it will override the default password set with :meth:`setpassword`. Calling |
Gregory P. Smith | f2a448a | 2015-04-14 10:02:20 -0700 | [diff] [blame] | 303 | :meth:`read` on a closed ZipFile will raise a :exc:`RuntimeError`. Calling |
| 304 | :meth:`read` on a ZipFile that uses a compression method other than |
Gregory P. Smith | 23a6a0d | 2015-04-14 10:04:30 -0700 | [diff] [blame] | 305 | :const:`ZIP_STORED`, :const:`ZIP_DEFLATED`, :const:`ZIP_BZIP2` or |
Gregory P. Smith | f2a448a | 2015-04-14 10:02:20 -0700 | [diff] [blame] | 306 | :const:`ZIP_LZMA` will raise a :exc:`NotImplementedError`. An error will also |
| 307 | be raised if the corresponding compression module is not available. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 308 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 309 | |
| 310 | .. method:: ZipFile.testzip() |
| 311 | |
| 312 | Read all the files in the archive and check their CRC's and file headers. |
| 313 | Return the name of the first bad file, or else return ``None``. Calling |
| 314 | :meth:`testzip` on a closed ZipFile will raise a :exc:`RuntimeError`. |
| 315 | |
| 316 | |
Georg Brandl | 7f01a13 | 2009-09-16 15:58:14 +0000 | [diff] [blame] | 317 | .. method:: ZipFile.write(filename, arcname=None, compress_type=None) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 318 | |
| 319 | Write the file named *filename* to the archive, giving it the archive name |
| 320 | *arcname* (by default, this will be the same as *filename*, but without a drive |
| 321 | letter and with leading path separators removed). If given, *compress_type* |
| 322 | overrides the value given for the *compression* parameter to the constructor for |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 323 | the new entry. |
| 324 | The archive must be open with mode ``'w'``, ``'x'`` or ``'a'`` -- calling |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 325 | :meth:`write` on a ZipFile created with mode ``'r'`` will raise a |
| 326 | :exc:`RuntimeError`. Calling :meth:`write` on a closed ZipFile will raise a |
| 327 | :exc:`RuntimeError`. |
| 328 | |
| 329 | .. note:: |
| 330 | |
| 331 | There is no official file name encoding for ZIP files. If you have unicode file |
Thomas Wouters | 47b49bf | 2007-08-30 22:15:33 +0000 | [diff] [blame] | 332 | names, you must convert them to byte strings in your desired encoding before |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 333 | passing them to :meth:`write`. WinZip interprets all file names as encoded in |
| 334 | CP437, also known as DOS Latin. |
| 335 | |
| 336 | .. note:: |
| 337 | |
| 338 | Archive names should be relative to the archive root, that is, they should not |
| 339 | start with a path separator. |
| 340 | |
| 341 | .. note:: |
| 342 | |
| 343 | If ``arcname`` (or ``filename``, if ``arcname`` is not given) contains a null |
| 344 | byte, the name of the file in the archive will be truncated at the null byte. |
| 345 | |
Martin Panter | 71e8636 | 2016-06-15 00:24:34 +0000 | [diff] [blame] | 346 | .. method:: ZipFile.writestr(zinfo_or_arcname, data[, compress_type]) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 347 | |
Martin Panter | 71e8636 | 2016-06-15 00:24:34 +0000 | [diff] [blame] | 348 | Write the string *data* to the archive; *zinfo_or_arcname* is either the file |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 349 | name it will be given in the archive, or a :class:`ZipInfo` instance. If it's |
| 350 | an instance, at least the filename, date, and time must be given. If it's a |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 351 | name, the date and time is set to the current date and time. |
| 352 | The archive must be opened with mode ``'w'``, ``'x'`` or ``'a'`` -- calling |
| 353 | :meth:`writestr` on a ZipFile created with mode ``'r'`` will raise a |
| 354 | :exc:`RuntimeError`. Calling :meth:`writestr` on a closed ZipFile will |
| 355 | raise a :exc:`RuntimeError`. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 356 | |
Ronald Oussoren | ee5c885 | 2010-02-07 20:24:02 +0000 | [diff] [blame] | 357 | If given, *compress_type* overrides the value given for the *compression* |
| 358 | parameter to the constructor for the new entry, or in the *zinfo_or_arcname* |
| 359 | (if that is a :class:`ZipInfo` instance). |
| 360 | |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 361 | .. note:: |
| 362 | |
Éric Araujo | 0d4bcf4 | 2010-12-26 17:53:27 +0000 | [diff] [blame] | 363 | When passing a :class:`ZipInfo` instance as the *zinfo_or_arcname* parameter, |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 364 | the compression method used will be that specified in the *compress_type* |
| 365 | member of the given :class:`ZipInfo` instance. By default, the |
Christian Heimes | 790c823 | 2008-01-07 21:14:23 +0000 | [diff] [blame] | 366 | :class:`ZipInfo` constructor sets this member to :const:`ZIP_STORED`. |
| 367 | |
Ezio Melotti | f8754a6 | 2010-03-21 07:16:43 +0000 | [diff] [blame] | 368 | .. versionchanged:: 3.2 |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 369 | The *compress_type* argument. |
Ronald Oussoren | ee5c885 | 2010-02-07 20:24:02 +0000 | [diff] [blame] | 370 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 371 | The following data attributes are also available: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 372 | |
| 373 | |
| 374 | .. attribute:: ZipFile.debug |
| 375 | |
| 376 | The level of debug output to use. This may be set from ``0`` (the default, no |
| 377 | output) to ``3`` (the most output). Debugging information is written to |
| 378 | ``sys.stdout``. |
| 379 | |
Martin v. Löwis | b09b844 | 2008-07-03 14:13:42 +0000 | [diff] [blame] | 380 | .. attribute:: ZipFile.comment |
| 381 | |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 382 | The comment text associated with the ZIP file. If assigning a comment to a |
Serhiy Storchaka | 764fc9b | 2015-03-25 10:09:41 +0200 | [diff] [blame] | 383 | :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, |
| 384 | this should be a |
Georg Brandl | 48310cd | 2009-01-03 21:18:54 +0000 | [diff] [blame] | 385 | string no longer than 65535 bytes. Comments longer than this will be |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 386 | truncated in the written archive when :meth:`close` is called. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 387 | |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 388 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 389 | .. _pyzipfile-objects: |
| 390 | |
| 391 | PyZipFile Objects |
| 392 | ----------------- |
| 393 | |
| 394 | The :class:`PyZipFile` constructor takes the same parameters as the |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 395 | :class:`ZipFile` constructor, and one additional parameter, *optimize*. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 396 | |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 397 | .. class:: PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, \ |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 398 | optimize=-1) |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 399 | |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 400 | .. versionadded:: 3.2 |
| 401 | The *optimize* parameter. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 402 | |
Serhiy Storchaka | 235c5e0 | 2013-11-23 15:55:38 +0200 | [diff] [blame] | 403 | .. versionchanged:: 3.4 |
| 404 | ZIP64 extensions are enabled by default. |
| 405 | |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 406 | Instances have one method in addition to those of :class:`ZipFile` objects: |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 407 | |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 408 | .. method:: PyZipFile.writepy(pathname, basename='', filterfunc=None) |
| 409 | |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 410 | Search for files :file:`\*.py` and add the corresponding file to the |
| 411 | archive. |
| 412 | |
| 413 | If the *optimize* parameter to :class:`PyZipFile` was not given or ``-1``, |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 414 | the corresponding file is a :file:`\*.pyc` file, compiling if necessary. |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 415 | |
| 416 | If the *optimize* parameter to :class:`PyZipFile` was ``0``, ``1`` or |
| 417 | ``2``, only files with that optimization level (see :func:`compile`) are |
| 418 | added to the archive, compiling if necessary. |
| 419 | |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 420 | If *pathname* is a file, the filename must end with :file:`.py`, and |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 421 | just the (corresponding :file:`\*.py[co]`) file is added at the top level |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 422 | (no path information). If *pathname* is a file that does not end with |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 423 | :file:`.py`, a :exc:`RuntimeError` will be raised. If it is a directory, |
| 424 | and the directory is not a package directory, then all the files |
| 425 | :file:`\*.py[co]` are added at the top level. If the directory is a |
| 426 | package directory, then all :file:`\*.py[co]` are added under the package |
| 427 | name as a file path, and if any subdirectories are package directories, |
Larry Hastings | 3732ed2 | 2014-03-15 21:13:56 -0700 | [diff] [blame] | 428 | all of these are added recursively. |
| 429 | |
| 430 | *basename* is intended for internal use only. |
| 431 | |
| 432 | *filterfunc*, if given, must be a function taking a single string |
| 433 | argument. It will be passed each path (including each individual full |
| 434 | file path) before it is added to the archive. If *filterfunc* returns a |
| 435 | false value, the path will not be added, and if it is a directory its |
| 436 | contents will be ignored. For example, if our test files are all either |
| 437 | in ``test`` directories or start with the string ``test_``, we can use a |
| 438 | *filterfunc* to exclude them:: |
| 439 | |
| 440 | >>> zf = PyZipFile('myprog.zip') |
| 441 | >>> def notests(s): |
| 442 | ... fn = os.path.basename(s) |
| 443 | ... return (not (fn == 'test' or fn.startswith('test_'))) |
| 444 | >>> zf.writepy('myprog', filterfunc=notests) |
| 445 | |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 446 | The :meth:`writepy` method makes archives with file names like |
Georg Brandl | 8334fd9 | 2010-12-04 10:26:46 +0000 | [diff] [blame] | 447 | this:: |
| 448 | |
| 449 | string.pyc # Top level name |
| 450 | test/__init__.pyc # Package directory |
| 451 | test/testall.pyc # Module test.testall |
| 452 | test/bogus/__init__.pyc # Subpackage directory |
| 453 | test/bogus/myfile.pyc # Submodule test.bogus.myfile |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 454 | |
Georg Brandl | a606542 | 2013-10-21 08:29:29 +0200 | [diff] [blame] | 455 | .. versionadded:: 3.4 |
| 456 | The *filterfunc* parameter. |
| 457 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 458 | |
| 459 | .. _zipinfo-objects: |
| 460 | |
| 461 | ZipInfo Objects |
| 462 | --------------- |
| 463 | |
Andrew Svetlov | afbf90c | 2012-10-06 18:02:05 +0300 | [diff] [blame] | 464 | Instances of the :class:`ZipInfo` class are returned by the :meth:`.getinfo` and |
| 465 | :meth:`.infolist` methods of :class:`ZipFile` objects. Each object stores |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 466 | information about a single member of the ZIP archive. |
| 467 | |
| 468 | Instances have the following attributes: |
| 469 | |
| 470 | |
| 471 | .. attribute:: ZipInfo.filename |
| 472 | |
| 473 | Name of the file in the archive. |
| 474 | |
| 475 | |
| 476 | .. attribute:: ZipInfo.date_time |
| 477 | |
| 478 | The time and date of the last modification to the archive member. This is a |
| 479 | tuple of six values: |
| 480 | |
| 481 | +-------+--------------------------+ |
| 482 | | Index | Value | |
| 483 | +=======+==========================+ |
Senthil Kumaran | 29fa9d4 | 2011-10-20 01:46:00 +0800 | [diff] [blame] | 484 | | ``0`` | Year (>= 1980) | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 485 | +-------+--------------------------+ |
| 486 | | ``1`` | Month (one-based) | |
| 487 | +-------+--------------------------+ |
| 488 | | ``2`` | Day of month (one-based) | |
| 489 | +-------+--------------------------+ |
| 490 | | ``3`` | Hours (zero-based) | |
| 491 | +-------+--------------------------+ |
| 492 | | ``4`` | Minutes (zero-based) | |
| 493 | +-------+--------------------------+ |
| 494 | | ``5`` | Seconds (zero-based) | |
| 495 | +-------+--------------------------+ |
| 496 | |
Senthil Kumaran | 29fa9d4 | 2011-10-20 01:46:00 +0800 | [diff] [blame] | 497 | .. note:: |
| 498 | |
| 499 | The ZIP file format does not support timestamps before 1980. |
| 500 | |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 501 | |
| 502 | .. attribute:: ZipInfo.compress_type |
| 503 | |
| 504 | Type of compression for the archive member. |
| 505 | |
| 506 | |
| 507 | .. attribute:: ZipInfo.comment |
| 508 | |
| 509 | Comment for the individual archive member. |
| 510 | |
| 511 | |
| 512 | .. attribute:: ZipInfo.extra |
| 513 | |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 514 | Expansion field data. The `PKZIP Application Note`_ contains |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 515 | some comments on the internal structure of the data contained in this string. |
| 516 | |
| 517 | |
| 518 | .. attribute:: ZipInfo.create_system |
| 519 | |
| 520 | System which created ZIP archive. |
| 521 | |
| 522 | |
| 523 | .. attribute:: ZipInfo.create_version |
| 524 | |
| 525 | PKZIP version which created ZIP archive. |
| 526 | |
| 527 | |
| 528 | .. attribute:: ZipInfo.extract_version |
| 529 | |
| 530 | PKZIP version needed to extract archive. |
| 531 | |
| 532 | |
| 533 | .. attribute:: ZipInfo.reserved |
| 534 | |
| 535 | Must be zero. |
| 536 | |
| 537 | |
| 538 | .. attribute:: ZipInfo.flag_bits |
| 539 | |
| 540 | ZIP flag bits. |
| 541 | |
| 542 | |
| 543 | .. attribute:: ZipInfo.volume |
| 544 | |
| 545 | Volume number of file header. |
| 546 | |
| 547 | |
| 548 | .. attribute:: ZipInfo.internal_attr |
| 549 | |
| 550 | Internal attributes. |
| 551 | |
| 552 | |
| 553 | .. attribute:: ZipInfo.external_attr |
| 554 | |
| 555 | External file attributes. |
| 556 | |
| 557 | |
| 558 | .. attribute:: ZipInfo.header_offset |
| 559 | |
| 560 | Byte offset to the file header. |
| 561 | |
| 562 | |
| 563 | .. attribute:: ZipInfo.CRC |
| 564 | |
| 565 | CRC-32 of the uncompressed file. |
| 566 | |
| 567 | |
| 568 | .. attribute:: ZipInfo.compress_size |
| 569 | |
| 570 | Size of the compressed data. |
| 571 | |
| 572 | |
| 573 | .. attribute:: ZipInfo.file_size |
| 574 | |
| 575 | Size of the uncompressed file. |
Georg Brandl | 5d94134 | 2016-02-26 19:37:12 +0100 | [diff] [blame] | 576 | |
| 577 | .. _PKZIP Application Note: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT |