From f01d1be97d740ea0369379ca305646a26694236e Mon Sep 17 00:00:00 2001 From: Raymond Hettinger Date: Mon, 4 May 2020 22:52:13 -0700 Subject: bpo-40286: Put methods in correct sections. Add security notice to use secrets for session tokens. (GH-19870) --- Doc/library/random.rst | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/Doc/library/random.rst b/Doc/library/random.rst index ab4ca4b..f37bc2a 100644 --- a/Doc/library/random.rst +++ b/Doc/library/random.rst @@ -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 ----------------------- -- cgit v0.12