djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
circuitpython/docs/library/zlib.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

39 lines
1.4 KiB
ReStructuredText
Raw Normal View History

docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-08-11 23:59:29 -04:00
:mod:`zlib` -- zlib decompression
=================================
docs: Add quick docs for uzlib.
2014-12-04 17:40:21 -05:00
docs: Replace ufoo with foo in all docs. Anywhere a module is mentioned, use its "non-u" name for consistency. The "import module" vs "import umodule" is something of a FAQ, and this commit intends to help clear that up. As a first approximation MicroPython is Python, and so imports should work the same as Python and use the same name, to a first approximation. The u-version of a module is a detail that can be learned later on, when the user wants to understand more and have finer control over importing. Existing Python code should just work, as much as it is possible to do that within the constraints of embedded systems, and the MicroPython documentation should match the idiomatic way to write Python code. With universal weak links for modules (via MICROPY_MODULE_WEAK_LINKS) users can consistently use "import foo" across all ports (with the exception of the minimal ports). And the ability to override/extend via "foo.py" continues to work well. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
2021-08-11 23:59:29 -04:00
.. module:: zlib
docs: Add quick docs for uzlib.
2014-12-04 17:40:21 -05:00
:synopsis: zlib decompression
docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-07-02 08:37:31 -04:00
|see_cpython_module| :mod:`python:zlib`.
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-03 19:32:42 -04:00
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
docs: Add quick docs for uzlib.
2014-12-04 17:40:21 -05:00
is not yet implemented.
Functions
---------
docs/library: Add / to indicate positional-only args in library docs. Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2020-01-11 01:44:17 -05:00
.. function:: decompress(data, wbits=0, bufsize=0, /)
docs: Add quick docs for uzlib.
2014-12-04 17:40:21 -05:00
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-03 19:32:42 -04:00
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.
docs/library: Add / to indicate positional-only args in library docs. Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2020-01-11 01:44:17 -05:00
.. class:: DecompIO(stream, wbits=0, /)
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-03 19:32:42 -04:00
docs/library: Add xrefs to "stream" dictionary entry for many modules.
2017-12-04 11:36:20 -05:00
Create a `stream` wrapper which allows transparent decompression of
docs/uzlib: Update description of decompress() and mention DecompIO.
2017-07-03 19:32:42 -04:00
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.