This module allows to decompress binary data compressed with DEFLATE algorithm (commonly used in zlib library and gzip archiver). Compression is not yet implemented.
decompress(data, wbits=0, bufsize=0, /)¶
Return decompressed data as bytes. wbits is DEFLATE dictionary window size used during compression (8-15, the dictionary size is power of 2 of that value). Additionally, if value is positive, data is assumed to be zlib stream (with zlib header). Otherwise, if it’s negative, it’s assumed to be raw DEFLATE stream. bufsize parameter is for compatibility with CPython and is ignored.
DecompIO(stream, wbits=0, dictbuf=None, /)¶
streamwrapper which allows transparent decompression of compressed data in another stream. This allows to process compressed streams with data larger than available heap size. In addition to values described in
decompress(), wbits may take values 24..31 (16 + 8..15), meaning that input stream has gzip header.
bufferdictbuf is passed, it’s used to store decompression dictionary (the size of dictbuf should be consistent with wbits parameter). Otherwise, decompression dictionary is allocated by the constructor. Using dictbuf is useful to preallocate large chunk of memory for dictionary at the start of program, and avoid memory
Difference to CPython
This class is MicroPython extension. It’s included on provisional basis and may be changed considerably or removed in later versions.
Reinitialize DecompIO object to handle a new stream. This allows to reuse the same DecompIO instance to handle multiple decompression streams, instead of allocating a new instance each time, which helps to avoid
fragmentation. After reinitialization, the same values for wbits and dictbuf are used, as were passed to the constructor.