libgzip.tex 3.25 KB
Newer Older
Fred Drake's avatar
Fred Drake committed
1
\section{\module{gzip} ---
2
         Support for \program{gzip} files}
3

4
\declaremodule{standard}{gzip}
Fred Drake's avatar
Fred Drake committed
5 6
\modulesynopsis{Interfaces for \program{gzip} compression and
decompression using file objects.}
7

Guido van Rossum's avatar
Guido van Rossum committed
8 9

The data compression provided by the \code{zlib} module is compatible
Fred Drake's avatar
Fred Drake committed
10 11 12 13
with that used by the GNU compression program \program{gzip}.
Accordingly, the \module{gzip} module provides the \class{GzipFile}
class to read and write \program{gzip}-format files, automatically
compressing or decompressing the data so it looks like an ordinary
14 15 16 17
file object.  Note that additional file formats which can be
decompressed by the \program{gzip} and \program{gunzip} programs, such 
as those produced by \program{compress} and \program{pack}, are not
supported by this module.
Fred Drake's avatar
Fred Drake committed
18

19 20 21 22 23
The module defines the following items:

\begin{classdesc}{GzipFile}{\optional{filename\optional{, mode\optional{,
                            compresslevel\optional{, fileobj}}}}}
Constructor for the \class{GzipFile} class, which simulates most of
24 25
the methods of a file object, with the exception of the \method{readinto()}
and \method{truncate()} methods.  At least one of
26 27 28 29 30 31 32 33 34 35 36 37 38 39
\var{fileobj} and \var{filename} must be given a non-trivial value.

The new class instance is based on \var{fileobj}, which can be a
regular file, a \class{StringIO} object, or any other object which
simulates a file.  It defaults to \code{None}, in which case
\var{filename} is opened to provide a file object.

When \var{fileobj} is not \code{None}, the \var{filename} argument is
only used to be included in the \program{gzip} file header, which may
includes the original filename of the uncompressed file.  It defaults
to the filename of \var{fileobj}, if discernible; otherwise, it
defaults to the empty string, and in this case the original filename
is not included in the header.

40 41 42 43
The \var{mode} argument can be any of \code{'r'}, \code{'rb'},
\code{'a'}, \code{'ab'}, \code{'w'}, or \code{'wb'}, depending on
whether the file will be read or written.  The default is the mode of
\var{fileobj} if discernible; otherwise, the default is \code{'rb'}.
44 45
If not given, the 'b' flag will be added to the mode to ensure the
file is opened in binary mode for cross-platform portability.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

The \var{compresslevel} argument is an integer from \code{1} to
\code{9} controlling the level of compression; \code{1} is fastest and
produces the least compression, and \code{9} is slowest and produces
the most compression.  The default is \code{9}.

Calling a \class{GzipFile} object's \method{close()} method does not
close \var{fileobj}, since you might wish to append more material
after the compressed data.  This also allows you to pass a
\class{StringIO} object opened for writing as \var{fileobj}, and
retrieve the resulting memory buffer using the \class{StringIO}
object's \method{getvalue()} method.
\end{classdesc}

\begin{funcdesc}{open}{filename\optional{, mode\optional{, compresslevel}}}
This is a shorthand for \code{GzipFile(\var{filename},}
\code{\var{mode},} \code{\var{compresslevel})}.  The \var{filename}
63
argument is required; \var{mode} defaults to \code{'rb'} and
64
\var{compresslevel} defaults to \code{9}.
Guido van Rossum's avatar
Guido van Rossum committed
65 66 67
\end{funcdesc}

\begin{seealso}
68 69
  \seemodule{zlib}{The basic data compression module needed to support
                   the \program{gzip} file format.}
Guido van Rossum's avatar
Guido van Rossum committed
70
\end{seealso}