tools: add stack_frame kwarg to deprecated decorator
#2046
Merged
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
Allows specifying which stack frame to show in the traceback, if the default (the most recent) isn't helpful. Sometimes the parent caller or a more distant ancestor is more informative to the end user.
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.
Description
Allows specifying which stack frame to show in the traceback, if the default (the most recent) isn't helpful. Sometimes the parent caller or a more distant ancestor is more informative to the end user.
Checklist
make qa(runsmake qualityandmake test)Notes
Inspired by challenges encountered when working on #2044. This should be merged first if approved.
I seriously considered making
stack_framejust a plain integer, and not requiring the negative sign, just because 99% (maybe even 100%) of all use cases are going to want a frame relative to the end of the list generated bytraceback.extract_stack(). But it's more intuitive to make the argument the same value as the list index used inside the decorator…