-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
bpo-35784: Include optional kwargs in hashlib.new() documentation #15890
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A news entry isn't really necessary for a documentation update, but is harmless regardless. :)
This is going to raise the question of which keywords are available for each algorithm and what they do. It would be nice if we had a summary table (like that at the top of the itertools() documentation). |
While you are technically correct, I would like to hold off on this change for a bit more. I plan to replace our internal vendored copies of sha3 and blake2 with OpenSSL code. OpenSSL 1.1.1 has some of the new required APIs. OpenSSL 3.0.0-dev is currently adding more but with slightly different semantic. For example OpenSSL does not have blake2b, but blake2b512 for hashing and blake2bmac for keyed hashing with salting and personalization. I like to get integration with OpenSSL right until hashlib.new() is officially documented. |
Lets not make such a table. People shouldn't use The one true canonical place for arguments for any given hash function to be defined is in the documentation for the |
@tiran should this PR be closed then, since the semantic might change anyway after you finish integrating OpenSSL? |
Makes sense, let's close it. Thanks for your contribution. 👍 |
Updating documentation for hashlib.new(), including Doc/library/hashlib.rst and the docstring in Lib/hashlib.py.
https://bugs.python.org/issue35784
https://bugs.python.org/issue35784