]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-40286: Put methods in correct sections. Add security notice to use secrets for...
authorRaymond Hettinger <rhettinger@users.noreply.github.com>
Tue, 5 May 2020 05:52:13 +0000 (22:52 -0700)
committerGitHub <noreply@github.com>
Tue, 5 May 2020 05:52:13 +0000 (22:52 -0700)
Doc/library/random.rst

index ab4ca4b3f8532829ec1a48e1e0948edaf9ef0fe5..f37bc2a111d9540d65e06e2e14c42cb3002212d7 100644 (file)
@@ -104,21 +104,16 @@ Bookkeeping functions
    the time :func:`getstate` was called.
 
 
-.. function:: getrandbits(k)
-
-   Returns a Python integer with *k* random bits. This method is supplied with
-   the Mersenne Twister generator and some other generators may also provide it
-   as an optional part of the API. When available, :meth:`getrandbits` enables
-   :meth:`randrange` to handle arbitrarily large ranges.
-
-   .. versionchanged:: 3.9
-      This method now accepts zero for *k*.
-
+Functions for bytes
+-------------------
 
 .. function:: randbytes(n)
 
    Generate *n* random bytes.
 
+   This method should not be used for generating security tokens.
+   Use :func:`secrets.token_bytes` instead.
+
    .. versionadded:: 3.9
 
 
@@ -145,6 +140,16 @@ Functions for integers
    Return a random integer *N* such that ``a <= N <= b``.  Alias for
    ``randrange(a, b+1)``.
 
+.. function:: getrandbits(k)
+
+   Returns a Python integer with *k* random bits. This method is supplied with
+   the MersenneTwister generator and some other generators may also provide it
+   as an optional part of the API. When available, :meth:`getrandbits` enables
+   :meth:`randrange` to handle arbitrarily large ranges.
+
+   .. versionchanged:: 3.9
+      This method now accepts zero for *k*.
+
 
 Functions for sequences
 -----------------------