Vai al contenuto
code-to-code

Apro l'indice…

↑ ↓ per scegliere, Invio per aprire, Esc per chiudere

HTTP e API6. Pydanticp. 162

Pydantic, le soluzioni

Il ragionamento, il codice, le trappole

Per ogni esercizio, sempre lo stesso ordine: in italiano → il codice → le trappole. Per i due più difficili, anche il passo per passo.

La tua soluzione è diversa ma i test sono verdi? Probabilmente va bene: spesso ci sono più strade giuste. Leggi comunque le trappole. In questo capitolo quasi tutte passano metà dei test: lo stampo sbagliato accetta i dati giusti, e si tradisce solo con quelli sbagliati.

Le soluzioni complete

La stessa cartella, con il codice al posto di pass. Aprila dopo averci provato: i test sono gli stessi.

http-pydantic-soluzioni.zip12 KB

1 · L'abbonamento

In italiano. Quattro campi, un tipo per campo. Il titolare è un testo. Le zone si contano, quindi sono un numero intero. Il prezzo ha i centesimi, quindi è un numero con la virgola. Lo studente è sì o no.

Python
class Abbonamento(BaseModel):
    titolare: str
    zone: int
    prezzo: float
    studente: bool

Tutto il resto lo fa Pydantic: "3" diventa 3, "22.5" diventa 22.5, "tante" e 2.5 per le zone sono errori, il titolare senza valore di partenza è obbligatorio, e il colore che non è nello stampo sparisce.

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
zone: strPydantic non trasforma un numero in testo: zone=2 dà Input should be a valid string. E "3" resta il testo "3": assert '3' == 3. E "tante" passatest_un_abbonamento_giusto, test_i_numeri_scritti_come_testo_diventano_numeri, test_zone_scritte_a_parole_sono_un_errore, test_un_campo_in_piu_si_ignora
prezzo: int39.5 ha la virgola: Input should be a valid integer, got a number with a fractional part (int_from_float). E "22.5" non si legge come intero (int_parsing)test_un_abbonamento_giusto, test_i_numeri_scritti_come_testo_diventano_numeri, test_un_campo_in_piu_si_ignora
zone: floatLe zone 2.5 passano: Failed: DID NOT RAISE ValidationErrortest_le_zone_sono_un_numero_intero

La terza è la più subdola: tutti gli altri test sono verdi. "3" diventa 3.0, e per Python 3.0 == 3 è vero. Solo le mezze zone la tradiscono. Scegli il tipo pensando a cosa non deve passare: si possono comprare 2 zone e mezzo? No: int.


2 · Gli oggetti smarriti

In italiano. L'oggetto e la stazione ci sono sempre: due testi obbligatori. Il colore è un testo oppure None, e se non arriva vale None.

Python
class OggettoSmarrito(BaseModel):
    oggetto: str
    stazione: str
    colore: str | None = None

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
colore: str | NoneSenza = il campo è obbligatorio, anche se accetta None: un oggetto senza colore dà Field requiredtest_senza_colore_il_colore_e_none, test_nel_dizionario_c_e_anche_il_colore_vuoto
colore: str = NoneSe il colore non arriva, vale None e va bene. Ma se arriva None (in JSON, null), Pydantic lo controlla con il tipo: Input should be a valid stringtest_il_colore_puo_arrivare_vuoto
stazione: str | None = NoneTutto facoltativo: un ombrello senza stazione passa, e nessuno saprà mai dove cercarlo. Failed: DID NOT RAISE ValidationErrortest_la_stazione_e_obbligatoria

Le prime due sono la tabella dell'esempio B, in un caso vero. Il tipo dice cosa può arrivare, il = dice cosa vale quando non arriva niente: servono tutti e due.


3 · La ricarica

In italiano.

  1. La tessera è un testo lungo esattamente 6: almeno 6 e al massimo 6.
  2. L'importo è un numero con la virgola, più di 0 (lo zero escluso) e al massimo 100 (il 100 compreso).
