saymrwulf/cryptography
1
0
Fork 0
mirror of https://github.com/saymrwulf/cryptography.git synced 2026-05-14 20:37:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document AlreadyFinalized.

Browse source
This commit is contained in:
David Reid 2013-11-13 10:01:15 -08:00
parent 152d6bec8c
commit 6392a9c63c
2 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/exceptions.rst
View file

@ -3,7 +3,13 @@ Exceptions
.. currentmodule:: cryptography.exceptions
.. class:: AlreadyFinalized
This is raised when a context is used after being it has been finalized.
.. class:: UnsupportedAlgorithm
This is raised when a backend doesn't support the requested algorithm (or
combination of algorithms).

13
docs/hazmat/primitives/cryptographic-hashes.rst
View file

@ -30,16 +30,25 @@ Message Digests
.. method:: update(data)
:param bytes data: The bytes you wish to hash.
:raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`
.. method:: copy()
:return: a new instance of this object with a copied internal state.
Copy this :class:`Hash` instance, usually so that we may call
:meth:`finalize` and get an intermediate digest value while we continue
to call :meth:`update` on the original.
:return: A new instance of :class:`Hash` which can be updated
and finalized independently of the original instance.
:raises cryptography.exceptions.AlreadyFinalized: See :meth:`finalize`
.. method:: finalize()
Finalize the current context and return the message digest as bytes.
Once ``finalize`` is called this object can no longer be used.
Once ``finalize`` is called this object can no longer be used and
:meth:`update` and :meth:`copy` will raise
:class:`~cryptography.exceptions.AlreadyFinalized`.
:return bytes: The message digest as bytes.