summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-07-04 02:32:42 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-07-04 02:32:42 +0300
commit503cf3d097e273dae88557cc5b284ba39c77e384 (patch)
treeb114c372e10aef869a1ab564a7ba3e45c3bcb746 /docs
parent6b8b56f8596d3dde544a72d037e9feddd9f70938 (diff)
downloadmicropython-503cf3d097e273dae88557cc5b284ba39c77e384.tar.gz
micropython-503cf3d097e273dae88557cc5b284ba39c77e384.zip
docs/uzlib: Update description of decompress() and mention DecompIO.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/uzlib.rst28
1 files changed, 24 insertions, 4 deletions
diff --git a/docs/library/uzlib.rst b/docs/library/uzlib.rst
index e531407b0f..fb1746fe8e 100644
--- a/docs/library/uzlib.rst
+++ b/docs/library/uzlib.rst
@@ -6,13 +6,33 @@
|see_cpython_module| :mod:`python:zlib`.
-This modules allows to decompress binary data compressed with DEFLATE
-algorithm (commonly used in zlib library and gzip archiver). Compression
+This module allows to decompress binary data compressed with
+`DEFLATE algorithm <https://en.wikipedia.org/wiki/DEFLATE>`_
+(commonly used in zlib library and gzip archiver). Compression
is not yet implemented.
Functions
---------
-.. function:: decompress(data)
+.. function:: decompress(data, wbits=0, bufsize=0)
- Return decompressed data as bytes.
+ 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.
+
+.. class:: DecompIO(stream, wbits=0)
+
+ Create a stream wrapper 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 :func:`decompress`, *wbits* may take values
+ 24..31 (16 + 8..15), meaning that input stream has gzip header.
+
+ .. admonition:: Difference to CPython
+ :class: attention
+
+ This class is MicroPython extension. It's included on provisional
+ basis and may be changed considerably or removed in later versions.