diff options
author | Alyssa Coghlan <ncoghlan@gmail.com> | 2024-06-01 06:21:48 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-01 06:21:48 (GMT) |
commit | 2180991ea3d50f56595edae241cc92dd4e7de642 (patch) | |
tree | 38def68e773099a727a18d06fccadc4bdb0fc003 /Doc/c-api | |
parent | 3859e09e3d92d004978dd838f0511364e7edfb94 (diff) | |
download | cpython-2180991ea3d50f56595edae241cc92dd4e7de642.zip cpython-2180991ea3d50f56595edae241cc92dd4e7de642.tar.gz cpython-2180991ea3d50f56595edae241cc92dd4e7de642.tar.bz2 |
gh-118888: Further PEP 667 docs updates (gh-119893)
* Clarify impact on default behaviour of exec, eval, etc
* Update documentation for changes to PyEval_GetLocals (gh-74929)
Closes gh-11888
Diffstat (limited to 'Doc/c-api')
-rw-r--r-- | Doc/c-api/reflection.rst | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/Doc/c-api/reflection.rst b/Doc/c-api/reflection.rst index 5dcfe40..af9a1a7 100644 --- a/Doc/c-api/reflection.rst +++ b/Doc/c-api/reflection.rst @@ -19,11 +19,24 @@ Reflection .. deprecated:: 3.13 - Use :c:func:`PyEval_GetFrameLocals` instead. + To avoid creating a reference cycle in :term:`optimized scopes <optimized scope>`, + use either :c:func:`PyEval_GetFrameLocals` to obtain the same behaviour as calling + :func:`locals` in Python code, or else call :c:func:`PyFrame_GetLocals` on the result + of :c:func:`PyEval_GetFrame` to get the same result as this function without having to + cache the proxy instance on the underlying frame. - Return a dictionary of the local variables in the current execution frame, + Return the :attr:`~frame.f_locals` attribute of the currently executing frame, or ``NULL`` if no frame is currently executing. + If the frame refers to an :term:`optimized scope`, this returns a + write-through proxy object that allows modifying the locals. + In all other cases (classes, modules, :func:`exec`, :func:`eval`) it returns + the mapping representing the frame locals directly (as described for + :func:`locals`). + + .. versionchanged:: 3.13 + As part of :pep:`667`, return a proxy object for optimized scopes. + .. c:function:: PyObject* PyEval_GetGlobals(void) @@ -57,6 +70,10 @@ Reflection or ``NULL`` if no frame is currently executing. Equivalent to calling :func:`locals` in Python code. + To access :attr:`~frame.f_locals` on the current frame without making an independent + snapshot in :term:`optimized scopes <optimized scope>`, call :c:func:`PyFrame_GetLocals` + on the result of :c:func:`PyEval_GetFrame`. + .. versionadded:: 3.13 |