gh-109653: Defer importing warnings in several modules - #110286
Merged
AlexWaygood merged 2 commits intoOct 4, 2023
Merged
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
hauntsaninja
approved these changes
Oct 4, 2023
hauntsaninja
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Thanks, look good!
This is somewhat marginal. On my laptop, the time it takes to import warnings is below the noise floor. On another system I have access to, it looks like it's about 0.3ms. (Both measuring Python 3.11 builds)
λ hyperfine --warmup 3 'python -c "pass"' 'python -c "import warnings"'
Benchmark 1: python -c "pass"
Time (mean ± σ): 39.0 ms ± 1.4 ms [User: 30.8 ms, System: 8.3 ms]
Range (min … max): 34.4 ms … 41.3 ms 78 runs
Benchmark 2: python -c "import warnings"
Time (mean ± σ): 39.3 ms ± 1.9 ms [User: 28.9 ms, System: 10.4 ms]
Range (min … max): 30.4 ms … 47.0 ms 69 runs
Summary
python -c "pass" ran
1.01 ± 0.06 times faster than python -c "import warnings"
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Author
|
Yeah, definitely not the biggest contributor to import-time issues, but probably one of the easiest to tackle :) Thanks for the review! |
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
2 participants
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.
warnings is a pretty cheap import, so the import-time saving from deferring it is usually pretty minimal. However, it's also a textbook example of an import that should be deferred wherever reasonable. Most of the time, it's only imported so that a DeprecationWarning can be emitted, and we should try to make it so that users only have to pay the (small) performance penalty from it being imported if they actually hit the specific code path that's deprecated.
Nonetheless, since the performance impact of importing warnings is so small, I've tried to avoid modules that make multiple uses of warnings -- it's not particularly DRY to have import warnings repeated several times in the same module. The one exception I made here is argparse: argparse really should be importing the absolute minimum set of modules given that it's a CLI framework (see #74338 for previous discussion).