mirror of
https://github.com/python/cpython.git
synced 2025-08-31 14:07:50 +00:00
0a266f7e74
* Add docs for new APIs
* Add soft-deprecation notices
* Add What's New porting entries
* Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead
* Other related cleanups found when looking for refs to the deprecated APIs
(cherry picked from commit 3859e09e3d)
Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
84 lines
2.3 KiB
ReStructuredText
84 lines
2.3 KiB
ReStructuredText
.. highlight:: c
|
|
|
|
.. _reflection:
|
|
|
|
Reflection
|
|
==========
|
|
|
|
.. c:function:: PyObject* PyEval_GetBuiltins(void)
|
|
|
|
.. deprecated:: 3.13
|
|
|
|
Use :c:func:`PyEval_GetFrameBuiltins` instead.
|
|
|
|
Return a dictionary of the builtins in the current execution frame,
|
|
or the interpreter of the thread state if no frame is currently executing.
|
|
|
|
|
|
.. c:function:: PyObject* PyEval_GetLocals(void)
|
|
|
|
.. deprecated:: 3.13
|
|
|
|
Use :c:func:`PyEval_GetFrameLocals` instead.
|
|
|
|
Return a dictionary of the local variables in the current execution frame,
|
|
or ``NULL`` if no frame is currently executing.
|
|
|
|
|
|
.. c:function:: PyObject* PyEval_GetGlobals(void)
|
|
|
|
.. deprecated:: 3.13
|
|
|
|
Use :c:func:`PyEval_GetFrameGlobals` instead.
|
|
|
|
Return a dictionary of the global variables in the current execution frame,
|
|
or ``NULL`` if no frame is currently executing.
|
|
|
|
|
|
.. c:function:: PyFrameObject* PyEval_GetFrame(void)
|
|
|
|
Return the current thread state's frame, which is ``NULL`` if no frame is
|
|
currently executing.
|
|
|
|
See also :c:func:`PyThreadState_GetFrame`.
|
|
|
|
|
|
.. c:function:: PyObject* PyEval_GetFrameBuiltins(void)
|
|
|
|
Return a dictionary of the builtins in the current execution frame,
|
|
or the interpreter of the thread state if no frame is currently executing.
|
|
|
|
.. versionadded:: 3.13
|
|
|
|
|
|
.. c:function:: PyObject* PyEval_GetFrameLocals(void)
|
|
|
|
Return a dictionary of the local variables in the current execution frame,
|
|
or ``NULL`` if no frame is currently executing. Equivalent to calling
|
|
:func:`locals` in Python code.
|
|
|
|
.. versionadded:: 3.13
|
|
|
|
|
|
.. c:function:: PyObject* PyEval_GetFrameGlobals(void)
|
|
|
|
Return a dictionary of the global variables in the current execution frame,
|
|
or ``NULL`` if no frame is currently executing. Equivalent to calling
|
|
:func:`globals` in Python code.
|
|
|
|
.. versionadded:: 3.13
|
|
|
|
|
|
.. c:function:: const char* PyEval_GetFuncName(PyObject *func)
|
|
|
|
Return the name of *func* if it is a function, class or instance object, else the
|
|
name of *func*\s type.
|
|
|
|
|
|
.. c:function:: const char* PyEval_GetFuncDesc(PyObject *func)
|
|
|
|
Return a description string, depending on the type of *func*.
|
|
Return values include "()" for functions and methods, " constructor",
|
|
" instance", and " object". Concatenated with the result of
|
|
:c:func:`PyEval_GetFuncName`, the result will be a description of
|
|
*func*.
|