remove hashlib, zlib from micropython modules index
.. these have been converted to shared-bindings style and have their own documentation now that better matches our implementation. Closes: #7034
This commit is contained in:
Jeff Epler
parent
5192082e64
commit
07dda44b20
|
|
@ -1,60 +0,0 @@
|
||||||
:mod:`hashlib` -- hashing algorithms
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
.. include:: ../templates/unsupported_in_circuitpython.inc
|
|
||||||
|
|
||||||
.. module:: hashlib
|
|
||||||
:synopsis: hashing algorithms
|
|
||||||
:noindex:
|
|
||||||
|
|
||||||
|see_cpython_module| :mod:`cpython:hashlib`.
|
|
||||||
|
|
||||||
This module implements binary data hashing algorithms. The exact inventory
|
|
||||||
of available algorithms depends on a board. Among the algorithms which may
|
|
||||||
be implemented:
|
|
||||||
|
|
||||||
* SHA256 - The current generation, modern hashing algorithm (of SHA2 series).
|
|
||||||
It is suitable for cryptographically-secure purposes. Included in the
|
|
||||||
MicroPython core and any board is recommended to provide this, unless
|
|
||||||
it has particular code size constraints.
|
|
||||||
|
|
||||||
* SHA1 - A previous generation algorithm. Not recommended for new usages,
|
|
||||||
but SHA1 is a part of number of Internet standards and existing
|
|
||||||
applications, so boards targeting network connectivity and
|
|
||||||
interoperability will try to provide this.
|
|
||||||
|
|
||||||
* MD5 - A legacy algorithm, not considered cryptographically secure. Only
|
|
||||||
selected boards, targeting interoperability with legacy applications,
|
|
||||||
will offer this.
|
|
||||||
|
|
||||||
Constructors
|
|
||||||
------------
|
|
||||||
|
|
||||||
.. class:: hashlib.sha256([data])
|
|
||||||
|
|
||||||
Create an SHA256 hasher object and optionally feed ``data`` into it.
|
|
||||||
|
|
||||||
.. class:: hashlib.sha1([data])
|
|
||||||
|
|
||||||
Create an SHA1 hasher object and optionally feed ``data`` into it.
|
|
||||||
|
|
||||||
.. class:: hashlib.md5([data])
|
|
||||||
|
|
||||||
Create an MD5 hasher object and optionally feed ``data`` into it.
|
|
||||||
|
|
||||||
Methods
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. method:: hash.update(data)
|
|
||||||
|
|
||||||
Feed more binary data into hash.
|
|
||||||
|
|
||||||
.. method:: hash.digest()
|
|
||||||
|
|
||||||
Return hash for all data passed through hash, as a bytes object. After this
|
|
||||||
method is called, more data cannot be fed into the hash any longer.
|
|
||||||
|
|
||||||
.. method:: hash.hexdigest()
|
|
||||||
|
|
||||||
This method is NOT implemented. Use ``binascii.hexlify(hash.digest())``
|
|
||||||
to achieve a similar effect.
|
|
||||||
|
|
@ -19,7 +19,7 @@ limited flash memory, usually on non-Express builds:
|
||||||
``binascii``, ``errno``, ``json``, ``re``.
|
``binascii``, ``errno``, ``json``, ``re``.
|
||||||
|
|
||||||
These libraries are not currently enabled in any CircuitPython build, but may be in the future:
|
These libraries are not currently enabled in any CircuitPython build, but may be in the future:
|
||||||
``ctypes``, ``hashlib``, ``zlib``.
|
``ctypes``
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
@ -31,7 +31,6 @@ These libraries are not currently enabled in any CircuitPython build, but may be
|
||||||
collections.rst
|
collections.rst
|
||||||
errno.rst
|
errno.rst
|
||||||
gc.rst
|
gc.rst
|
||||||
hashlib.rst
|
|
||||||
io.rst
|
io.rst
|
||||||
json.rst
|
json.rst
|
||||||
re.rst
|
re.rst
|
||||||
|
|
@ -39,7 +38,6 @@ These libraries are not currently enabled in any CircuitPython build, but may be
|
||||||
asyncio.rst
|
asyncio.rst
|
||||||
ctypes.rst
|
ctypes.rst
|
||||||
select.rst
|
select.rst
|
||||||
zlib.rst
|
|
||||||
|
|
||||||
Omitted functions in the ``string`` library
|
Omitted functions in the ``string`` library
|
||||||
-------------------------------------------
|
-------------------------------------------
|
||||||
|
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
:mod:`zlib` -- zlib decompression
|
|
||||||
=================================
|
|
||||||
|
|
||||||
.. include:: ../templates/unsupported_in_circuitpython.inc
|
|
||||||
|
|
||||||
.. module:: zlib
|
|
||||||
:synopsis: zlib decompression
|
|
||||||
:noindex:
|
|
||||||
|
|
||||||
|see_cpython_module| :mod:`cpython:zlib`.
|
|
||||||
|
|
||||||
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, 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.
|
|
||||||
|
|
||||||
.. class:: DecompIO(stream, wbits=0, /)
|
|
||||||
:noindex:
|
|
||||||
|
|
||||||
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.
|
|
||||||
Loading…
Reference in New Issue