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.

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

gh-118934: Fix PyEval_GetLocals docs (PEP 667) #119932

Merged
merged 4 commits into from
Jun 2, 2024

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Jun 2, 2024

PEP 667's description of the planned changes to PyEval_GetLocals was internally inconsistent when accepted, so the docs added for gh-74929 didn't match either the current behaviour or the intended behaviour once gh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the intended behaviour (once gh-118934 is fixed).


📚 Documentation preview 📚: https://cpython-previews--119932.org.readthedocs.build/

PEP 667's description of the planned changes to PyEval_GetLocals
was internally inconsistent when accepted, so the docs added for
pythongh-74929 didn't match either the current behaviour or the intended
behaviour once pythongh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the
intended behaviour (once pythongh-118934 is fixed).
@ncoghlan ncoghlan self-assigned this Jun 2, 2024
@ncoghlan ncoghlan added 3.13 bugs and security fixes 3.14 new features, bugs and security fixes needs backport to 3.13 bugs and security fixes labels Jun 2, 2024
@ncoghlan ncoghlan enabled auto-merge (squash) June 2, 2024 04:33
@ncoghlan
Copy link
Contributor Author

ncoghlan commented Jun 2, 2024

Set to auto-merge, since I don't want to risk the currently incorrect docs making their way into beta2 this week.

@ncoghlan ncoghlan merged commit fd6cd62 into python:main Jun 2, 2024
25 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-app
Copy link

Sorry, @ncoghlan, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker fd6cd621e0cce6ba2e737103d2a62b5ade90f41f 3.13

@ncoghlan ncoghlan added needs backport to 3.13 bugs and security fixes and removed needs backport to 3.13 bugs and security fixes labels Jun 2, 2024
@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 2, 2024
PEP 667's description of the planned changes to PyEval_GetLocals
was internally inconsistent when accepted, so the docs added for
pythongh-74929 didn't match either the current behaviour or the intended
behaviour once pythongh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the
intended behaviour (once pythongh-118934 is fixed).

It also tidies up lingering references to `f_locals` always being a
dictionary (this hasn't been true since at least when custom
namespace support for class statement execution was added)
(cherry picked from commit fd6cd62)

Co-authored-by: Alyssa Coghlan <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jun 2, 2024

GH-119934 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 2, 2024
@ncoghlan
Copy link
Contributor Author

ncoghlan commented Jun 2, 2024

Conflict was due to my failure to merge #119894 yesterday. Fixed that, and retriggered miss-islington

barneygale pushed a commit to barneygale/cpython that referenced this pull request Jun 5, 2024
PEP 667's description of the planned changes to PyEval_GetLocals
was internally inconsistent when accepted, so the docs added for
pythongh-74929 didn't match either the current behaviour or the intended
behaviour once pythongh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the
intended behaviour (once pythongh-118934 is fixed).

It also tidies up lingering references to `f_locals` always being a
dictionary (this hasn't been true since at least when custom
namespace support for class statement execution was added)
noahbkim pushed a commit to hudson-trading/cpython that referenced this pull request Jul 11, 2024
PEP 667's description of the planned changes to PyEval_GetLocals
was internally inconsistent when accepted, so the docs added for
pythongh-74929 didn't match either the current behaviour or the intended
behaviour once pythongh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the
intended behaviour (once pythongh-118934 is fixed).

It also tidies up lingering references to `f_locals` always being a
dictionary (this hasn't been true since at least when custom
namespace support for class statement execution was added)
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
PEP 667's description of the planned changes to PyEval_GetLocals
was internally inconsistent when accepted, so the docs added for
pythongh-74929 didn't match either the current behaviour or the intended
behaviour once pythongh-118934 is fixed.

This PR updates the documentation and 3.13 What's New to match the
intended behaviour (once pythongh-118934 is fixed).

It also tidies up lingering references to `f_locals` always being a
dictionary (this hasn't been true since at least when custom
namespace support for class statement execution was added)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

1 participant