python: do not alter warnings' filter #1017
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
We recently added a couple of `DeprecationWarning`s, and to make sure users would see them, we also set `warnings.simplefilter` to `always`. However, this inadvertently modified the warnings' settings for all other modules as well. This is not nice. This patch removes the edit to the simplefilter (going back to default) and uses `stacklevel`s `warn` argument to increase the `DeprecationWarning` visibiilty. This is not a silver bullet as if one uses the deprecated property "three levels or more" deep, the warning is not visible. Very recent versions of python added the `skip_file_prefixes` argument to `warn`, but it's not worth using it and break compatibility with older versions of python.
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.
We recently added a couple of
DeprecationWarnings, and to make sure users would see them, we also setwarnings.simplefiltertoalways. However, this inadvertently modified the warnings' settings for all other modules as well. This is not nice.This patch removes the edit to the simplefilter (going back to default) and uses
stacklevelswarnargument to increase theDeprecationWarningvisibiilty. This is not a silver bullet as if one uses the deprecated property "three levels or more" deep, the warning is not visible.To fix this limitation, python 3.12 added the
skip_file_prefixesargument towarn(python/cpython#100840), but it's not worth using it and break compatibility with older versions of python.stacklevel=2should not create any problems (see python/cpython#88462).Fixes #1006.