docs: Add quick docs for uhashlib.
This commit is contained in:
parent
7f0699eedf
commit
d96a916405
@ -38,6 +38,7 @@ it will fallback to loading the built-in ``ujson`` module.
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
uhashlib.rst
|
||||||
uheapq.rst
|
uheapq.rst
|
||||||
ujson.rst
|
ujson.rst
|
||||||
usocket.rst
|
usocket.rst
|
||||||
|
37
docs/library/uhashlib.rst
Normal file
37
docs/library/uhashlib.rst
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
:mod:`uhashlib` -- hashing algorithm
|
||||||
|
====================================
|
||||||
|
|
||||||
|
.. module:: uhashlib
|
||||||
|
:synopsis: hashing algorithm
|
||||||
|
|
||||||
|
This module implements binary data hashing algorithms. Currently, it
|
||||||
|
implements SHA256 algorithm. Choosing SHA256 was a deliberate choice,
|
||||||
|
as a modern, cryptographically secure algorithm. This means that a
|
||||||
|
single algorithm can cover both usecases of "any hash algorithm" and
|
||||||
|
security-related usage, and thus save space omitting legacy algorithms
|
||||||
|
like MD5 or SHA1.
|
||||||
|
|
||||||
|
Constructors
|
||||||
|
------------
|
||||||
|
|
||||||
|
.. class:: uhashlib.sha256([data])
|
||||||
|
|
||||||
|
Create a hasher object and optionally feed ``data`` into it.
|
||||||
|
|
||||||
|
|
||||||
|
Methods
|
||||||
|
-------
|
||||||
|
|
||||||
|
.. method:: sha256.update(data)
|
||||||
|
|
||||||
|
Feed more binary data into hash.
|
||||||
|
|
||||||
|
.. method:: sha256.digest()
|
||||||
|
|
||||||
|
Return hash for all data passed thru hash, as a bytes object. After this
|
||||||
|
method is called, more data cannot be fed into hash any longer.
|
||||||
|
|
||||||
|
.. method:: sha256.hexdigest()
|
||||||
|
|
||||||
|
This method is NOT implemented. Use ``ubinascii.hexlify(sha256.digest())``
|
||||||
|
to achieve similar effect.
|
Loading…
x
Reference in New Issue
Block a user