Inconsistent Handling of Self in ClassVar Annotations
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 20.6k
- Forks
- 3.3k
- Ø Merge
- 1 T. 18 Std.
- Gemergte PRs (30 T.)
- 54
Beschreibung
Bug Report
When using Self within a ClassVar, mypy raises an arg-type error. This behavior seems inconsistent with the intended use of Self and ClassVar.
To Reproduce
MyPy playground: https://mypy-play.net/?mypy=latest&python=3.12&gist=dfe06f06e69d157317a667311aa75952
from typing import TypeVar, Generic, ClassVar, Self
T = TypeVar("T", bound="BaseModel")
class BaseModel:
_meta: "ClassVar[Meta[Self]]"
class Meta(Generic[T]):
"""Metadata class for BaseModel."""
def __init__(self, model: type[T]) -> None:
self.model = model
@classmethod
def __init_subclass__(cls) -> None:
# The following line triggers mypy error "arg-type"
# bug.py: note: In member "__init_subclass__" of class "BaseModel":
# bug.py:21:30: error: Argument 1 to "Meta" has incompatible type "type[BaseModel]"; expected "type[Self]" [arg-type]
cls._meta = cls.Meta(cls)
# outputs --> Revealed type is "bug.BaseModel.Meta[bug.BaseModel]"
reveal_type(BaseModel._meta)
Expected Behavior
The code should type-check without errors, as Self within the ClassVar should correspond to the subclass type, making cls.Meta(cls) a valid instantiation.
Actual Behavior
mypy raises an arg-type error
bug.py: note: In member "__init_subclass__" of class "BaseModel":
bug.py:21:30: error: Argument 1 to "Meta" has incompatible type "type[BaseModel]"; expected "type[Self]" [arg-type]
Your Environment:
mypy version used: 1.15.0
Python version used: 3.12.8
Additional Context:
Removing ClassVar, or changing Self to BaseModel both eliminate the mypy error.
This issue may be related to or a duplicate of Issue #17395, where Self types in ClassVar annotations lose specificity through TypeVar. In that case, Self appears to decay to the TypeVar bound instead of retaining the specific subclass type. I'm not certain if these are the same issue.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem MyPy-playground-Reproducer unter Verwendung von mypy 1.15.0 und Python 3.12.8 und vergleiche dann das Verhalten mit Issue #17395. Verfolge, wie Self innerhalb der ClassVar-Annotation und des init_subclass-Aufrufs behandelt wird. Fertig ist die Aufgabe, wenn das Beispiel ohne den arg-type-Fehler typgeprüft wird und eine Regressionstestabdeckung vorhanden ist.
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
- 42/100