gzip --- 對(duì) gzip 格式的支持?
源代碼： Lib/gzip.py
此模塊提供的簡(jiǎn)單接口幫助用戶壓縮和解壓縮文件，功能類似于 GNU 應(yīng)用程序 gzip 和 gunzip。
數(shù)據(jù)壓縮由 zlib 模塊提供。
gzip 模塊提供 GzipFile 類和 open()、compress()、decompress() 幾個(gè)便利的函數(shù)。GzipFile 類可以讀寫 gzip 格式的文件，還能自動(dòng)壓縮和解壓縮數(shù)據(jù)，這讓操作壓縮文件如同操作普通的 file object 一樣方便。
注意，此模塊不支持部分可以被 gzip 和 gunzip 解壓的格式，如利用 compress 或 pack 壓縮所得的文件。
這個(gè)模塊定義了以下內(nèi)容：
-
gzip.open(filename, mode='rb', compresslevel=9, encoding=None, errors=None, newline=None)? 以二進(jìn)制方式或者文本方式打開一個(gè) gzip 格式的壓縮文件，返回一個(gè) file object。
filename 參數(shù)可以是一個(gè)實(shí)際的文件名(一個(gè)a
str對(duì)象或者bytes對(duì)象), 或者是一個(gè)用來(lái)讀寫的已存在的文件對(duì)象。mode 參數(shù)可以是二進(jìn)制模式：
'r','rb','a','ab','w','wb','x'or'xb', 或者是文本模式'rt','at','wt', or'xt'。默認(rèn)值是'rb'。The compresslevel argument is an integer from 0 to 9, as for the
GzipFileconstructor.對(duì)于二進(jìn)制模式，這個(gè)函數(shù)等價(jià)于
GzipFile構(gòu)造器：GzipFile(filename, mode, compresslevel)。在這個(gè)例子中，encoding, errors 和 newline 三個(gè)參數(shù)一定不要設(shè)置。對(duì)于文本模式，將會(huì)創(chuàng)建一個(gè)
GzipFile對(duì)象，并將它封裝到一個(gè)io.TextIOWrapper實(shí)例中， 這個(gè)實(shí)例默認(rèn)了指定編碼，錯(cuò)誤抓獲行為和行。在 3.3 版更改: 支持 filename 為一個(gè)文件對(duì)象，支持文本模式和 encoding, errors 和 newline 參數(shù)。
在 3.4 版更改: 支持
'x','xb'和``'xt'`` 三種模式。在 3.6 版更改: 接受一個(gè) path-like object。
-
class
gzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)? GzipFile類的構(gòu)造器支持truncate()的異常，與 file object 的大多數(shù)方法非常相似。fileobj 和 filename 至少有一個(gè)不為空。新的實(shí)例基于 fileobj，它可以是一個(gè)普通文件，一個(gè)
io.BytesIO對(duì)象，或者任何一個(gè)與文件相似的對(duì)象。當(dāng) filename 是一個(gè)文件對(duì)象時(shí)，它的默認(rèn)值是None。當(dāng) fileobj 為
None時(shí)， filename 參數(shù)只用于 gzip 文件頭中，這個(gè)文件有可能包含未壓縮文件的源文件名。如果文件可以被識(shí)別，默認(rèn) fileobj 的文件名；否則默認(rèn)為空字符串，在這種情況下文件頭將不包含源文件名。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'.需要注意的是，文件默認(rèn)使用二進(jìn)制模式打開。如果要以文本模式打開文件一個(gè)壓縮文件，請(qǐng)使用
open()方法(或者使用io.TextIOWrapper包裝GzipFile)。compresslevel 參數(shù)是一個(gè)從
0to9的整數(shù)，用于控制壓縮等級(jí)；1最快但壓縮比例最小，9最慢但壓縮比例最大。0不壓縮。默認(rèn)為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 themtimeattribute for more details.調(diào)用
GzipFile的close()方法不會(huì)關(guān)閉 fileobj，因?yàn)槟憧梢韵Ｍ黾悠渌鼉?nèi)容到已經(jīng)壓縮的數(shù)中。你可以將一個(gè)io.BytesIO對(duì)象作為 fileobj，也可以使用io.BytesIO的getvalue()方法從內(nèi)存緩存中恢復(fù)數(shù)據(jù)。GzipFile支持io.BufferedIOBase類的接口, 包括迭代和with語(yǔ)句。只有truncate()方法沒(méi)有實(shí)現(xiàn)。GzipFile還提供了以下的方法和屬性:-
peek(n)? 在不移動(dòng)文件指針的情況下讀取 n 個(gè)未壓縮字節(jié)。最多只有一個(gè)單獨(dú)的讀取流來(lái)服務(wù)這個(gè)方法調(diào)用。返回的字節(jié)數(shù)不一定剛好等于要求的數(shù)量。
注解
調(diào)用
peek()并沒(méi)有改變GzipFile的文件指針，它可能改變潛在文件對(duì)象(例如：GzipFile使用 fileobj 參數(shù)進(jìn)行初始化)。3.2 新版功能.
-
mtime? 在解壓的過(guò)程中，最后修改時(shí)間字段的值可能來(lái)自于這個(gè)屬性，以整數(shù)的形式出現(xiàn)。在讀取任何文件頭信息前，初始值為
None。所有 gzip 東方壓縮流中必須包含時(shí)間戳這個(gè)字段。以便于像 gunzip這樣的程序可以使用時(shí)間戳。格式與
time.time()的返回值和os.stat()對(duì)象的st_mtime屬性值一樣。
在 3.2 版更改: 添加了對(duì)零填充和不可搜索文件的支持。
在 3.3 版更改: 實(shí)現(xiàn)
io.BufferedIOBase.read1()方法。在 3.4 版更改: 支持
'x'and'xb'兩種模式。在 3.5 版更改: 支持寫入任意 bytes-like objects。
read()方法可以接受``None``為參數(shù)。在 3.6 版更改: 接受一個(gè) path-like object。
-
-
gzip.compress(data, compresslevel=9)? 壓縮 data 返回一個(gè)包含壓縮數(shù)據(jù)的
bytes對(duì)象。 compresslevel 的意義與上面提到的GzipFile構(gòu)造器一至。3.2 新版功能.
用法示例?
讀取壓縮文件示例：
import gzip
with gzip.open('/home/joe/file.txt.gz', 'rb') as f:
file_content = f.read()
創(chuàng)建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 壓縮二進(jìn)制字符串示例：
import gzip
s_in = b"Lots of content here"
s_out = gzip.compress(s_in)
參見
- 模塊
zlib 支持 gzip 格式所需要的基本壓縮模塊。