[docs] [issue33953] The DEFAULT_ENTROPY variable used to store the current default random bytes value should be documented for `secrets` module

Serge Matveenko report at bugs.python.org
Mon Jun 25 03:59:11 EDT 2018


New submission from Serge Matveenko <serge at matveenko.ru>:

There is the corresponding section on the topic here https://github.com/python/cpython/blob/3.6/Doc/library/secrets.rst#how-many-bytes-should-tokens-use

The current value of 32 bytes is mentioned there correctly.

Unfortunately, there is no way to know which constant in the `secrets` stores this value.

It is easy to imagine a use case to use say `DEFAULT_ENTROPY * 4` in the code and stay updated with the default entropy being increased over time.

Thus, it looks reasonable to document the `secrets.DEFAULT_ENTROPY` constant in the module docs.

----------
assignee: docs at python
components: Documentation
messages: 320402
nosy: docs at python, lig
priority: normal
severity: normal
status: open
title: The DEFAULT_ENTROPY variable used to store the current default random bytes value should be documented for `secrets` module
type: enhancement
versions: Python 3.6, Python 3.7, Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue33953>
_______________________________________


More information about the docs mailing list