Skip to content

gh-134565: Use ExceptionGroup to handle multiple errors in unittest.doModuleCleanups() #134566

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 5 commits into from
May 23, 2025
Merged

gh-134565: Use ExceptionGroup to handle multiple errors in unittest.doModuleCleanups() #134566

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c06caac
gh-134565: Use ExceptionGroup to handle multiple errors in unittest.d…
serhiy-storchaka May 23, 2025
5ae08b0
Update 2025-05-23-10-15-36.gh-issue-134565.zmb66C.rst
serhiy-storchaka May 23, 2025
0bd3333
Use ExceptionGroup even for 1 exception.
serhiy-storchaka May 23, 2025
7207643
Merge remote-tracking branch 'refs/remotes/origin/unittest-doModuleCl…
serhiy-storchaka May 23, 2025
fb27d61
Use assertExceptionIsLike().
serhiy-storchaka May 23, 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
37 changes: 34 additions & 3 deletions Lib/test/test_unittest/test_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1282,14 +1282,22 @@ def setUpModule():
suite(result)
expected_out = '\nStdout:\ndo cleanup2\ndo cleanup1\n'
self.assertEqual(stdout.getvalue(), expected_out)
self.assertEqual(len(result.errors), 1)
self.assertEqual(len(result.errors), 2)
description = 'tearDownModule (Module)'
test_case, formatted_exc = result.errors[0]
self.assertEqual(test_case.description, description)
self.assertIn('ValueError: bad cleanup2', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('TypeError', formatted_exc)
self.assertIn(expected_out, formatted_exc)

test_case, formatted_exc = result.errors[1]
self.assertEqual(test_case.description, description)
self.assertIn('TypeError: bad cleanup1', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ValueError', formatted_exc)
self.assertIn(expected_out, formatted_exc)

def testBufferSetUpModule_DoModuleCleanups(self):
with captured_stdout() as stdout:
result = unittest.TestResult()
Expand All @@ -1313,22 +1321,34 @@ def setUpModule():
suite(result)
expected_out = '\nStdout:\nset up module\ndo cleanup2\ndo cleanup1\n'
self.assertEqual(stdout.getvalue(), expected_out)
self.assertEqual(len(result.errors), 2)
self.assertEqual(len(result.errors), 3)
description = 'setUpModule (Module)'
test_case, formatted_exc = result.errors[0]
self.assertEqual(test_case.description, description)
self.assertIn('ZeroDivisionError: division by zero', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ValueError', formatted_exc)
self.assertNotIn('TypeError', formatted_exc)
self.assertIn('\nStdout:\nset up module\n', formatted_exc)

test_case, formatted_exc = result.errors[1]
self.assertIn(expected_out, formatted_exc)
self.assertEqual(test_case.description, description)
self.assertIn('ValueError: bad cleanup2', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ZeroDivisionError', formatted_exc)
self.assertNotIn('TypeError', formatted_exc)
self.assertIn(expected_out, formatted_exc)

test_case, formatted_exc = result.errors[2]
self.assertIn(expected_out, formatted_exc)
self.assertEqual(test_case.description, description)
self.assertIn('TypeError: bad cleanup1', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ZeroDivisionError', formatted_exc)
self.assertNotIn('ValueError', formatted_exc)
self.assertIn(expected_out, formatted_exc)

def testBufferTearDownModule_DoModuleCleanups(self):
with captured_stdout() as stdout:
result = unittest.TestResult()
Expand All @@ -1355,21 +1375,32 @@ def tearDownModule():
suite(result)
expected_out = '\nStdout:\ntear down module\ndo cleanup2\ndo cleanup1\n'
self.assertEqual(stdout.getvalue(), expected_out)
self.assertEqual(len(result.errors), 2)
self.assertEqual(len(result.errors), 3)
description = 'tearDownModule (Module)'
test_case, formatted_exc = result.errors[0]
self.assertEqual(test_case.description, description)
self.assertIn('ZeroDivisionError: division by zero', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ValueError', formatted_exc)
self.assertNotIn('TypeError', formatted_exc)
self.assertIn('\nStdout:\ntear down module\n', formatted_exc)

test_case, formatted_exc = result.errors[1]
self.assertEqual(test_case.description, description)
self.assertIn('ValueError: bad cleanup2', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ZeroDivisionError', formatted_exc)
self.assertNotIn('TypeError', formatted_exc)
self.assertIn(expected_out, formatted_exc)

test_case, formatted_exc = result.errors[2]
self.assertEqual(test_case.description, description)
self.assertIn('TypeError: bad cleanup1', formatted_exc)
self.assertNotIn('ExceptionGroup', formatted_exc)
self.assertNotIn('ZeroDivisionError', formatted_exc)
self.assertNotIn('ValueError', formatted_exc)
self.assertIn(expected_out, formatted_exc)


if __name__ == '__main__':
unittest.main()
45 changes: 41 additions & 4 deletions Lib/test/test_unittest/test_runner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -646,11 +646,46 @@ class Module(object):
[(module_cleanup_good, (1, 2, 3),
dict(four='hello', five='goodbye')),
(module_cleanup_bad, (), {})])
with self.assertRaises(CustomError) as e:
with self.assertRaises(Exception) as e:
unittest.case.doModuleCleanups()
self.assertEqual(str(e.exception), 'CleanUpExc')
e = e.exception
self.assertEqual(str(e), 'module cleanup failed (1 sub-exception)')
self.assertEqual(str(e.exceptions[0]), 'CleanUpExc')
self.assertEqual(unittest.case._module_cleanups, [])

def test_doModuleCleanup_with_multiple_errors_in_addModuleCleanup(self):
def module_cleanup_bad1():
raise TypeError('CleanUpExc1')

def module_cleanup_bad2():
raise ValueError('CleanUpExc2')

class Module:
unittest.addModuleCleanup(module_cleanup_bad1)
unittest.addModuleCleanup(module_cleanup_bad2)
with self.assertRaises(ExceptionGroup) as e:
unittest.case.doModuleCleanups()
e = e.exception
self.assertEqual(str(e), 'module cleanup failed (2 sub-exceptions)')
self.assertEqual(str(e.exceptions[0]), 'CleanUpExc2')
self.assertEqual(str(e.exceptions[1]), 'CleanUpExc1')

def test_doModuleCleanup_with_exception_group_in_addModuleCleanup(self):
def module_cleanup_bad():
raise ExceptionGroup('CleanUpExc', [TypeError('CleanUpExc1'),
ValueError('CleanUpExc2')])

class Module:
unittest.addModuleCleanup(module_cleanup_bad)
with self.assertRaises(ExceptionGroup) as e:
unittest.case.doModuleCleanups()
e = e.exception
self.assertEqual(str(e), 'module cleanup failed (1 sub-exception)')
e = e.exceptions[0]
self.assertEqual(str(e), 'CleanUpExc (2 sub-exceptions)')
self.assertEqual(str(e.exceptions[0]), 'CleanUpExc1')
self.assertEqual(str(e.exceptions[1]), 'CleanUpExc2')
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a utility for this check:
Lib/test/support/testcase.py: def assertExceptionIsLike(self, exc, template):

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


def test_addModuleCleanup_arg_errors(self):
cleanups = []
def cleanup(*args, **kwargs):
Expand Down Expand Up @@ -871,9 +906,11 @@ def tearDownClass(cls):
ordering = []
blowUp = True
suite = unittest.defaultTestLoader.loadTestsFromTestCase(TestableTest)
with self.assertRaises(CustomError) as cm:
with self.assertRaises(Exception) as cm:
suite.debug()
self.assertEqual(str(cm.exception), 'CleanUpExc')
e = cm.exception
self.assertEqual(str(e), 'module cleanup failed (1 sub-exception)')
self.assertEqual(str(e.exceptions[0]), 'CleanUpExc')
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
'tearDownClass', 'tearDownModule', 'cleanup_exc'])
self.assertEqual(unittest.case._module_cleanups, [])
Expand Down
4 changes: 1 addition & 3 deletions Lib/unittest/case.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,9 +149,7 @@ def doModuleCleanups():
except Exception as exc:
exceptions.append(exc)
if exceptions:
# Swallows all but first exception. If a multi-exception handler
# gets written we should use that here instead.
raise exceptions[0]
raise ExceptionGroup('module cleanup failed', exceptions)


def skip(reason):
Expand Down
20 changes: 16 additions & 4 deletions Lib/unittest/suite.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,11 @@ def _handleModuleFixture(self, test, result):
if result._moduleSetUpFailed:
try:
case.doModuleCleanups()
except ExceptionGroup as eg:
for e in eg.exceptions:
self._createClassOrModuleLevelException(result, e,
'setUpModule',
currentModule)
except Exception as e:
self._createClassOrModuleLevelException(result, e,
'setUpModule',
Expand All @@ -235,15 +240,15 @@ def _createClassOrModuleLevelException(self, result, exc, method_name,
errorName = f'{method_name} ({parent})'
self._addClassOrModuleLevelException(result, exc, errorName, info)

def _addClassOrModuleLevelException(self, result, exception, errorName,
def _addClassOrModuleLevelException(self, result, exc, errorName,
info=None):
error = _ErrorHolder(errorName)
addSkip = getattr(result, 'addSkip', None)
if addSkip is not None and isinstance(exception, case.SkipTest):
addSkip(error, str(exception))
if addSkip is not None and isinstance(exc, case.SkipTest):
addSkip(error, str(exc))
else:
if not info:
result.addError(error, sys.exc_info())
result.addError(error, (type(exc), exc, exc.__traceback__))
else:
result.addError(error, info)

Expand Down Expand Up @@ -273,6 +278,13 @@ def _handleModuleTearDown(self, result):
previousModule)
try:
case.doModuleCleanups()
except ExceptionGroup as eg:
if isinstance(result, _DebugResult):
raise
for e in eg.exceptions:
self._createClassOrModuleLevelException(result, e,
'tearDownModule',
previousModule)
except Exception as e:
if isinstance(result, _DebugResult):
raise
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2025-05-23-10-15-36.gh-issue-134565.zmb66C.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:func:`unittest.doModuleCleanups` no longer swallows all but first exception
raised in the cleanup code, but raises a :exc:`ExceptionGroup` if multiple
errors occurred.
Loading