python / python/mypy

TypeVar bound not respected in Generic class method overloads

Offen
#18,419 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

bug topic-overloads
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug Report

Mypy chooses the wrong overload of a generic class method in the below code. str | Sequence[int] would match Sequence[ItemT] if ItemT was not bounded or constrained, but since it is constrained to non-str the overload for str | Sequence[ItemT] should be matched instead. The issue only affects generic class methods and not regular functions.

To Reproduce

from collections.abc import Sequence
from typing import Generic, TypeVar, overload

from typing_extensions import assert_type


T = TypeVar("T", covariant=True)
ItemT = TypeVar("ItemT", bound=int)  # OR TypeVar("ItemT", int, float)


class MyGeneric(Generic[T]):
    @overload
    def transform(self: "MyGeneric[str]") -> "MyGeneric[str]": ...

    @overload
    def transform(self: "MyGeneric[Sequence[ItemT]]") -> "MyGeneric[Sequence[ItemT]]": ...

    @overload
    def transform(self: "MyGeneric[str | Sequence[ItemT]]") -> "MyGeneric[str | Sequence[ItemT]]": ...

    def transform(self: "MyGeneric[str | Sequence[ItemT]]") -> "MyGeneric[str | Sequence[ItemT]]": ...  # type: ignore


assert_type(MyGeneric[str]().transform(), MyGeneric[str])
assert_type(MyGeneric[Sequence[int]]().transform(), MyGeneric[Sequence[int]])
assert_type(MyGeneric[str | Sequence[int]]().transform(), MyGeneric[str | Sequence[int]])
# error: Expression is of type "MyGeneric[Sequence[object]]", not "MyGeneric[str | Sequence[int]]"

# ---
# The equivalent functions do not have the same issue

@overload
def transform(x: "MyGeneric[str]") -> "MyGeneric[str]": ...

@overload
def transform(x: "MyGeneric[Sequence[ItemT]]") -> "MyGeneric[Sequence[ItemT]]": ...

@overload
def transform(x: "MyGeneric[str | Sequence[ItemT]]") -> "MyGeneric[str | Sequence[ItemT]]": ...

def transform(x: "MyGeneric[str | Sequence[ItemT]]") -> "MyGeneric[str | Sequence[ItemT]]": ...  # type: ignore


assert_type(transform(MyGeneric[str]()), MyGeneric[str])
assert_type(transform(MyGeneric[Sequence[int]]()), MyGeneric[Sequence[int]])
assert_type(transform(MyGeneric[str | Sequence[int]]()), MyGeneric[str | Sequence[int]])

Your Environment

  • Mypy version used: 1.14.1
  • Mypy command-line flags:
  • Mypy configuration options from mypy.ini (and other config files):
  • Python version used: 3.13.0

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die bereitgestellte Reproduktion mit mypy 1.14.1 auszuführen und das falsche assert_type-Ergebnis für die generische Klassenmethode zu bestätigen. Verfolge anschließend die Überladungsauflösung für generische Klassenmethoden und füge Tests hinzu oder aktualisiere die Testabdeckung so, dass der gebundene oder eingeschränkte TypeVar die erwartete Überladung auswählt, während die entsprechenden Funktionen weiterhin korrekt funktionieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.