diff options
| author | Victor Stinner <vstinner@python.org> | 2020-03-20 14:51:45 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-20 14:51:45 (GMT) |
| commit | fd1e1a18fa3befe5b6eeac32e0561e15c7e5164b (patch) | |
| tree | 06a32a688ef6d88553386ec2710eecc5fd246226 /Doc | |
| parent | d83168854e19d0381fa57db25fca6c622917624f (diff) | |
| download | cpython-fd1e1a18fa3befe5b6eeac32e0561e15c7e5164b.zip cpython-fd1e1a18fa3befe5b6eeac32e0561e15c7e5164b.tar.gz cpython-fd1e1a18fa3befe5b6eeac32e0561e15c7e5164b.tar.bz2 | |
bpo-39947: Add PyThreadState_GetFrame() function (GH-19092)
Add PyThreadState_GetFrame() function: get the current frame
of a Python thread state.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/c-api/init.rst | 12 | ||||
| -rw-r--r-- | Doc/c-api/reflection.rst | 10 | ||||
| -rw-r--r-- | Doc/whatsnew/3.9.rst | 3 |
3 files changed, 21 insertions, 4 deletions
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index a4ec0e3..294c1b9 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -1072,6 +1072,18 @@ All of the following functions must be called after :c:func:`Py_Initialize`. to :c:func:`PyThreadState_Clear`. +.. c:function:: PyFrameObject* PyThreadState_GetFrame(PyThreadState *tstate) + + Get the current frame of the Python thread state *tstate*. It can be + ``NULL`` if no frame is currently executing. + + See also :c:func:`PyEval_GetFrame`. + + *tstate* must not be ``NULL``. + + .. versionadded:: 3.9 + + .. c:function:: PyInterpreterState* PyThreadState_GetInterpreter(PyThreadState *tstate) Get the interpreter of the Python thread state *tstate*. diff --git a/Doc/c-api/reflection.rst b/Doc/c-api/reflection.rst index 1d86de6..4d3d25e 100644 --- a/Doc/c-api/reflection.rst +++ b/Doc/c-api/reflection.rst @@ -5,29 +5,31 @@ Reflection ========== -.. c:function:: PyObject* PyEval_GetBuiltins() +.. c:function:: PyObject* PyEval_GetBuiltins(void) Return a dictionary of the builtins in the current execution frame, or the interpreter of the thread state if no frame is currently executing. -.. c:function:: PyObject* PyEval_GetLocals() +.. c:function:: PyObject* PyEval_GetLocals(void) Return a dictionary of the local variables in the current execution frame, or ``NULL`` if no frame is currently executing. -.. c:function:: PyObject* PyEval_GetGlobals() +.. c:function:: PyObject* PyEval_GetGlobals(void) Return a dictionary of the global variables in the current execution frame, or ``NULL`` if no frame is currently executing. -.. c:function:: PyFrameObject* PyEval_GetFrame() +.. c:function:: PyFrameObject* PyEval_GetFrame(void) Return the current thread state's frame, which is ``NULL`` if no frame is currently executing. + See also :c:func:`PyThreadState_GetFrame`. + .. c:function:: int PyFrame_GetLineNumber(PyFrameObject *frame) diff --git a/Doc/whatsnew/3.9.rst b/Doc/whatsnew/3.9.rst index ac5d317..3e30f84 100644 --- a/Doc/whatsnew/3.9.rst +++ b/Doc/whatsnew/3.9.rst @@ -427,6 +427,9 @@ Build and C API Changes * New :c:func:`PyThreadState_GetInterpreter` and :c:func:`PyInterpreterState_Get` functions to get the interpreter. + New :c:func:`PyThreadState_GetFrame` function to get the current frame of a + Python thread state. + (Contributed by Victor Stinner in :issue:`39947`.) * Add ``--with-platlibdir`` option to the ``configure`` script: name of the platform-specific library directory, stored in the new :attr:`sys.platlibdir` |