[Regression 1.19.1 -> 1.20.0] `value in container` based narrowing causes false negatives.
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 20.6k
- Forks
- 3.3k
- PR merge metrics
- PR metrics pending
Description
mypy seems to narrow the type of value in a if value in container branch, which leads to false negatives.
class Size(tuple[int, ...]):
def numel(self) -> int:
return 0 # math.prod(self)
sizes: list[Size] = [Size([1, 2, 3])]
print(sizes[0].numel()) # OK
value = (1, 2, 3)
if value in sizes:
reveal_type(value) # mypy: Size; pyright, ty, zuban, pyrefly: tuple
print(value.numel()) # ERROR at runtime
- with 1.19.1,
mypyrevealstuple[int, int, int]and correctly errors. https://mypy-play.net/?mypy=1.19.1&python=3.12&gist=12a961d6aab6b40ee13d895ab9ce037b - with 1.20.0 onwards,
mypyrevealsSizeand produces a false negative. https://mypy-play.net/?mypy=1.20.0&python=3.12&gist=76665c3096babff2c683164fdae02dbc
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 reproducing the narrowing difference in the linked mypy-play examples with versions 1.19.1 and 1.20.0, then trace the handling of value in sizes and its revealed type. Add a regression test for the Size and tuple example, and confirm that mypy retains the tuple type and reports the invalid numel() call.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- compilers, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100