python / python/mypy

Type inconsistently and insufficiently refined

Open
#10,224 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-type-narrowing
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Bug Report

Through a if/elif (with multiple elif) construct using isinstance in conditional, I was expecting the type of the variable checked to be refined in the branches.

To Reproduce

from typing import Any, Union
class A: ...
class B: ...
class C: ...

def _binary_operation(left: C, right: Union[A, B]) -> Any: ...

ALL = Union[A, B, C]
def commutative_binary_operation(left: ALL, right: ALL) -> Any:
    # Handling of a corner case.
    if isinstance(left, C) and isinstance(right, C):
        ...
    elif isinstance(left, C):
        reveal_type(right)
        return _binary_operation(left, right)
    elif isinstance(right, C):
        reveal_type(left)
        return _binary_operation(right, left)

    # Treatment of other combination of types.
    ...
$ mypy test_issue.py

Expected Behavior

I was expecting mypy to raise no error, because I was expecting the type of right to be Union[test_issue.A, test_issue.B] at line 15 (and respectively, of left at line 18).

Actual Behavior

Here is the result of running mypy on the example above:

$ mypy test_issue.py
test_issue.py:15: note: Revealed type is 'Union[test_issue.A, test_issue.B, test_issue.C]'
test_issue.py:16: error: Argument 2 to "_binary_operation" has incompatible type "Union[A, B, C]"; expected "Union[A, B]"
test_issue.py:18: note: Revealed type is 'Union[test_issue.A, test_issue.B]'

Strangely, it seems that the second branch refines the type of left properly...

Your Environment

  • Mypy version used: mypy 0.812
  • Mypy command-line flags: None
  • Mypy configuration options from mypy.ini (and other config files): None
  • Python version used: Python 3.8.5
  • Operating system and version: NixOS unstable

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the supplied Python snippet with mypy 0.812 and compare the revealed types in the two elif branches. Trace the conditional type-narrowing behavior responsible for the inconsistent results, then verify that the reproduced calls are accepted and the revealed types match the expected unions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
compilers, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.