python / python/mypy

Can't match a TypedDict with a Protocol

Aperta
#17,074 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

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

Descrizione

Bug Report

I was trying to use a Protocol to fish out the value type from a TypedDict type corresponding to a key Literal passed to a function, so I could bind it to a TypeVar. That didn't work, but in trying to debug that I noticed that it's just straight up not possible to get a TypedDict to match a simple Protocol that we can see at type-checking time it does in fact match.

To Reproduce

See https://mypy-play.net/?mypy=latest&python=3.12&gist=928611fe3fcf77630451b8ca6b26dfca

from typing import Literal, TypedDict, Protocol, Optional

class Foo(TypedDict):
    bar: int

concrete_var: Foo = Foo(bar=5)

# This typechecks (though it has to be optional for some reason even if the key
# is Required in the TypedDict):
int_var: Optional[int] = concrete_var.get("bar")

class Gettable(Protocol):
    def get(self, key: Literal["bar"]) -> Optional[int]: ...

# But we don't use that to know that the protocol matches. This fails:
test_var: Gettable = concrete_var 

Actual Behavior

main.py:16: error: Incompatible types in assignment (expression has type "Foo", variable has type "Gettable")  [assignment]
main.py:16: note: Following member(s) of "Foo" have conflicts:
main.py:16: note:     Expected:
main.py:16: note:         def get(self, key: Literal['bar']) -> int | None
main.py:16: note:     Got:
main.py:16: note:         @overload
main.py:16: note:         def get(self, str, /) -> object
main.py:16: note:         @overload
main.py:16: note:         def [_T] get(self, str, /, default: object) -> object
Found 1 error in 1 file (checked 1 source file)

MyPy appears to have forgotten everything it ever knew about the types of the things in the TypedDict when it tries to match the get() method to the protocol.

Your Environment

  • Mypy version used: 1.9.0
  • Python version used: 3.10 and 3.12

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 eseguendo la riproduzione collegata di mypy-play con le definizioni TypedDict e Protocol fornite. Traccia come vengono confrontati TypedDict get overloads e Protocol methods; il lavoro è completato quando l'assegnazione segnalata viene accettata correttamente e c'è una copertura di regressione nell'area di test esistente pertinente.

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

Valutazione

Stack tecnologico
python
Ambito
compilers
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.