Skip to content

gh-74929: PEP 667 general docs update #119201

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
ncoghlan merged 20 commits into from
May 21, 2024
Merged

gh-74929: PEP 667 general docs update #119201

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
6ecb4b3
gh-74929: PEP 667 general docs update
ncoghlan May 20, 2024
fa4172b
pdb's interact still uses a new namespace
ncoghlan May 20, 2024
9ba869b
Cleanup Sphinx lint errors
ncoghlan May 20, 2024
40d0a81
Improve What's New wording
ncoghlan May 20, 2024
b95890d
Define 'optimised scope' term, review f_locals
ncoghlan May 20, 2024
a87f1d7
Move What's New entry to correct section, add credits
ncoghlan May 20, 2024
6e3f1d1
Add porting notes
ncoghlan May 20, 2024
ebcf2d0
Simplify locals() versionchanged notes
ncoghlan May 20, 2024
2a15a62
Merge branch 'main' into gh-74929-pep-667-general-docs-update
ncoghlan May 20, 2024
1e73460
Use newly defined term in pdb docs
ncoghlan May 20, 2024
a867005
Revert extraneous whitespace change
ncoghlan May 20, 2024
70f1db9
Merge remote-tracking branch 'origin/main' into gh-74929-pep-667-gene…
ncoghlan May 21, 2024
c5cb001
Replace the 'mapping namespace' phrase
ncoghlan May 21, 2024
d0fa5e1
Review comments
ncoghlan May 21, 2024
e109eee
Use US spelling for 'optimized'
ncoghlan May 21, 2024
672458f
Clarify that most optimizations are universal
ncoghlan May 21, 2024
270dfac
Fix code.py wording in docs, not just docstring
ncoghlan May 21, 2024
e0ba6c7
exec quirk affects classes, too
ncoghlan May 21, 2024
1187f62
Be consistent about 'top level'
ncoghlan May 21, 2024
9f86cf5
Avoid touching unrelated files
ncoghlan May 21, 2024
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 porting notes
  • Loading branch information
@ncoghlan
ncoghlan committed May 20, 2024
commit 6e3f1d1149a3dadda8752198abdfe8a6f871f8df
18 changes: 18 additions & 0 deletions Doc/whatsnew/3.13.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2215,6 +2215,24 @@ Changes in the Python API
Calling it with argument ``2`` restores the current default behavior.
(Contributed by Serhiy Storchaka in :gh:`66410`.)

* Calling :func:`locals` in an :term:`optimised scope` now produces an
independent snapshot on each call, and hence no longer implicitly updates
previously returned references. Obtaining the legacy CPython behaviour now
requires explicit calls to update the initially returned dictionary with the
results of subsequent calls to ``locals()``. (Changed as part of :pep:`667`.)

* Calling :func:`locals` from a comprehension at module or class scope
(including via ``exec`` or ``eval``) once more behaves as if the comprehension
were running as an independent nested function (i.e. the local variables from
the containing scope are not included). In Python 3.12, this had changed
to include the local variables from the containing scope when implementing
:pep:`709`. (Changed as part of :pep:`667`.)

Comment thread
ncoghlan marked this conversation as resolved.
* Accessing :attr:`FrameType.f_locals <frame.f_locals>` in an
:term:`optimised scope` now returns a write-through proxy rather than a
snapshot that gets updated at ill-specified times. If a snapshot is desired,
it must be created explicitly with ``dict`` or the proxy's ``.copy()`` method.
(Changed as part of :pep:`667`.)

Changes in the C API
--------------------
Expand Down