https://github.com/python/cpython/commit/9c13d9e37a194f574b8591da634bf98419786448
commit: 9c13d9e37a194f574b8591da634bf98419786448
branch: main
author: Guido van Rossum <[email protected]>
committer: gvanrossum <[email protected]>
date: 2024-05-05T15:31:26Z
summary:
gh-74929: Rudimentary docs for PEP 667 (#118581)
This is *not* sufficient for the final 3.13 release, but it will do for beta 1:
- What's new entry
- Updated changelog entry (news blurb)
- Mention the proxy for f_globals in the datamodel and Python frame object docs
This doesn't have any C API details (what's new refers to the PEP).
files:
M Doc/c-api/frame.rst
M Doc/reference/datamodel.rst
M Doc/whatsnew/3.13.rst
M Misc/NEWS.d/next/Core and
Builtins/2024-04-27-21-44-40.gh-issue-74929.C2nESp.rst
diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst
index 6bb1e9b5803b58..82e0980ad753d0 100644
--- a/Doc/c-api/frame.rst
+++ b/Doc/c-api/frame.rst
@@ -120,12 +120,19 @@ See also :ref:`Reflection <reflection>`.
.. c:function:: PyObject* PyFrame_GetLocals(PyFrameObject *frame)
- Get the *frame*'s :attr:`~frame.f_locals` attribute (:class:`dict`).
+ Get the *frame*'s :attr:`~frame.f_locals` attribute.
+ If the frame refers to a function or comprehension, this returns
+ a write-through proxy object that allows modifying the locals.
+ In all other cases (classes, modules) it returns the :class:`dict`
+ representing the frame locals directly.
Return a :term:`strong reference`.
.. versionadded:: 3.11
+ .. versionchanged:: 3.13
+ Return a proxy object for functions and comprehensions.
+
.. c:function:: int PyFrame_GetLineNumber(PyFrameObject *frame)
diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 5e1558362ffaa0..f9438a141657be 100644
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1341,7 +1341,12 @@ Special read-only attributes
* - .. attribute:: frame.f_locals
- The dictionary used by the frame to look up
- :ref:`local variables <naming>`
+ :ref:`local variables <naming>`.
+ If the frame refers to a function or comprehension,
+ this may return a write-through proxy object.
+
+ .. versionchanged:: 3.13
+ Return a proxy for functions and comprehensions.
* - .. attribute:: frame.f_globals
- The dictionary used by the frame to look up
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index c76d0087f9e2ff..152c8707dfe259 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -87,6 +87,11 @@ Interpreter improvements:
Performance improvements are modest -- we expect to be improving this
over the next few releases.
+* :pep:`667`: :attr:`FrameType.f_locals <frame.f_locals>` when used in
+ a function now returns a write-through proxy to the frame's locals,
+ rather than a ``dict``. See the PEP for corresponding C API changes
+ and deprecations.
+
New typing features:
* :pep:`696`: Type parameters (:data:`typing.TypeVar`,
:data:`typing.ParamSpec`,
diff --git a/Misc/NEWS.d/next/Core and
Builtins/2024-04-27-21-44-40.gh-issue-74929.C2nESp.rst b/Misc/NEWS.d/next/Core
and Builtins/2024-04-27-21-44-40.gh-issue-74929.C2nESp.rst
index 46e628f7fa7dbe..29c7975fa66bc0 100644
--- a/Misc/NEWS.d/next/Core and
Builtins/2024-04-27-21-44-40.gh-issue-74929.C2nESp.rst
+++ b/Misc/NEWS.d/next/Core and
Builtins/2024-04-27-21-44-40.gh-issue-74929.C2nESp.rst
@@ -1 +1,3 @@
-Implement PEP 667 - converted ``frame.f_locals`` to a write through proxy
+Implement PEP 667: converted :attr:`FrameType.f_locals <frame.f_locals>`
+and :c:func:`PyFrame_GetLocals` to return a write-through proxy object
+when the frame refers to a function or comprehension.
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
