Skip to content

gh-143700: Document secrets.DEFAULT_ENTROPY #144447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kovan wants to merge 1 commit into from
Closed

gh-143700: Document secrets.DEFAULT_ENTROPY #144447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Doc/library/secrets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ The :mod:`secrets` module provides functions for generating secure
tokens, suitable for applications such as password resets,
hard-to-guess URLs, and similar.

.. data:: DEFAULT_ENTROPY

The default number of bytes of randomness used by the ``token_*``
functions when *nbytes* is not specified. This is an opaque value
that may change at any time, including during maintenance releases.
Users who need a specific amount of entropy should explicitly pass
the *nbytes* argument.

.. function:: token_bytes([nbytes=None])

Return a random byte string containing *nbytes* number of bytes.
Expand Down
Loading