Recwarn: Fix module when re-emitting unmatched warnings #12898
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
psf-chronographer
bot
added
the
bot:chronographer:provided
for more information, see https://pre-commit.ci
nicoddemus
requested changes
Oct 19, 2024
There was a problem hiding this comment.
Thanks @reaganjlee, we appreciate the PR!
Left a comment, but other than that we need a test to ensure this fix does not regress in the future. 👍
src/_pytest/recwarn.py
Outdated
Comment on lines
331
to
335
| module = next( | ||
| k | ||
| for k, v in sys.modules.items() | ||
| if getattr(v, "__file__", None) == w.filename | ||
| ) |
There was a problem hiding this comment.
We should probably fallback to some string just in case something is very wrong and we cannot match the filename:
Suggested change
| module = next( | |
| k | |
| for k, v in sys.modules.items() | |
| if getattr(v, "__file__", None) == w.filename | |
| ) | |
| module = next( | |
| k | |
| for k, v in sys.modules.items() | |
| if getattr(v, "__file__", None) == w.filename, | |
| None | |
| ) |
I'm assuming None is a valid argument for module=.
| @@ -0,0 +1 @@ | |||
| Fix regression with :func:`pytest.warns` using wrong module when re-emitting unmatched warnings. | |||
nicoddemus
requested changes
Oct 27, 2024
|
|
||
| def test_ignore_warning_from_module_a(): | ||
| with pytest.raises(pytest.fail.Exception, match="DID NOT WARN"): | ||
| with pytest.warns(UserWarning, match="module A.") as outer: |
There was a problem hiding this comment.
The test is not really veryfing the new module attribute... if I go in the code and set module = None in warnings.warn_explicit, the test still passes, which makes it unsuitable for a regression test... can you improve the test to check the actual module attribute of the warnings?
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.
Fixes #11933
Credit to @Zac-HD for fix!