libzlib.tex 7.82 KB
Newer Older
Fred Drake's avatar
Fred Drake committed
1
\section{\module{zlib} ---
2
         Compression compatible with \program{gzip}}
3

4
\declaremodule{builtin}{zlib}
Fred Drake's avatar
Fred Drake committed
5
\modulesynopsis{Low-level interface to compression and decompression
6
                routines compatible with \program{gzip}.}
7

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

For applications that require data compression, the functions in this
10 11
module allow compression and decompression, using the zlib library.
The zlib library has its own home page at
12
\url{http://www.gzip.org/zlib/}.  Version 1.1.3 is the
13 14 15
most recent version as of September 2000; use a later version if one
is available.  There are known incompatibilities between the Python
module and earlier versions of the zlib library.
16

Fred Drake's avatar
Fred Drake committed
17 18 19 20 21
The available exception and functions in this module are:

\begin{excdesc}{error}
  Exception raised on compression and decompression errors.
\end{excdesc}
Guido van Rossum's avatar
Guido van Rossum committed
22 23


24
\begin{funcdesc}{adler32}{string\optional{, value}}
Guido van Rossum's avatar
Guido van Rossum committed
25 26 27 28 29 30 31
   Computes a Adler-32 checksum of \var{string}.  (An Adler-32
   checksum is almost as reliable as a CRC32 but can be computed much
   more quickly.)  If \var{value} is present, it is used as the
   starting value of the checksum; otherwise, a fixed default value is
   used.  This allows computing a running checksum over the
   concatenation of several input strings.  The algorithm is not
   cryptographically strong, and should not be used for
32 33 34
   authentication or digital signatures.  Since the algorithm is
   designed for use as a checksum algorithm, it is not suitable for
   use as a general hash algorithm.
Guido van Rossum's avatar
Guido van Rossum committed
35 36
\end{funcdesc}

37
\begin{funcdesc}{compress}{string\optional{, level}}
38 39 40 41 42 43
  Compresses the data in \var{string}, returning a string contained
  compressed data.  \var{level} is an integer from \code{1} to
  \code{9} controlling the level of compression; \code{1} is fastest
  and produces the least compression, \code{9} is slowest and produces
  the most.  The default value is \code{6}.  Raises the
  \exception{error} exception if any error occurs.
Guido van Rossum's avatar
Guido van Rossum committed
44 45 46
\end{funcdesc}

\begin{funcdesc}{compressobj}{\optional{level}}
47
  Returns a compression object, to be used for compressing data streams
Guido van Rossum's avatar
Guido van Rossum committed
48
  that won't fit into memory at once.  \var{level} is an integer from
49 50 51
  \code{1} to \code{9} controlling the level of compression; \code{1} is
  fastest and produces the least compression, \code{9} is slowest and
  produces the most.  The default value is \code{6}.
Guido van Rossum's avatar
Guido van Rossum committed
52 53
\end{funcdesc}

54
\begin{funcdesc}{crc32}{string\optional{, value}}
Fred Drake's avatar
Fred Drake committed
55 56
  Computes a CRC (Cyclic Redundancy Check)%
  \index{Cyclic Redundancy Check}
Fred Drake's avatar
Fred Drake committed
57
  \index{checksum!Cyclic Redundancy Check}
Fred Drake's avatar
Fred Drake committed
58 59 60 61 62
  checksum of \var{string}. If
  \var{value} is present, it is used as the starting value of the
  checksum; otherwise, a fixed default value is used.  This allows
  computing a running checksum over the concatenation of several
  input strings.  The algorithm is not cryptographically strong, and
63 64 65
  should not be used for authentication or digital signatures.  Since
  the algorithm is designed for use as a checksum algorithm, it is not
  suitable for use as a general hash algorithm.
Guido van Rossum's avatar
Guido van Rossum committed
66 67
\end{funcdesc}

68
\begin{funcdesc}{decompress}{string\optional{, wbits\optional{, bufsize}}}
69 70
  Decompresses the data in \var{string}, returning a string containing
  the uncompressed data.  The \var{wbits} parameter controls the size of
71
  the window buffer.  If \var{bufsize} is given, it is used as the
72 73
  initial size of the output buffer.  Raises the \exception{error}
  exception if any error occurs.
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90

The absolute value of \var{wbits} is the base two logarithm of the
size of the history buffer (the ``window size'') used when compressing
data.  Its absolute value should be between 8 and 15 for the most
recent versions of the zlib library, larger values resulting in better
compression at the expense of greater memory usage.  The default value
is 15.  When \var{wbits} is negative, the standard
\program{gzip} header is suppressed; this is an undocumented feature
of the zlib library, used for compatibility with \program{unzip}'s
compression file format.

\var{bufsize} is the initial size of the buffer used to hold
decompressed data.  If more space is required, the buffer size will be
increased as needed, so you don't have to get this value exactly
right; tuning it will only save a few calls to \cfunction{malloc()}.  The
default size is 16384.
   
Guido van Rossum's avatar
Guido van Rossum committed
91 92 93
\end{funcdesc}

\begin{funcdesc}{decompressobj}{\optional{wbits}}
94
  Returns a decompression object, to be used for decompressing data
95 96
  streams that won't fit into memory at once.  The \var{wbits}
  parameter controls the size of the window buffer.
Guido van Rossum's avatar
Guido van Rossum committed
97 98 99 100
\end{funcdesc}

Compression objects support the following methods:

Fred Drake's avatar
Fred Drake committed
101
\begin{methoddesc}[Compress]{compress}{string}
Guido van Rossum's avatar
Guido van Rossum committed
102 103 104
Compress \var{string}, returning a string containing compressed data
for at least part of the data in \var{string}.  This data should be
concatenated to the output produced by any preceding calls to the
105
\method{compress()} method.  Some input may be kept in internal buffers
Guido van Rossum's avatar
Guido van Rossum committed
106
for later processing.
Fred Drake's avatar
Fred Drake committed
107
\end{methoddesc}
Guido van Rossum's avatar
Guido van Rossum committed
108

109 110 111 112 113 114 115 116 117 118
\begin{methoddesc}[Compress]{flush}{\optional{mode}}
All pending input is processed, and a string containing the remaining
compressed output is returned.  \var{mode} can be selected from the
constants \constant{Z_SYNC_FLUSH},  \constant{Z_FULL_FLUSH},  or 
\constant{Z_FINISH}, defaulting to \constant{Z_FINISH}.  \constant{Z_SYNC_FLUSH} and 
\constant{Z_FULL_FLUSH} allow compressing further strings of data and
are used to allow partial error recovery on decompression, while
\constant{Z_FINISH} finishes the compressed stream and 
prevents compressing any more data.  After calling
\method{flush()} with \var{mode} set to \constant{Z_FINISH}, the
119
\method{compress()} method cannot be called again; the only realistic
120
action is to delete the object.  
Fred Drake's avatar
Fred Drake committed
121
\end{methoddesc}
Guido van Rossum's avatar
Guido van Rossum committed
122

123
Decompression objects support the following methods, and two attributes:
124 125 126 127 128 129 130 131 132 133 134 135 136

\begin{memberdesc}{unused_data}
A string which contains any unused data from the last string fed to
this decompression object.  If the whole string turned out to contain
compressed data, this is \code{""}, the empty string. 

The only way to determine where a string of compressed data ends is by
actually decompressing it.  This means that when compressed data is
contained part of a larger file, you can only find the end of it by
reading data and feeding it into a decompression object's
\method{decompress} method until the \member{unused_data} attribute is
no longer the empty string.  
\end{memberdesc}
Guido van Rossum's avatar
Guido van Rossum committed
137

138 139 140 141 142 143 144
\begin{memberdesc}{unconsumed_tail}
A string that contains any data that was not consumed by the last
\method{decompress} call because it exceeded the limit for the
uncompressed data buffer.
\end{memberdesc}

\begin{methoddesc}[Decompress]{decompress}{string}{\optional{max_length}}
Guido van Rossum's avatar
Guido van Rossum committed
145 146 147 148
Decompress \var{string}, returning a string containing the
uncompressed data corresponding to at least part of the data in
\var{string}.  This data should be concatenated to the output produced
by any preceding calls to the
149
\method{decompress()} method.  Some of the input data may be preserved
150
in internal buffers for later processing.
151 152 153 154 155 156 157 158

If the optional parameter \var{max_length} is supplied then the return value
will be no longer than \var{max_length}. This may mean that not all of the
compressed input can be processed; and unconsumed data will be stored
in the attribute \member{unconsumed_tail}. This string must be passed
to a subsequent call to \method{decompress()} if decompression is to
continue.  If \var{max_length} is not supplied then the whole input is
decompressed, and \member{unconsumed_tail} is an empty string.
Fred Drake's avatar
Fred Drake committed
159
\end{methoddesc}
Guido van Rossum's avatar
Guido van Rossum committed
160

Fred Drake's avatar
Fred Drake committed
161
\begin{methoddesc}[Decompress]{flush}{}
Guido van Rossum's avatar
Guido van Rossum committed
162
All pending input is processed, and a string containing the remaining
163 164
uncompressed output is returned.  After calling \method{flush()}, the
\method{decompress()} method cannot be called again; the only realistic
Guido van Rossum's avatar
Guido van Rossum committed
165
action is to delete the object.
Fred Drake's avatar
Fred Drake committed
166
\end{methoddesc}
Guido van Rossum's avatar
Guido van Rossum committed
167

Guido van Rossum's avatar
Guido van Rossum committed
168
\begin{seealso}
169
  \seemodule{gzip}{Reading and writing \program{gzip}-format files.}
170
  \seeurl{http://www.gzip.org/zlib/}{The zlib library home page.}
Guido van Rossum's avatar
Guido van Rossum committed
171
\end{seealso}