python / python/mypy

Protocol Subclass checking method mentioned in documentation does not work / gives desired output

Aperta
#17,799 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Documentation

The current documentation https://mypy.readthedocs.io/en/latest/protocols.html#defining-subprotocols-and-subclassing-protocols mentions the following:

explicitly assigning to a protocol instance can be a way to ask the type checker to verify that your class implements a protocol:
_proto: SomeProto = cast(ExplicitSubclass, None)

Minimal Test

# test.py
from typing import Protocol, cast

class SomeProto(Protocol):
    def method(self) -> str: ...

class ExplicitSubclass(SomeProto):
    pass

_: SomeProto = cast(ExplicitSubclass, None)

Expected Behaviour
➤ mypy --strict --extra-checks test.py
test.py:12: ERROR  ...
Actual Behaviour
➤ mypy --version
mypy 1.12.0+dev.5dfc7d941253553ab77836e9845cb8fdfb9d23a9 (compiled: no)
➤ mypy --strict --extra-checks test.py
Success: no issues found in 1 source file

Suggestion

Change the documentation example code line to:

_: type[SomeProto] = ExplicitSubclass

This actually triggers a type check of the subclass:

➤ mypy --strict --extra-checks testmypy.py
testmypy.py:12: error: Can only assign concrete classes to a variable of type "type[SomeProto]"  [type-abstract]

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

Inizia con la sezione sulla creazione di sottoclassi di Protocol all’URL della documentazione collegata e riproduci il test minimo usando mypy --strict --extra-checks. Aggiorna l’esempio in modo che rifletta il comportamento mostrato nell’issue, quindi verifica che l’esempio nella documentazione produca la diagnostica prevista del type checker.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.