Python
class Ricarica(BaseModel):
    tessera: str = Field(min_length=6, max_length=6)
    importo: float = Field(gt=0, le=100)

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
importo: float = Field(ge=0, le=100)Con ge lo zero è ammesso: la ricarica di 0 euro passatest_zero_euro_non_sono_una_ricarica
importo: float = Field(gt=0, lt=100)Con lt il 100 è escluso: Input should be less than 100 (less_than)test_cento_euro_si_possono_caricare
tessera: str = Field(min_length=6)Solo il minimo: un codice di 7 caratteri passatest_codice_troppo_lungo

Per le prime due, la domanda è sempre la stessa: il confine è ammesso? Leggi la storia parola per parola. «Più di 0»: lo zero no, gt. «Al massimo 100»: il 100 sì, le. La e finale di ge e le vuol dire equal, «uguale»: il confine è dentro.


4 · I turni

In italiano. Il badge è un testo. La fascia è un testo, ma solo uno dei tre: Literal, con i tre valori. Le ore sono un numero intero da 1 a 8, estremi compresi.

Python
class Turno(BaseModel):
    badge: str
    fascia: Literal["mattina", "pomeriggio", "notte"]
    ore: int = Field(ge=1, le=8)

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
fascia: strQualsiasi testo passa: «pranzo», «Notte», anche «boh»test_una_fascia_che_non_esiste, test_le_maiuscole_contano
fascia: Literal["mattina, pomeriggio, notte"]Un testo solo, con le virgole dentro. L'unico valore ammesso è proprio "mattina, pomeriggio, notte": "notte" dà Input should be 'mattina, pomeriggio, notte'test_un_turno_giusto, test_le_tre_fasce

La seconda si vede bene nel messaggio: Pydantic elenca i valori ammessi, e ce n'è uno solo. Contali: ogni valore ha le sue virgolette.


5 · Il treno nuovo

In italiano.

  1. Prendo i dati del treno, un TrenoNuovo, e li trasformo in un dizionario con model_dump().
  2. Apro il dizionario con le due stelle: ogni campo diventa un argomento con il nome.
  3. Davanti metto l'id scelto dal deposito, con il suo nome.
  4. Restituisco il Treno che ne esce.
Python
def registra_treno(dati: TrenoNuovo, nuovo_id: int) -> Treno:
    return Treno(id=nuovo_id, **dati.model_dump())

La versione lunga è giusta anche lei, purché ci siano tutti e quattro i campi:

Python
def registra_treno(dati: TrenoNuovo, nuovo_id: int) -> Treno:
    return Treno(id=nuovo_id, codice=dati.codice, tipo=dati.tipo, vagoni=dati.vagoni, guasto=dati.guasto)

Passo per passo, con registra_treno(TrenoNuovo(codice="M18", tipo="metro", vagoni=4), 7):

Il pezzoChe cos'è
datiTrenoNuovo(codice='M18', tipo='metro', vagoni=4, guasto=None)
dati.model_dump(){"codice": "M18", "tipo": "metro", "vagoni": 4, "guasto": None}
**dati.model_dump()codice="M18", tipo="metro", vagoni=4, guasto=None
Treno(id=nuovo_id, **dati.model_dump())Treno(id=7, codice="M18", tipo="metro", vagoni=4, guasto=None)

Il disegno.

