Repository navigation
The DEFAULT_ENTROPY variable used to store the current default random bytes value should be documented for secrets module #78134
Description
| BPO | 33953 |
|---|---|
| Nosy | @rhettinger, @stevendaprano, @lig |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = 'https://github.com/stevendaprano'
closed_at = <Date 2020-09-14.14:15:47.875>
created_at = <Date 2018-06-25.07:59:11.493>
labels = ['3.8', 'type-feature', '3.7', '3.9', 'docs']
title = 'The DEFAULT_ENTROPY variable used to store the current default random bytes value should be documented for `secrets` module'
updated_at = <Date 2020-09-14.14:15:47.874>
user = 'https://github.com/lig'bugs.python.org fields:
activity = <Date 2020-09-14.14:15:47.874>
actor = 'lig'
assignee = 'steven.daprano'
closed = True
closed_date = <Date 2020-09-14.14:15:47.875>
closer = 'lig'
components = ['Documentation']
creation = <Date 2018-06-25.07:59:11.493>
creator = 'lig'
dependencies = []
files = []
hgrepos = []
issue_num = 33953
keywords = []
message_count = 1.0
messages = ['320402']
nosy_count = 4.0
nosy_names = ['rhettinger', 'steven.daprano', 'docs@python', 'lig']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33953'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9']
Activity
lig commented on Jun 25, 2018
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.