with ZipFile('spam.zip') as myzip:
with myzip.open('eggs.txt') as myfile:
print(myfile.read())
如果 mode 为 'r' 则文件型对象 (ZipExtFile) 将为只读并且提供下列方法: read(), readline(), readlines(), seek(), tell(), __iter__(), __next__()。 这些对象可独立于 ZipFile 进行操作。
如果 mode='w' 则返回一个可写入的文件句柄，它将支持 write() 方法。 当一个可写入的文件句柄被打开时，尝试读写 ZIP 文件中的其他文件将会引发 ValueError。
当写入一个文件时，如果文件大小不能预先确定但是可能超过 2 GiB，可传入 force_zip64=True 以确保标头格式能够支持超大文件。 如果文件大小可以预先确定，则在构造 ZipInfo 对象时应设置 file_size，并将其用作 name 形参。
open(), read() 和 extract() 方法可接受文件名或 ZipInfo 对象。 当尝试读取一个包含重复名称成员的 ZIP 文件时你将发现此功能很有好处。
3.6 版更變: 移除了对 mode='U' 的支持。 请使用 io.TextIOWrapper 以在 universal newlines 模式中读取已压缩的文本文件。
3.6 版更變: 现在 ZipFile.open() 可以被用来配合 mode='w' 选项将文件写入归档。
3.6 版更變: 在已关闭的 ZipFile 上调用 open() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。
ZipFile.extract(member, path=None, pwd=None)
从归档中提取一个成员放入当前工作目录；member 必须是一个成员的完整名称或 ZipInfo 对象。 成员的文件信息会尽可能精确地被提取。 path 指定一个要放入的不同目录。 member 可以是一个文件名或 ZipInfo 对象。 pwd 是 bytes 对象形式的用于解密已加密文件的密码。
返回所创建的经正规化的路径（对应于目录或新文件）。
如果一个成员文件名为绝对路径，则将去掉驱动器/UNC共享点和前导的（反）斜杠，例如: ///foo/bar 在 Unix 上将变为 foo/bar，而 C:\foo\bar 在 Windows 上将变为 foo\bar。 并且一个成员文件名中的所有 ".." 都将被移除，例如: ../../foo../../ba..r 将变为 foo../ba..r。 在 Windows 上非法字符 (:, <, >, |, ", ?, and *) 会被替换为下划线 (_)。
3.6 版更變: 在已关闭的 ZipFile 上调用 extract() 将引发 ValueError。 在之前的版本中则将引发 RuntimeError。
3.6.2 版更變: path 形参接受一个 path-like object。
ZipFile.extractall(path=None, members=None, pwd=None)
从归档中提取出所有成员放入当前工作目录。 path 指定一个要放入的不同目录。 members 为可选项且必须为 namelist() 所返回列表的一个子集。 pwd 是 bytes 对象形式的用于解密已加密文件的密码。
绝不要未经预先检验就从不可靠的源中提取归档文件。 这样有可能在 path 之外创建文件，例如某些成员具有以 "/" 开始的文件名或带有两个点号 ".." 的文件名。 此模块会尝试防止这种情况。 参见 extract() 的注释。
3.6 版更變: 在已关闭的 ZipFile 上调用 extractall() 将引发 ValueError。 在之前的版本中则将引发 RuntimeError。
3.6.2 版更變: path 形参接受一个 path-like object。
ZipFile.read(name, pwd=None)
返回归档中文件 name 的字节数据。 name 是归档中文件的名称，或是一个 ZipInfo 对象。 归档必须以读取或追加模式打开。 pwd 为 bytes 对象形式的用于解密已加密文件的密码，并且如果指定了该参数则它将覆盖通过 setpassword() 设置的默认密码。 在使用 ZIP_STORED, ZIP_DEFLATED, ZIP_BZIP2 or ZIP_LZMA 以外的压缩方法的 ZipFile 上调用 read() 将引发 NotImplementedError。 如果相应的压缩模块不可用也会引发错误。
3.6 版更變: 在已关闭的 ZipFile 上调用 read() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。
ZipFile.write(filename, arcname=None, compress_type=None, compresslevel=None)
将名为 filename 的文件写入归档，给予的归档名为 arcname (默认情况下将与 filename 一致，但是不带驱动器盘符并会移除开头的路径分隔符)。 compress_type 如果给出，它将覆盖作为构造器 compression 形参对于新条目所给出的值。 类似地，compresslevel 如果给出也将覆盖构造器。 归档必须使用 'w', 'x' 或 'a' 模式打开。
归档名称应当是基于归档根目录的相对路径，也就是说，它们不应以路径分隔符开头。
如果 arcname (或 filename，如果 arcname 未给出) 包含一个空字节，则归档中该文件的名称将在空字节位置被截断。
文件名开头有一个斜杠可能导致存档文件无法在 Windows 系统上的某些 zip 程序中打开。
3.6 版更變: 在使用 'r' 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 write() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。
ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, compresslevel=None)
将一个文件写入归档。 内容为 data，它可以是一个 str 或 bytes 的实例；如果是 str，则会先使用 UTF-8 进行编码。 zinfo_or_arcname 可以是它在归档中将被给予的名称，或者是 ZipInfo 的实例。 如果它是一个实例，则至少必须给定文件名、日期和时间。 如果它是一个名称，则日期和时间会被设为当前日期和时间。 归档必须以 'w', 'x' 或 'a' 模式打开。
如果给定了 compress_type，它将会覆盖作为新条目构造器的 compression 形参或在 zinfo_or_arcname (如果是一个 ZipInfo 实例) 中所给出的值。 类似地，如果给定了 compresslevel，它将会覆盖构造器。
当传入一个 ZipInfo 实例作为 zinfo_or_arcname 形参时，所使用的压缩方法将为在给定的 ZipInfo 实例的 compress_type 成员中指定的方法。 默认情况下，ZipInfo 构造器将将此成员设为 ZIP_STORED。
3.2 版更變: compress_type 引數。
3.6 版更變: 在使用 'r' 模式创建的 ZipFile 或已关闭的 ZipFile 上调用 writestr() 将引发 ValueError。 在之前的版本中则会引发 RuntimeError。
以下数据属性也是可用的:
ZipFile.filename
ZIP 文件的名称。
class zipfile.Path(root, at='')
根据 root zipfile (它可以是一个 ZipFile 实例或适合传给 ZipFile 构造器的 file) 构造一个 Path 对象。
at 指定此 Path 在 zipfile 中的位置，例如 'dir/file.txt', 'dir/' 或 ''。 默认为空字符串，即指定跟目录。
Path 对象会公开 pathlib.Path 对象的下列特性:
Path 对象可以使用 / 运算符或 joinpath 来进行遍历。
Path.name
最终的路径组成部分。
Path.open(mode='r', *, pwd, **)
在当前路径上发起调用 ZipFile.open()。 允许通过支持的模式打开用于读取或写入文本或二进制数据: 'r', 'w', 'rb', 'wb'。 当以文本模式打开时位置和关键字参数会被传给 io.TextIOWrapper，在其他情况下则会被忽略。 pwd 是要传给 ZipFile.open() 的 pwd 形参。
3.9 版更變: 增加了对以文本和二进制模式打开的支持。 现在默认为文本模式。
3.10.10 版更變: encoding 形参可以作为位置参数来提供而不会引起 TypeError。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 io.TextIOWrapper 参数，包括 encoding 作为关键字参数传入。
Path.read_text(*, **)
读取当前文件为 unicode 文本。 位置和关键字参数会被传递给 io.TextIOWrapper (buffer 除外，它将由上下文确定)。
3.10.10 版更變: encoding 形参可以作为位置参数来提供而不会引起 TypeError。 这种情况在 3.9 中是会发生的。 需要与未打补丁的 3.10 和 3.11 版保持兼容的代码必须将所有 io.TextIOWrapper 参数，包括 encoding 作为关键字参数传入。
Path.joinpath(*other)
返回一个新的 Path 对象，其中合并了每个 other 参数。 以下代码是等价的:
>>> Path(...).joinpath('child').joinpath('grandchild')
>>> Path(...).joinpath('child', 'grandchild')
>>> Path(...) / 'child' / 'grandchild'
3.10 版更變: 在 3.10 之前，joinpath 未被写入文档并且只接受一个形参。
class zipfile.PyZipFile(file, mode='r', compression=ZIP_STORED, allowZip64=True, optimize=- 1)
3.2 版新加入: optimize 參數。
3.4 版更變: 默认启用 ZIP64 扩展。
实例在 ZipFile 对象所具有的方法以外还附加了一个方法:
writepy(pathname, basename='', filterfunc=None)
查找 *.py 文件并将相应的文件添加到归档。
如果 PyZipFile 的 optimize 形参未给定或为 -1，则相应的文件为 *.pyc 文件，并在必要时进行编译。
如果 PyZipFile 的 optimize 形参为 0, 1 或 2，则限具有相应优化级别 (参见 compile()) 的文件会被添加到归档，并在必要时进行编译。
如果 pathname 是文件，则文件名必须以 .py 为后缀，并且只有 (相应的 *.pyc) 文件会被添加到最高层级（不带路径信息）。 如果 pathname 不是以 .py 为后缀的文件，则将引发 RuntimeError。 如果它是目录，并且该目录不是一个包目录，则所有的 *.pyc 文件会被添加到最高层级。 如果目录是一个包目录，则所有的 *.pyc 会被添加到包名所表示的文件路径下，并且如果有任何子目录为包目录，则会以排好的顺序递归地添加这些目录。
basename 仅限在内部使用。
如果给定 filterfunc，则它必须是一个接受单个字符串参数的函数。 在将其添加到归档之前它将被传入每个路径（包括每个单独的完整路径）。 如果 filterfunc 返回假值，则路径将不会被添加，而如果它是一个目录则其内容将被忽略。 例如，如果我们的测试文件全都位于 test 目录或以字符串 test_ 打头，则我们可以使用一个 filterfunc 来排除它们:
>>> 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)
writepy() 方法会产生带有这样一些文件名的归档:
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 版更變: pathname 形参接受一个 path-like object。
3.7 版更變: 递归排序目录条目。
ZipInfo 物件
ZipInfo 类的实例会通过 getinfo() 和 ZipFile 对象的 infolist() 方法返回。 每个对象将存储关于 ZIP 归档的一个成员的信息。
有一个类方法可以为文件系统文件创建 ZipInfo 实例:
classmethod ZipInfo.from_file(filename, arcname=None, *, strict_timestamps=True)
为文件系统中的文件构造一个 ZipInfo 实例，并准备将其添加到一个 zip 文件。
filename 应为文件系统中某个文件或目录的路径。
如果指定了 arcname，它会被用作归档中的名称。 如果未指定 arcname，则所用名称与 filename 相同，但将去除任何驱动器盘符和打头的路径分隔符。
strict_timestamps 参数在设为 False 时允许压缩早于 1980-01-01 的文件，代价时会将时间戳设为 1980-01-01。 类似的行为也会对晚于 2107-12-31 的文件发生，时间戳也会被设为该上限值。
3.6 版新加入.
3.6.2 版更變: filename 形参接受一个 path-like object。
3.8 版新加入: strict_timestamps 仅限关键字参数
实例具有下列方法和属性:
ZipInfo.is_dir()
如果此归档成员是一个目录则返回 True。
这会使用条目的名称：目录应当总是以 / 结尾。
3.6 版新加入.
命令行接口
zipfile 模块提供了简单的命令行接口用于与 ZIP 归档的交互。
如果你想要创建一个新的 ZIP 归档，请在 -c 选项后指定其名称然后列出应当被包含的文件名:
$ python -m zipfile -c monty.zip spam.txt eggs.txt
传入一个目录也是可接受的:
$ python -m zipfile -c monty.zip life-of-brian_1979/
如果你想要将一个 ZIP 归档提取到指定的目录，请使用 -e 选项:
$ python -m zipfile -e monty.zip target-dir/
要获取一个 ZIP 归档中的文件列表，请使用 -l 选项:
$ python -m zipfile -l monty.zip
命令行选项
-l <zipfile>
--list <zipfile>
列出一个 zipfile 中的文件名。
2001-2024, Python Software Foundation.
This page is licensed under the Python Software Foundation License Version 2.
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
See History and License for more information.
