summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2013-08-03 09:39:39 (GMT)
committerJason R. Coombs <jaraco@jaraco.com>2013-08-03 09:39:39 (GMT)
commitb2aa6f40559da92085e77a247b8756d860171a12 (patch)
tree515da7c5a74232209caaba85dedde4dce8c7ae36 /Doc
parent21e9ac7c1ae4923031e01bfe0da59ef1b593a342 (diff)
downloadcpython-b2aa6f40559da92085e77a247b8756d860171a12.zip
cpython-b2aa6f40559da92085e77a247b8756d860171a12.tar.gz
cpython-b2aa6f40559da92085e77a247b8756d860171a12.tar.bz2
Issue 18532: Added tests and documentation to formally specify the .name attribute on hashlib objects.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/hashlib.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 6cb76c1..db41db4 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -124,6 +124,18 @@ returned by the constructors:
The internal block size of the hash algorithm in bytes.
+A hash object has the following attributes:
+
+.. attribute:: hash.name
+
+ The canonical name of this hash, always lowercase and always suitable as a
+ parameter to :func:`new` to create another hash of this type.
+
+ .. versionchanged:: 3.4
+ The name attribute has been present in CPython since its inception, but
+ until Python 3.4 was not formally specified, so may not exist on some
+ platforms.
+
A hash object has the following methods: