[Python-checkins] gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)

encukou webhook-mailer at python.org
Tue Nov 22 10:42:24 EST 2022


https://github.com/python/cpython/commit/d15b9f19ac0ffb29b646735d69b29f48a71c247f
commit: d15b9f19ac0ffb29b646735d69b29f48a71c247f
branch: main
author: Petr Viktorin <encukou at gmail.com>
committer: encukou <encukou at gmail.com>
date: 2022-11-22T16:41:57+01:00
summary:

gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)

files:
M Doc/c-api/frame.rst

diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst
index b81faab1d970..1ac8f03d6e48 100644
--- a/Doc/c-api/frame.rst
+++ b/Doc/c-api/frame.rst
@@ -19,6 +19,24 @@ can be used to get a frame object.
 
 See also :ref:`Reflection <reflection>`.
 
+.. c:var:: PyTypeObject PyFrame_Type
+
+   The type of frame objects.
+   It is the same object as :py:class:`types.FrameType` in the Python layer.
+
+   .. versionchanged:: 3.11
+
+      Previously, this type was only available after including
+      ``<frameobject.h>``.
+
+.. c:function:: int PyFrame_Check(PyObject *obj)
+
+   Return non-zero if *obj* is a frame object.
+
+   .. versionchanged:: 3.11
+
+      Previously, this function was only available after including
+      ``<frameobject.h>``.
 
 .. c:function:: PyFrameObject* PyFrame_GetBack(PyFrameObject *frame)
 



More information about the Python-checkins mailing list