python / python/typing

Allow TypedDict.__required_keys__/__optional_keys__ to be used as Literal[...]

Aperta
#1,394 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

topic: feature
Lingua principale
Python
Stelle
1.8k
Fork
302
Merge medio
23h
PR unite (30g)
8

Descrizione

TypedDict instances work very well for NoSQL databases, like Mongo DB, but for any extended functionality a class is required, and marrying the two requires a few error-prone steps described here.

Consider a Mongo DB database document described with this structure, which works out well to the most part when being supplied into pymongo methods (with the exception of mypy failing to realize that it's TypedDict is a mutable mapping).

class X(TypedDict):
    i: int
    s: str
    f: NotRequired[float]

Compared to Mapping, using a typed dictionary allows one to catch field references and value type mismatches quite quickly.

For more advanced functionality for this entity, however, a class may be maintained, like below. I will omit getters, etc, and just show relevant methods to set required and optional fields.

class Y:
    def __init__(self, x: X) -> None:
        self._storage = x

    def set_required(self, key: Literal["i", "s"], value: Any) -> None:
        self._storage[key] = value

    def set_optional(self, key: Literal["f"], value: Any) -> None:
        if value is None:
            del self._storage[key]
        else:
            self._storage[key] = value

Herein lies the problem - I cannot use X.__required_keys__ to drive field references in the underlying storage because it's not a literal and the fact that it's frozenset doesn't help here, so I have to maintain copies of field names separately.

If X.__required_keys__ and X.__optional_keys__ would operate similarly to how constexpr behaves in C++ and would propagate literal keys they are created with to where they are used, like those methods above, it would make it very straightforward to integrate typed dictionaries with classes and use the former as storage with a well-defined schema that can be referenced in class methods to enforce proper field references.

I will also note that @dataclass is not good for this functionality because of a couple of reasons. First, just like any class, it has no concept of missing attributes and an attribute set to None is interpreted by the database driver as null. Second, @dataclass is implemented via auto-generated __init__, so it imposes unreasonable field order to satisfy optional arguments following required ones in the constructor. Lack of an alternative constructor doesn't help either.

EDIT: Replaced self.x_o with self._storage, which was a copy-and-paste error copying examples from a larger test case.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

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 esaminando l’interazione richiesta tra TypedDict.required_keys, TypedDict.optional_keys e Literal, insieme all’esempio che usa mypy e pymongo. L’issue non indica file o test del repository; il lavoro sarebbe completato con un design concordato e la validazione che gli insiemi di chiavi di TypedDict possano fornire informazioni letterali sulle chiavi per le operazioni di archiviazione tipizzate.

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
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.