gh-144764: Made dataclasses construct automatic docstrings lazily#144765
Open
adamchainz wants to merge 1 commit intopython:mainfrom
Open
gh-144764: Made dataclasses construct automatic docstrings lazily#144765adamchainz wants to merge 1 commit intopython:mainfrom
adamchainz wants to merge 1 commit intopython:mainfrom
Conversation
Member
|
|
Move the default docstring construction to occur on-access through a descriptor. Verified with [tprof](https://github.com/adamchainz/tprof) and this script that generates 10k dataclasses: ```py from dataclasses import dataclass for i in range(10_000): @DataClass class Example: field1: int field2: str field3: float ``` **Before:** ``` $ tprof -t dataclasses._process_class example.py 🎯 tprof results: function calls total mean ± σ min … max dataclasses._process_class() 10000 5s 485μs ± 120μs 458μs … 6ms ``` After: ``` $ PYTHONPATH=Lib/ uvx tprof -t dataclasses._process_class example.py 🎯 tprof results: function calls total mean ± σ min … max dataclasses._process_class() 10000 3s 275μs ± 131μs 245μs … 6ms ``` The mean time spent in `_process_class()` has dropped from 485μs to 275μs, a ~42% time saving (admittedly skewed due to the small size of the dataclass).
b69f2e5 to
e2293d9
Compare
Contributor
Author
Good point, done! |
Contributor
|
Hehe, funny, I ended doing do same trick in my recent PR #144387, with the main purpose of being able to lazy import the inspect module. It's great to see it improves dataclass creation as well (I had a hunch but didn't do careful benchmarking). |
Contributor
Author
|
Aha. I guess your PR wins then, with the lazy import a bonus. |
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
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.
Move the default docstring construction to occur on-access through a descriptor.
Verified with tprof and this script that generates 10k dataclasses:
Before:
After:
The mean time spent in
_process_class()has dropped from 485μs to 275μs, a ~42% time saving (admittedly skewed due to the small size of the dataclass).