gh-132781: Cleanup Code Related to NotShareableError (gh-132782)

The following are added to the internal C-API:

* _PyErr_FormatV()
* _PyErr_SetModuleNotFoundError()
* _PyXIData_GetNotShareableErrorType()
* _PyXIData_FormatNotShareableError()

We also drop _PyXIData_lookup_context_t and _PyXIData_GetLookupContext().

Author: ericsnowcurrently

Include/internal/pycore_crossinterp.h

@@ -97,26 +97,22 @@ PyAPI_FUNC(void) _PyXIData_Free(_PyXIData_t *data);
 
 typedef int (*xidatafunc)(PyThreadState *tstate, PyObject *, _PyXIData_t *);
 
-typedef struct _xid_lookup_state _PyXIData_lookup_t;
-
-typedef struct {
-    _PyXIData_lookup_t *global;
-    _PyXIData_lookup_t *local;
-    PyObject *PyExc_NotShareableError;
-} _PyXIData_lookup_context_t;
-
-PyAPI_FUNC(int) _PyXIData_GetLookupContext(
-        PyInterpreterState *,
-        _PyXIData_lookup_context_t *);
+PyAPI_FUNC(PyObject *) _PyXIData_GetNotShareableErrorType(PyThreadState *);
+PyAPI_FUNC(void) _PyXIData_SetNotShareableError(PyThreadState *, const char *);
+PyAPI_FUNC(void) _PyXIData_FormatNotShareableError(
+        PyThreadState *,
+        const char *,
+        ...);
 
 PyAPI_FUNC(xidatafunc) _PyXIData_Lookup(
-        _PyXIData_lookup_context_t *,
+        PyThreadState *,
         PyObject *);
 PyAPI_FUNC(int) _PyObject_CheckXIData(
-        _PyXIData_lookup_context_t *,
+        PyThreadState *,
         PyObject *);
+
 PyAPI_FUNC(int) _PyObject_GetXIData(
-        _PyXIData_lookup_context_t *,
+        PyThreadState *,
         PyObject *,
         _PyXIData_t *);
 
@@ -171,6 +167,8 @@ PyAPI_FUNC(void) _PyXIData_Clear( PyInterpreterState *, _PyXIData_t *);
 /* runtime state & lifecycle */
 /*****************************/
 
