Skip to content
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

gh-74929: PEP 667 C API documentation #119379

Merged
merged 7 commits into from
Jun 1, 2024
Merged

gh-74929: PEP 667 C API documentation #119379

merged 7 commits into from
Jun 1, 2024

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented May 22, 2024 •
edited by github-actions bot
Loading

@ncoghlan ncoghlan added docs Documentation in the Doc dir skip news 3.13 bugs and security fixes 3.14 new features, bugs and security fixes needs backport to 3.13 bugs and security fixes labels May 22, 2024
@ncoghlan ncoghlan self-assigned this May 22, 2024
@bedevere-app bedevere-app bot mentioned this pull request May 22, 2024
Closed
@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 22, 2024 •
edited
Loading

Searching for the C APIs updated by the PEP identified some outdated mentions in comments, hence the changes to a few Python and C files.

ncoghlan
ncoghlan commented May 22, 2024
View reviewed changes
Objects/frameobject.c
@@ -1888,8 +1888,7 @@ frame_get_var(_PyInterpreterFrame *frame, PyCodeObject *co, int i,
}
// (likely) Otherwise it is an arg (kind & CO_FAST_LOCAL),
// with the initial value set when the frame was created...
// (unlikely) ...or it was set to some initial value by
// an earlier call to PyFrame_LocalsToFast().
// (unlikely) ...or it was set via the f_locals proxy.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm pretty sure this "set externally" loophole still exists, it's just accessed slightly differently now.

ncoghlan
ncoghlan commented May 25, 2024
View reviewed changes
Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 27, 2024 •
edited
Loading

I've kept the reference out to the PEP for details of the C API changes, so I'll submit a PR there that skips listing PyFrame_GetLocals() as a new API (it was already added back in Python 3.11, so it isn't being added by the PEP anymore)

PR posted: python/peps#3793

@ncoghlan ncoghlan mentioned this pull request May 27, 2024
Merged
encukou
encukou reviewed May 30, 2024
View reviewed changes
Doc/c-api/reflection.rst Outdated Show resolved Hide resolved
@ncoghlan
Copy link
Contributor Author

I'll leave this another couple of days to give @markshannon and @gaogaotiantian a further chance to comment, but I'll make sure this and the related PR to the PEP are merged before beta2 next week.

picnixz
picnixz reviewed May 30, 2024
View reviewed changes
Copy link
Contributor

@picnixz picnixz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nitpicks for consistency.

Doc/whatsnew/3.13.rst Outdated Show resolved Hide resolved
Doc/c-api/reflection.rst Show resolved Hide resolved
ncoghlan and others added 2 commits May 31, 2024 20:43
@ncoghlan @picnixz
Apply suggestions from code review
3c04ea9 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@ncoghlan
Merge branch 'main' into pythongh-74929-pep-667-c-api-docs
185b48f
@ncoghlan ncoghlan mentioned this pull request May 31, 2024
Closed
@ncoghlan ncoghlan merged commit 3859e09 into python:main Jun 1, 2024
56 checks passed
@miss-islington-app
Copy link

Thanks @ncoghlan for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 1, 2024
@ncoghlan @miss-islington
pythongh-74929: PEP 667 C API documentation (pythongh-119379)
898cd58 
* Add docs for new APIs
* Add soft-deprecation notices
* Add What's New porting entries
* Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead
* Other related cleanups found when looking for refs to the deprecated APIs
(cherry picked from commit 3859e09)

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Jun 1, 2024

GH-119892 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 1, 2024
barneygale pushed a commit to barneygale/cpython that referenced this pull request Jun 5, 2024
@ncoghlan @barneygale
pythongh-74929: PEP 667 C API documentation (pythongh-119379)
5c79eb4 
* Add docs for new APIs
* Add soft-deprecation notices
* Add What's New porting entries
* Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead
* Other related cleanups found when looking for refs to the deprecated APIs
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
@ncoghlan @noahbkim
pythongh-74929: PEP 667 C API documentation (pythongh-119379)
c323b49 
* Add docs for new APIs
* Add soft-deprecation notices
* Add What's New porting entries
* Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead
* Other related cleanups found when looking for refs to the deprecated APIs
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@ncoghlan @estyxx
pythongh-74929: PEP 667 C API documentation (pythongh-119379)
d290499 
* Add docs for new APIs
* Add soft-deprecation notices
* Add What's New porting entries
* Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead
* Other related cleanups found when looking for refs to the deprecated APIs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@picnixz picnixz picnixz left review comments

@encukou encukou encukou left review comments

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@markshannon markshannon Awaiting requested review from markshannon markshannon is a code owner

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

Assignees

@ncoghlan ncoghlan

Labels
3.13 bugs and security fixes 3.14 new features, bugs and security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ncoghlan @encukou @picnixz