13.2. gzip — 对 gzip 格式的支持

    此模块提供的简单接口帮助用户压缩和解压缩文件，功能类似于 GNU 应用程序 gzip 和 gunzip。

    数据压缩由 模块提供。

    gzip 模块提供 类和 open()、、decompress() 几个便利的函数。 类可以读写 gzip 格式的文件，还能自动压缩和解压缩数据，这让操作压缩文件如同操作普通的 file object 一样方便。

    注意，此模块不支持部分可以被 gzip 和 gunzip 解压的格式，如利用 compress 或 pack 压缩所得的文件。

    这个模块定义了以下内容：

    (filename, mode=’rb’, compresslevel=9, encoding=None, errors=None, newline=None)

    以二进制方式或者文本方式打开一个 gzip 格式的压缩文件，返回一个 。

    filename 参数可以是一个实际的文件名(一个a str 对象或者 对象), 或者是一个用来读写的已存在的文件对象。

    mode 参数可以是二进制模式： 'r', 'rb', 'a', 'ab', 'w', 'wb', 'x' or 'xb' , 或者是文本模式 'rt', 'at', 'wt', or 'xt'。默认值是 'rb'。

    The compresslevel argument is an integer from 0 to 9, as for the GzipFile constructor.

    对于二进制模式，这个函数等价于 构造器：GzipFile(filename, mode, compresslevel)。在这个例子中，encoding, errors 和 newline 三个参数一定不要设置。

    对于文本模式，将会创建一个 GzipFile 对象，并将它封装到一个 实例中， 这个实例默认了指定编码，错误抓获行为和行。

    在 3.3 版更改: 支持 filename 为一个文件对象，支持文本模式和 encoding, errors 和 newline 参数。

    在 3.4 版更改: 支持 , 'xb' 和``’xt’`` 三种模式。

    在 3.6 版更改: 接受一个 path-like object。

    class gzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)

    类的构造器支持 truncate() 的异常，与 file object 的大多数方法非常相似。fileobj 和 filename 至少有一个不为空。

    当 fileobj 为 None 时， filename 参数只用于 gzip 文件头中，这个文件有可能包含未压缩文件的源文件名。如果文件可以被识别，默认 fileobj 的文件名；否则默认为空字符串，在这种情况下文件头将不包含源文件名。

    The mode argument can be any of 'r', 'rb', 'a', 'ab', 'w', 'wb', 'x', or 'xb', depending on whether the file will be read or written. The default is the mode of fileobj if discernible; otherwise, the default is 'rb'.

    需要注意的是，文件默认使用二进制模式打开。如果要以文本模式打开文件一个压缩文件，请使用 方法(或者使用 io.TextIOWrapper 包装 )。

    compresslevel 参数是一个从 to 9 的整数，用于控制压缩等级；1 最快但压缩比例最小，9 最慢但压缩比例最大。 0 不压缩。默认为 9。

    The mtime argument is an optional numeric timestamp to be written to the last modification time field in the stream when compressing. It should only be provided in compression mode. If omitted or None, the current time is used. See the mtime attribute for more details.

    调用 的 close() 方法不会关闭 fileobj，因为你可以希望增加其它内容到已经压缩的数中。你可以将一个 io.BytesIO 对象作为 fileobj，也可以使用 的 getvalue() 方法从内存缓存中恢复数据。

    支持 io.BufferedIOBase 类的接口, 包括迭代和 语句。只有 truncate() 方法没有实现。

    GzipFile 还提供了以下的方法和属性:

    在 3.1 版更改: 支持 语句，构造器参数 mtime 和 mtime 属性。

    在 3.3 版更改: 实现 方法。

    在 3.4 版更改: 支持 'x' and 'xb' 两种模式。

    在 3.5 版更改: 支持写入任意 bytes-like objects。 方法可以接受``None``为参数。

    在 3.6 版更改: 接受一个 path-like object。

    gzip.compress(data, compresslevel=9)

    压缩 data 返回一个包含压缩数据的 对象。 compresslevel 的意义与上面提到的 GzipFile 构造器一至。

    3.2 新版功能.

    (data)

    解压数据，返回一个 包含未解压数据的对象。

    3.2 新版功能.

    读取压缩文件示例：

    创建GZIP 文件示例：

    使用 GZIP 压缩已有的文件示例：

    使用 GZIP 压缩二进制字符串示例：

    参见

    模块 zlib

    支持 gzip 格式所需要的基本压缩模块。