Text of docs.python.org › pa › 3 › library › zlib.html as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

zlib --- Compression compatible with gzip — Python 3.15.2 documentation

Navigation index modules | next | previous | Python » 3.15.2 documentation » The Python standard library » ਡਾਟਾ ਸੰਕੁਚਨ ਅਤੇ ਆਰਕਾਈਵਿੰਗ » zlib --- Compression compatible with gzip | Theme | zlib --- Compression compatible with gzip ¶ For applications that require data compression, the functions in this module allow compression and decompression, using the zlib library . This is an optional module .

If it is missing from your copy of CPython, look for documentation from your distributor (that is, whoever provided Python to you). If you are the distributor, see ਵਿਕਲਪਿਕ ਮੋਡੀਊਲਾਂ ਲਈ ਲੋੜਾਂ . zlib's functions have many options and often need to be used in a particular order. This documentation doesn't attempt to cover all of the permutations; consult the zlib manual for authoritative information.

For reading and writing .gz files see the gzip module. The available exception and functions in this module are: exception zlib. error ¶ Exception raised on compression and decompression errors. zlib. adler32 ( data , value = 1 , / ) ¶ Computes an Adler-32 checksum of data . (An Adler-32 checksum is almost as reliable as a CRC32 but can be computed much more quickly.) The result is an unsigned 32-bit integer. If value is present, it is used as the starting value of the checksum; otherwise, a default value of 1 is used.

Passing in value allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and 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. Changed in version 3.0: The result is always unsigned. zlib. adler32_combine ( adler1 , adler2 , len2 , / ) ¶ Combine two Adler-32 checksums into one.

Given the Adler-32 checksum adler1 of a sequence A and the Adler-32 checksum adler2 of a sequence B of length len2 , return the Adler-32 checksum of A and B concatenated. This function is typically useful to combine Adler-32 checksums that were concurrently computed. To compute checksums sequentially, use adler32() with the running checksum as the value argument. Added in version 3.15. zlib. compress ( data , / , level = Z_DEFAULT_COMPRESSION , wbits = MAX_WBITS ) ¶ Compresses the bytes in data , returning a bytes object containing compressed data. level is an integer from 0 to 9 or -1 controlling the level of compression; See Z_BEST_SPEED ( 1 ), Z_BEST_COMPRESSION ( 9 ), Z_NO_COMPRESSION ( 0 ), and the default, Z_DEFAULT_COMPRESSION ( -1 ) for more information about these values.

The wbits argument controls the size of the history buffer (or the "window size") used when compressing data, and whether a header and trailer is included in the output. It can take several ranges of values, defaulting to 15 ( MAX_WBITS ): +9 to +15: The base-two logarithm of the window size, which therefore ranges between 512 and 32768. Larger values produce better compression at the expense of greater memory usage. The resulting output will include a zlib-specific header and trailer. −9 to −15: Uses the absolute value of wbits as the window size logarithm, while producing a raw output stream with no header or trailing checksum. +25 to +31 = 16 + (9 to 15): Uses the low 4 bits of the value as the window size logarithm, while including a basic gzip header and trailing checksum in the output.

Raises the error exception if any error occurs. Changed in version 3.6: level can now be used as a keyword parameter. Changed in version 3.11: The wbits parameter is now available to set window bits and compression type. zlib. compressobj ( level = Z_DEFAULT_COMPRESSION , method = DEFLATED , wbits = MAX_WBITS , memLevel = DEF_MEM_LEVEL , strategy = Z_DEFAULT_STRATEGY [ , zdict ] ) ¶ Returns a compression object, to be used for compressing data streams that won't fit into memory at once. level is the compression level -- an integer from 0 to 9 or -1 .

See Z_BEST_SPEED ( 1 ), Z_BEST_COMPRESSION ( 9 ), Z_NO_COMPRESSION ( 0 ), and the default, Z_DEFAULT_COMPRESSION ( -1 ) for more information about these values. method is the compression algorithm. Currently, the only supported value is DEFLATED . The wbits parameter controls the size of the history buffer (or the "window size"), and what header and trailer format will be used. It has the same meaning as described for compress() .

The memLevel argument controls the amount of memory used for the internal compression state. Valid values range from 1 to 9 . Higher values use more memory, but are faster and produce smaller output. strategy is used to tune the compression algorithm. Possible values are Z_DEFAULT_STRATEGY , Z_FILTERED , Z_HUFFMAN_ONLY , Z_RLE and Z_FIXED . zdict is a predefined compression dictionary. This is a sequence of bytes (such as a bytes object) containing subsequences that are expected to occur frequently in the data that is to be compressed.

Those subsequences that are expected to be most common should come at the end of the dictionary. Changed in version 3.3: Added the zdict parameter and keyword argument support. zlib. crc32 ( data , value = 0 , / ) ¶ Computes a CRC (Cyclic Redundancy Check) checksum of data . The result is an unsigned 32-bit integer. If value is present, it is used as the starting value of the checksum; otherwise, a default value of 0 is used.

Passing in value allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and 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. Changed in version 3.0: The result is always unsigned. zlib. crc32_combine ( crc1 , crc2 , len2 , / ) ¶ Combine two CRC-32 checksums into one.

Given the CRC-32 checksum crc1 of a sequence A and the CRC-32 checksum crc2 of a sequence B of length len2 , return the CRC-32 checksum of A and B concatenated. This function is typically useful to combine CRC-32 checksums that were concurrently computed. To compute checksums sequentially, use crc32() with the running checksum as the value argument. Added in version 3.15. zlib. decompress ( data , / , wbits = MAX_WBITS , bufsize = DEF_BUF_SIZE ) ¶ Decompresses the bytes in data , returning a bytes object containing the uncompressed data.

The wbits parameter depends on the format of data , and is discussed further below. If bufsize is given, it is used as the initial size of the output buffer. Raises the error exception if any error occurs. The wbits parameter controls the size of the history buffer (or "window size"), and what header and trailer format is expected. It is similar to the parameter for compressobj() , but accepts more ranges of values: +8 to +15: The base-two logarithm of the window size.

The input must include a zlib header and trailer. 0: Automatically determine the window size from the zlib header. Only supported since zlib 1.2.3.5. −8 to −15: Uses the absolute value of wbits as the window size logarithm. The input must be a raw stream with no header or trailer. +24 to +31 = 16 + (8 to 15): Uses the low 4 bits of the value as the window size logarithm. The input must include a gzip header and trailer. +40 to +47 = 32 + (8 to 15): Uses the low 4 bits of the value as the window size logarithm, and automatically accepts either the zlib or gzip format.

When decompressing a stream, the window size must not be smaller than the size originally used to compress the stream; using a too-small value may result in an error exception. The default wbits value corresponds to the largest window size and requires a zlib header and trailer to be included. 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

The rest of this page is on the live site.