python / python/mypy

does not prevent overriding of `ClassVar` with instance setter

Aperta
#18,790 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug good-second-issue
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Bug Report

this seems to be a special case for @property but probably shouldn't be

a settable instance @property currently is allowed to override a ClassVar but I believe it should produce a diagnostic

To Reproduce

from typing import ClassVar

class C:
    u: ClassVar[str]

class D(C):
    u: str

class E(C):
    @property
    def u(self) -> str: return ''
    @u.setter
    def u(self, s: str) -> None: ...

Expected Behavior

I expect both D and E to produce errors (cannot override ClassVar with instance variable)

Actual Behavior

but only D does

$ mypy t2.py 
t2.py:7: error: Cannot override class variable (previously declared on base class "C") with instance variable  [misc]
Found 1 error in 1 file (checked 1 source file)

interestingly enough, if you leave out the setter it does produce a diagnostic -- so I suspect this should be an easy patch to that particular codepath:

$ diff -u t2.py t3.py
--- t2.py	2025-03-11 19:31:11.656092408 -0400
+++ t3.py	2025-03-11 19:38:46.827393165 -0400
@@ -9,5 +9,3 @@
 class E(C):
     @property
     def u(self) -> str: return ''
-    @u.setter
-    def u(self, s: str) -> None: ...
$ mypy t3.py 
t3.py:7: error: Cannot override class variable (previously declared on base class "C") with instance variable  [misc]
t3.py:11: error: Cannot override writeable attribute with read-only property  [override]
Found 2 errors in 1 file (checked 1 source file)

Your Environment

  • Mypy version used: 1.15.0
  • Mypy command-line flags: n/a
  • Mypy configuration options from mypy.ini (and other config files): n/a
  • Python version used: 3.12.3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Usa la riproduzione C/D/E fornita come caso di regressione iniziale, quindi esamina la gestione dei setter delle proprietà da parte di mypy e il percorso diagnostico esistente per l’override di ClassVar. Il lavoro è completo quando sia D sia E producono l’errore cannot-override previsto e il comportamento esistente delle proprietà di sola lettura continua a essere coperto.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
55/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.