iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PEP 667: PyFrame_GetLocals is no longer new (#3793) 

PyFrame_GetLocals was already added back in Python 3.11,
so PEP 667 is changing it rather than adding it.

(Discrepancy picked up while writing the C API docs update)
This commit is contained in:
Alyssa Coghlan 2024-06-01 13:56:09 +10:00 committed by GitHub
parent 3b62de3fac
commit d1aae7bae0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
peps/pep-0667.rst
View File

@ -138,23 +138,23 @@ C-API
Extensions to the API Extensions to the API
''''''''''''''''''''' '''''''''''''''''''''
Four new C-API functions will be added:: Three new C-API functions will be added::
PyObject *PyEval_GetFrameLocals(void) PyObject *PyEval_GetFrameLocals(void)
PyObject *PyEval_GetFrameGlobals(void) PyObject *PyEval_GetFrameGlobals(void)
PyObject *PyEval_GetFrameBuiltins(void) PyObject *PyEval_GetFrameBuiltins(void)
PyObject *PyFrame_GetLocals(PyFrameObject *f)
``PyEval_GetFrameLocals()`` is equivalent to: ``locals()``. ``PyEval_GetFrameLocals()`` is equivalent to: ``locals()``.
``PyEval_GetFrameGlobals()`` is equivalent to: ``globals()``. ``PyEval_GetFrameGlobals()`` is equivalent to: ``globals()``.
``PyFrame_GetLocals(f)`` is equivalent to: ``f.f_locals``.
All these functions will return a new reference. All these functions will return a new reference.
Changes to existing APIs Changes to existing APIs
'''''''''''''''''''''''' ''''''''''''''''''''''''
``PyFrame_GetLocals(f)`` is equivalent to ``f.f_locals``, and hence its return value
will change as described above for accessing ``f.f_locals``.
The following C-API functions will be deprecated, as they return borrowed references:: The following C-API functions will be deprecated, as they return borrowed references::
PyEval_GetLocals() PyEval_GetLocals()
@ -170,7 +170,7 @@ The following functions should be used instead::
which return new references. which return new references.
The semantics of ``PyEval_GetLocals()`` is changed as it now returns a The semantics of ``PyEval_GetLocals()`` is changed as it now returns a
view of the frame locals, not a dictionary. proxy for the frame locals in optimized frames, not a dictionary.
The following three functions will become no-ops, and will be deprecated:: The following three functions will become no-ops, and will be deprecated::
@ -208,7 +208,7 @@ PyEval_GetLocals
'''''''''''''''' ''''''''''''''''
Because ``PyEval_GetLocals()`` returns a borrowed reference, it requires Because ``PyEval_GetLocals()`` returns a borrowed reference, it requires
the dictionary to be cached on the frame, extending its lifetime and the proxy mapping to be cached on the frame, extending its lifetime and
creating a cycle. ``PyEval_GetFrameLocals()`` should be used instead. creating a cycle. ``PyEval_GetFrameLocals()`` should be used instead.
This code:: This code::