[3.14] gh-141004: Document Py_MakePendingCalls (GH-141137) (GH-141787)

gh-141004: Document `Py_MakePendingCalls` (GH-141137)
(cherry picked from commit ce701032a3)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
This commit is contained in:
Miss Islington (bot) 2025-11-20 14:48:11 +01:00 committed by GitHub
parent daf98fe5bd
commit 59fa59e381
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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