Skip to content

gh-109653: Defer importing warnings in several modules - #110286

Merged
AlexWaygood merged 2 commits into
python:mainfrom
AlexWaygood:lazy-warnings-imports
Oct 4, 2023
Merged

gh-109653: Defer importing warnings in several modules#110286
AlexWaygood merged 2 commits into
python:mainfrom
AlexWaygood:lazy-warnings-imports

Conversation

@AlexWaygood

@AlexWaygoodAlexWaygood commented Oct 3, 2023

Copy link
Copy Markdown
Member

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).

@AlexWaygoodAlexWaygood added the performance Performance or resource usage label Oct 3, 2023
@AlexWaygoodAlexWaygood changed the title gh-109653: Defer importing warnings in several modulesgh-109653: Defer importing warnings in several modulesOct 3, 2023

@hauntsaninjahauntsaninja left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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"

@AlexWaygood

Copy link
Copy Markdown
MemberAuthor

Yeah, definitely not the biggest contributor to import-time issues, but probably one of the easiest to tackle :)

Thanks for the review!

@AlexWaygood
AlexWaygood merged commit bfe7e72 into python:mainOct 4, 2023
@AlexWaygood
AlexWaygood deleted the lazy-warnings-imports branch October 4, 2023 05:09
@AlexWaygood
AlexWaygood restored the lazy-warnings-imports branch February 22, 2024 16:37
@AlexWaygood
AlexWaygood deleted the lazy-warnings-imports branch March 7, 2024 14:35
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

performancePerformance or resource usage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@AlexWaygood@hauntsaninja