https://github.com/python/cpython/commit/fe462f5a9122e1c2641b5369cbb88c4a5e822816
commit: fe462f5a9122e1c2641b5369cbb88c4a5e822816
branch: main
author: Eric Snow <[email protected]>
committer: ericsnowcurrently <[email protected]>
date: 2025-04-28T12:46:22-06:00
summary:
gh-132775: Drop PyUnstable_InterpreterState_GetMainModule() (gh-132978)
We replace it with _Py_GetMainModule(), and add _Py_CheckMainModule(), but both
in the internal-only C-API. We also add _PyImport_GetModulesRef(), which is
the equivalent of _PyImport_GetModules(), but which increfs before the lock is
released.
This is used by a later change related to pickle and handling __main__.
files:
M Doc/c-api/init.rst
M Include/cpython/pystate.h
M Include/internal/pycore_import.h
M Include/internal/pycore_pystate.h
M Python/crossinterp.c
M Python/import.c
M Python/pystate.c
diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst
index 33e9f87a6061df..52f64a61006b74 100644
--- a/Doc/c-api/init.rst
+++ b/Doc/c-api/init.rst
@@ -1517,16 +1517,6 @@ 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__`` :ref:`module object
<moduleobjects>`
- for the given interpreter.
-
- The caller must have an :term:`attached thread state`.
-
- .. versionadded:: 3.13
-
-
.. c:type:: PyObject* (*_PyFrameEvalFunction)(PyThreadState *tstate,
_PyInterpreterFrame *frame, int throwflag)
Type of a frame evaluation function.
diff --git a/Include/cpython/pystate.h b/Include/cpython/pystate.h
index c562426767c2cb..97f11fff244a8b 100644
--- a/Include/cpython/pystate.h
+++ b/Include/cpython/pystate.h
@@ -8,8 +8,6 @@
PyAPI_FUNC(int) _PyInterpreterState_RequiresIDRef(PyInterpreterState *);
PyAPI_FUNC(void) _PyInterpreterState_RequireIDRef(PyInterpreterState *, int);
-PyAPI_FUNC(PyObject *)
PyUnstable_InterpreterState_GetMainModule(PyInterpreterState *);
-
/* State unique per thread */
/* Py_tracefunc return -1 when raising an exception, or 0 for success. */
diff --git a/Include/internal/pycore_import.h b/Include/internal/pycore_import.h
index 3acafd02bbdd7c..13fbff4eb65cb2 100644
--- a/Include/internal/pycore_import.h
+++ b/Include/internal/pycore_import.h
@@ -63,6 +63,7 @@ extern void _PyImport_SetDLOpenFlags(PyInterpreterState
*interp, int new_val);
extern PyObject * _PyImport_InitModules(PyInterpreterState *interp);
extern PyObject * _PyImport_GetModules(PyInterpreterState *interp);
+extern PyObject * _PyImport_GetModulesRef(PyInterpreterState *interp);
extern void _PyImport_ClearModules(PyInterpreterState *interp);
extern void _PyImport_ClearModulesByIndex(PyInterpreterState *interp);
diff --git a/Include/internal/pycore_pystate.h
b/Include/internal/pycore_pystate.h
index 864e0f5d1db289..601b9790001a03 100644
--- a/Include/internal/pycore_pystate.h
+++ b/Include/internal/pycore_pystate.h
@@ -283,6 +283,9 @@ PyAPI_FUNC(const PyConfig*) _Py_GetConfig(void);
// See also PyInterpreterState_Get() and _PyInterpreterState_GET().
extern PyInterpreterState* _PyGILState_GetInterpreterStateUnsafe(void);
+extern PyObject * _Py_GetMainModule(PyThreadState *);
+extern int _Py_CheckMainModule(PyObject *module);
+
#ifndef NDEBUG
/* Modern equivalent of assert(PyGILState_Check()) */
static inline void
diff --git a/Python/crossinterp.c b/Python/crossinterp.c
index 8ba88c4b057686..a1dd6b5901dcfa 100644
--- a/Python/crossinterp.c
+++ b/Python/crossinterp.c
@@ -1738,6 +1738,7 @@ _PyXI_Enter(_PyXI_session *session,
// Switch to the requested interpreter (if necessary).
_enter_session(session, interp);
+ PyThreadState *session_tstate = session->init_tstate;
_PyXI_errcode errcode = _PyXI_ERR_UNCAUGHT_EXCEPTION;
// Ensure this thread owns __main__.
@@ -1751,8 +1752,8 @@ _PyXI_Enter(_PyXI_session *session,
session->running = 1;
// Cache __main__.__dict__.
- PyObject *main_mod = PyUnstable_InterpreterState_GetMainModule(interp);
- if (main_mod == NULL) {
+ PyObject *main_mod = _Py_GetMainModule(session_tstate);
+ if (_Py_CheckMainModule(main_mod) < 0) {
errcode = _PyXI_ERR_MAIN_NS_FAILURE;
goto error;
}
diff --git a/Python/import.c b/Python/import.c
index 8742b6ec767c9b..a671a08daeb50f 100644
--- a/Python/import.c
+++ b/Python/import.c
@@ -153,6 +153,20 @@ _PyImport_GetModules(PyInterpreterState *interp)
return MODULES(interp);
}
+PyObject *
+_PyImport_GetModulesRef(PyInterpreterState *interp)
+{
+ _PyImport_AcquireLock(interp);
+ PyObject *modules = MODULES(interp);
+ if (modules == NULL) {
+ /* The interpreter hasn't been initialized yet. */
+ modules = Py_None;
+ }
+ Py_INCREF(modules);
+ _PyImport_ReleaseLock(interp);
+ return modules;
+}
+
void
_PyImport_ClearModules(PyInterpreterState *interp)
{
diff --git a/Python/pystate.c b/Python/pystate.c
index aba558279a657d..ec19e3ae6a415a 100644
--- a/Python/pystate.c
+++ b/Python/pystate.c
@@ -1210,14 +1210,40 @@ _PyInterpreterState_SetWhence(PyInterpreterState
*interp, long whence)
PyObject *
-PyUnstable_InterpreterState_GetMainModule(PyInterpreterState *interp)
+_Py_GetMainModule(PyThreadState *tstate)
{
- PyObject *modules = _PyImport_GetModules(interp);
- if (modules == NULL) {
- PyErr_SetString(PyExc_RuntimeError, "interpreter not initialized");
- return NULL;
+ // We return None to indicate "not found" or "bogus".
+ PyObject *modules = _PyImport_GetModulesRef(tstate->interp);
+ if (modules == Py_None) {
+ return modules;
+ }
+ PyObject *module = NULL;
+ (void)PyMapping_GetOptionalItem(modules, &_Py_ID(__main__), &module);
+ Py_DECREF(modules);
+ if (module == NULL && !PyErr_Occurred()) {
+ Py_RETURN_NONE;
}
- return PyMapping_GetItemString(modules, "__main__");
+ return module;
+}
+
+int
+_Py_CheckMainModule(PyObject *module)
+{
+ if (module == NULL || module == Py_None) {
+ if (!PyErr_Occurred()) {
+ (void)_PyErr_SetModuleNotFoundError(&_Py_ID(__main__));
+ }
+ return -1;
+ }
+ if (!Py_IS_TYPE(module, &PyModule_Type)) {
+ /* The __main__ module has been tampered with. */
+ PyObject *msg = PyUnicode_FromString("invalid __main__ module");
+ if (msg != NULL) {
+ (void)PyErr_SetImportError(msg, &_Py_ID(__main__), NULL);
+ }
+ return -1;
+ }
+ return 0;
}
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
