zipfile
— 操控 ZIP 存档
¶
源代码： Lib/zipfile/
ZIP 文件格式是常见存档和压缩标准。此模块提供创建、读取、写入、追加和列出 ZIP 文件的工具。此模块的任何高级用法都要求理解格式，作为定义在 PKZIP Application Note .
此模块目前不处理多磁盘 ZIP 文件。它可以处理使用 ZIP64 扩展名的 ZIP 文件 (也就是大小超过 4 GB 的 ZIP 文件)。它支持解密在 ZIP 档案中的加密文件，但目前无法创建加密文件。解密非常慢，因为它是以本机 Python 而不是 C 实现的。
模块定义了下列项：
由坏 ZIP 文件引发的错误。
Added in version 3.2.
别名化的
BadZipFile
，为兼容较旧版 Python。
从 3.2 版起弃用。
The error raised when a ZIP file would require ZIP64 functionality but that has not been enabled.
The class for reading and writing ZIP files. See section ZipFile 对象 for constructor details.
Class that implements a subset of the interface provided by
pathlib.Path
, including the full
importlib.resources.abc.Traversable
接口。
Added in version 3.8.
Class for creating ZIP archives containing Python libraries.
Class used to represent information about a member of an archive. Instances of this class are returned by the
getinfo()
and
infolist()
methods of
ZipFile
objects. Most users of the
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
ZipInfo 对象
.
Changed in version 3.13:
A public
compress_level
attribute has been added to expose the formerly protected
_compresslevel
. The older protected name continues to work as a property for backwards compatibility.
返回
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.
3.1 版改变： 支持文件和像文件对象。
The numeric constant for an uncompressed archive member.
The numeric constant for the usual ZIP compression method. This requires the
zlib
模块。
The numeric constant for the BZIP2 compression method. This requires the
bz2
模块。
Added in version 3.3.
The numeric constant for the LZMA compression method. This requires the
lzma
模块。
Added in version 3.3.
注意
The ZIP file format specification has included support for bzip2 compression since 2001, and for LZMA compression since 2006. However, some tools (including older Python releases) do not support these compression methods, and may either refuse to process the ZIP file altogether, or fail to extract individual files.
另请参阅
Documentation on the ZIP file format by Phil Katz, the creator of the format and algorithms used.
Information about the Info-ZIP project’s ZIP archive programs and development libraries.
打开 ZIP 文件，其中 file can be a path to a file (a string), a file-like object or a 像路径对象 .
The
mode
parameter should be
'r'
to read an existing file,
'w'
to truncate and write a new file,
'a'
to append to an existing file, or
'x'
to exclusively create and write a new file. If
mode
is
'x'
and
file
refers to an existing file, a
FileExistsError
会被引发。若
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
python.exe
)。若
mode
is
'a'
and the file does not exist at all, it is created. If
mode
is
'r'
or
'a'
, the file should be seekable.
压缩
is the ZIP compression method to use when writing the archive, and should be
ZIP_STORED
,
ZIP_DEFLATED
,
ZIP_BZIP2
or
ZIP_LZMA
; unrecognized values will cause
NotImplementedError
to be raised. If
ZIP_DEFLATED
,
ZIP_BZIP2
or
ZIP_LZMA
is specified but the corresponding module (
zlib
,
bz2
or
lzma
) is not available,
RuntimeError
is raised. The default is
ZIP_STORED
.
若
allowZip64
is
True
(the default) zipfile will create ZIP files that use the ZIP64 extensions when the zipfile is larger than 4 GiB. If it is
false
zipfile
will raise an exception when the ZIP file would require ZIP64 extensions.
The
compresslevel
parameter controls the compression level to use when writing files to the archive. When using
ZIP_STORED
or
ZIP_LZMA
it has no effect. When using
ZIP_DEFLATED
integers
0
through
9
are accepted (see
zlib
for more information). When using
ZIP_BZIP2
integers
1
through
9
are accepted (see
bz2
了解更多信息)。
The
strict_timestamps
argument, when set to
False
, allows to zip files older than 1980-01-01 at the cost of setting the timestamp to 1980-01-01. Similar behavior occurs with files newer than 2107-12-31, the timestamp is also set to the limit.
When mode is
'r'
,
metadata_encoding
may be set to the name of a codec, which will be used to decode metadata such as the names of members and ZIP comments.
If the file is created with mode
'w'
,
'x'
or
'a'
and then
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
with
statement. In the example,
myzip
被关闭后于
with
语句套件的完成 — 即使出现异常：
with ZipFile('spam.zip', 'w') as myzip: myzip.write('eggs.txt')
注意
metadata_encoding is an instance-wide setting for the ZipFile. It is not currently possible to set this on a per-member basis.
This attribute is a workaround for legacy implementations which produce archives with names in the current locale encoding or code page (mostly on Windows). According to the .ZIP standard, the encoding of metadata may be specified to be either IBM code page (default) or UTF-8 by a flag in the archive header. That flag takes precedence over metadata_encoding , which is a Python-specific extension.
3.2 版改变：
Added the ability to use
ZipFile
as a context manager.
3.3 版改变：
添加支持
bzip2
and
lzma
压缩。
3.4 版改变： ZIP64 extensions are enabled by default.
3.5 版改变：
Added support for writing to unseekable streams. Added support for the
'x'
模式。
3.6 版改变：
先前，纯
RuntimeError
was raised for unrecognized compression values.
3.6.2 版改变： The file 参数接受 像路径对象 .
3.7 版改变： 添加 compresslevel 参数。
3.8 版改变： The strict_timestamps 仅关键词参数。
3.11 版改变： Added support for specifying member name encoding for reading metadata in the zipfile’s directory and file headers.
Close the archive file. You must call
close()
before exiting your program or essential records will not be written.
返回
ZipInfo
object with information about the archive member
name
。调用
getinfo()
for a name not currently contained in the archive will raise a
KeyError
.
Return a list containing a
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.
Return a list of archive members by name.
Access a member of the archive as a binary file-like object.
name
can be either the name of a file within the archive or a
ZipInfo
对象。
mode
parameter, if included, must be
'r'
(默认) 或
'w'
.
pwd
is the password used to decrypt encrypted ZIP files as a
bytes
对象。
with ZipFile('spam.zip') as myzip: with myzip.open('eggs.txt') as myfile: print(myfile.read())
采用
mode
'r'
the file-like object (
ZipExtFile
) is read-only and provides the following methods:
read()
,
readline()
,
readlines()
,
seek()
,
tell()
,
__iter__()
,
__next__()
. These objects can operate independently of the ZipFile.
采用
mode='w'
, a writable file handle is returned, which supports the
write()
method. While a writable file handle is open, attempting to read or write other files in the ZIP file will raise a
ValueError
.
In both cases the file-like object has also attributes
name
, which is equivalent to the name of a file within the archive, and
mode
，其是
'rb'
or
'wb'
depending on the input mode.
When writing a file, if the file size is not known in advance but may exceed 2 GiB, pass
force_zip64=True
to ensure that the header format is capable of supporting large files. If the file size is known in advance, construct a
ZipInfo
对象采用
file_size
set, and use that as the
name
参数。
注意
The
open()
,
read()
and
extract()
methods can take a filename or a
ZipInfo
object. You will appreciate this when trying to read a ZIP file that contains members with duplicate names.
3.6 版改变：
Removed support of
mode='U'
。使用
io.TextIOWrapper
for reading compressed text files in
通用换行符
模式。
3.6 版改变：
ZipFile.open()
can now be used to write files into the archive with the
mode='w'
选项。
3.6 版改变：
调用
open()
on a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
Changed in version 3.13:
Added attributes
name
and
mode
for the writeable file-like object. The value of the
mode
attribute for the readable file-like object was changed from
'r'
to
'rb'
.
Extract a member from the archive to the current working directory;
member
must be its full name or a
ZipInfo
object. Its file information is extracted as accurately as possible.
path
specifies a different directory to extract to.
member
can be a filename or a
ZipInfo
对象。
pwd
is the password used for encrypted files as a
bytes
对象。
Returns the normalized path created (a directory or new file).
注意
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 (
:
,
<
,
>
,
|
,
"
,
?
，和
*
) replaced by underscore (
_
).
3.6 版改变：
调用
extract()
on a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
3.6.2 版改变： The path 参数接受 像路径对象 .
Extract all members from the archive to the current working directory.
path
specifies a different directory to extract to.
members
is optional and must be a subset of the list returned by
namelist()
.
pwd
is the password used for encrypted files as a
bytes
对象。
警告
Never extract archives from untrusted sources without prior inspection. It is possible that files are created outside of
path
, e.g. members that have absolute filenames starting with
"/"
or filenames with two dots
".."
. This module attempts to prevent that. See
extract()
note.
3.6 版改变：
调用
extractall()
on a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
3.6.2 版改变： The path 参数接受 像路径对象 .
Print a table of contents for the archive to
sys.stdout
.
Set
pwd
(
bytes
object) as default password to extract encrypted files.
Return the bytes of the file
name
in the archive.
name
is the name of the file in the archive, or a
ZipInfo
object. The archive must be open for read or append.
pwd
is the password used for encrypted files as a
bytes
object and, if specified, overrides the default password set with
setpassword()
。调用
read()
on a ZipFile that uses a compression method other than
ZIP_STORED
,
ZIP_DEFLATED
,
ZIP_BZIP2
or
ZIP_LZMA
将引发
NotImplementedError
. An error will also be raised if the corresponding compression module is not available.
3.6 版改变：
调用
read()
on a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
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
.
3.6 版改变：
调用
testzip()
on a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
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
压缩
parameter to the constructor for the new entry. Similarly,
compresslevel
will override the constructor if given. The archive must be open with mode
'w'
,
'x'
or
'a'
.
注意
The ZIP file standard historically did not specify a metadata encoding, but strongly recommended CP437 (the original IBM PC encoding) for interoperability. Recent versions allow use of UTF-8 (only). In this module, UTF-8 will automatically be used to write the member names if they contain any non-ASCII characters. It is not possible to write member names in any encoding other than ASCII or UTF-8.
注意
Archive names should be relative to the archive root, that is, they should not start with a path separator.
注意
若
arcname
(或
filename
，若
arcname
is not given) contains a null byte, the name of the file in the archive will be truncated at the null byte.
注意
A leading slash in the filename may lead to the archive being impossible to open in some zip programs on Windows systems.
3.6 版改变：
调用
write()
on a ZipFile created with mode
'r'
or a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
Write a file into the archive. The contents is
data
, which may be either a
str
或
bytes
instance; if it is a
str
, it is encoded as UTF-8 first.
zinfo_or_arcname
is either the file name it will be given in the archive, or a
ZipInfo
instance. If it’s an instance, at least the filename, date, and time must be given. If it’s a name, the date and time is set to the current date and time. The archive must be opened with mode
'w'
,
'x'
or
'a'
.
若给定，
compress_type
overrides the value given for the
压缩
parameter to the constructor for the new entry, or in the
zinfo_or_arcname
(if that is a
ZipInfo
instance). Similarly,
compresslevel
will override the constructor if given.
注意
当传递
ZipInfo
instance as the
zinfo_or_arcname
parameter, the compression method used will be that specified in the
compress_type
member of the given
ZipInfo
instance. By default, the
ZipInfo
constructor sets this member to
ZIP_STORED
.
3.2 版改变： The compress_type 自变量。
3.6 版改变：
调用
writestr()
on a ZipFile created with mode
'r'
or a closed ZipFile will raise a
ValueError
. Previously, a
RuntimeError
被引发。
Create a directory inside the archive. If
zinfo_or_directory
is a string, a directory is created inside the archive with the mode that is specified in the
mode
argument. If, however,
zinfo_or_directory
是
ZipInfo
instance then the
mode
argument is ignored.
The archive must be opened with mode
'w'
,
'x'
or
'a'
.
Added in version 3.11.
The following data attributes are also available:
ZIP 文件的名称。
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
.
The comment associated with the ZIP file as a
bytes
object. If assigning a comment to a
ZipFile
instance created with mode
'w'
,
'x'
or
'a'
, it should be no longer than 65535 bytes. Comments longer than this will be truncated.
Construct a Path object from a
root
zipfile (which may be a
ZipFile
instance or
file
suitable for passing to the
ZipFile
构造函数)。
at
specifies the location of this Path within the zipfile, e.g. ‘dir/file.txt’, ‘dir/’, or ‘’. Defaults to the empty string, indicating the root.
Path objects expose the following features of
pathlib.Path
对象：
Path objects are traversable using the
/
operator or
joinpath
.
The final path component.
援引
ZipFile.open()
on the current path. Allows opening for read or write, text or binary through supported modes: ‘r’, ‘w’, ‘rb’, ‘wb’. Positional and keyword arguments are passed through to
io.TextIOWrapper
when opened as text and ignored otherwise.
pwd
是
pwd
参数用于
ZipFile.open()
.
3.9 版改变： Added support for text and binary modes for open. Default mode is now text.
Changed in version 3.11.2:
The
encoding
parameter can be supplied as a positional argument without causing a
TypeError
. As it could in 3.9. Code needing to be compatible with unpatched 3.10 and 3.11 versions must pass all
io.TextIOWrapper
arguments,
encoding
included, as keywords.
Enumerate the children of the current directory.
返回
True
if the current context references a directory.
返回
True
if the current context references a file.
返回
True
if the current context references a symbolic link.
3.12 版添加。
Changed in version 3.13:
先前，
is_symlink
would unconditionally return
False
.
返回
True
if the current context references a file or directory in the zip file.
The last dot-separated portion of the final component, if any. This is commonly called the file extension.
Added in version 3.11:
添加
Path.suffix
特性。
The final path component, without its suffix.
Added in version 3.11:
添加
Path.stem
特性。
A list of the path’s suffixes, commonly called file extensions.
Added in version 3.11:
添加
Path.suffixes
特性。
Read the current file as unicode text. Positional and keyword arguments are passed through to
io.TextIOWrapper
(except
buffer
, which is implied by the context).
Changed in version 3.11.2:
The
encoding
parameter can be supplied as a positional argument without causing a
TypeError
. As it could in 3.9. Code needing to be compatible with unpatched 3.10 and 3.11 versions must pass all
io.TextIOWrapper
arguments,
encoding
included, as keywords.
以字节形式读取当前文件。
Return a new Path object with each of the other arguments joined. The following are equivalent:
>>> Path(...).joinpath('child').joinpath('grandchild') >>> Path(...).joinpath('child', 'grandchild') >>> Path(...) / 'child' / 'grandchild'
3.10 版改变：
Prior to 3.10,
joinpath
was undocumented and accepted exactly one parameter.
The
zipp
project provides backports of the latest path object functionality to older Pythons. Use
zipp.Path
in place of
zipfile.Path
for early access to changes.
The
PyZipFile
constructor takes the same parameters as the
ZipFile
constructor, and one additional parameter,
optimize
.
3.2 版改变： 添加 optimize 参数。
3.4 版改变： ZIP64 extensions are enabled by default.
Instances have one method in addition to those of
ZipFile
对象：
Search for files
*.py
and add the corresponding file to the archive.
若
optimize
参数用于
PyZipFile
was not given or
-1
, the corresponding file is a
*.pyc
file, compiling if necessary.
若
optimize
参数用于
PyZipFile
was
0
,
1
or
2
, only files with that optimization level (see
compile()
) are added to the archive, compiling if necessary.
若
pathname
is a file, the filename must end with
.py
, and just the (corresponding
*.pyc
) file is added at the top level (no path information). If
pathname
is a file that does not end with
.py
，
RuntimeError
will be raised. If it is a directory, and the directory is not a package directory, then all the files
*.pyc
are added at the top level. If the directory is a package directory, then all
*.pyc
are added under the package name as a file path, and if any subdirectories are package directories, all of these are added recursively in sorted order.
basename is intended for internal use only.
filterfunc
, if given, must be a function taking a single string argument. It will be passed each path (including each individual full file path) before it is added to the archive. If
filterfunc
returns a false value, the path will not be added, and if it is a directory its contents will be ignored. For example, if our test files are all either in
test
directories or start with the string
test_
, we can use a
filterfunc
to exclude them:
>>> zf = PyZipFile('myprog.zip') >>> def notests(s): ... fn = os.path.basename(s) ... return (not (fn == 'test' or fn.startswith('test_'))) ... >>> zf.writepy('myprog', filterfunc=notests)
The
writepy()
method makes archives with file names like this:
string.pyc # Top level name test/__init__.pyc # Package directory test/testall.pyc # Module test.testall test/bogus/__init__.pyc # Subpackage directory test/bogus/myfile.pyc # Submodule test.bogus.myfile
3.4 版改变： 添加 filterfunc 参数。
3.6.2 版改变： The pathname 参数接受 像路径对象 .
3.7 版改变： 递归排序目录条目。
实例化的
ZipInfo
class are returned by the
getinfo()
and
infolist()
methods of
ZipFile
objects. Each object stores information about a single member of the ZIP archive.
There is one classmethod to make a
ZipInfo
instance for a filesystem file:
构造
ZipInfo
instance for a file on the filesystem, in preparation for adding it to a zip file.
filename should be the path to a file or directory on the filesystem.
若 arcname is specified, it is used as the name within the archive. If arcname is not specified, the name will be the same as filename , but with any drive letter and leading path separators removed.
The
strict_timestamps
argument, when set to
False
, allows to zip files older than 1980-01-01 at the cost of setting the timestamp to 1980-01-01. Similar behavior occurs with files newer than 2107-12-31, the timestamp is also set to the limit.
Added in version 3.6.
3.6.2 版改变： The filename 参数接受 像路径对象 .
3.8 版改变： 添加 strict_timestamps 仅关键词参数。
Instances have the following methods and attributes:
返回
True
if this archive member is a directory.
This uses the entry’s name: directories should always end with
/
.
Added in version 3.6.
Name of the file in the archive.
The time and date of the last modification to the archive member. This is a tuple of six values:
|
索引 |
值 |
|---|---|
|
|
Year (>= 1980) |
|
|
Month (one-based) |
|
|
Day of month (one-based) |
|
|
Hours (zero-based) |
|
|
Minutes (zero-based) |
|
|
Seconds (zero-based) |
注意
The ZIP file format does not support timestamps before 1980.
Type of compression for the archive member.
Comment for the individual archive member as a
bytes
对象。
Expansion field data. The
PKZIP Application Note
contains some comments on the internal structure of the data contained in this
bytes
对象。
System which created ZIP archive.
PKZIP version which created ZIP archive.
PKZIP version needed to extract archive.
必须为 0。
ZIP 标志位。
Volume number of file header.
Internal attributes.
External file attributes.
Byte offset to the file header.
CRC-32 of the uncompressed file.
Size of the compressed data.
Size of the uncompressed file.
The
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
-c
option and then list the filename(s) that should be included:
$ python -m zipfile -c monty.zip spam.txt eggs.txt
Passing a directory is also acceptable:
$ python -m zipfile -c monty.zip life-of-brian_1979/
If you want to extract a ZIP archive into the specified directory, use the
-e
选项：
$ python -m zipfile -e monty.zip target-dir/
For a list of the files in a ZIP archive, use the
-l
选项：
$ python -m zipfile -l monty.zip
List files in a zipfile.
Create zipfile from source files.
将 zipfile 提取到目标目录下。
Test whether the zipfile is valid or not.
The extraction in zipfile module might fail due to some pitfalls listed below.
Decompression may fail due to incorrect password / CRC checksum / ZIP format or unsupported compression method / decryption.
Exceeding limitations on different file systems can cause decompression failed. Such as allowable characters in the directory entries, length of the file name, length of the pathname, size of a single file, and number of files, etc.
The lack of memory or disk volume would lead to decompression failed. For example, decompression bombs (aka ZIP bomb ) apply to zipfile library that can cause disk volume exhaustion.
Interruption during the decompression, such as pressing control-C or killing the decompression process may result in incomplete decompression of the archive.
Not knowing the default extraction behaviors can cause unexpected decompression results. For example, when extracting the same archive twice, it overwrites files without asking.