gzip
zlib — 压缩兼容 gzip
zlib
bz2 — 支持 bzip2 就业培训 下载中心 Wiki 联络 登录 注册 首页 Python 3.12.4 索引 模块 下一 上一 Python 标准库 数据压缩和存档 gzip — 支持 gzip 文件 gzip — 支持 gzip 文件 ¶ 源代码： Lib/gzip.py This module provides a simple interface to compress and decompress files just like the GNU programs gzip and gunzip would. The data compression is provided by the zlib 模块。 The gzip module provides the GzipFile class, as well as the open() , compress() and decompress() convenience functions. The GzipFile class reads and writes gzip -format files, automatically compressing or decompressing the data so that it looks like an ordinary 文件对象 . Note that additional file formats which can be decompressed by the gzip and gunzip programs, such as those produced by compress and pack , are not supported by this module. 模块定义了下列项： gzip. open ( filename , mode = 'rb' , compresslevel = 9 , encoding = None , errors = None , newline = None ) ¶ Open a gzip-compressed file in binary or text mode, returning a 文件对象 . The filename argument can be an actual filename (a str or bytes object), or an existing file object to read from or write to. The mode argument can be any of 'r' , 'rb' , 'a' , 'ab' , 'w' , 'wb' , 'x' or 'xb' 对于二进制模式，或 'rt' , 'at' , 'wt' ，或 'xt' for text mode. The default is 'rb' . The compresslevel argument is an integer from 0 to 9, as for the GzipFile 构造函数。 For binary mode, this function is equivalent to the GzipFile 构造函数： GzipFile(filename, mode, compresslevel) 。在此情况下， encoding , errors and newline arguments must not be provided. 对于文本模式， GzipFile object is created, and wrapped in an io.TextIOWrapper instance with the specified encoding, error handling behavior, and line ending(s). 3.3 版改变： 添加支持 filename being a file object, support for text mode, and the encoding , errors and newline 自变量。 3.4 版改变： 添加支持 'x' , 'xb' and 'xt' 模式。 3.6 版改变： 接受 像路径对象 . exception gzip. BadGzipFile ¶ An exception raised for invalid gzip files. It inherits from OSError . EOFError and zlib.error can also be raised for invalid gzip files. Added in version 3.8. class gzip. GzipFile ( filename = None , mode = None , compresslevel = 9 , fileobj = None , mtime = None ) ¶ 构造函数对于 GzipFile class, which simulates most of the methods of a 文件对象 , with the exception of the truncate() method. At least one of fileobj and filename must be given a non-trivial value. The new class instance is based on fileobj , which can be a regular file, an io.BytesIO object, or any other object which simulates a file. It defaults to None ，在这种情况下 filename is opened to provide a file object. 当 fileobj 不是 None ， filename argument is only used to be included in the gzip file header, which may include the original filename of the uncompressed file. It defaults to the filename of fileobj , if discernible; otherwise, it defaults to the empty string, and in this case the original filename is not included in the header. The mode argument can be any of 'r' , 'rb' , 'a' , 'ab' , 'w' , 'wb' , 'x' ，或 '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' . In future Python releases the mode of fileobj will not be used. It is better to always specify mode for writing. Note that the file is always opened in binary mode. To open a compressed file in text mode, use open() (or wrap your GzipFile with an io.TextIOWrapper ). The compresslevel argument is an integer from 0 to 9 controlling the level of compression; 1 is fastest and produces the least compression, and 9 is slowest and produces the most compression. 0 is no compression. The default is 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. Calling a GzipFile 对象的 close() method does not close fileobj , since you might wish to append more material after the compressed data. This also allows you to pass an io.BytesIO object opened for writing as fileobj , and retrieve the resulting memory buffer using the io.BytesIO 对象的 getvalue() 方法。 GzipFile 支持 io.BufferedIOBase interface, including iteration and the with statement. Only the truncate() method isn’t implemented. GzipFile also provides the following method and attribute: peek ( n ) ¶ 读取 n uncompressed bytes without advancing the file position. At most one single read on the compressed stream is done to satisfy the call. The number of bytes returned may be more or less than requested. 注意 While calling peek() does not change the file position of the GzipFile , it may change the position of the underlying file object (e.g. if the GzipFile was constructed with the fileobj parameter). Added in version 3.2. mtime ¶ When decompressing, the value of the last modification time field in the most recently read header may be read from this attribute, as an integer. The initial value before reading any headers is None . 所有 gzip compressed streams are required to contain this timestamp field. Some programs, such as gunzip , make use of the timestamp. The format is the same as the return value of time.time() 和 st_mtime attribute of the object returned by os.stat() . name ¶ The path to the gzip file on disk, as a str or bytes . Equivalent to the output of os.fspath() on the original input path, with no other normalization, resolution or expansion. 3.1 版改变： 支持 with statement was added, along with the mtime constructor argument and mtime 属性。 3.2 版改变： Support for zero-padded and unseekable files was added. 3.3 版改变： The io.BufferedIOBase.read1() method is now implemented. 3.4 版改变： 添加支持 'x' and 'xb' 模式。 3.5 版改变： Added support for writing arbitrary 像字节对象 。 read() method now accepts an argument of None . 3.6 版改变： 接受 像路径对象 . Changed in version 3.12: Remove the filename attribute, use the name attribute instead. 从 3.9 版起弃用： 打开 GzipFile for writing without specifying the mode argument is deprecated. gzip. compress ( data , compresslevel = 9 , * , mtime = None ) ¶ 压缩 data ，返回 bytes object containing the compressed data. compresslevel and mtime 拥有相同含义如在 GzipFile constructor above. When mtime 被设为 0 , this function is equivalent to zlib.compress() with wbits 设为 31 . The zlib function is faster. Added in version 3.2. 3.8 版改变： 添加 mtime parameter for reproducible output. 3.11 版改变： Speed is improved by compressing all data at once instead of in a streamed fashion. Calls with mtime 设为 0 are delegated to zlib.compress() for better speed. gzip. decompress ( data ) ¶ 解压缩 data ，返回 bytes object containing the uncompressed data. This function is capable of decompressing multi-member gzip data (multiple gzip blocks concatenated together). When the data is certain to contain only one member the zlib.decompress() function with wbits set to 31 is faster. Added in version 3.2. 3.11 版改变： Speed is improved by decompressing members at once in memory instead of in a streamed fashion. 用法范例 ¶ Example of how to read a compressed file: import gzip with gzip.open('/home/joe/file.txt.gz', 'rb') as f: file_content = f.read() Example of how to create a compressed GZIP file: import gzip content = b"Lots of content here" with gzip.open('/home/joe/file.txt.gz', 'wb') as f: f.write(content) Example of how to GZIP compress an existing file: import gzip import shutil with open('/home/joe/file.txt', 'rb') as f_in: with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out: shutil.copyfileobj(f_in, f_out) Example of how to GZIP compress a binary string: import gzip s_in = b"Lots of content here" s_out = gzip.compress(s_in) 另请参阅 模块 zlib The basic data compression module needed to support the gzip 文件格式。 命令行接口 ¶ The gzip module provides a simple command line interface to compress or decompress files. Once executed the gzip module keeps the input file(s). 3.8 版改变： Add a new command line interface with a usage. By default, when you will execute the CLI, the default compression level is 6. 命令行选项 ¶ file ¶ 若 file 未指定，读取自 sys.stdin . --fast ¶ Indicates the fastest compression method (less compression). --best ¶ Indicates the slowest compression method (best compression). -d , --decompress ¶ 解压缩给定文件。 -h , --help ¶ 展示帮助消息。 内容表 gzip — 支持 gzip 文件 用法范例 命令行接口 命令行选项 上一话题 zlib — 压缩兼容 gzip 下一话题 bz2 — 支持 bzip2 压缩 本页 报告 Bug 展示源 快速搜索 键入搜索术语或模块、类、函数名称。 首页 Python 3.12.4 索引 模块 下一 上一 Python 标准库 数据压缩和存档 gzip — 支持 gzip 文件
bz2
源代码： Lib/gzip.py
This module provides a simple interface to compress and decompress files just like the GNU programs gzip and gunzip would.
The data compression is provided by the zlib 模块。
The gzip module provides the GzipFile class, as well as the open() , compress() and decompress() convenience functions. The GzipFile class reads and writes gzip -format files, automatically compressing or decompressing the data so that it looks like an ordinary 文件对象 .
GzipFile
open()
compress()
decompress()
Note that additional file formats which can be decompressed by the gzip and gunzip programs, such as those produced by compress and pack , are not supported by this module.
模块定义了下列项：
Open a gzip-compressed file in binary or text mode, returning a 文件对象 .
The filename argument can be an actual filename (a str or bytes object), or an existing file object to read from or write to.
str
bytes
The mode argument can be any of 'r' , 'rb' , 'a' , 'ab' , 'w' , 'wb' , 'x' or 'xb' 对于二进制模式，或 'rt' , 'at' , 'wt' ，或 'xt' for text mode. The default is 'rb' .
'r'
'rb'
'a'
'ab'
'w'
'wb'
'x'
'xb'
'rt'
'at'
'wt'
'xt'
The compresslevel argument is an integer from 0 to 9, as for the GzipFile 构造函数。
For binary mode, this function is equivalent to the GzipFile 构造函数： GzipFile(filename, mode, compresslevel) 。在此情况下， encoding , errors and newline arguments must not be provided.
GzipFile(filename, mode, compresslevel)
对于文本模式， GzipFile object is created, and wrapped in an io.TextIOWrapper instance with the specified encoding, error handling behavior, and line ending(s).
io.TextIOWrapper
3.3 版改变： 添加支持 filename being a file object, support for text mode, and the encoding , errors and newline 自变量。
3.4 版改变： 添加支持 'x' , 'xb' and 'xt' 模式。
3.6 版改变： 接受 像路径对象 .
An exception raised for invalid gzip files. It inherits from OSError . EOFError and zlib.error can also be raised for invalid gzip files.
OSError
EOFError
zlib.error
Added in version 3.8.
构造函数对于 GzipFile class, which simulates most of the methods of a 文件对象 , with the exception of the truncate() method. At least one of fileobj and filename must be given a non-trivial value.
truncate()
The new class instance is based on fileobj , which can be a regular file, an io.BytesIO object, or any other object which simulates a file. It defaults to None ，在这种情况下 filename is opened to provide a file object.
io.BytesIO
None
当 fileobj 不是 None ， filename argument is only used to be included in the gzip file header, which may include the original filename of the uncompressed file. It defaults to the filename of fileobj , if discernible; otherwise, it defaults to the empty string, and in this case the original filename is not included in the header.
The mode argument can be any of 'r' , 'rb' , 'a' , 'ab' , 'w' , 'wb' , 'x' ，或 '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' . In future Python releases the mode of fileobj will not be used. It is better to always specify mode for writing.
Note that the file is always opened in binary mode. To open a compressed file in text mode, use open() (or wrap your GzipFile with an io.TextIOWrapper ).
The compresslevel argument is an integer from 0 to 9 controlling the level of compression; 1 is fastest and produces the least compression, and 9 is slowest and produces the most compression. 0 is no compression. The default is 9 .
0
9
1
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.
mtime
Calling a GzipFile 对象的 close() method does not close fileobj , since you might wish to append more material after the compressed data. This also allows you to pass an io.BytesIO object opened for writing as fileobj , and retrieve the resulting memory buffer using the io.BytesIO 对象的 getvalue() 方法。
close()
getvalue()
GzipFile 支持 io.BufferedIOBase interface, including iteration and the with statement. Only the truncate() method isn’t implemented.
io.BufferedIOBase
with
GzipFile also provides the following method and attribute:
读取 n uncompressed bytes without advancing the file position. At most one single read on the compressed stream is done to satisfy the call. The number of bytes returned may be more or less than requested.
注意
While calling peek() does not change the file position of the GzipFile , it may change the position of the underlying file object (e.g. if the GzipFile was constructed with the fileobj parameter).
peek()
Added in version 3.2.
When decompressing, the value of the last modification time field in the most recently read header may be read from this attribute, as an integer. The initial value before reading any headers is None .
所有 gzip compressed streams are required to contain this timestamp field. Some programs, such as gunzip , make use of the timestamp. The format is the same as the return value of time.time() 和 st_mtime attribute of the object returned by os.stat() .
time.time()
st_mtime
os.stat()
The path to the gzip file on disk, as a str or bytes . Equivalent to the output of os.fspath() on the original input path, with no other normalization, resolution or expansion.
os.fspath()
3.1 版改变： 支持 with statement was added, along with the mtime constructor argument and mtime 属性。
3.2 版改变： Support for zero-padded and unseekable files was added.
3.3 版改变： The io.BufferedIOBase.read1() method is now implemented.
io.BufferedIOBase.read1()
3.4 版改变： 添加支持 'x' and 'xb' 模式。
3.5 版改变： Added support for writing arbitrary 像字节对象 。 read() method now accepts an argument of None .
read()
Changed in version 3.12: Remove the filename attribute, use the name attribute instead.
filename
name
从 3.9 版起弃用： 打开 GzipFile for writing without specifying the mode argument is deprecated.
压缩 data ，返回 bytes object containing the compressed data. compresslevel and mtime 拥有相同含义如在 GzipFile constructor above. When mtime 被设为 0 , this function is equivalent to zlib.compress() with wbits 设为 31 . The zlib function is faster.
zlib.compress()
31
3.8 版改变： 添加 mtime parameter for reproducible output.
3.11 版改变： Speed is improved by compressing all data at once instead of in a streamed fashion. Calls with mtime 设为 0 are delegated to zlib.compress() for better speed.
解压缩 data ，返回 bytes object containing the uncompressed data. This function is capable of decompressing multi-member gzip data (multiple gzip blocks concatenated together). When the data is certain to contain only one member the zlib.decompress() function with wbits set to 31 is faster.
zlib.decompress()
3.11 版改变： Speed is improved by decompressing members at once in memory instead of in a streamed fashion.
Example of how to read a compressed file:
import gzip with gzip.open('/home/joe/file.txt.gz', 'rb') as f: file_content = f.read()
Example of how to create a compressed GZIP file:
import gzip content = b"Lots of content here" with gzip.open('/home/joe/file.txt.gz', 'wb') as f: f.write(content)
Example of how to GZIP compress an existing file:
import gzip import shutil with open('/home/joe/file.txt', 'rb') as f_in: with gzip.open('/home/joe/file.txt.gz', 'wb') as f_out: shutil.copyfileobj(f_in, f_out)
Example of how to GZIP compress a binary string:
import gzip s_in = b"Lots of content here" s_out = gzip.compress(s_in)
另请参阅
The basic data compression module needed to support the gzip 文件格式。
The gzip module provides a simple command line interface to compress or decompress files.
Once executed the gzip module keeps the input file(s).
3.8 版改变： Add a new command line interface with a usage. By default, when you will execute the CLI, the default compression level is 6.
若 file 未指定，读取自 sys.stdin .
sys.stdin
Indicates the fastest compression method (less compression).
Indicates the slowest compression method (best compression).
解压缩给定文件。
展示帮助消息。
bz2 — 支持 bzip2 压缩
键入搜索术语或模块、类、函数名称。