mmap: constants not listed in the documentation

[goodmami]

BPO	45528
Nosy	@goodmami
PRs	bpo-45528: list mmap constants in documentation #29075

^{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 = None
closed_at = None
created_at = <Date 2021-10-19.19:32:50.645>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'mmap: constants not listed in the documentation'
updated_at = <Date 2021-10-22.07:54:45.502>
user = 'https://github.com/goodmami'

bugs.python.org fields:

activity = <Date 2021-10-22.07:54:45.502>
actor = 'christian.heimes'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2021-10-19.19:32:50.645>
creator = 'goodmami'
dependencies = []
files = []
hgrepos = []
issue_num = 45528
keywords = ['patch']
message_count = 3.0
messages = ['404342', '404357', '404701']
nosy_count = 2.0
nosy_names = ['docs@python', 'goodmami']
pr_nums = ['29075']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue45528'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']

[goodmami]

Some constants mentioned in the mmap module documentation are not listed as module contents (i.e., with permalinks), so the mentions do not appear as links and it's not explicit that they are in the mmap module namespace. For instance, ACCESS_READ is referenced but does not link to anything, whereas MAP_PRIVATE links to the MAP_* constants section below showing that it is available as mmap.MAP_PRIVATE.

Constants available but not listed:

• ACCESS_* constants
  • ACCESS_READ
  • ACCESS_WRITE
  • ACCESS_COPY
  • ACCESS_DEFAULT
• PROT_* constants
  • PROT_READ
  • PROT_WRITE
  • PROT_EXEC (this one isn't even mentioned in the docs)
• ALLOCATIONGRANULARITY
• PAGESIZE

These constants are available and unlisted in the documentation for all active versions of Python (except ACCESS_DEFAULT, which is available from 3.7). In addition, none of the MAP_* constants are listed for Python 3.9 and prior, although they all (except MAP_POPULATE) have been available since at least 3.6.

Since these are valid and available constants in the mmap module, can we list them in the documentation for the appropriate versions?