8000 Add PEP 688 special buffer methods to C API Type Object and Buffer Protocol docs · Issue #132246 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Add PEP 688 special buffer methods to C API Type Object and Buffer Protocol docs #132246

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

Jump to bottom
Closed
cmaloney opened this issue Apr 7, 2025 · 2 comments
Closed

Add PEP 688 special buffer methods to C API Type Object and Buffer Protocol docs #132246

cmaloney opened this issue Apr 7, 2025 · 2 comments
Labels
docs Documentation in the Doc dir topic-C-API

Comments

@cmaloney
Copy link
Contributor
cmaloney commented Apr 7, 2025 •
edited by bedevere-app bot
Loading

Documentation

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.

C API Type Object: https://docs.python.org/3/c-api/typeobj.html#tp-slots
Data Model: https://docs.python.org/3/reference/datamodel.html#emulating-buffer-types

Linked PRs
@cmaloney cmaloney added the docs Documentation in the Doc dir label Apr 7, 2025
cmaloney added a commit to cmaloney/cpython that referenced this issue Apr 7, 2025
@cmaloney
pythongh-132246: Add special buffer methods to C API Type Object docs
c5be72a 
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.
8000
@bedevere-app bedevere-app bot mentioned this issue Apr 7, 2025
Merged
@cmaloney cmaloney changed the title Update C API Type Object Documentation to include PEP-688 Buffer Protocol special methods Add PEP 688 special buffer methods to C API Type Object docs Apr 7, 2025
@cmaloney cmaloney changed the title Add PEP 688 special buffer methods to C API Type Object docs Add PEP 688 special buffer methods to C API Type Object and Buffer Object docs Apr 7, 2025
@cmaloney cmaloney changed the title Add PEP 688 special buffer methods to C API Type Object and Buffer Object docs Add PEP 688 special buffer methods to C API Type Object and Buffer Protocol docs Apr 7, 2025
cmaloney added a commit to cmaloney/cpython that referenced this issue Apr 8, 2025
@cmaloney
pythongh-132246: Add PEP 688 to C Buffer Protocol docs
5730a38
@bedevere-app bedevere-app bot mentioned this issue Apr 8, 2025
Merged
@cmaloney
Copy link
Contributor Author
cmaloney commented Apr 8, 2025

cc: @JelleZijlstra (PEP 688 Author)

JelleZijlstra pushed a commit that referenced this issue Apr 8, 2025
@cmaloney
gh-132246: Add PEP 688 to C Buffer Protocol docs (#132249)
8421b64
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 8, 2025
@cmaloney @miss-islington
pythongh-132246: Add PEP 688 to C Buffer Protocol docs (pythonGH-132249)
a316fd5 
(cherry picked from commit 8421b64)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
@bedevere-app bedevere-app bot mentioned this issue Apr 8, 2025
Merged
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
@cmaloney @seehwan80
pythongh-132246: Add PEP 688 to C Buffer Protocol docs (python#132249)
8dbfcc6
AA-Turner pushed a commit that referenced this issue May 1, 2025
@miss-islington @cmaloney
[3.13] gh-132246: Add PEP 688 to C Buffer Protocol docs (GH-132249) (#…
679e632 
…132282)

gh-132246: Add PEP 688 to C Buffer Protocol docs (GH-132249)
(cherry picked from commit 8421b64)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
ambv pushed a commit that referenced this issue May 21, 2025
@cmaloney
gh-132246: Add special buffer methods to C API Type Object docs (gh-1…
b529b60 
…32247)

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.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 21, 2025
@cmaloney @miss-islington
pythongh-132246: Add special buffer methods to C API Type Object docs (…
b164ddb 
…pythongh-132247)

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.
(cherry picked from commit b529b60)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue May 21, 2025
@cmaloney @miss-islington
pythongh-132246: Add special buffer methods to C API Type Object docs (…
3e06aa9 
…pythongh-132247)

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.
(cherry picked from commit b529b60)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
This was referenced May 21, 2025
Merged
Merged
ambv pushed a commit that referenced this issue May 21, 2025
@miss-islington @cmaloney
[3.14] gh-132246: Add special buffer methods to C API Type Object docs (
cd3395a 
gh-132247) (gh-134426)

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.

(cherry picked from commit b529b60)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
ambv pushed a commit that referenced this issue May 21, 2025
@miss-islington @cmaloney
[3.13] gh-132246: Add special buffer methods to C API Type Object docs (
bc60b33 
gh-132247) (gh-134427)

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.
(cherry picked from commit b529b60)

Co-authored-by: Cody Maloney <cmaloney@users.noreply.github.com>
@ambv ambv closed this as completed May 21, 2025
@ambv
Copy link
Contributor
ambv commented May 21, 2025

Thanks, Cody!

lkollar pushed a commit to lkollar/cpython that referenced this issue May 26, 2025
@cmaloney @lkollar
pythongh-132246: Add special buffer methods to C API Type Object docs (…
869903f 
…pythongh-132247)

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-C-API
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ambv @cmaloney @picnixz
0