Skip to content

gh-99741: Implement Multi-Phase Init for the _xxsubinterpreters Module #99742

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
ericsnowcurrently merged 10 commits into from
Dec 5, 2022
Merged

gh-99741: Implement Multi-Phase Init for the _xxsubinterpreters Module #99742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bd7ee33
Add _PyCrossInterpreterData_Init() and _PyCrossInterpreterData_Clear().
ericsnowcurrently Dec 2, 2022
0bfe7b5
Clear channels before interpreters.
ericsnowcurrently Dec 2, 2022
6932dc7
Add a test for importing the module in a subinterpreter.
ericsnowcurrently Dec 5, 2022
fe3fd40
Add module state.
ericsnowcurrently Nov 21, 2022
8c976d6
fix _str_shared()
ericsnowcurrently Dec 2, 2022
8a50e87
Move the exceptions to module state.
ericsnowcurrently Nov 23, 2022
89e3ecc
Drop the globals for the error types.
ericsnowcurrently Nov 22, 2022
2540946
Make ChannelIDType a heap type.
ericsnowcurrently Nov 23, 2022
98c240a
Switch to multi-phase init.
ericsnowcurrently Nov 21, 2022
9d388e7
Add a NEWS entry.
ericsnowcurrently Nov 24, 2022
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
21 changes: 18 additions & 3 deletions Include/cpython/pystate.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,9 @@ PyAPI_FUNC(const PyConfig*) _Py_GetConfig(void);
// is necessary to pass safely between interpreters in the same process.
typedef struct _xid _PyCrossInterpreterData;

typedef PyObject *(*xid_newobjectfunc)(_PyCrossInterpreterData *);
typedef void (*xid_freefunc)(void *);

struct _xid {
// data is the cross-interpreter-safe derivation of a Python object
// (see _PyObject_GetCrossInterpreterData). It will be NULL if the
Expand All @@ -379,7 +382,7 @@ struct _xid {
// interpreter given the data. The resulting object (a new
// reference) will be equivalent to the original object. This field
// is required.
PyObject *(*new_object)(_PyCrossInterpreterData *);
xid_newobjectfunc new_object;
// free is called when the data is released. If it is NULL then
// nothing will be done to free the data. For some types this is
// okay (e.g. bytes) and for those types this field should be set
Expand All @@ -389,9 +392,20 @@ struct _xid {
// leak. In that case, at the very least this field should be set
// to PyMem_RawFree (the default if not explicitly set to NULL).
// The call will happen with the original interpreter activated.
void (*free)(void *);
xid_freefunc free;
};

PyAPI_FUNC(void) _PyCrossInterpreterData_Init(
_PyCrossInterpreterData *data,
PyInterpreterState *interp, void *shared, PyObject *obj,
xid_newobjectfunc new_object);
PyAPI_FUNC(int) _PyCrossInterpreterData_InitWithSize(
_PyCrossInterpreterData *,
PyInterpreterState *interp, const size_t, PyObject *,
xid_newobjectfunc);
PyAPI_FUNC(void) _PyCrossInterpreterData_Clear(
PyInterpreterState *, _PyCrossInterpreterData *);

PyAPI_FUNC(int) _PyObject_GetCrossInterpreterData(PyObject *, _PyCrossInterpreterData *);
PyAPI_FUNC(PyObject *) _PyCrossInterpreterData_NewObject(_PyCrossInterpreterData *);
PyAPI_FUNC(int) _PyCrossInterpreterData_Release(_PyCrossInterpreterData *);
Expand All @@ -400,7 +414,8 @@ PyAPI_FUNC(int) _PyObject_CheckCrossInterpreterData(PyObject *);

/* cross-interpreter data registry */

typedef int (*crossinterpdatafunc)(PyObject *, _PyCrossInterpreterData *);
typedef int (*crossinterpdatafunc)(PyThreadState *tstate, PyObject *,
_PyCrossInterpreterData *);

PyAPI_FUNC(int) _PyCrossInterpreterData_RegisterClass(PyTypeObject *, crossinterpdatafunc);
PyAPI_FUNC(int) _PyCrossInterpreterData_UnregisterClass(PyTypeObject *);
Expand Down
11 changes: 10 additions & 1 deletion Lib/test/test__xxsubinterpreters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,8 +295,8 @@ def clean_up_channels():
class TestBase(unittest.TestCase):

def tearDown(self):
clean_up_interpreters()
clean_up_channels()
clean_up_interpreters()


##################################
Expand Down Expand Up @@ -411,6 +411,15 @@ def test_non_shareable_int(self):
interpreters.channel_send(self.cid, i)


class ModuleTests(TestBase):

def test_import_in_interpreter(self):
_run_output(
interpreters.create(),
'import _xxsubinterpreters as _interpreters',
)


##################################
# interpreter tests

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Tests/2022-11-23-18-32-16.gh-issue-99741.q4R7NH.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
We've implemented multi-phase init (PEP 489/630/687)
for the internal (for testing) _xxsubinterpreters module.
Loading