zipfile
— 操控 ZIP 存档
¶
源代码： Lib/zipfile.py
ZIP 文件格式是常见存档和压缩标准。此模块提供创建、读取、写入、追加和列出 ZIP 文件的工具。此模块的任何高级用法都要求理解格式，作为定义在 PKZIP Application Note .
此模块目前不处理多磁盘 ZIP 文件。它可以处理使用 ZIP64 扩展名的 ZIP 文件 (也就是大小超过 4 GB 的 ZIP 文件)。它支持解密在 ZIP 档案中的加密文件，但目前无法创建加密文件。解密非常慢，因为它是以本机 Python 而不是 C 实现的。
模块定义了下列项：
zipfile.
BadZipFile
¶
由坏 ZIP 文件引发的错误。
3.2 版新增。
zipfile.
BadZipfile
¶
别名化的
BadZipFile
，为兼容较旧版 Python。
从 3.2 版起弃用。
zipfile.
LargeZipFile
¶
The error raised when a ZIP file would require ZIP64 functionality but that has not been enabled.
zipfile.
ZipFile
The class for reading and writing ZIP files. See section ZipFile 对象 for constructor details.
zipfile.
PyZipFile
Class for creating ZIP archives containing Python libraries.
zipfile.
ZipInfo
(
filename='NoName'
,
date_time=(1980
,
1
,
1
,
0
,
0
,
0)
)
¶
Class used to represent information about a member of an archive. Instances of this class are returned by the
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 对象
.
zipfile.
is_zipfile
(
filename
)
¶
返回
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 版改变： 支持文件和像文件对象。
zipfile.
ZIP_STORED
¶
The numeric constant for an uncompressed archive member.
zipfile.
ZIP_DEFLATED
¶
The numeric constant for the usual ZIP compression method. This requires the
zlib
模块。
zipfile.
ZIP_BZIP2
¶
The numeric constant for the BZIP2 compression method. This requires the
bz2
模块。
3.3 版新增。
zipfile.
ZIP_LZMA
¶
The numeric constant for the LZMA compression method. This requires the
lzma
模块。
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.
另请参阅
zipfile.
ZipFile
(
file
,
mode='r'
,
compression=ZIP_STORED
,
allowZip64=True
)
¶
打开 ZIP 文件，其中
file
can be either a path to a file (a string) or a file-like object. The
mode
parameter should be
'r'
to read an existing file,
'w'
to truncate and write a new file, or
'a'
to append to an existing file. If
mode
is
'a'
and
file
refers to an existing ZIP file, then additional files are added to it. If
file
does not refer to a ZIP file, then a new ZIP archive is appended to the file. This is meant for adding a ZIP archive to another file (such as
python.exe
)。若
mode
is
a
and the file does not exist at all, it is created.
压缩
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
RuntimeError
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 also 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 2 GiB. If it is false
zipfile
will raise an exception when the ZIP file would require ZIP64 extensions.
If the file is created with mode
'a'
or
'w'
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')
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.
ZipFile.
close
(
)
¶
Close the archive file. You must call
close()
before exiting your program or essential records will not be written.
ZipFile.
getinfo
(
name
)
¶
返回
ZipInfo
object with information about the archive member
name
。调用
getinfo()
for a name not currently contained in the archive will raise a
KeyError
.
ZipFile.
infolist
(
)
¶
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.
ZipFile.
namelist
(
)
¶
Return a list of archive members by name.
ZipFile.
open
(
name
,
mode='r'
,
pwd=None
)
¶
Extract a member from the archive as a file-like object (ZipExtFile).
name
is the name of the file in the archive, or a
ZipInfo
对象。
mode
parameter, if included, must be one of the following:
'r'
(默认)，
'U'
，或
'rU'
. Choosing
'U'
or
'rU'
will enable
通用换行符
support in the read-only object.
pwd
is the password used for encrypted files. Calling
open()
on a closed ZipFile will raise a
RuntimeError
.
with ZipFile('spam.zip') as myzip: with myzip.open('eggs.txt') as myfile: print(myfile.read())
注意
The file-like object is read-only and provides the following methods:
read()
,
readline()
,
readlines()
,
__iter__()
,
__next__()
.
注意
If the ZipFile was created by passing in a file-like object as the first argument to the constructor, then the object returned by
open()
shares the ZipFile’s file pointer. Under these circumstances, the object returned by
open()
should not be used after any additional operations are performed on the ZipFile object. If the ZipFile was created by passing in a string (the filename) as the first argument to the constructor, then
open()
will create a new file object that will be held by the ZipExtFile, allowing it to operate independently of the ZipFile.
注意
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.
Deprecated since version 3.4, will be removed in version 3.6:
The
'U'
or
'rU'
mode. Use
io.TextIOWrapper
for reading compressed text files in
通用换行符
模式。
ZipFile.
extract
(
member
,
path=None
,
pwd=None
)
¶
Extract a member from the archive to the current working directory;
member
must be its full name or a
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.
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 (
_
).
ZipFile.
extractall
(
path=None
,
members=None
,
pwd=None
)
¶
Extract all members from the archive to the current working directory.
path
specifies a different directory to extract to.
members
is optional and must be a subset of the list returned by
namelist()
.
pwd
is the password used for encrypted files.
警告
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.
ZipFile.
printdir
(
)
¶
Print a table of contents for the archive to
sys.stdout
.
ZipFile.
setpassword
(
pwd
)
¶
Set pwd as default password to extract encrypted files.
ZipFile.
read
(
name
,
pwd=None
)
¶
Return the bytes of the file
name
in the archive.
name
is the name of the file in the archive, or a
ZipInfo
object. The archive must be open for read or append.
pwd
is the password used for encrypted files and, if specified, it will override the default password set with
setpassword()
。调用
read()
on a closed ZipFile will raise a
RuntimeError
。调用
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.
ZipFile.
testzip
(
)
¶
Read all the files in the archive and check their CRC’s and file headers. Return the name of the first bad file, or else return
None
。调用
testzip()
on a closed ZipFile will raise a
RuntimeError
.
ZipFile.
write
(
filename
,
arcname=None
,
compress_type=None
)
¶
Write the file named
filename
to the archive, giving it the archive name
arcname
(by default, this will be the same as
filename
, but without a drive letter and with leading path separators removed). If given,
compress_type
overrides the value given for the
压缩
parameter to the constructor for the new entry. The archive must be open with mode
'w'
or
'a'
– calling
write()
on a ZipFile created with mode
'r'
将引发
RuntimeError
。调用
write()
on a closed ZipFile will raise a
RuntimeError
.
注意
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
write()
. WinZip interprets all file names as encoded in CP437, also known as DOS Latin.
注意
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.
ZipFile.
writestr
(
zinfo_or_arcname
,
bytes
[
,
compress_type
]
)
¶
写入字符串
bytes
to the archive;
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'
or
'a'
– calling
writestr()
on a ZipFile created with mode
'r'
将引发
RuntimeError
。调用
writestr()
on a closed ZipFile will raise a
RuntimeError
.
若给定，
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
实例)。
注意
当传递
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 自变量。
The following data attributes are also available:
ZipFile.
debug
¶
The level of debug output to use. This may be set from
0
(the default, no output) to
3
(the most output). Debugging information is written to
sys.stdout
.
ZipFile.
comment
¶
The comment text associated with the ZIP file. If assigning a comment to a
ZipFile
instance created with mode ‘a’ or ‘w’, this should be a string no longer than 65535 bytes. Comments longer than this will be truncated in the written archive when
close()
被调用。
The
PyZipFile
constructor takes the same parameters as the
ZipFile
constructor, and one additional parameter,
optimize
.
zipfile.
PyZipFile
(
file
,
mode='r'
,
compression=ZIP_STORED
,
allowZip64=True
,
optimize=-1
)
¶
3.2 版新增： The optimize 参数。
3.4 版改变： ZIP64 extensions are enabled by default.
Instances have one method in addition to those of
ZipFile
对象：
writepy
(
pathname
,
basename=''
,
filterfunc=None
)
¶
Search for files
*.py
and add the corresponding file to the archive.
若
optimize
参数用于
PyZipFile
was not given or
-1
, the corresponding file is a
*.pyo
file if available, else 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
*.py[co]
) 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
*.py[co]
are added at the top level. If the directory is a package directory, then all
*.py[co]
are added under the package name as a file path, and if any subdirectories are package directories, all of these are added recursively.
basename is intended for internal use only.
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 版新增： The filterfunc 参数。
实例化的
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.
Instances have the following attributes:
ZipInfo.
filename
¶
Name of the file in the archive.
ZipInfo.
date_time
¶
The time and date of the last modification to the archive member. This is a tuple of six values:
| 索引 | 值 |
|---|---|
0
|
Year (>= 1980) |
1
|
Month (one-based) |
2
|
Day of month (one-based) |
3
|
Hours (zero-based) |
4
|
Minutes (zero-based) |
5
|
Seconds (zero-based) |
注意
The ZIP file format does not support timestamps before 1980.
ZipInfo.
compress_type
¶
Type of compression for the archive member.
ZipInfo.
comment
¶
Comment for the individual archive member.
ZipInfo.
extra
¶
Expansion field data. The PKZIP Application Note contains some comments on the internal structure of the data contained in this string.
ZipInfo.
create_system
¶
System which created ZIP archive.
ZipInfo.
create_version
¶
PKZIP version which created ZIP archive.
ZipInfo.
extract_version
¶
PKZIP version needed to extract archive.
ZipInfo.
reserved
¶
必须为 0。
ZipInfo.
flag_bits
¶
ZIP 标志位。
ZipInfo.
volume
¶
Volume number of file header.
ZipInfo.
internal_attr
¶
Internal attributes.
ZipInfo.
external_attr
¶
External file attributes.
ZipInfo.
header_offset
¶
Byte offset to the file header.
ZipInfo.
CRC
¶
CRC-32 of the uncompressed file.
ZipInfo.
compress_size
¶
Size of the compressed data.
ZipInfo.
file_size
¶
Size of the uncompressed file.