Skip to content
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

gh-102251: Explicitly free state for test modules with state in test_import #105085

Merged
merged 8 commits into from
May 31, 2023
Merged

gh-102251: Explicitly free state for test modules with state in test_import #105085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f4de1f7
clear module state after use
sunmy2019 May 30, 2023
bd32c13
PEP 7
erlend-aasland May 30, 2023
ac72ac4
use `unittest.addCleanup`
sunmy2019 May 30, 2023
764be66
Update Modules/_testsinglephase.c
sunmy2019 May 30, 2023
52f46f2
Update Lib/test/test_import/__init__.py
sunmy2019 May 30, 2023
daebdf7
Update Lib/test/test_import/__init__.py
sunmy2019 May 30, 2023
a0f5bb7
Update Lib/test/test_import/__init__.py
sunmy2019 May 30, 2023
26a9ede
tell by `has_state` instead of name
sunmy2019 May 30, 2023
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
14 changes: 10 additions & 4 deletions Lib/test/test_import/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2320,6 +2320,7 @@ def test_variants(self):
self.add_module_cleanup(name)
with self.subTest(name):
loaded = self.load(name)
self.addCleanup(loaded.module._clear_module_state)

self.check_common(loaded)
self.assertIsNot(loaded.snapshot.state_initialized, None)
Expand Down Expand Up @@ -2379,14 +2380,19 @@ def test_with_reinit_reloaded(self):
# Keep a reference around.
basic = self.load(self.NAME)

for name in [
f'{self.NAME}_with_reinit', # m_size == 0
f'{self.NAME}_with_state', # m_size > 0
for name, has_state in [
(f'{self.NAME}_with_reinit', False), # m_size == 0
(f'{self.NAME}_with_state', True), # m_size > 0
]:
self.add_module_cleanup(name)
with self.subTest(name):
with self.subTest(name=name, has_state=has_state):
loaded = self.load(name)
if has_state:
self.addCleanup(loaded.module._clear_module_state)

reloaded = self.re_load(name, loaded.module)
if has_state:
self.addCleanup(reloaded.module._clear_module_state)

self.check_common(loaded)
self.check_common(reloaded)
Expand Down
22 changes: 21 additions & 1 deletion Modules/_testsinglephase.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,25 @@ basic__clear_globals(PyObject *self, PyObject *Py_UNUSED(ignored))
basic__clear_globals_doc}


PyDoc_STRVAR(basic__clear_module_state_doc, "_clear_module_state()\n\
\n\
Free the module state and set it to uninitialized.");

static PyObject *
basic__clear_module_state(PyObject *self, PyObject *Py_UNUSED(ignored))
{
module_state *state = get_module_state(self);
if (state != NULL) {
clear_state(state);
}
Py_RETURN_NONE;
}

#define _CLEAR_MODULE_STATE_METHODDEF \
{"_clear_module_state", basic__clear_module_state, METH_NOARGS, \
basic__clear_module_state_doc}


/*********************************************/
/* the _testsinglephase module (and aliases) */
/*********************************************/
Expand Down Expand Up @@ -408,7 +427,7 @@ PyInit__testsinglephase_with_reinit(void)
/* the _testsinglephase_with_state module */
/******************************************/

/* This ia less typical of legacy extensions in the wild:
/* This is less typical of legacy extensions in the wild:
- single-phase init (same as _testsinglephase above)
- has some module state
- supports repeated initialization
Expand All @@ -424,6 +443,7 @@ static PyMethodDef TestMethods_WithState[] = {
LOOK_UP_SELF_METHODDEF,
SUM_METHODDEF,
STATE_INITIALIZED_METHODDEF,
_CLEAR_MODULE_STATE_METHODDEF,
{NULL, NULL} /* sentinel */
};

Expand Down