8000 gh-123609: Clarify usage of standalone `PyBUF_FORMAT` by ZeroIntensity · Pull Request #123778 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-123609: Clarify usage of standalone PyBUF_FORMAT #123778

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
merged 6 commits into from
Sep 10, 2024
Merged

gh-123609: Clarify usage of standalone PyBUF_FORMAT #123778

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4e40251
Clarify usage of standalone PyBUF_FORMAT
ZeroIntensity Sep 6, 2024
82f7d21
Update Doc/c-api/buffer.rst
ZeroIntensity Sep 6, 2024
55dfc6b
Try and make the message more user facing.
ZeroIntensity Sep 8, 2024
3aac9bb
Add example to the buffer request types paragraph.
ZeroIntensity Sep 9, 2024
6256646
Update buffer.rst
ZeroIntensity Sep 9, 2024
beee985
Update buffer.rst
ZeroIntensity Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions Doc/c-api/buffer.rst
View file
Open in desktop
9A88
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,6 @@ The following fields are not influenced by *flags* and must always be filled in
with the correct values: :c:member:`~Py_buffer.obj`, :c:member:`~Py_buffer.buf`,
:c:member:`~Py_buffer.len`, :c:member:`~Py_buffer.itemsize`, :c:member:`~Py_buffer.ndim`.


readonly, format
~~~~~~~~~~~~~~~~

Expand All @@ -253,7 +252,8 @@ readonly, format
Controls the :c:member:`~Py_buffer.readonly` field. If set, the exporter
MUST provide a writable buffer or else report failure. Otherwise, the
exporter MAY provide either a read-only or writable buffer, but the choice
MUST be consistent for all consumers.
MUST be consistent for all consumers. For example, :c:expr:`PyBUF_SIMPLE | PyBUF_WRITABLE`
can be used to request a simple writable buffer.

.. c:macro:: PyBUF_FORMAT

Expand All @@ -265,8 +265,9 @@ readonly, format
Since :c:macro:`PyBUF_SIMPLE` is defined as 0, :c:macro:`PyBUF_WRITABLE`
can be used as a stand-alone flag to request a simple writable buffer.

:c:macro:`PyBUF_FORMAT` can be \|'d to any of the flags except :c:macro:`PyBUF_SIMPLE`.
The latter already implies format ``B`` (unsigned bytes).
:c:macro:`PyBUF_FORMAT` must be \|'d to any of the flags except :c:macro:`PyBUF_SIMPLE`, because
the latter already implies format ``B`` (unsigned bytes). :c:macro:`!PyBUF_FORMAT` cannot be
used on its own.


shape, strides, suboffsets
Expand Down
Loading
0