diff options
| author | Guido van Rossum <guido@python.org> | 2024-05-05 15:31:26 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-05 15:31:26 (GMT) |
| commit | 9c13d9e37a194f574b8591da634bf98419786448 (patch) | |
| tree | f07a1aee30fcce27fc372d7892e967e7669c6c89 /Doc | |
| parent | 5a0022a1d70e4f7f781c4e8d7b43e9f5c9e2f0b4 (diff) | |
| download | cpython-9c13d9e37a194f574b8591da634bf98419786448.zip cpython-9c13d9e37a194f574b8591da634bf98419786448.tar.gz cpython-9c13d9e37a194f574b8591da634bf98419786448.tar.bz2 | |
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).
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/c-api/frame.rst | 9 | ||||
| -rw-r--r-- | Doc/reference/datamodel.rst | 7 | ||||
| -rw-r--r-- | Doc/whatsnew/3.13.rst | 5 |
3 files changed, 19 insertions, 2 deletions
diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst index 6bb1e9b..82e0980 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 5e15583..f9438a1 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 c76d008..152c870 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`, |