Skip to content

bpo-45459: Add Py_buffer to limited API #29991

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
miss-islington merged 12 commits into from
Feb 2, 2022
Merged

bpo-45459: Add Py_buffer to limited API #29991

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
549fcdb
bpo-45459: Add Py_buffer to limited API
tiran Oct 18, 2021
526c58c
Move Py_buffer APIs to buffer.h
tiran Oct 18, 2021
1440b94
Hide typo alias with limited API
tiran Oct 18, 2021
cf98a23
Make Py_buffer public
tiran Dec 8, 2021
0e67e2c
Update stable_abi.txt and run make regen-limited-abi
tiran Dec 8, 2021
d516781
Add simple tests for Py_buffer stable ABI
tiran Dec 8, 2021
c1391cf
Add PyMemoryView_FromBuffer to limited API
tiran Dec 8, 2021
92d2ea5
Add docs
tiran Dec 8, 2021
7df9317
Document PyObject_CopyData
tiran Feb 2, 2022
0ab2a44
Address Petr's code review of xxlimited.c
tiran Feb 2, 2022
98a4ee5
Make Py_Buffer struct anon
tiran Feb 2, 2022
6119c2b
Remove forward declaration of Py_Buffer
tiran Feb 2, 2022
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
Prev Previous commit
Next Next commit
Add docs
  • Loading branch information
@tiran
tiran committed Feb 2, 2022
commit 92d2ea5565a08b3f7f97e7d094da04159abcc738
11 changes: 5 additions & 6 deletions Doc/c-api/type.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,12 +272,6 @@ The following functions and structs are used to create
* :c:member:`~PyTypeObject.tp_vectorcall_offset`
(see :ref:`PyMemberDef <pymemberdef-offsets>`)

The following fields cannot be set using :c:type:`PyType_Spec` and
:c:type:`PyType_Slot` under the limited API:

* :c:member:`~PyBufferProcs.bf_getbuffer`
* :c:member:`~PyBufferProcs.bf_releasebuffer`

Setting :c:data:`Py_tp_bases` or :c:data:`Py_tp_base` may be
problematic on some platforms.
To avoid issues, use the *bases* argument of
Expand All @@ -287,6 +281,11 @@ The following functions and structs are used to create

Slots in :c:type:`PyBufferProcs` in may be set in the unlimited API.

.. versionchanged:: 3.11
:c:member:`~PyBufferProcs.bf_getbuffer` and
:c:member:`~PyBufferProcs.bf_releasebuffer` are now available
under limited API.

.. c:member:: void *PyType_Slot.pfunc

The desired value of the slot. In most cases, this is a pointer
Expand Down
20 changes: 20 additions & 0 deletions Doc/whatsnew/3.11.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,6 +657,26 @@ New Features
:c:macro:`PY_VERSION_HEX`.
(Contributed by Gabriele N. Tornetta in :issue:`43931`.)

* :c:type:`Py_buffer` and APIs are now part of the limited API and the stable
ABI:

* :c:func:`PyObject_CheckBuffer`
* :c:func:`PyObject_GetBuffer`
* :c:func:`PyBuffer_GetPointer`
* :c:func:`PyBuffer_SizeFromFormat`
* :c:func:`PyBuffer_ToContiguous`
* :c:func:`PyBuffer_FromContiguous`
* :c:func:`PyBuffer_CopyData`
* :c:func:`PyBuffer_IsContiguous`
* :c:func:`PyBuffer_FillContiguousStrides`
* :c:func:`PyBuffer_FillInfo`
* :c:func:`PyBuffer_Release`
* :c:func:`PyMemoryView_FromBuffer`
* :c:member:`~PyBufferProcs.bf_getbuffer` and
:c:member:`~PyBufferProcs.bf_releasebuffer` type slots

(Contributed by Christian Heimes in :issue:`45459`.)


Porting to Python 3.11
----------------------
Expand Down
3 changes: 2 additions & 1 deletion Misc/NEWS.d/next/C API/2021-10-18-16-54-24.bpo-45459.Y1pEZs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Add :c:type:`Py_buffer` to limited API / stable ABI.
:c:type:`Py_buffer` and various ``Py_buffer`` related functions are now
part of the limited API and stable ABI.