python / python/mypy

Wrong 'incompatible return value type' when using TypeVar with constraints

Open
#12,989 3 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Bug Report

Mypy throws an error where everything should be alright.

To Reproduce

from typing import TypeVar

class Hello:
    pass

class World:
    pass

HelloWorld = TypeVar("HelloWorld", Hello, World)

def fn(x: HelloWorld) -> HelloWorld:
    if isinstance(x, Hello):
        return Hello()
    if isinstance(x, World):
        return World()

Expected Behavior

No issues found.

Actual Behavior

Got error in line "return Hello()":

error: Incompatible return value type (got "Hello", expected "World")

Your Environment

  • Mypy version used: 0.961
  • Mypy command-line flags: none
  • Mypy configuration options from mypy.ini (and other config files):
[mypy]
plugins = numpy.typing.mypy_plugin
show_absolute_path = True

[mypy-numpy]
ignore_errors = True

[mypy-numpy.*]
ignore_errors = True
  • Python version used: 3.9.12
  • Operating system and version: Ubuntu 22.04

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 mypy on the supplied TypeVar reproduction and confirm the reported error on the Hello() return. Trace the type-checking path for constrained TypeVars and isinstance narrowing; done means the example produces no issues as described in Expected Behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.