summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/veryhigh.rst
diff options
context:
space:
mode:
authorVictor Stinner <vstinner@python.org>2022-02-25 11:53:19 (GMT)
committerGitHub <noreply@github.com>2022-02-25 11:53:19 (GMT)
commit18b5dd68c6b616257ae243c0b6bb965ffc885a23 (patch)
tree5d7248f7ff003e8f51b1883eb23018bd61ef5750 /Doc/c-api/veryhigh.rst
parent4657bf701670215ce69b89401b2307022a3b0a7d (diff)
downloadcpython-18b5dd68c6b616257ae243c0b6bb965ffc885a23.zip
cpython-18b5dd68c6b616257ae243c0b6bb965ffc885a23.tar.gz
cpython-18b5dd68c6b616257ae243c0b6bb965ffc885a23.tar.bz2
bpo-46836: Move PyFrameObject to pycore_frame.h (GH-31530)
Move the PyFrameObject type definition (struct _frame) to the internal C API pycore_frame.h header file.
Diffstat (limited to 'Doc/c-api/veryhigh.rst')
-rw-r--r--Doc/c-api/veryhigh.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
index 5b8735d..2f5720d 100644
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -288,8 +288,16 @@ the same library that the Python runtime is using.
.. c:type:: PyFrameObject
- The C structure of the objects used to describe frame objects. The
- fields of this type are subject to change at any time.
+ The C structure of the objects used to describe frame objects.
+
+ The structure is only part of the internal C API: fields should not be
+ access directly. Use getter functions like :c:func:`PyFrame_GetCode` and
+ :c:func:`PyFrame_GetBack`.
+
+ Debuggers and profilers can use the limited C API to access this structure.
+
+ .. versionchanged:: 3.11
+ The structure moved to the internal C API headers.
.. c:function:: PyObject* PyEval_EvalFrame(PyFrameObject *f)