Skip to content

gh-132775: Drop PyUnstable_InterpreterState_GetMainModule() #132978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2025
Merged

gh-132775: Drop PyUnstable_InterpreterState_GetMainModule() #132978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6db588c
Add _PyImport_GetModulesRef().
ericsnowcurrently Apr 9, 2025
9c9c41c
Replace PyUnstable_InterpreterState_GetMainModule() with _Py_GetMainM…
ericsnowcurrently Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions Doc/c-api/init.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 0 additions & 2 deletions Include/cpython/pystate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. */
Expand Down
1 change: 1 addition & 0 deletions Include/internal/pycore_import.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
3 changes: 3 additions & 0 deletions Include/internal/pycore_pystate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 3 additions & 2 deletions Python/crossinterp.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1728,6 +1728,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__.
Expand All @@ -1741,8 +1742,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;
}
Expand Down
14 changes: 14 additions & 0 deletions Python/import.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
38 changes: 32 additions & 6 deletions Python/pystate.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}


Expand Down
Loading