Use Generic TypeAlias (PEP 585) and Union Type (PEP 604) in generated .pyi stub files
#129420
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
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/129420
Note: Links to docs will display an error until the docs builds have been completed. ❌ 4 New Failures, 1 Unrelated FailureAs of commit 13ae75b with merge base 09c4da9 ( NEW FAILURES - The following jobs have failed:
BROKEN TRUNK - The following job failed but were present on the merge base:👉 Rebase onto the `viable/strict` branch to avoid these failures
This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This was referenced Jun 24, 2024
XuehaiPan
commented
Jun 24, 2024
tools/pyi/gen_pyi.py
Outdated
| @@ -1088,26 +1087,26 @@ def replace_special_case(hint: str) -> str: | |||
| "def __init__(self, other: Tensor) -> None: ...", | |||
| f"def __init__(self, size: _size, *, {DEVICE_PARAM}) -> None: ...", | |||
| ], | |||
| "as_subclass": ["def as_subclass(self, cls: _Type[S]) -> S: ..."], | |||
| "as_subclass": ["def as_subclass(self, cls: type[S]) -> S: ..."], | |||
There was a problem hiding this comment.
Use type[S] instead of from typing import Type as _Type and _Type[S]. Using _Type is hard to maintain while one can use Type[S] which is torch._C.Type[S].
| @@ -3,25 +3,33 @@ | |||
| # mypy: allow-untyped-defs | |||
|
|
|||
| import builtins | |||
| from types import EllipsisType | |||
There was a problem hiding this comment.
ellipsis in builtins is deprecated. Import EllipsisType = type(Ellipsis) explicitly.
| SupportsIndex, | ||
| Tuple, | ||
| Type as _Type, |
There was a problem hiding this comment.
See commnet for type[S] and _Type[S] above.
torch/_C/__init__.pyi.in
Outdated
| @@ -128,44 +115,40 @@ class Stream: | |||
| device: _device # The device of the stream | |||
|
|
|||
| @overload | |||
| def __new__(self, device: Optional[DeviceLikeType] = None, *, priority: _int = 0) -> Stream: ... | |||
| def __new__(cls, device: DeviceLikeType | None = None, *, priority: _int = 0) -> Stream: ... | |||
There was a problem hiding this comment.
self -> cls is auto fixed by ruff.
| def _set_dispatch_mode(mode: TorchDispatchMode) -> None: ... | ||
| def _get_dispatch_stack_at(idx: _int) -> Any: ... | ||
| def _len_torch_dispatch_stack() -> _int: ... | ||
| def _activate_gpu_trace() -> None: ... | ||
|
|
||
| class _DisableTorchDispatch: | ||
| def __init__(self): ... | ||
| def __init__(self) -> None: ... |
There was a problem hiding this comment.
__init__(self, ...) -> None: is auto fixed by ruff.
torchgen/code_template.py
Outdated
| @@ -42,7 +42,7 @@ def lookup(v: str) -> object: | |||
|
|
|||
| def indent_lines(indent: str, v: Sequence[object]) -> str: | |||
| return "".join( | |||
| [indent + l + "\n" for e in v for l in str(e).splitlines()] | |||
| [(indent + l).rstrip() + "\n" for e in v for l in str(e).splitlines()] | |||
There was a problem hiding this comment.
Removes white spaces in empty lines.
XuehaiPan
commented
Jun 24, 2024
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Feb 28, 2025
… `.pyi` stub files ghstack-source-id: 30623d4 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 3, 2025
… `.pyi` stub files ghstack-source-id: 30623d4 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 6, 2025
… `.pyi` stub files ghstack-source-id: 1e80e66 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 13, 2025
… `.pyi` stub files ghstack-source-id: 33706e9 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
t
8000
o XuehaiPan/pytorch
that referenced
this pull request
Mar 13, 2025
… `.pyi` stub files ghstack-source-id: 33706e9 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 13, 2025
… `.pyi` stub files ghstack-source-id: 33706e9 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 14, 2025
… `.pyi` stub files ghstack-source-id: 9e49fdb Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 16, 2025
… `.pyi` stub files ghstack-source-id: bdd93e6 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 16, 2025
… `.pyi` stub files ghstack-source-id: bdd93e6 Pull Request resolved: pytorch#129420
jurgen-paul
pushed a commit
to jurgen-paul/pytorch.git.file
that referenced
this pull request
Mar 19, 2025
… `.pyi` stub files ghstack-source-id: f8aa3d1 Pull Request resolved: pytorch/pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 20, 2025
… `.pyi` stub files ghstack-source-id: 3ed051e Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Mar 20, 2025
… `.pyi` stub files ghstack-source-id: 697aa2f Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Apr 3, 2025
… `.pyi` stub files ghstack-source-id: 697aa2f Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Apr 3, 2025
… `.pyi` stub files ghstack-source-id: ec656d8 Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Apr 4, 2025
… `.pyi` stub files ghstack-source-id: 0712fde Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Apr 4, 2025
… `.pyi` stub files ghstack-source-id: 0712fde Pull Request resolved: pytorch#129420
XuehaiPan
added a commit
to XuehaiPan/pytorch
that referenced
this pull request
Apr 5, 2025
… `.pyi` stub files ghstack-source-id: 0712fde Pull Request resolved: pytorch#129420
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.
#129001 (comment) is the motivation for the whole stack of PRs. In
torch/__init__.py,torch._C.Typeshadowsfrom typing import Type, and there is no type stub fortorch._C.Typeintorch/_C/__init__.pyi. So we need to usefrom typing import Type as _Type. After enabling Generic TypeAlias (PEP 585) in the.pyitype stub files, we can usetypeinstead oftyping.Typeorfrom typing import Type as _Type.Stack from ghstack (oldest at bottom):
lintrunneron generated.pyistub files in CI #129887torch/utils/data/datapipes/gen_pyi.pywithtorchgen#150626__all__totorch/nn/functional.pyiandtorch/return_types.pyi#129872.pyistub files #129420torchgen.utils.FileManagerto acceptpathlib.Path#129871typing.List[T] -> list[T],typing.Dict[KT, VT] -> dict[KT, VT],typing.Type[T] -> type[T].Union[X, Y] -> X | Y,Optional[X] -> X | None,Optional[Union[X, Y]] -> X | Y | None.Note that in
.pyistub files, we do not needfrom __future__ import annotations. So this PR does not violate issue #117449:cc @ezyang @malfet @xuzhao9 @gramster @albanD @Skylion007