[Python-checkins] Improve code examples in hashlib cookie signing (GH-3562) (GH-3566)

Thu Sep 14 09:45:35 EDT 2017

https://github.com/python/cpython/commit/c8b6506404540eb06c45a51b04ccc102f8b92813
commit: c8b6506404540eb06c45a51b04ccc102f8b92813
branch: 3.6
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017年09月14日T06:45:31-07:00
summary:
Improve code examples in hashlib cookie signing (GH-3562) (GH-3566)
The `blake2b` function does not take the `data` keyword argument.
The hex digest returned by sign was a string, whereas compare_digest expects bytes-like objects.
Typo fix: compare_digesty -> compare_digest
(cherry picked from commit 312ffead1eb272535e021e248b5d74ab04b2e72e)
files:
M Doc/library/hashlib.rst

diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 9d563566d49..725dce6fa15 100644
--- a/Doc/library/hashlib.rst
+++ b/Doc/library/hashlib.rst
@@ -506,8 +506,9 @@ to users and later verify them to make sure they weren't tampered with::
 >>> AUTH_SIZE = 16
 >>>
 >>> def sign(cookie):
- ... h = blake2b(data=cookie, digest_size=AUTH_SIZE, key=SECRET_KEY)
- ... return h.hexdigest()
+ ... h = blake2b(digest_size=AUTH_SIZE, key=SECRET_KEY)
+ ... h.update(cookie)
+ ... return h.hexdigest().encode('utf-8')
 >>>
 >>> cookie = b'user:vatrogasac'
 >>> sig = sign(cookie)
@@ -517,7 +518,7 @@ to users and later verify them to make sure they weren't tampered with::
 True
 >>> compare_digest(b'user:policajac', sig)
 False
- >>> compare_digesty(cookie, '0102030405060708090a0b0c0d0e0f00')
+ >>> compare_digest(cookie, b'0102030405060708090a0b0c0d0e0f00')
 False
 
 Even though there's a native keyed hashing mode, BLAKE2 can, of course, be used
