Reflection — Python 3.13.14 documentation

# Reflection

PyObject *PyEval_GetBuiltins(void)
  Return value: Borrowed reference. Part of the Stable ABI.

  Deprecated since version 3.13: Use `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.

PyObject *PyEval_GetLocals(void)
  Return value: Borrowed reference. Part of the Stable ABI.

  Deprecated since version 3.13: Use either `PyEval_GetFrameLocals()` to obtain the same behaviour as calling `locals()` in Python code, or else call `PyFrame_GetLocals()` on the result of `PyEval_GetFrame()` to access the `f_locals` attribute of the currently executing frame.

  Return a mapping providing access to the local variables in the current execution frame, or `NULL` if no frame is currently executing.

  Refer to `locals()` for details of the mapping returned at different scopes.

  As this function returns a borrowed reference, the dictionary returned for optimized scopes is cached on the frame object and will remain alive as long as the frame object does. Unlike `PyEval_GetFrameLocals()` and `locals()`, subsequent calls to this function in the same frame will update the contents of the cached dictionary to reflect changes in the state of the local variables rather than returning a new snapshot.

  Changed in version 3.13: As part of PEP 667, `PyFrame_GetLocals()`, `locals()`, and `FrameType.f_locals` no longer make use of the shared cache dictionary. Refer to the What’s New entry for additional details.

PyObject *PyEval_GetGlobals(void)
  Return value: Borrowed reference. Part of the Stable ABI.

  Deprecated since version 3.13: Use `PyEval_GetFrameGlobals()` instead.

  Return a dictionary of the global variables in the current execution frame, or `NULL` if no frame is currently executing.

PyFrameObject *PyEval_GetFrame(void)
  Return value: Borrowed reference. Part of the Stable ABI.

  Return the current thread state’s frame, which is `NULL` if no frame is currently executing.

  See also `PyThreadState_GetFrame()`.

PyObject *PyEval_GetFrameBuiltins(void)
  Return value: New reference. Part of the Stable ABI since version 3.13.

  Return a dictionary of the builtins in the current execution frame, or the interpreter of the thread state if no frame is currently executing.

  Added in version 3.13.

PyObject *PyEval_GetFrameLocals(void)
  Return value: New reference. Part of the Stable ABI since version 3.13.

  Return a dictionary of the local variables in the current execution frame, or `NULL` if no frame is currently executing. Equivalent to calling `locals()` in Python code.

  To access `f_locals` on the current frame without making an independent snapshot in optimized scopes, call `PyFrame_GetLocals()` on the result of `PyEval_GetFrame()`.

  Added in version 3.13.

PyObject *PyEval_GetFrameGlobals(void)
  Return value: New reference. Part of the Stable ABI since version 3.13.

  Return a dictionary of the global variables in the current execution frame, or `NULL` if no frame is currently executing. Equivalent to calling `globals()` in Python code.

  Added in version 3.13.

const char *PyEval_GetFuncName(PyObject *func)
  Part of the Stable ABI.

  Return the name of func if it is a function, class or instance object, else the name of funcs type.

const char *PyEval_GetFuncDesc(PyObject *func)
  Part of the Stable ABI.

  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 `PyEval_GetFuncName()`, the result will be a description of func.