[pyupgrade] Avoid PEP-604 unions with typing.NamedTuple (UP007, UP045)
#18682
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
robsdedude
force-pushed
the
fix/18619-up007-named-tuple
branch
from
687cd54 to
ca36006
Compare
|
ntBre
reviewed
Jun 16, 2025
robsdedude
changed the title
pyupgrade] Fix UP007: ignore Optional[NamedTuple]pyupgrade] Fix UP045: ignore Optional[NamedTuple]
ntBre
reviewed
Jun 26, 2025
There was a problem hiding this comment.
Thanks, I think this looks good for UP045. However, we have the same problem for UP007, which is actually the rule from the initial report. Maybe my earlier comments were a bit confusing, but we need to handle both UP045, which replaces Optional[NamedTuple] with NamedTuple | None and UP007, which replaces Union[NamedTuple, int] (for example) with NamedTuple | int, which is also an error.
Comment on lines
135
to
138
| // `NamedTuple` is not a type; it's a type constructor. Using it in a type annotation doesn't | ||
| // make much sense. But since type checkers will currently (incorrectly) _not_ complain about it | ||
| // being used in a type annotation, we just ignore `Optional[typing.NamedTuple]`. | ||
| // https://github.com/astral-sh/ruff/issues/18619 |
There was a problem hiding this comment.
nit: I think this might make sense as the docstring for is_optional_named_tuple instead of here in the middle of the code.
ntBre
changed the title
pyupgrade] Fix UP045: ignore Optional[NamedTuple]pyupgrade] Avoid PEP-604 unions with typing.NamedTuple (UP007, UP045)
iyakushev
pushed a commit
to iyakushev/ruff
that referenced
this pull request
Jul 1, 2025
… `UP045`) (astral-sh#18682) <!-- Thank you for contributing to Ruff/ty! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? (Please prefix with `[ty]` for ty pull requests.) - Does this pull request include references to any relevant issues? --> ## Summary Make `UP045` ignore `Optional[NamedTuple]` as `NamedTuple` is a function (not a proper type). Rewriting it to `NamedTuple | None` breaks at runtime. While type checkers currently accept `NamedTuple` as a type, they arguably shouldn't. Therefore, we outright ignore it and don't touch or lint on it. For a more detailed discussion, see the linked issue. ## Test Plan Added examples to the existing tests. ## Related Issues Fixes: astral-sh#18619
7 tasks
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.
Summary
Make
UP045ignoreOptional[NamedTuple]asNamedTupleis a function (not a proper type). Rewriting it toNamedTuple | Nonebreaks at runtime. While type checkers currently acceptNamedTupleas a type, they arguably shouldn't. Therefore, we outright ignore it and don't touch or lint on it.For a more detailed discussion, see the linked issue.
Test Plan
Added examples to the existing tests.
Related Issues
Fixes: #18619