python3.13/cpython/pyframe.h

0001 #ifndef Py_CPYTHON_PYFRAME_H
0002 #  error "this header file must not be included directly"
0003 #endif
0004
0005 PyAPI_DATA(PyTypeObject) PyFrame_Type;
0006 PyAPI_DATA(PyTypeObject) PyFrameLocalsProxy_Type;
0007
0008 #define PyFrame_Check(op) Py_IS_TYPE((op), &PyFrame_Type)
0009 #define PyFrameLocalsProxy_Check(op) Py_IS_TYPE((op), &PyFrameLocalsProxy_Type)
0010
0011 PyAPI_FUNC(PyFrameObject *) PyFrame_GetBack(PyFrameObject *frame);
0012 PyAPI_FUNC(PyObject *) PyFrame_GetLocals(PyFrameObject *frame);
0013
0014 PyAPI_FUNC(PyObject *) PyFrame_GetGlobals(PyFrameObject *frame);
0015 PyAPI_FUNC(PyObject *) PyFrame_GetBuiltins(PyFrameObject *frame);
0016
0017 PyAPI_FUNC(PyObject *) PyFrame_GetGenerator(PyFrameObject *frame);
0018 PyAPI_FUNC(int) PyFrame_GetLasti(PyFrameObject *frame);
0019 PyAPI_FUNC(PyObject*) PyFrame_GetVar(PyFrameObject *frame, PyObject *name);
0020 PyAPI_FUNC(PyObject*) PyFrame_GetVarString(PyFrameObject *frame, const char *name);
0021
0022 /* The following functions are for use by debuggers and other tools
0023  * implementing custom frame evaluators with PEP 523. */
0024
0025 struct _PyInterpreterFrame;
0026
0027 /* Returns the code object of the frame (strong reference).
0028  * Does not raise an exception. */
0029 PyAPI_FUNC(PyObject *) PyUnstable_InterpreterFrame_GetCode(struct _PyInterpreterFrame *frame);
0030
0031 /* Returns a byte ofsset into the last executed instruction.
0032  * Does not raise an exception. */
0033 PyAPI_FUNC(int) PyUnstable_InterpreterFrame_GetLasti(struct _PyInterpreterFrame *frame);
0034
0035 /* Returns the currently executing line number, or -1 if there is no line number.
0036  * Does not raise an exception. */
0037 PyAPI_FUNC(int) PyUnstable_InterpreterFrame_GetLine(struct _PyInterpreterFrame *frame);
0038
0039 #define PyUnstable_EXECUTABLE_KIND_SKIP 0
0040 #define PyUnstable_EXECUTABLE_KIND_PY_FUNCTION 1
0041 #define PyUnstable_EXECUTABLE_KIND_BUILTIN_FUNCTION 3
0042 #define PyUnstable_EXECUTABLE_KIND_METHOD_DESCRIPTOR 4
0043 #define PyUnstable_EXECUTABLE_KINDS 5
0044
0045 PyAPI_DATA(const PyTypeObject *) const PyUnstable_ExecutableKinds[PyUnstable_EXECUTABLE_KINDS+1];