From acda29450bf5b88876504b22fab1bde7688950e3 Mon Sep 17 00:00:00 2001 From: Peter Bierma Date: Thu, 20 Nov 2025 08:42:01 -0500 Subject: [PATCH] gh-141004: Document `Py_MakePendingCalls` (GH-141137) (cherry picked from commit ce701032a3d5d3597466d5836ebe989db6eda2aa) Co-authored-by: Peter Bierma Co-authored-by: Victor Stinner --- Doc/c-api/init.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index 660ab3c3cf97ac..b53fce8c727ade 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -2019,6 +2019,25 @@ pointer and a void pointer argument. This function now always schedules *func* to be run in the main interpreter. + +.. c:function:: int Py_MakePendingCalls(void) + + Execute all pending calls. This is usually executed automatically by the + interpreter. + + This function returns ``0`` on success, and returns ``-1`` with an exception + set on failure. + + If this is not called in the main thread of the main + interpreter, this function does nothing and returns ``0``. + The caller must hold an :term:`attached thread state`. + + .. versionadded:: 3.1 + + .. versionchanged:: 3.12 + This function only runs pending calls in the main interpreter. + + .. _profiling: Profiling and Tracing