-
-
Notifications
You must be signed in to change notification settings - Fork 34.4k
gh-137855: Lazy import inspect module in dataclasses
#144387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
danielhollas
wants to merge
17
commits into
python:main
Choose a base branch
from
danielhollas:dataclass-lazy-inspect
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+56
−17
Open
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
4210688
Lazy import `inspect` in dataclasses module
danielhollas b1578d5
Simplify vendored unwrap function
danielhollas 43e2633
Unvendor unwrap, call it only when needed
danielhollas 6bc6199
Use PEP810!
danielhollas 3901a4c
Merge branch 'main' into dataclass-lazy-inspect
danielhollas 9910cfd
Add blurb
danielhollas 0d5efb7
Add regression test
danielhollas ff59bd3
Remove unrelated change
danielhollas 6f0db76
move lazy import
danielhollas 7c9f75b
Lazy import copy module
danielhollas b577f3b
Use the same _AutoDocstring instance
danielhollas 1703153
Lazy import re module
danielhollas b581777
Merge branch 'main' into dataclass-lazy-inspect
danielhollas 820e28c
Merge branch 'main' into dataclass-lazy-inspect
danielhollas f0a4146
Add test for docstring of recursive dataclass
danielhollas 80dca62
Merge branch 'main' into dataclass-lazy-inspect
danielhollas 152ae79
Merge branch 'main' into dataclass-lazy-inspect
danielhollas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,12 @@ | ||
| import sys | ||
| import types | ||
| import inspect | ||
| import keyword | ||
| import itertools | ||
| import annotationlib | ||
| import abc | ||
| from reprlib import recursive_repr | ||
| lazy import copy | ||
| lazy import inspect | ||
| lazy import re | ||
|
|
||
|
|
||
|
|
@@ -988,6 +988,28 @@ def _hash_exception(cls, fields, func_builder): | |
| # See https://bugs.python.org/issue32929#msg312829 for an if-statement | ||
| # version of this table. | ||
|
|
||
| # A non-data descriptor to autogenerate class docstring | ||
| # from the signature of its __init__ method on demand. | ||
| # The primary reason is to be able to lazy import `inspect` module. | ||
| class _AutoDocstring: | ||
|
|
||
| def __get__(self, _obj, cls): | ||
| try: | ||
| # In some cases fetching a signature is not possible. | ||
| # But, we surely should not fail in this case. | ||
| text_sig = str(inspect.signature( | ||
| cls, | ||
| annotation_format=annotationlib.Format.FORWARDREF, | ||
| )).replace(' -> None', '') | ||
| except (TypeError, ValueError): | ||
| text_sig = '' | ||
|
|
||
| doc = cls.__name__ + text_sig | ||
| setattr(cls, '__doc__', doc) | ||
| return doc | ||
|
|
||
| _auto_docstring = _AutoDocstring() | ||
|
|
||
|
|
||
| def _process_class(cls, init, repr, eq, order, unsafe_hash, frozen, | ||
| match_args, kw_only, slots, weakref_slot): | ||
|
|
@@ -1215,23 +1237,13 @@ def _process_class(cls, init, repr, eq, order, unsafe_hash, frozen, | |
| if hash_action: | ||
| cls.__hash__ = hash_action(cls, field_list, func_builder) | ||
|
|
||
| # Generate the methods and add them to the class. This needs to be done | ||
| # before the __doc__ logic below, since inspect will look at the __init__ | ||
| # signature. | ||
| # Generate the methods and add them to the class. | ||
| func_builder.add_fns_to_class(cls) | ||
|
|
||
| if not getattr(cls, '__doc__'): | ||
| # Create a class doc-string. | ||
| try: | ||
| # In some cases fetching a signature is not possible. | ||
| # But, we surely should not fail in this case. | ||
| text_sig = str(inspect.signature( | ||
| cls, | ||
| annotation_format=annotationlib.Format.FORWARDREF, | ||
| )).replace(' -> None', '') | ||
| except (TypeError, ValueError): | ||
| text_sig = '' | ||
| cls.__doc__ = (cls.__name__ + text_sig) | ||
| # Create a class doc-string lazily via descriptor protocol | ||
| # to avoid importing `inspect` module. | ||
| cls.__doc__ = _auto_docstring | ||
|
|
||
| if match_args: | ||
| # I could probably compute this once. | ||
|
|
@@ -1383,8 +1395,10 @@ def _add_slots(cls, is_frozen, weakref_slot, defined_fields): | |
| # make an update, since all closures for a class will share a | ||
| # given cell. | ||
| for member in newcls.__dict__.values(): | ||
|
|
||
| # If this is a wrapped function, unwrap it. | ||
| member = inspect.unwrap(member) | ||
| if not isinstance(member, type) and hasattr(member, '__wrapped__'): | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This check was copied from the while loop in |
||
| member = inspect.unwrap(member) | ||
|
|
||
| if isinstance(member, types.FunctionType): | ||
| if _update_func_cell_for__class__(member, cls, newcls): | ||
|
|
||
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
1 change: 1 addition & 0 deletions
1
Misc/NEWS.d/next/Library/2026-02-12-18-05-16.gh-issue-137855.2_PTbg.rst
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Reduce the import time of :mod:`dataclasses` module by ~20%. |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://docs.python.org/3/whatsnew/3.14.html#whatsnew314-bracketless-except :)