From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 10 Jan 2025 07:41:14 +0000 (+0100)
Subject: [3.13] gh-118915: Document `PyUnstable_InterpreterState_GetMainModule` (GH-128483... 
X-Git-Tag: v3.13.2~118
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=65da5db28a39cb0d9ee311206bdc8745b482c56f;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-118915: Document `PyUnstable_InterpreterState_GetMainModule` (GH-128483) (GH-128677)

(cherry picked from commit ea39c8b08d8f025273bfa5b7a95f7b5984dc1e86)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
---

diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index d0632cb6fa17..130942e070ef 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1445,6 +1445,17 @@ All of the following functions must be called after :c:func:`Py_Initialize`.
 
    .. versionadded:: 3.8
 
+
+.. c:function:: PyObject* PyUnstable_InterpreterState_GetMainModule(PyInterpreterState *interp)
+
+   Return a :term:`strong reference` to the ``__main__`` `module object <moduleobjects>`_
+   for the given interpreter.
+
+   The caller must hold the GIL.
+
+   .. versionadded:: 3.13
+
+
 .. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate, _PyInterpreterFrame *frame, int throwflag)
 
    Type of a frame evaluation function.