Skip to content

Commit 59fa59e

Browse files
miss-islingtonZeroIntensityvstinner
authored
[3.14] gh-141004: Document Py_MakePendingCalls (GH-141137) (GH-141787)
gh-141004: Document `Py_MakePendingCalls` (GH-141137) (cherry picked from commit ce70103) Co-authored-by: Peter Bierma <zintensitydev@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
1 parent daf98fe commit 59fa59e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

Doc/c-api/init.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2019,6 +2019,25 @@ pointer and a void pointer argument.
20192019
This function now always schedules *func* to be run in the main
20202020
interpreter.
20212021
2022+
2023+
.. c:function:: int Py_MakePendingCalls(void)
2024+
2025+
Execute all pending calls. This is usually executed automatically by the
2026+
interpreter.
2027+
2028+
This function returns ``0`` on success, and returns ``-1`` with an exception
2029+
set on failure.
2030+
2031+
If this is not called in the main thread of the main
2032+
interpreter, this function does nothing and returns ``0``.
2033+
The caller must hold an :term:`attached thread state`.
2034+
2035+
.. versionadded:: 3.1
2036+
2037+
.. versionchanged:: 3.12
2038+
This function only runs pending calls in the main interpreter.
2039+
2040+
20222041
.. _profiling:
20232042
20242043
Profiling and Tracing

0 commit comments

Comments
 (0)