FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[3.15] gh-151950: Fix Sphinx references in mmap documentation (GH-153764) by miss-islington · Pull Request #160077 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

[3.15] gh-151950: Fix Sphinx references in mmap documentation (GH-153764) #160077

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

Merged
hugovk merged 1 commit into from
Oct 21, 2026
+52 −6
Conversation 0 Commits 1 Checks 36 Files changed 2
Merged

[3.15] gh-151950: Fix Sphinx references in mmap documentation (GH-153764) #160077

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

Filter by extension

Filter by extension .rst  (1) dotfile  (1) All 2 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
57 changes: 52 additions & 5 deletions Doc/library/mmap.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ where :class:`bytearray` are expected; for example, you can use the :mod:`re`
module to search through a memory-mapped file. You can also change a single
byte by doing ``obj[index] = 97``, or change a subsequence by assigning to a
slice: ``obj[i1:i2] = b'...'``. You can also read and write data starting at
the current file position, and :meth:`seek` through the file to different positions.
the current file position, and :meth:`~mmap.mmap.seek` through the file to
different positions.

A memory-mapped file is created by the :class:`~mmap.mmap` constructor, which is
different on Unix and on Windows. In either case you must provide a file
Expand Down Expand Up @@ -103,7 +104,7 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
*prot*, if specified, gives the desired memory protection; the two most
useful values are :const:`PROT_READ` and :const:`PROT_WRITE`, to specify
that the pages may be read or written. *prot* defaults to
:const:`PROT_READ \| PROT_WRITE`.
:const:`PROT_READ` \| :const:`PROT_WRITE`.

*access* may be specified in lieu of *flags* and *prot* as an optional
keyword parameter. It is an error to specify both *flags*, *prot* and
Expand Down Expand Up @@ -386,9 +387,55 @@ To map anonymous memory, -1 should be passed as the fileno along with the length
the mmap was created with :const:`ACCESS_READ`, then writing to it will
raise a :exc:`TypeError` exception.

.. _access-constants:

ACCESS_* constants
++++++++++++++++++

.. data:: ACCESS_DEFAULT
ACCESS_READ
ACCESS_WRITE
ACCESS_COPY

These constants specify the access mode for a memory mapping.
:const:`ACCESS_READ` provides read-only access, :const:`ACCESS_WRITE`
provides write-through access, and :const:`ACCESS_COPY` provides
copy-on-write access. :const:`ACCESS_DEFAULT` defers to the *prot*
argument of :class:`mmap`.

.. _page-size-constants:

Page size constants
+++++++++++++++++++

.. data:: PAGESIZE
ALLOCATIONGRANULARITY

:const:`PAGESIZE` is the system memory page size in bytes.
:const:`ALLOCATIONGRANULARITY` is the minimum alignment in bytes required
for the *offset* argument of :class:`mmap`. On Unix,
:const:`ALLOCATIONGRANULARITY` is equal to :const:`PAGESIZE`.

.. _prot-constants:

PROT_* constants
++++++++++++++++

.. data:: PROT_READ
PROT_WRITE
PROT_EXEC

Memory protection flags accepted by the *prot* argument of :class:`mmap`.
:const:`PROT_READ` allows pages to be read, :const:`PROT_WRITE` allows pages
to be written, and :const:`PROT_EXEC` allows pages to be executed. Values
can be combined using the bitwise OR operator. Not every option is present
on every system.

.. availability:: Unix.

.. _madvise-constants:

MADV_* Constants
MADV_* constants
++++++++++++++++

.. data:: MADV_NORMAL
Expand Down Expand Up @@ -425,7 +472,7 @@ MADV_* Constants

.. _map-constants:

MAP_* Constants
MAP_* constants
+++++++++++++++

.. data:: MAP_SHARED
Expand Down Expand Up @@ -472,7 +519,7 @@ MAP_* Constants

.. _ms-constants:

MS_* Constants
MS_* constants
++++++++++++++

.. data:: MS_SYNC
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Doc/library/email.charset.rst
Doc/library/email.parser.rst
Doc/library/logging.config.rst
Doc/library/logging.handlers.rst
Doc/library/mmap.rst
Doc/library/multiprocessing.rst
Doc/library/optparse.rst
Doc/library/pickletools.rst
Expand Down
Loading
Back | FazBrowse Home | New Git URL