Avoid forgetting about stacklevel in warnings #2594
+29
−14
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
Avasam
force-pushed
the
Avoid-forgetting-about-stacklevel-in-warnings
branch
from
49f0fe8 to
51b5992
Compare
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.
I myself forget about it from time to time.
stacklevel=2helps point the warning to the caller's code.B028only warns if nostacklevelis specified.stacklevel=1is perfectly valid if explicit about it. It doesn't force a specific level, it just makes it so you can't forget.This is optionally autofixable (
ruff check --fix --unsafe-fixes) tostacklevel=2.