Fix todo in inspect #13129
Merged
Fix todo in inspect #13129
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
This comment has been minimized.
This comment has been minimized.
sobolevn
reviewed
Nov 26, 2024
stdlib/inspect.pyi
Outdated
| # seem to be supporting this at the moment: | ||
| # _ClassTreeItem = list[_ClassTreeItem] | Tuple[type, Tuple[type, ...]] | ||
| def getclasstree(classes: list[type], unique: bool = False) -> list[Any]: ... | ||
| _ClassTreeItem: TypeAlias = list[_ClassTreeItem] | tuple[type, tuple[type, ...]] |
There was a problem hiding this comment.
I don't think that it ever returns a tuple. See:
walktreewhich is called ingetclasstreeLine 428 in 693add9
- source of
walktreehttps://github.com/python/cpython/blob/71ede1142ddad2d31cc966b8fe4a5aff664f4d53/Lib/inspect.py#L1158-L1164
But, the list contains tuple items, see https://github.com/python/cpython/blob/71ede1142ddad2d31cc966b8fe4a5aff664f4d53/Lib/inspect.py#L1161
This comment has been minimized.
This comment has been minimized.
sobolevn
reviewed
Dec 16, 2024
stdlib/inspect.pyi
Outdated
| # _ClassTreeItem = list[_ClassTreeItem] | Tuple[type, Tuple[type, ...]] | ||
| def getclasstree(classes: list[type], unique: bool = False) -> list[Any]: ... | ||
| def walktree(classes: list[type], children: Mapping[type[Any], list[type]], parent: type[Any] | None) -> list[Any]: ... | ||
| _ClassTreeItem: TypeAlias = list[_ClassTreeItem] | list[tuple[type, ...]] |
There was a problem hiding this comment.
I would suggest to write it other way around:
Suggested change
| _ClassTreeItem: TypeAlias = list[_ClassTreeItem] | list[tuple[type, ...]] | |
| _ClassTreeItem: TypeAlias = list[tuple[type, ...]] | list[_ClassTreeItem] |
Since this type is recursive, it better reads this way.
|
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
sobolevn
approved these changes
Dec 16, 2024
There was a problem hiding this comment.
After further testing this looks correct to me:
>>> import inspect
>>> inspect.getclasstree([int])
[(<class 'object'>, ()), [(<class 'int'>, (<class 'object'>,))]]
>>> inspect.getclasstree([int, list])
[(<class 'object'>, ()), [(<class 'int'>, (<class 'object'>,)), (<class 'list'>, (<class 'object'>,))]]
>>> class A: ...
...
>>> class B(A): ...
...
>>> class C(B): ...
...
>>> inspect.getclasstree([int, B])
[(<class '__main__.A'>, (<class 'object'>,)), [(<class '__main__.B'>, (<class '__main__.A'>,))], (<class 'object'>, ()), [(<class 'int'>, (<class 'object'>,))]]
>>> inspect.getclasstree([int, str, B])
[(<class '__main__.A'>, (<class 'object'>,)), [(<class '__main__.B'>, (<class '__main__.A'>,))], (<class 'object'>, ()), [(<class 'int'>, (<class 'object'>,)), (<class 'str'>, (<class 'object'>,))]]
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.
latest mypy seems to accept it.