hashlib.HASH objects should officially expose the hash name

[jaraco]

BPO	18532
Nosy	@gpshead, @jaraco, @tiran, @dholth

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-08-06.13:52:44.063>
created_at = <Date 2013-07-22.20:29:00.346>
labels = ['type-feature', 'library', 'docs']
title = 'hashlib.HASH objects should officially expose the hash name'
updated_at = <Date 2013-08-15.16:33:28.981>
user = 'https://github.com/jaraco'

bugs.python.org fields:

activity = <Date 2013-08-15.16:33:28.981>
actor = 'christian.heimes'
assignee = 'docs@python'
closed = True
closed_date = <Date 2013-08-06.13:52:44.063>
closer = 'christian.heimes'
components = ['Documentation', 'Library (Lib)']
creation = <Date 2013-07-22.20:29:00.346>
creator = 'jaraco'
dependencies = []
files = []
hgrepos = []
issue_num = 18532
keywords = ['needs review']
message_count = 8.0
messages = ['193563', '193564', '193568', '194242', '194453', '194454', '194545', '195261']
nosy_count = 6.0
nosy_names = ['gregory.p.smith', 'jaraco', 'christian.heimes', 'dholth', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue18532'
versions = ['Python 3.4']

[jaraco]

In hashlib, the HASH objects currently supply a 'name' attribute, reflecting the name used to initialize the hash object, and they have since Python 2.5. However, this interface is not published so isn't honored by other platforms (namely pypy).

I propose the '.name' attribute be formally added to the documentation to reflect the actual implementation.

I suggest this change be considered as a bugfix release if the original intention was for the '.name' attribute to be public (as it's a bug in the documentation if the intended and implemented interface isn't fully documented).

I plan to do some research to ascertain the intention of this attribute (as can be inferred from tests and the source). For now, I'll assume Python 3.4 only.

Any comments or suggestions welcome.

[tiran]

Sounds like a good idea.

[dholth]

fwiw pypy 2 supports HASH.name but the older 1.9 (still part of some Linux distributions) did not.

[jaraco]

It's not obvious to me if the authors originally intended to have the 'name' attribute as a formal interface, so I've decided the change should probably be added to Python 3.4. Here's a diff I've put together: http://paste.jaraco.com/tMdQ2

It updates the documentation and adds a test to guarantee the interface. I'm unsure about the RST syntax, so I would appreciate a review of the syntax there. Also, I haven't run the test yet, but I'll do that at a later date.

[python-dev]

New changeset 238c37e4c395 by Jason R. Coombs in branch 'default':
bpo-18532: Added tests and documentation to formally specify the .name attribute on hashlib objects.
http://hg.python.org/cpython/rev/238c37e4c395

[jaraco]

I've confirmed the tests pass and the updated documentation renders nicely and without warnings. These changes now make the name attribute officially-supported and tested.

[tiran]

I added some tests in 5fbf23e947d8 and found a bug in the _sha1 module, too.

[tiran]

The builtin hash algorithms still had upper case names. I fixed it in
revision http://hg.python.org/cpython/rev/9a4949f5d15c