`in` keyword should narrow Union[TypedDict, ...]
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
Feature
Using in on a Union[TypedDict] should narrow the Union. There is already something similar for isinstance that can narrow based on types. If a certain key exists you could narrow down that your types from a Union as well. This would prevent an error saying a certain key is missing because you checked already, they code can safely access the key. Currently the only workaround for this would be to use cast() but really shouldn't be necessary.
Pitch
After the change the following code should pass validation.
from typing import castm Union
from typing_extensions import TypedDict
class Movie(TypedDict):
name: str
year: int
class MovieResponse(TypedDict):
movie: Movie
class Book(TypedDict):
name: str
year: int
class BookResponse(TypedDict):
book: Book
MediaResponse = Union[MovieResponse, BookResponse]
response : MediaResponse = MovieResponse(movie=Movie(name="Blade Runner", year=1982))
if 'movie' in response:
reveal_type(response) # Current: Union[MovieResponse, BookResponse]
# Desired: Union[MovieResponse]
print(response["movie"]) # This fails due to `BookResponse` not having a key "movie"
# but we already validated existance of the 'movie' key and that type
# should no longer be considered here
print(cast(MovieResponse, response)["movie"]) # current workaround
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining mypy's existing isinstance-based narrowing, then trace how Union and TypedDict key checks are validated. The work is done when an in check narrows the response to the matching TypedDict and the provided example passes validation without cast().
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100