+typedef struct _xid_lookup_state _PyXIData_lookup_t;
+
 typedef struct {
     // builtin types
     _PyXIData_lookup_t data_lookup;

Include/internal/pycore_crossinterp_data_registry.h

@@ -28,11 +28,11 @@ typedef struct {
 } _PyXIData_registry_t;
 
 PyAPI_FUNC(int) _PyXIData_RegisterClass(
-    _PyXIData_lookup_context_t *,
+    PyThreadState *,
     PyTypeObject *,
     xidatafunc);
 PyAPI_FUNC(int) _PyXIData_UnregisterClass(
-    _PyXIData_lookup_context_t *,
+    PyThreadState *,
     PyTypeObject *);
 
 struct _xid_lookup_state {

Include/internal/pycore_pyerrors.h

@@ -60,6 +60,7 @@ extern PyObject* _PyErr_SetImportErrorWithNameFrom(
         PyObject *,
         PyObject *,
         PyObject *);
+extern int _PyErr_SetModuleNotFoundError(PyObject *name);
 
 
 /* runtime lifecycle */
@@ -113,6 +114,7 @@ extern void _PyErr_SetObject(
     PyObject *value);
 
 extern void _PyErr_ChainStackItem(void);
+extern void _PyErr_ChainExceptions1Tstate(PyThreadState *, PyObject *);
 
 PyAPI_FUNC(void) _PyErr_Clear(PyThreadState *tstate);
 
@@ -148,6 +150,12 @@ PyAPI_FUNC(PyObject*) _PyErr_Format(
     const char *format,
     ...);
 
+PyAPI_FUNC(PyObject*) _PyErr_FormatV(
+    PyThreadState *tstate,
+    PyObject *exception,
+    const char *format,
+    va_list vargs);
+
 extern void _PyErr_NormalizeException(
     PyThreadState *tstate,
     PyObject **exc,

Lib/test/test__interpreters.py

@@ -15,7 +15,7 @@
 
 _interpreters = import_helper.import_module('_interpreters')
 _testinternalcapi = import_helper.import_module('_testinternalcapi')
-from _interpreters import InterpreterNotFoundError
+from _interpreters import InterpreterNotFoundError, NotShareableError
 
 
 ##################################
@@ -189,8 +189,9 @@ def test_non_shareable_int(self):
         ]
         for i in ints:
             with self.subTest(i):
-                with self.assertRaises(OverflowError):
+                with self.assertRaises(NotShareableError) as cm:
                     _testinternalcapi.get_crossinterp_data(i)
+                self.assertIsInstance(cm.exception.__cause__, OverflowError)
 
     def test_bool(self):
         self._assert_values([True, False])
@@ -215,14 +216,12 @@ def test_tuples_containing_non_shareable_types(self):
         for s in non_shareables:
             value = tuple([0, 1.0, s])
             with self.subTest(repr(value)):
-                # XXX Assert the NotShareableError when it is exported
-                with self.assertRaises(ValueError):
+                with self.assertRaises(NotShareableError):
                     _testinternalcapi.get_crossinterp_data(value)
             # Check nested as well
             value = tuple([0, 1., (s,)])
             with self.subTest("nested " + repr(value)):
-                # XXX Assert the NotShareableError when it is exported
-                with self.assertRaises(ValueError):
+                with self.assertRaises(NotShareableError):
                     _testinternalcapi.get_crossinterp_data(value)
 
 

Lib/test/test_interpreters/test_api.py

@@ -693,8 +693,7 @@ def test_dict_and_kwargs(self):
 
     def test_not_shareable(self):
         interp = interpreters.create()
-        # XXX TypeError?
-        with self.assertRaises(ValueError):
+        with self.assertRaises(interpreters.NotShareableError):
             interp.prepare_main(spam={'spam': 'eggs', 'foo': 'bar'})
 
         # Make sure neither was actually bound.

Modules/_interpchannelsmodule.c

@@ -1754,17 +1754,10 @@ static int
 channel_send(_channels *channels, int64_t cid, PyObject *obj,
              _waiting_t *waiting, int unboundop)
 {
-    PyInterpreterState *interp = _get_current_interp();
-    if (interp == NULL) {
-        return -1;
-    }
+    PyThreadState *tstate = _PyThreadState_GET();
+    PyInterpreterState *interp = tstate->interp;
     int64_t interpid = PyInterpreterState_GetID(interp);
 
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return -1;
-    }
-
     // Look up the channel.
     PyThread_type_lock mutex = NULL;
     _channel_state *chan = NULL;
@@ -1786,7 +1779,7 @@ channel_send(_channels *channels, int64_t cid, PyObject *obj,
         PyThread_release_lock(mutex);
         return -1;
     }
-    if (_PyObject_GetXIData(&ctx, obj, data) != 0) {
+    if (_PyObject_GetXIData(tstate, obj, data) != 0) {
         PyThread_release_lock(mutex);
         GLOBAL_FREE(data);
         return -1;

Modules/_interpqueuesmodule.c

@@ -1127,11 +1127,7 @@ queue_destroy(_queues *queues, int64_t qid)
 static int
 queue_put(_queues *queues, int64_t qid, PyObject *obj, int fmt, int unboundop)
 {
-    PyInterpreterState *interp = PyInterpreterState_Get();
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return -1;
-    }
+    PyThreadState *tstate = PyThreadState_Get();
 
     // Look up the queue.
     _queue *queue = NULL;
@@ -1147,12 +1143,13 @@ queue_put(_queues *queues, int64_t qid, PyObject *obj, int fmt, int unboundop)
         _queue_unmark_waiter(queue, queues->mutex);
         return -1;
     }
-    if (_PyObject_GetXIData(&ctx, obj, data) != 0) {
+    if (_PyObject_GetXIData(tstate, obj, data) != 0) {
         _queue_unmark_waiter(queue, queues->mutex);
         GLOBAL_FREE(data);
         return -1;
     }
-    assert(_PyXIData_INTERPID(data) == PyInterpreterState_GetID(interp));
+    assert(_PyXIData_INTERPID(data) ==
+            PyInterpreterState_GetID(tstate->interp));
 
     // Add the data to the queue.
     int64_t interpid = -1;  // _queueitem_init() will set it.

Modules/_interpreters_common.h

@@ -8,24 +8,16 @@
 static int
 ensure_xid_class(PyTypeObject *cls, xidatafunc getdata)
 {
-    PyInterpreterState *interp = PyInterpreterState_Get();
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return -1;
-    }
-    return _PyXIData_RegisterClass(&ctx, cls, getdata);
+    PyThreadState *tstate = PyThreadState_Get();
+    return _PyXIData_RegisterClass(tstate, cls, getdata);
 }
 
 #ifdef REGISTERS_HEAP_TYPES
 static int
 clear_xid_class(PyTypeObject *cls)
 {
-    PyInterpreterState *interp = PyInterpreterState_Get();
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return -1;
-    }
-    return _PyXIData_UnregisterClass(&ctx, cls);
+    PyThreadState *tstate = PyThreadState_Get();
+    return _PyXIData_UnregisterClass(tstate, cls);
 }
 #endif
 

Modules/_interpretersmodule.c

@@ -1278,13 +1278,8 @@ object_is_shareable(PyObject *self, PyObject *args, PyObject *kwds)
         return NULL;
     }
 
-    PyInterpreterState *interp = PyInterpreterState_Get();
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return NULL;
-    }
-
-    if (_PyObject_CheckXIData(&ctx, obj) == 0) {
+    PyThreadState *tstate = _PyThreadState_GET();
+    if (_PyObject_CheckXIData(tstate, obj) == 0) {
         Py_RETURN_TRUE;
     }
     PyErr_Clear();
@@ -1577,14 +1572,9 @@ The 'interpreters' module provides a more convenient interface.");
 static int
 module_exec(PyObject *mod)
 {
-    PyInterpreterState *interp = PyInterpreterState_Get();
+    PyThreadState *tstate = _PyThreadState_GET();
     module_state *state = get_module_state(mod);
 
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return -1;
-    }
-
 #define ADD_WHENCE(NAME) \
     if (PyModule_AddIntConstant(mod, "WHENCE_" #NAME,                   \
                                 _PyInterpreterState_WHENCE_##NAME) < 0) \
@@ -1606,7 +1596,8 @@ module_exec(PyObject *mod)
     if (PyModule_AddType(mod, (PyTypeObject *)PyExc_InterpreterNotFoundError) < 0) {
         goto error;
     }
-    if (PyModule_AddType(mod, (PyTypeObject *)ctx.PyExc_NotShareableError) < 0) {
+    PyObject *exctype = _PyXIData_GetNotShareableErrorType(tstate);
+    if (PyModule_AddType(mod, (PyTypeObject *)exctype) < 0) {
         goto error;
     }
 

Modules/_testinternalcapi.c

@@ -1696,11 +1696,7 @@ _xid_capsule_destructor(PyObject *capsule)
 static PyObject *
 get_crossinterp_data(PyObject *self, PyObject *args)
 {
-    PyInterpreterState *interp = PyInterpreterState_Get();
-    _PyXIData_lookup_context_t ctx;
-    if (_PyXIData_GetLookupContext(interp, &ctx) < 0) {
-        return NULL;
-    }
+    PyThreadState *tstate = _PyThreadState_GET();
 
     PyObject *obj = NULL;
     if (!PyArg_ParseTuple(args, "O:get_crossinterp_data", &obj)) {
@@ -1711,7 +1707,7 @@ get_crossinterp_data(PyObject *self, PyObject *args)
     if (data == NULL) {
         return NULL;
     }
-    if (_PyObject_GetXIData(&ctx, obj, data) != 0) {
+    if (_PyObject_GetXIData(tstate, obj, data) != 0) {
         _PyXIData_Free(data);
         return NULL;
     }