python3.12/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
0007 #define PyFrame_Check(op) Py_IS_TYPE((op), &PyFrame_Type)
0008
0009 PyAPI_FUNC(PyFrameObject *) PyFrame_GetBack(PyFrameObject *frame);
0010 PyAPI_FUNC(PyObject *) PyFrame_GetLocals(PyFrameObject *frame);
0011
0012 PyAPI_FUNC(PyObject *) PyFrame_GetGlobals(PyFrameObject *frame);
0013 PyAPI_FUNC(PyObject *) PyFrame_GetBuiltins(PyFrameObject *frame);
0014
0015 PyAPI_FUNC(PyObject *) PyFrame_GetGenerator(PyFrameObject *frame);
0016 PyAPI_FUNC(int) PyFrame_GetLasti(PyFrameObject *frame);
0017 PyAPI_FUNC(PyObject*) PyFrame_GetVar(PyFrameObject *frame, PyObject *name);
0018 PyAPI_FUNC(PyObject*) PyFrame_GetVarString(PyFrameObject *frame, const char *name);
0019
0020 /* The following functions are for use by debuggers and other tools
0021  * implementing custom frame evaluators with PEP 523. */
0022
0023 struct _PyInterpreterFrame;
0024
0025 /* Returns the code object of the frame (strong reference).
0026  * Does not raise an exception. */
0027 PyAPI_FUNC(PyObject *) PyUnstable_InterpreterFrame_GetCode(struct _PyInterpreterFrame *frame);
0028
0029 /* Returns a byte ofsset into the last executed instruction.
0030  * Does not raise an exception. */
0031 PyAPI_FUNC(int) PyUnstable_InterpreterFrame_GetLasti(struct _PyInterpreterFrame *frame);
0032
0033 /* Returns the currently executing line number, or -1 if there is no line number.
0034  * Does not raise an exception. */
0035 PyAPI_FUNC(int) PyUnstable_InterpreterFrame_GetLine(struct _PyInterpreterFrame *frame);