8000 gh-132246: Add special buffer methods to C API Type Object docs by cmaloney · Pull Request #132247 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-1 8000 32246: Add special buffer methods to C API Type Object docs #132247

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 3 commits into from
May 21, 2025
Merged

gh-132246: Add special buffer methods to C API Type Object docs #132247

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5be72a
gh-132246: Add special buffer methods to C API Type Object docs
cmaloney Apr 7, 2025
1533b10
Hide the object. in link
cmaloney Apr 8, 2025
f57b0ff
Remove :meth:, escape to get non-italic and non-link
cmaloney Apr 21, 2025
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
Next Next commit
gh-132246: Add special buffer methods to C API Type Object docs 
Two special methods, __buffer__ and __release_buffer__ were added to
Python 3.12 by PEP 688. The C API Type Object documentation for slots
includes `tp_as_buffer`, and sub-slots `bf_getbuffer`, `bf_releasebuffer`
but does not refer to the Python Data Model version of those. Add the
missing references.
  • Loading branch information
@cmaloney
cmaloney committed Apr 7, 2025
commit c5be72a03ac99f66794b35eabe6f5490dfef9ce3
13 changes: 10 additions & 3 deletions Doc/c-api/typeobj.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Quick Reference
| :c:member:`~PyTypeObject.tp_setattro` | :c:type:`setattrofunc` | __setattr__, | X | X | | G |
| | | __delattr__ | | | | |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_as_buffer` | :c:type:`PyBufferProcs` * | | | | | % |
| :c:member:`~PyTypeObject.tp_as_buffer` | :c:type:`PyBufferProcs` * | :ref:`sub-slots` | | | | % |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
| :c:member:`~PyTypeObject.tp_flags` | unsigned long | | X | X | | ? |
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
Expand Down Expand Up @@ -325,9 +325,16 @@ sub-slots
+---------------------------------------------------------+-----------------------------------+---------------+
| |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | |
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | :meth:`\ |
| | | object.\ |
| | | __buffer__` |
| | | |
| | | |
+---------------------------------------------------------+-----------------------------------+---------------+
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | |
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | :meth:`\ |
| | | object.\ |
| | | __release_\ |
| | | buffer__` |
+---------------------------------------------------------+-----------------------------------+---------------+

.. _slot-typedefs-table:
Expand Down
Loading
0