Skip to content

gh-118915: C API: Document frame locals proxies. #127720

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
vstinner merged 5 commits into from
Dec 11, 2024
Merged

gh-118915: C API: Document frame locals proxies. #127720

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef168c1
Docs: C API: Document frame locals proxies.
ZeroIntensity Dec 7, 2024
61662c0
Clarify 3.13
ZeroIntensity Dec 7, 2024
86f7cdd
Minor change to wording.
ZeroIntensity Dec 7, 2024
8ec995f
Update frame.rst
ZeroIntensity Dec 9, 2024
4fca539
Remove redundant version added directive
ZeroIntensity Dec 11, 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
Update frame.rst 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
  • Loading branch information
@ZeroIntensity @AlexWaygood
ZeroIntensity and AlexWaygood authored Dec 9, 2024
commit 8ec995f618a2f56f3f1ca3b4a889f28f40e83503
11 changes: 5 additions & 6 deletions Doc/c-api/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,11 @@ Frame Locals Proxies

.. versionadded:: 3.13

In older versions of :term:`CPython`, the exposed local variables dictionary
(via :attr:`~frame.f_locals`, :c:func:`PyFrame_GetLocals`, or :func:`locals`)
wasn't consistent with the actual local variables, which lead to all sorts of
weird issues. In Python 3.13, instead of using a dictionary to expose locals,
a special proxy type that retains consistency when manipulating
scopes is used.
The :attr:`~frame.f_locals` attribute on a :ref:`frame object <frame-objects>`
is an instance of a "frame-locals proxy". The proxy object exposes a
write-through view of the underlying locals dictionary for the frame. This
ensures that the variables exposed by ``f_locals`` are always up to date with
the live local variables in the frame itself.

See :pep:`667` for more information.

Expand Down