Skip to content

gh-74929: PEP 667 C API documentation - #119379

Merged
ncoghlan merged 7 commits into
python:mainfrom
ncoghlan:gh-74929-pep-667-c-api-docs
Jun 1, 2024
Merged

gh-74929: PEP 667 C API documentation#119379
ncoghlan merged 7 commits into
python:mainfrom
ncoghlan:gh-74929-pep-667-c-api-docs

Conversation

@ncoghlan

@ncoghlanncoghlan commented May 22, 2024•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

@ncoghlanncoghlan added docs Documentation in the Doc dir skip news 3.13 bugs and security fixes 3.14 bugs and security fixes needs backport to 3.13 bugs and security fixes labels May 22, 2024
@ncoghlanncoghlan self-assigned this May 22, 2024
@bedevere-appbedevere-appBot mentioned this pull request May 22, 2024
Closed
@ncoghlan

ncoghlan commented May 22, 2024•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

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
Comment threadObjects/frameobject.c
// 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.

@ncoghlanncoghlanMay 22, 2024

Copy link
Copy Markdown
ContributorAuthor

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
Comment threadDoc/whatsnew/3.13.rst Outdated
@ncoghlan

ncoghlan commented May 27, 2024•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

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

@ncoghlanncoghlan mentioned this pull request May 27, 2024
Merged
encukou
encukou reviewed May 30, 2024
View reviewed changes
Comment threadDoc/c-api/reflection.rst Outdated
@ncoghlan

ncoghlan commented May 30, 2024

Copy link
Copy Markdown
ContributorAuthor

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

@picnixzpicnixz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Small nitpicks for consistency.

Comment threadDoc/whatsnew/3.13.rst Outdated
Comment threadDoc/c-api/reflection.rst
ncoghlanand 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' intopythongh-74929-pep-667-c-api-docs
185b48f
@ncoghlanncoghlan mentioned this pull request May 31, 2024
Closed
@ncoghlan
ncoghlan merged commit 3859e09 into python:mainJun 1, 2024
@miss-islington-app

miss-islington-appBot commented Jun 1, 2024

Copy link
Copy Markdown

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

bedevere-appBot commented Jun 1, 2024

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot 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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukouencukouencukou left review comments
@picnixzpicnixzpicnixz left review comments
@ericsnowcurrentlyericsnowcurrentlyAwaiting requested review from ericsnowcurrentlyericsnowcurrently is a code owner
@markshannonmarkshannonAwaiting requested review from markshannonmarkshannon is a code owner
@gvanrossumgvanrossumAwaiting requested review from gvanrossum

Assignees

@ncoghlanncoghlan

Labels

3.13bugs and security fixes3.14bugs and security fixesdocsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ncoghlan@encukou@picnixz