python / python/mypy

Keys and values could be narrower for closed TypedDicts

Offen
#21,700 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

feature topic-typed-dict
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

I was very excited to try out mypy 2.2 with the initial support for the TypedDict closed keyword.
But in our code base, where we often iterate over TypedDicts, it did not help much because the keys and values are still inferred as str and object, respectively.

from typing_extensions import TypedDict, reveal_type


class Closed(TypedDict, closed=True, total=False):
    a: int
    b: str

c = Closed(a=1, b='a')
reveal_type(c.items())

for key, val in c.items():
    c[key]
$ mypy --pretty test.py
test.py:9: note: Revealed type is "_collections_abc.dict_items[str, object]"
test.py:12: error: TypedDict key must be a string literal; expected one of ("a", "b")  [literal-required]
        c[key]
          ^~~
Found 1 error in 1 file (checked 1 source file)

ty narrows both keys and values here

$ ty check test.py
ty check test.py 
info[revealed-type]: Revealed type
 --> test.py:9:13
  |
9 | reveal_type(c.items())
  |             ^^^^^^^^^^ `dict_items[Literal["a", "b"], int | str]`
  |

Found 1 diagnostic

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, das test.py-Beispiel des Issues mit mypy --pretty nachzustellen, wobei der Fokus auf TypedDict.items() und dem anschließenden Zugriff c[key] liegt. Verfolge den für diese inferierten Typen verantwortlichen TypedDict-Typprüfpfad; als abgeschlossen gilt die Aufgabe, wenn die Iteration über ein geschlossenes TypedDict eine Literal-Union der Schlüssel und der entsprechenden Werttypen ergibt und der Zugriff per Index mit dem iterierten Schlüssel akzeptiert wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
devtools
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Ruhig
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.