TST: Added script to enforce usage of match argument for tm.assert_produces_warning #59173
Conversation
This file contains 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
Aloqeely
reviewed
Jul 4, 2024
Co-authored-by: Abdulaziz Aloqeely <[email protected]>
|
@Aloqeely Just fixed the issue with |
|
LGTM. cc @mroeschke |
|
@mroeschke - are we going ahead with this PR? Any reason we’d like to hold it off for now? cc @Aloqeely |
|
This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Added a script called
enforce_match_arg_in_assert_produces_warning.pywhich checks that all usages of tm.assert_produces_warning make use of thematchargument. This is done to ensure that users are always displayed the correct warning message. Uses oftm.assert_produces_warning(None)have been excluded as no warning is produced in this case.Furthermore, to ensure that the existing code doesn't fail the
pre-commitstage, all files that currently do not use the match argument have been excluded.Once the PR is merged in, we can open up another issue to shorten the list of "excluded" files.