python / python/mypy

Mypy should allow for Self in parametrized parent class definition — issues with contextlib.AbstractContextManager

Offen
#17,758 4 Kommentare 3 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature topic-self-types
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug Report

AbstractContextManager defines a __enter__ that returns self

But it's impossible to just inherit from contextlib.AbstractContextManager and have the type of __enter__ be correctly assumed to be Self, without a bit of boilerplate.

To Reproduce

class A(contextlib.AbstractContextManager):
    pass

reveal_type(A().__enter__())  # should be Self but assumed to be Any

and mypy disallows writing

class B(contextlib.AbstractContextManager[Self]):  # error: Self type is only allowed in annotations within class definition  [misc]
    pass

and doesn't issue a warning for this runtime error:

class C(contextlib.AbstractContextManager[C]):
    pass

Full example here
https://mypy-play.net/?mypy=latest&python=3.11&gist=7e76e56be6c702005a7ffbb7846b69c2

Expected Behavior

Either Self is allowed in the AbstractContextManager parameter list, or the type vars work by default.

Actual Behavior

Errors. See the playground.
(Although pyright doesn't error when using Self in the parameter list, but it still wrongly infers Any as the return of __enter__)

Workaround

Repeat the class name, and repeat the __enter__ impelmentation

class E(contextlib.AbstractContextManager["E"]):
    def __enter__(self) -> Self:
        return self

Your Environment

  • Mypy version used: 1.11.2
  • Mypy command-line flags: n/a
  • Python version used: 3.11

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 Beispiele im mypy-play-Link zu reproduzieren, insbesondere die Fälle AbstractContextManager und Self, und vergleiche die aufgedeckten Typen und gemeldeten Fehler mit dem erwarteten Verhalten. Erledigt ist die Aufgabe, wenn ein fokussierter Regressionstest das gewählte Verhalten von Self oder der Typvariable ohne den Workaround demonstriert und dabei die relevanten Python 3.11-Semantiken beibehält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
30/100

Neue Issues direkt in Ihr Postfach

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