From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Thu, 14 Sep 2017 13:45:31 +0000 (-0700)
Subject: Improve code examples in hashlib cookie signing (GH-3562) (GH-3566)
X-Git-Tag: v3.6.3rc1~19
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c8b6506404540eb06c45a51b04ccc102f8b92813;p=thirdparty%2FPython%2Fcpython.git

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)
---

diff --git a/Doc/library/hashlib.rst b/Doc/library/hashlib.rst
index 9d563566d49d..725dce6fa15f 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