gzip – Supporto per i file gzip¶

Codice sorgente: Lib/gzip.py

Questo modulo fornisce una semplice interfaccia per comprimere e decomprimere file proprio come farebbero i programmi GNU gzip e gunzip.

La compressione dei dati è fornita dal modulo zlib.

Il modulo gzip fornisce la classe GzipFile, così come le funzioni di convenienzaopen(), compress() e decompress().La classe GzipFile legge e scrive file in formato gzip, comprimendo o decomprimendo automaticamente i dati in modo che appaiano come un normale oggetto file.

Nota che altri formati di file che possono essere decompressi dai programmi gzip e gunzip, come quelli prodotti dacompress e pack, non sono supportati da questo modulo.

Il modulo definisce i seguenti elementi:

gzip.open(filename, mode=’rb’, compresslevel=9, encoding=None, errors=None, newline=None)¶

Apre un file compresso con gzip in modalità binaria o testo, restituendo un fileobject.

L’argomento filename può essere un nome di file reale (un oggetto str obytes), o un oggetto file esistente da cui leggere o su cui scrivere.

L’argomento mode può essere uno qualsiasi tra 'r', 'rb', 'a', 'ab','w', 'wb', 'x' o 'xb' per il modo binario, o 'rt','at', 'wt', o 'xt' per il modo testo. Il default è 'rb'.

L’argomento compresslevel è un intero da 0 a 9, come per il costruttore GzipFile.

Per il modo binario, questa funzione è equivalente al costruttore GzipFile: GzipFile(filename, mode, compresslevel). In questo caso, gli argomenti codifica, errori e newline non devono essere forniti.

Per il modo testo, viene creato un oggetto GzipFile, e avvolto in un’istanzaio.TextIOWrapper con la codifica specificata, il comportamento di gestione degli errori, e le terminazioni di riga.

eccezionegzip.BadGzipFile¶

Un’eccezione sollevata per file gzip non validi. Eredita OSError.EOFError e zlib.error possono anche essere sollevate per gzipfiles non validi.

classegzip.GzipFile(filename=None, mode=None, compresslevel=9, fileobj=None, mtime=None)¶

Costruttore della classe GzipFile, che simula la maggior parte dei metodi di un oggetto file, ad eccezione del metodo truncate(). Almeno uno tra fileobj e filename deve avere un valore non banale.

La nuova istanza della classe è basata su fileobj, che può essere un normale file, un oggettoio.BytesIO o qualsiasi altro oggetto che simula un file. È predefinito a None, nel qual caso filename viene aperto per fornire un oggetto file.

Quando fileobj non è None, l’argomento filename è usato solo per essere incluso nell’intestazione del file gzip, che può includere il nome originale del file non compresso. È predefinito al nome del fileobj, se distinguibile; altrimenti, è predefinito alla stringa vuota, e in questo caso il nome originale del file non è incluso nell’intestazione.

L’argomento mode può essere uno qualsiasi tra 'r', 'rb', 'a', 'ab', 'w','wb', 'x', o 'xb', a seconda che il file venga letto o scritto. Il default è il modo di fileobj se distinguibile; altrimenti, il default è 'rb'. Nelle future versioni di Python la modalità di fileobj non sarà usata. È meglio specificare sempre la modalità di scrittura.

Nota che il file viene sempre aperto in modalità binaria. Per aprire un file compresso in modalità testo, usa open() (o avvolgi il tuo GzipFile con unio.TextIOWrapper).

L’argomento compresslevel è un intero da 0 a 9 che controlla il livello di compressione; 1 è più veloce e produce la minore compressione, e 9 è più lento e produce la maggiore compressione. 0è nessuna compressione. Il valore predefinito è 9.

L’argomento mtime è un timestamp numerico opzionale da scrivere nel campo del tempo di ultima modifica nel flusso quando si comprime. Dovrebbe essere fornito solo in modalità di compressione. Se omesso o None, viene usato il tempo corrente. Vedere l’attributo mtime per maggiori dettagli.

Chiamando il metodo close() di un oggetto GzipFile non si chiude il fileobj, poiché si potrebbe voler aggiungere altro materiale dopo i dati compressi. Questo permette anche di passare un oggetto io.BytesIO aperto per la scrittura come fileobj, e recuperare il buffer di memoria risultante usando il metodo getvalue() dell’oggettoio.BytesIO.

GzipFile supporta l’interfaccia io.BufferedIOBase, inclusa l’iterazione e la dichiarazione with. Solo il metodotruncate() non è implementato.

GzipFile fornisce anche il seguente metodo e attributo:

peek(n)¶

Leggi n byte non compressi senza avanzare la posizione del file.Al massimo viene fatta una singola lettura sul flusso compresso per soddisfare la chiamata. Il numero di byte restituito può essere maggiore o minore di quello richiesto.

mtime¶

Quando si decomprime, il valore del campo dell’ultimo tempo di modifica nell’intestazione più recente può essere letto da questo attributo, come un intero. Il valore iniziale prima di leggere qualsiasi intestazione è None.

Tutti i flussi compressi gzip devono contenere questo campotimestamp. Alcuni programmi, come gunzip, fanno uso del timestamp. Il formato è lo stesso del valore di ritorno ditime.time() e dell’attributo st_mtime dell’oggetto restituito da os.stat().

gzip.compress(data, compresslevel=9, *, mtime=None)¶

Comprime i dati, restituendo un oggetto bytes contenente i dati compressi. compresslevel e mtime hanno lo stesso significato del costruttore GzipFile sopra.

gzip.decompress(data)¶

Decomprime i dati, restituendo un oggetto bytes contenente i dati non compressi.

import gzipwith gzip.open('/home/joe/file.txt.gz', 'rb') as f: file_content = f.read()

import gzipcontent = b"Lots of content here"with gzip.open('/home/joe/file.txt.gz', 'wb') as f: f.write(content)

import gzipimport shutilwith 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)

import gzips_in = b"Lots of content here"s_out = gzip.compress(s_in)