From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Sat, 26 Nov 2022 09:49:23 +0000 (-0800)
Subject: [3.11] gh-99502: mention bytes-like objects as input in `secrets.compare_digest`... 
X-Git-Tag: v3.11.1~45
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f98322920ea5dda233a8c20aff32f7b8f8ea2317;p=thirdparty%2FPython%2Fcpython.git

[3.11] gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512) (#99791)

gh-99502: mention bytes-like objects as input in `secrets.compare_digest` (GH-99512)

Now it is in sync with https://docs.python.org/3/library/hmac.htmlGH-hmac.compare_digest
It is the same function, just re-exported. So, I guess they should mention the same input types.
(cherry picked from commit 47d673d81fc315069c14f9438ebe61fb70ef1ccc)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
---

diff --git a/Doc/library/secrets.rst b/Doc/library/secrets.rst
index dc8e5f46fb58..4405dfc05359 100644
--- a/Doc/library/secrets.rst
+++ b/Doc/library/secrets.rst
@@ -128,7 +128,9 @@ Other functions
 
 .. function:: compare_digest(a, b)
 
-   Return ``True`` if strings *a* and *b* are equal, otherwise ``False``,
+   Return ``True`` if strings or
+   :term:`bytes-like objects <bytes-like object>`
+   *a* and *b* are equal, otherwise ``False``,
    using a "constant-time compare" to reduce the risk of
    `timing attacks <https://codahale.com/a-lesson-in-timing-attacks/>`_.
    See :func:`hmac.compare_digest` for additional details.