mirror
/
micropython
kopia lustrzana https://github.com/micropython/micropython
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność
micropython/docs/library/hashlib.rst

58 wiersze
1.7 KiB
ReStructuredText
Czysty Bezpośredni odnośnik Zwykły widok Historia

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-12 03:59:29 +00:00
:mod:`hashlib` -- hashing algorithms
====================================
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00: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-12 03:59:29 +00:00
.. module:: hashlib
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
:synopsis: hashing algorithms
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
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 12:37:31 +00:00
|see_cpython_module| :mod:`python:hashlib`.
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
This module implements binary data hashing algorithms. The exact inventory
of available algorithms depends on a board. Among the algorithms which may
be implemented:
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
* 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.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
* SHA1 - A previous generation algorithm. Not recommended for new usages,
but SHA1 is a part of number of Internet standards and existing
various: Spelling fixes
2017-05-29 07:08:14 +00:00
applications, so boards targeting network connectivity and
docs: Fix spelling in various parts of the docs.
2019-02-13 01:29:01 +00:00
interoperability will try to provide this.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
* MD5 - A legacy algorithm, not considered cryptographically secure. Only
docs: Fix spelling in various parts of the docs.
2019-02-13 01:29:01 +00:00
selected boards, targeting interoperability with legacy applications,
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
will offer this.
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
Constructors
------------
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-12 03:59:29 +00:00
.. class:: hashlib.sha256([data])
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
Create an SHA256 hasher object and optionally feed ``data`` into it.
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-12 03:59:29 +00:00
.. class:: hashlib.sha1([data])
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
Create an SHA1 hasher object and optionally feed ``data`` into it.
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-12 03:59:29 +00:00
.. class:: hashlib.md5([data])
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
Create an MD5 hasher object and optionally feed ``data`` into it.
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
Methods
-------
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
.. method:: hash.update(data)
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
Feed more binary data into hash.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
.. method:: hash.digest()
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00:00
docs: Spelling mistakes
2016-07-31 23:52:00 +00:00
Return hash for all data passed through hash, as a bytes object. After this
docs/uhashlib: Provide port-neutral description. TODO: Remove WiPy-specific chunks.
2017-02-25 21:55:33 +00:00
method is called, more data cannot be fed into the hash any longer.
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
.. method:: hash.hexdigest()
docs: Add quick docs for uhashlib.
2014-12-01 22:52:41 +00: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-12 03:59:29 +00:00
This method is NOT implemented. Use ``binascii.hexlify(hash.digest())``
docs: Add initial draft documentation for the WiPy. This makes all common files "port-aware" using the .. only directive.
2015-06-10 21:29:56 +00:00
to achieve a similar effect.