Precise typing for TypedDict wrappers
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 20.6k
- Fork
- 3.3k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Bug or feature request: feature request (I think)
I tried to use TypedDict for my codebase and ran into some issues. Consider the following code snippet:
from typing import Any, Union, Optional
from typing_extensions import Literal
from mypy_extensions import TypedDict
class Test(TypedDict):
a: str
b: int
c: int
TestKeys = Literal["a", "b", "c"] # QUESTION: is there a Test.KEYS or something equivalent?
TestValue = Union[str, int] # QUESTION: is there a Test.VALUE_TYPES or something equivalent?
class Foo:
def __init__(self):
self._foo: Optional[Test] = None
def _set(self) -> None:
self._foo = {"a": "a", "b": 0, "c": 1}
def __getitem__(self, key: TestKeys) -> Any:
self._set()
assert self._foo is not None
return self._foo[key]
def a(self) -> str:
return self["a"]
def b(self) -> int:
return self["b"]
class Bar:
def __init__(self):
self._bar: Optional[Test] = None
def _set(self) -> None:
self._bar = {"a": "a", "b": 0, "c": 1}
def __getitem__(self, key: TestKeys) -> TestValue:
self._set()
assert self._bar is not None
return self._bar[key]
def a(self) -> str:
return self["a"] # WRONG: Incompatible return value type (got "Union[str, int]", expected "str")
def b(self) -> int:
return self["b"] # WRONG: Incompatible return value type (got "Union[str, int]", expected "int")
a = Foo().a()
a.find("a")
b = Foo().b()
b.find("a") # CORRECT: "int" has no attribute "find"
c = Foo()["a"]
c.find("a")
d = Foo()["b"]
d.find("a") # MISSING: no error reported here (if self._foo is not lazily initialized the error gets correctly reported)
e = Bar().a()
e.find("a")
f = Bar().b()
f.find("a") # CORRECT: "int" has no attribute "find"
g = Bar()["a"]
g.find("a") # WRONG: Item "int" of "Union[str, int]" has no attribute "find"
h = Bar()["b"]
h.find("a") # WRONG: Item "int" of "Union[str, int]" has no attribute "find" (should be "int" has no attribute "find")
(Python 3.8.0, mypy==0.740, mypy-extensions==0.4.3)
I'm not sure what the correct return type signature for a wrapping __getitem__ would be. Both Any and Union seem to erase the actual type coming from the TypedDict and lead to incorrect results. Is there currently a way to achieve the desired behavior here? Also, is there a way to specify Literals for the keys without manually copying them?
Something like
KT = TypeVar("KT", bound=TestKeys) # or better Test.KEYS
def __getitem__(self, key: KT) -> Test[KT]:
...
would be cool if it worked.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Usa l’esempio del wrapper TypedDict nell’issue come riproduzione, concentrandoti sui tipi di ritorno generici di getitem, sui letterali delle chiavi e sull’inizializzazione lazy. Confronta le diagnostiche riportate e attese per gli esempi con a, b e indexed-access; il lavoro è completato quando l’inferenza dei valori è precisa senza duplicare manualmente le chiavi o i tipi di TypedDict.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- devtools
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100