Simplify cleanup decorator implementation. #11292
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduce a single private `_cleanup_cm` contextmanager and use it to implement `CleanupTestCase` and `@cleanup`. Use `warnings.catch_warnings` to avoid completely destroying a preexisting warnings filter, instead just restoring the filter that existed before the test started. Use `matplotlib.style.context` to restore the style at exit, as it relies on rc_context which is ultimately more efficient than `rcParams.update` as it skips revalidation. Deprecate CleanupTest (and implement it in terms of CleanupTestCase), as it is clearly a nose-oriented base class that could have been deprecated at the same time as ImageComparisonTest.
Otherwise, rcParams cannot be deprecated without spamming stderr with one warning per test.
Contributor
Author
|
@efiring @tacaswell This PR fixes the warnings issue (and more generally makes it possible, among other things, to deprecate rcParams without jumping through hoops to avoid the same issue arising again). |
Member
|
Thank you. All this arcane testing machinery is beyond my knowledge and abilities, but I'm glad to see that it kills the spam. |
timhoffm
approved these changes
May 31, 2018
phobson
approved these changes
Jun 5, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce a single private
_cleanup_cmcontextmanager and use it toimplement
CleanupTestCaseand@cleanup.Use
warnings.catch_warningsto avoid completely destroying apreexisting warnings filter, instead just restoring the filter that
existed before the test started.
Use
matplotlib.style.contextto restore the style at exit, as itrelies on rc_context which is ultimately more efficient than
rcParams.updateas it skips revalidation.Deprecate CleanupTest (and implement it in terms of CleanupTestCase), as
it is clearly a nose-oriented base class that could have been deprecated
at the same time as ImageComparisonTest.
PR Summary
PR Checklist