gzip — 對 gzip 格式的支持 · Python3.7.3官方文檔簡體中文

### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](bz2.xhtml "bz2 --- 對 bzip2 壓縮算法的支持") | - [上一頁](zlib.xhtml "zlib --- 與 gzip 兼容的壓縮") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 標準庫](index.xhtml) ? - [數據壓縮和存檔](archiving.xhtml) ? - $('.inline-search').show(0); | # [`gzip`](#module-gzip "gzip: Interfaces for gzip compression and decompression using file objects.") --- 對 **gzip** 格式的支持 **源代碼：** [Lib/gzip.py](https://github.com/python/cpython/tree/3.7/Lib/gzip.py) \[https://github.com/python/cpython/tree/3.7/Lib/gzip.py\] - - - - - - 此模塊提供的簡單接口幫助用戶壓縮和解壓縮文件，功能類似于 GNU 應用程序 **gzip** 和 **gunzip**。數據壓縮由 [`zlib`](zlib.xhtml#module-zlib "zlib: Low-level interface to compression and decompression routines compatible with gzip.") 模塊提供。 [`gzip`](#module-gzip "gzip: Interfaces for gzip compression and decompression using file objects.") 模塊提供 [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") 類和便利的 [`open()`](#gzip.open "gzip.open")、[`compress()`](#gzip.compress "gzip.compress")、[`decompress()`](#gzip.decompress "gzip.decompress") 函數。[`GzipFile`](#gzip.GzipFile "gzip.GzipFile") 類讀寫 **gzip** 格式的文件，同時自動壓縮和解壓縮數據，這讓操作壓縮文件如同操作普通的 [file object](../glossary.xhtml#term-file-object) 一樣方便。注意，此模塊不支持部分可以被 **gzip** 和 **gunzip** 解壓的格式，如利用 **compress** 或 **pack** 壓縮所得的文件。這個模塊定義了以下內容： `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 [file object](../glossary.xhtml#term-file-object). The *filename* argument can be an actual filename (a [`str`](stdtypes.xhtml#str "str") or [`bytes`](stdtypes.xhtml#bytes "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'` for binary mode, or `'rt'`, `'at'`, `'wt'`, or `'xt'` for text mode. The default is `'rb'`. The *compresslevel* argument is an integer from 0 to 9, as for the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") constructor. For binary mode, this function is equivalent to the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile")constructor: `GzipFile(filename, mode, compresslevel)`. In this case, the *encoding*, *errors* and *newline* arguments must not be provided. For text mode, a [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") object is created, and wrapped in an [`io.TextIOWrapper`](io.xhtml#io.TextIOWrapper "io.TextIOWrapper") instance with the specified encoding, error handling behavior, and line ending(s). 在 3.3 版更改: Added support for *filename* being a file object, support for text mode, and the *encoding*, *errors* and *newline* arguments. 在 3.4 版更改: Added support for the `'x'`, `'xb'` and `'xt'` modes. 在 3.6 版更改: 接受一個 [類路徑對象](../glossary.xhtml#term-path-like-object)。 *class* `gzip.``GzipFile`(*filename=None*, *mode=None*, *compresslevel=9*, *fileobj=None*, *mtime=None*)Constructor for the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") class, which simulates most of the methods of a [file object](../glossary.xhtml#term-file-object), 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`](io.xhtml#io.BytesIO "io.BytesIO") object, or any other object which simulates a file. It defaults to `None`, in which case *filename* is opened to provide a file object. When *fileobj* is not `None`, the *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'`, 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'`. Note that the file is always opened in binary mode. To open a compressed file in text mode, use [`open()`](#gzip.open "gzip.open") (or wrap your [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") with an [`io.TextIOWrapper`](io.xhtml#io.TextIOWrapper "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`](#gzip.GzipFile.mtime "gzip.GzipFile.mtime") attribute for more details. Calling a [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") object's `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`](io.xhtml#io.BytesIO "io.BytesIO") object opened for writing as *fileobj*, and retrieve the resulting memory buffer using the [`io.BytesIO`](io.xhtml#io.BytesIO "io.BytesIO") object's [`getvalue()`](io.xhtml#io.BytesIO.getvalue "io.BytesIO.getvalue") method. [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") supports the [`io.BufferedIOBase`](io.xhtml#io.BufferedIOBase "io.BufferedIOBase") interface, including iteration and the [`with`](../reference/compound_stmts.xhtml#with) statement. Only the `truncate()` method isn't implemented. [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") also provides the following method and attribute: `peek`(*n*)Read *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()`](#gzip.GzipFile.peek "gzip.GzipFile.peek") does not change the file position of the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile"), it may change the position of the underlying file object (e.g. if the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") was constructed with the *fileobj* parameter). 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`. All **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()`](time.xhtml#time.time "time.time") and the [`st_mtime`](os.xhtml#os.stat_result.st_mtime "os.stat_result.st_mtime") attribute of the object returned by [`os.stat()`](os.xhtml#os.stat "os.stat"). 在 3.1 版更改: Support for the [`with`](../reference/compound_stmts.xhtml#with) statement was added, along with the *mtime* constructor argument and [`mtime`](#gzip.GzipFile.mtime "gzip.GzipFile.mtime") attribute. 在 3.2 版更改: Support for zero-padded and unseekable files was added. 在 3.3 版更改: The [`io.BufferedIOBase.read1()`](io.xhtml#io.BufferedIOBase.read1 "io.BufferedIOBase.read1") method is now implemented. 在 3.4 版更改: Added support for the `'x'` and `'xb'` modes. 在 3.5 版更改: Added support for writing arbitrary [bytes-like objects](../glossary.xhtml#term-bytes-like-object). The [`read()`](io.xhtml#io.BufferedIOBase.read "io.BufferedIOBase.read") method now accepts an argument of `None`. 在 3.6 版更改: 接受一個 [類路徑對象](../glossary.xhtml#term-path-like-object)。 `gzip.``compress`(*data*, *compresslevel=9*)Compress the *data*, returning a [`bytes`](stdtypes.xhtml#bytes "bytes") object containing the compressed data. *compresslevel* has the same meaning as in the [`GzipFile`](#gzip.GzipFile "gzip.GzipFile") constructor above. 3\.2 新版功能. `gzip.``decompress`(*data*)Decompress the *data*, returning a [`bytes`](stdtypes.xhtml#bytes "bytes") object containing the uncompressed data. 3\.2 新版功能. ## 用法示例如何讀取一個壓縮文件： ``` import gzip with gzip.open('/home/joe/file.txt.gz', 'rb') as f: file_content = f.read() ``` 如何創建一個 GZIP 文件： ``` import gzip content = b"Lots of content here" with gzip.open('/home/joe/file.txt.gz', 'wb') as f: f.write(content) ``` 如何使用 GZIP 壓縮一個已有的文件： ``` 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) ``` 如何使用 GZIP 壓縮一個二進制串： ``` import gzip s_in = b"Lots of content here" s_out = gzip.compress(s_in) ``` 參見模塊 [`zlib`](zlib.xhtml#module-zlib "zlib: Low-level interface to compression and decompression routines compatible with gzip.")支持 **gzip** 格式所需要的基本壓縮模塊。 ### 導航 - [索引](../genindex.xhtml "總目錄") - [模塊](../py-modindex.xhtml "Python 模塊索引") | - [下一頁](bz2.xhtml "bz2 --- 對 bzip2 壓縮算法的支持") | - [上一頁](zlib.xhtml "zlib --- 與 gzip 兼容的壓縮") | - ![](https://box.kancloud.cn/a721fc7ec672275e257bbbfde49a4d4e_16x16.png) - [Python](https://www.python.org/) ? - zh\_CN 3.7.3 [文檔](../index.xhtml) ? - [Python 標準庫](index.xhtml) ? - [數據壓縮和存檔](archiving.xhtml) ? - $('.inline-search').show(0); | ? [版權所有](../copyright.xhtml) 2001-2019, Python Software Foundation. Python 軟件基金會是一個非盈利組織。 [請捐助。](https://www.python.org/psf/donations/) 最后更新于 5月 21, 2019. [發現了問題](../bugs.xhtml)？使用[Sphinx](http://sphinx.pocoo.org/)1.8.4 創建。