Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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 deletionsLib/test/test_unittest/test_result.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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()
52 changes: 47 additions & 5 deletionsLib/test/test_unittest/test_runner.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
LoggingResult,
ResultWithNoStartTestRunStopTestRun,
)
from test.support.testcase import ExceptionIsLikeMixin


def resultFactory(*_):
Expand DownExpand Up@@ -604,7 +605,7 @@ class EmptyTest(unittest.TestCase):


@support.force_not_colorized_test_class
class TestModuleCleanUp(unittest.TestCase):
class TestModuleCleanUp(ExceptionIsLikeMixin,unittest.TestCase):
def test_add_and_do_ModuleCleanup(self):
module_cleanups = []

Expand DownExpand Up@@ -646,11 +647,50 @@ 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')
self.assertExceptionIsLike(e.exception,
ExceptionGroup('module cleanup failed',
[CustomError('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()
self.assertExceptionIsLike(e.exception,
ExceptionGroup('module cleanup failed', [
ValueError('CleanUpExc2'),
TypeError('CleanUpExc1'),
]))

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

class Module:
unittest.addModuleCleanup(module_cleanup_bad)
with self.assertRaises(ExceptionGroup) as e:
unittest.case.doModuleCleanups()
self.assertExceptionIsLike(e.exception,
ExceptionGroup('module cleanup failed', [
ExceptionGroup('CleanUpExc', [
ValueError('CleanUpExc2'),
TypeError('CleanUpExc1'),
]),
]))

def test_addModuleCleanup_arg_errors(self):
cleanups = []
def cleanup(*args, **kwargs):
Expand DownExpand Up@@ -871,9 +911,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')
self.assertExceptionIsLike(cm.exception,
ExceptionGroup('module cleanup failed',
[CustomError('CleanUpExc')]))
self.assertEqual(ordering, ['setUpModule', 'setUpClass', 'test',
'tearDownClass', 'tearDownModule', 'cleanup_exc'])
self.assertEqual(unittest.case._module_cleanups, [])
Expand Down
4 changes: 1 addition & 3 deletionsLib/unittest/case.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 deletionsLib/unittest/suite.py
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
[8]ページ先頭
©2009-2025 Movatter.jp