Reimplement HIDE_IN_STACKTRACES machinery #1635
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
Not used since commit 03fd1cc.
Prior to this commit, the HIDE_IN_STACKTRACES setting was implemented by importing the modules listed in the setting and recording their file system paths. Then tidy_stacktrace() and _StackRecorder.get_stack_trace() would look up the file system path for each frame's code object and compare that path against the paths for the excluded modules to see if it matched. If so, the frame would be excluded. This was inefficient since it used a file system access, os.path.realpath(), for each frame (although the _StackRecorder implementation included some caching to reduce the cost). It also would not work correctly for namespace packages since they can have multiple file system hierarchies. Replace with a new implementation that instead retrieves the __name__ variable from the frame's f_globals attribute and matches that module name against the list of excluded modules directly.
|
I accidentally closed this PR by renaming the branch in my repo. Re-opening. |
matthiask
approved these changes
May 31, 2022
Done. |
|
Thanks! |
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.
The pre-existing
HIDE_IN_STACKTRACESmachinery was based on file system paths, but was rather inefficient because it required a file system operation (os.path.realpath()) for each stack frame. In addition, it would not work properly for namespace packages since they can have multiple file system hierarchies.The new implementation avoids using paths altogether and instead uses the
__name__variable found in each frame'sf_globalsattribute to determine the associated module name, and compares that directly with the list of module names provided in theHIDE_IN_STACKTRACESsetting.