summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/frame.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/c-api/frame.rst')
-rw-r--r--Doc/c-api/frame.rst48
1 files changed, 48 insertions, 0 deletions
diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst
new file mode 100644
index 0000000..0e36e6e
--- /dev/null
+++ b/Doc/c-api/frame.rst
@@ -0,0 +1,48 @@
+.. highlight:: c
+
+Frame Objects
+-------------
+
+.. c:type:: PyFrameObject
+
+ The C structure of the objects used to describe frame objects.
+
+ The structure is not part of the C API.
+
+ .. versionchanged:: 3.11
+ The structure moved to the internal C API headers.
+
+The :c:func:`PyEval_GetFrame` and :c:func:`PyThreadState_GetFrame` functions
+can be used to get a frame object.
+
+See also :ref:`Reflection <reflection>`.
+
+
+.. c:function:: PyFrameObject* PyFrame_GetBack(PyFrameObject *frame)
+
+ Get the *frame* next outer frame.
+
+ Return a :term:`strong reference`, or ``NULL`` if *frame* has no outer
+ frame.
+
+ *frame* must not be ``NULL``.
+
+ .. versionadded:: 3.9
+
+
+.. c:function:: PyCodeObject* PyFrame_GetCode(PyFrameObject *frame)
+
+ Get the *frame* code.
+
+ Return a :term:`strong reference`.
+
+ *frame* must not be ``NULL``. The result (frame code) cannot be ``NULL``.
+
+ .. versionadded:: 3.9
+
+
+.. c:function:: int PyFrame_GetLineNumber(PyFrameObject *frame)
+
+ Return the line number that *frame* is currently executing.
+
+ *frame* must not be ``NULL``.