diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2022-11-22 15:50:39 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-22 15:50:39 (GMT) |
| commit | 9a4b2f4f7f81d00ee562c344883828e5db96c973 (patch) | |
| tree | 88c85f3887d638e61e6c06193b9d8d561924a1a5 /Doc/c-api/frame.rst | |
| parent | 49f2eee0a34af74d6c68969243d47ada79298975 (diff) | |
| download | cpython-9a4b2f4f7f81d00ee562c344883828e5db96c973.zip cpython-9a4b2f4f7f81d00ee562c344883828e5db96c973.tar.gz cpython-9a4b2f4f7f81d00ee562c344883828e5db96c973.tar.bz2 | |
gh-93937: Document PyFrame_Check and PyFrame_Type (GH-99695)
(cherry picked from commit d15b9f19ac0ffb29b646735d69b29f48a71c247f)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Diffstat (limited to 'Doc/c-api/frame.rst')
| -rw-r--r-- | Doc/c-api/frame.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/Doc/c-api/frame.rst b/Doc/c-api/frame.rst index 46ce700..b52f347 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) |