dati = TrenoNuovo(codice="M18", tipo="metro", vagoni=4, guasto=None) treno = Treno(id=7, codice="M18", tipo="metro", vagoni=4, guasto=None)datitrenoTrenoNuovocodice"M18"tipo"metro"vagoni4guastoNoneTrenoid7codice"M18"tipo"metro"vagoni4guastoNone
Prima e dopo registra_treno

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
return datiRestituisce il TrenoNuovo così com'è, senza id: AttributeError: 'TrenoNuovo' object has no attribute 'id'test_restituisce_un_treno, test_il_treno_ha_l_id_del_deposito, test_il_treno_in_json
La versione lunga senza guasto=dati.guastoNessun errore: il guasto è facoltativo, e Pydantic mette None. «freni consumati» sparisce: assert None == 'freni consumati'test_anche_il_guasto_passa
Treno(id=nuovo_id, **dati)Le stelle vogliono un dizionario, non un oggetto: TypeError: registra_treno.Treno() argument after ** must be a mapping, not TrenoNuovotutti e cinque
Treno(nuovo_id, **dati.model_dump())L'id senza nome: TypeError: BaseModel.__init__() takes 1 positional argument but 2 were giventutti e cinque

La seconda è la più pericolosa, perché non si ferma niente: un campo facoltativo dimenticato diventa None in silenzio. Le due stelle non dimenticano: il dizionario di model_dump() ha sempre tutti i campi.


6 · I rimborsi

In italiano. Uno stampo con cinque campi, uno per riga della docstring:

  1. La tessera: un testo.
  2. Il ritardo: un intero, almeno 15.
  3. Il prezzo: un numero con la virgola, più di 0.
  4. Il canale: solo «app» o «biglietteria».
  5. La nota: un testo oppure None, e se manca vale None.
Python
class RichiestaRimborso(BaseModel):
    tessera: str
    ritardo: int = Field(ge=15)
    prezzo: float = Field(gt=0)
    canale: Literal["app", "biglietteria"]
    nota: str | None = None

La rotta non cambia: legge richiesta.ritardo, richiesta.prezzo e richiesta.tessera con il punto. Con lo scheletro vuoto quei campi non c'erano, e ogni test si fermava con AttributeError: 'RichiestaRimborso' object has no attribute 'ritardo'.

Passo per passo: cosa controlla ogni test, e quale riga dello stampo lo fa diventare verde.

Il testMandaRispondeGrazie a
test_un_rimborso_giustotutto giusto, senza nota200, {"tessera": "MN1042", "euro": 1.1}nota: str | None = None
test_un_ora_di_ritardo_rimborsa_tutto"ritardo": "75", con la nota200, {"tessera": "TS0007", "euro": 2.2}ritardo: int: il testo "75" diventa 75, e 75 è almeno 60
test_ritardo_troppo_corto"ritardo": 10422, ["body", "ritardo"], greater_than_equalField(ge=15)
test_ritardo_scritto_a_parole"ritardo": "tanto"422, ["body", "ritardo"], int_parsingritardo: int
test_prezzo_zero"prezzo": 0422, ["body", "prezzo"], greater_thanField(gt=0)
test_canale_sconosciuto"canale": "telefono"422, ["body", "canale"], literal_errorLiteral["app", "biglietteria"]
test_manca_la_tesseraniente tessera422, ["body", "tessera"], missingtessera: str, senza =

Nei test con il 422, la funzione calcola_rimborso non parte mai: FastAPI risponde prima, con l'elenco degli errori.

Le trappole. Qui lo stampo sta in un file con una rotta, quindi ogni trappola è il file intero con una riga cambiata.

Il codice sbagliatoCosa succedeIl test rosso
ritardo: intIl tipo c'è, la regola no: 10 minuti di ritardo passano, e la rotta rimborsa 1.1 euro. assert 200 == 422test_ritardo_troppo_corto
canale: strQualsiasi canale passa, anche «telefono»: assert 200 == 422test_canale_sconosciuto
nota: str | NoneLa nota diventa obbligatoria: la richiesta giusta, che non ha la nota, riceve 422 con missing su ["body", "nota"]. assert 422 == 200test_un_rimborso_giusto

La terza è la trappola dell'esercizio 2, arrivata fino al client: per lui è un 422 su una richiesta giusta. Se un test con dati giusti dice assert 422 == 200, manda la stessa richiesta da /docs e leggi il detail: loc ti dice il campo che lo stampo vuole e non trova.