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.

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

Conversation

serhiy-storchaka
Copy link
Member

@serhiy-storchaka serhiy-storchaka commented May 23, 2025

@serhiy-storchaka serhiy-storchaka changed the title gh-134565: Use ExceptionGroup to handle multiple errors in unittest.doModuleCleanup() gh-134565: Use ExceptionGroup to handle multiple errors in unittest.doModuleCleanups() May 23, 2025
@iritkatriel
Copy link
Member

This looks like an API breaking change, it could break people's tests.

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.

Copy link
Member Author

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Normally exceptions are not raised in test cleanup code, so I do not think this change will break people's tests. It will change the error report to better if there were multiple errors.

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 Author

Choose a reason for hiding this comment

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

Done.

@serhiy-storchaka
Copy link
Member Author

Thank you for your review @iritkatriel.

@serhiy-storchaka serhiy-storchaka merged commit 393773a into python:main May 23, 2025
43 checks passed
@serhiy-storchaka serhiy-storchaka deleted the unittest-doModuleCleanups-multiple-errors branch May 23, 2025 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants