Issue 33953: The DEFAULT_ENTROPY variable used to store the current default random bytes value should be documented for `secrets` module

Issue33953

Created on 2018-06-25 07:59 by lig, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Messages (1)
msg320402 - (view)	Author: Serge Matveenko (lig) *	Date: 2018-06-25 07:59
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.

Messages (1)

msg320402 - (view)

Author: Serge Matveenko (lig) *

Date: 2018-06-25 07:59

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.

History
Date	User	Action	Args
2022-04-11 14:59:02	admin	set	github: 78134
2020-09-14 14:15:47	lig	set	status: open -> closed stage: resolved
2020-05-14 14:01:56	rhettinger	set	assignee: docs@python -> steven.daprano nosy: + steven.daprano
2020-05-14 12:00:54	lig	set	versions: + Python 3.6
2020-05-14 12:00:16	lig	set	versions: + Python 3.9
2019-03-27 22:29:39	cheryl.sabella	set	nosy: + rhettinger versions: - Python 3.6
2018-06-25 07:59:11	lig	create