Vai al contenuto
code-to-code

Apro l'indice…

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

HTTP e API6. Pydanticp. 157

Pydantic, la palestra

Sei stampi da scrivere, con i test

  • 60–90 minuti di lavoro

Sei esercizi corti, dal ★ al ★★★, ambientati sulla Linea Menta. In cinque scrivi i campi di uno stampo; in uno scrivi la riga con le due stelle. Ognuno ha il suo file di test: quando è tutto verde, hai finito.

Gli esercizi da scaricare

Una cartella con i file da completare e i test già pronti. Come si usa: la guida in cinque passi.

http-pydantic.zip12 KB

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt, code .. Pydantic arriva insieme a FastAPI: non serve altro. Se è la prima volta, la pagina Come si usa un esercizio lo fa con te, un comando alla volta.

Ogni esercizio, sempre gli stessi quattro passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi.
  2. Al posto di pass scrivi il codice. La docstring dello stampo dice i campi e le regole, con gli esempi.
  3. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code.
  4. Rosso? Leggi l'ultima riga del messaggio. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.

Prova a mano. I primi cinque esercizi non hanno un server: per provare uno stampo da solo, aprilo nel terminale di Python con -i. Il file parte, e poi il terminale resta aperto con lo stampo già pronto.

Terminale
python3 -i palestra/abbonamento.py

Poi scrivi una riga della docstring. Con lo stampo finito:

>>> Abbonamento(titolare="Rosa Bellini", zone="3", prezzo="22.5", studente=True)
Abbonamento(titolare='Rosa Bellini', zone=3, prezzo=22.5, studente=True)

Nel terminale di Python, scrivendo solo l'oggetto, vedi anche il nome dello stampo. Con lo scheletro ancora vuoto, la stessa riga dà Abbonamento(): nessun campo, e tutto quello che arriva viene buttato via. Per uscire: exit(). Dopo ogni modifica al file, esci e rientra.

#EsercizioLa cosa nuovaDifficoltà
1L'abbonamentoi tipi, e la conversione★
2Gli oggetti smarritiil campo facoltativo★
3La ricaricaField: i limiti★★
4I turniLiteral: solo quei valori★★
5Il treno nuovomodel_dump e le due stelle★★
6I rimborsilo stampo in una rotta, e il 422★★★

1 · L'abbonamento ★

palestra/abbonamento.py

Alla biglietteria di Porta Codice gli abbonamenti arrivano dall'app, in JSON. Rosa Bellini ne compra uno. Spesso i numeri arrivano scritti come testo: "3" invece di 3. Scrivi i quattro campi: il titolare (un testo), le zone (un numero intero), il prezzo (un numero con la virgola), se è uno studente (vero o falso).

Python
Abbonamento(titolare="Rosa Bellini", zone=2, prezzo=39.5, studente=False)        # va bene
Abbonamento(titolare="Rosa Bellini", zone="3", prezzo="22.5", studente=True)     # va bene: zone 3, prezzo 22.5
Abbonamento(titolare="Rosa Bellini", zone="tante", prezzo=39.5, studente=False)  # ValidationError
Abbonamento(titolare="Rosa Bellini", zone=2.5, prezzo=39.5, studente=False)      # ValidationError

Come provi: pytest palestra/test_abbonamento.py -v

Aiutino 1
Un campo per riga: il nome, i due punti, il tipo. Ti servono quattro tipi diversi: str, int, float, bool.
Aiutino 2
Le zone si contano: 1, 2, 3, mai 2,5. Il prezzo invece ha i centesimi. Quale dei due è int, e quale float?

2 · Gli oggetti smarriti ★

palestra/oggetto_smarrito.py

Al deposito degli oggetti smarriti di Piazza Query, Marta Villa registra quello che trova il personale: che oggetto è, in che stazione l'hanno trovato e, se si sa, di che colore è. Chi trova un ombrello al buio, il colore non lo sa.

Python
OggettoSmarrito(oggetto="ombrello", stazione="Largo Lista", colore="blu")   # colore "blu"
OggettoSmarrito(oggetto="ombrello", stazione="Largo Lista")                 # colore None
OggettoSmarrito(oggetto="ombrello", stazione="Largo Lista", colore=None)    # colore None (in JSON: null)
OggettoSmarrito(oggetto="ombrello")                                         # ValidationError: manca la stazione

Come provi: pytest palestra/test_oggetto_smarrito.py -v

Aiutino 1
Due campi sono obbligatori, uno no. Rileggi «Obbligatorio o facoltativo» nella teoria.
Aiutino 2
Il colore deve accettare tutti e tre i casi: un testo, None, e niente del tutto. È l'ultima riga della tabella dell'esempio B: il tipo con None, e il valore di partenza.

3 · La ricarica ★★

palestra/ricarica.py

Alla macchinetta di Porta Codice si ricarica la tessera. Il codice della tessera ha sempre 6 caratteri, né uno di più né uno di meno. Una ricarica è di più di 0 euro, e al massimo di 100.

Python
Ricarica(tessera="MN1042", importo=20)     # va bene
Ricarica(tessera="MN1042", importo=100)    # va bene: 100 è ancora ammesso
Ricarica(tessera="MN1042", importo=0)      # ValidationError: 0 euro non è una ricarica
Ricarica(tessera="MN10", importo=20)       # ValidationError: il codice è troppo corto

Come provi: pytest palestra/test_ricarica.py -v

Aiutino 1
Due campi, e per ognuno: il tipo, l'uguale, Field(...). Le regole della tessera parlano di lunghezza, quelle dell'importo di numeri. Field è già importato.
Aiutino 2
Sei caratteri esatti vuol dire almeno 6 e al massimo 6: min_length e max_length, con lo stesso numero.
Aiutino 3
«Più di 0» lascia fuori lo zero; «al massimo 100» tiene dentro il 100. Uno è un gt, l'altro un le.

4 · I turni ★★

palestra/turno.py

Ernesto Pozzi, il capo deposito, prepara i turni della settimana. Ogni turno ha il badge di chi lavora, una fascia e le ore. Le fasce sono tre, scritte proprio così: "mattina", "pomeriggio", "notte". Un turno dura da 1 a 8 ore.

Python
Turno(badge="B-04", fascia="notte", ore=8)     # va bene
Turno(badge="B-04", fascia="pranzo", ore=4)    # ValidationError: non è una delle tre fasce
Turno(badge="B-04", fascia="Notte", ore=8)     # ValidationError: le maiuscole contano
Turno(badge="B-04", fascia="notte", ore=9)     # ValidationError: troppe ore

Come provi: pytest palestra/test_turno.py -v

Aiutino 1
Literal è già importato in cima al file. Si scrive con le quadre, e dentro i valori ammessi: Literal[...].
Aiutino 2
Ogni fascia tra le sue virgolette: tre testi separati da virgole. Non un testo solo con le virgole dentro.

5 · Il treno nuovo ★★

palestra/registra_treno.py

Al deposito arriva un treno nuovo. Dall'app di Ernesto Pozzi arrivano i suoi dati, senza id: sono un TrenoNuovo. L'id lo sceglie il deposito. Serve il Treno completo: gli stessi dati, più l'id. I due stampi sono già scritti; tu scrivi la funzione.

Python
dati = TrenoNuovo(codice="M18", tipo="metro", vagoni=4)
registra_treno(dati, 7)
# Treno(codice="M18", tipo="metro", vagoni=4, guasto=None, id=7)

Come provi: pytest palestra/test_registra_treno.py -v

Aiutino 1
Rileggi l'esempio E degli esercizi spiegati: è la stessa riga, con Treno al posto di Segnalazione e nuovo_id al posto di 8. E ricordati il return.
Aiutino 2
Dall'interno verso l'esterno: dati.model_dump() è un dizionario; ** davanti lo apre negli argomenti con il nome; davanti a tutto, id=nuovo_id.
Aiutino 3
Preferisci la versione lunga? Va benissimo. Ma i campi di TrenoNuovo sono quattro: contali tutti, anche il guasto. Il test test_anche_il_guasto_passa è lì per questo.

6 · I rimborsi ★★★

palestra/rimborsi.py

Un treno in ritardo di almeno 15 minuti dà diritto a un rimborso: metà del biglietto, o tutto se il ritardo arriva a un'ora. Le richieste arrivano dall'app e dalla biglietteria. La rotta POST /rimborsi è già scritta, e non si tocca. Manca lo stampo: senza, passa di tutto.

La docstring di RichiestaRimborso dice i cinque campi:

CampoCosa èLa regola
tesseraun testo—
ritardoi minuti di ritardo, un numero interoalmeno 15
prezzoquanto è costato il biglietto, un numero con la virgolapiù di 0
canaleda dove arriva la richiestasolo "app" oppure "biglietteria"
notaun testofacoltativo: se manca vale None

I test mandano richieste vere alla rotta, con TestClient, e controllano le risposte. Non serve accendere il server: TestClient chiama l'API da solo. Per esempio:

JSON
{"tessera": "MN1042", "ritardo": 20, "prezzo": 2.2, "canale": "app"}

risponde 200 e {"tessera": "MN1042", "euro": 1.1}. Con "ritardo": 10, invece, risponde 422, e il primo errore di detail ha "loc": ["body", "ritardo"] e "type": "greater_than_equal".

Come provi: pytest palestra/test_rimborsi.py -v

Dal vivo: fastapi dev palestra/rimborsi.py, poi http://127.0.0.1:8000/docs, POST /rimborsi, Try it out. Manda il JSON di sopra e poi rovinalo un campo alla volta: per ogni errore guarda loc e type nella risposta.

Aiutino 1
Con lo scheletro, ogni test dice AttributeError: 'RichiestaRimborso' object has no attribute 'ritardo'. Lo stampo è vuoto, e la rotta cerca richiesta.ritardo: scrivi i campi con i nomi della tabella, lettera per lettera.
Aiutino 2
Riga per riga: ritardo è un int con Field(ge=15); prezzo un float con Field(gt=0), lo zero escluso; canale un Literal con due valori; nota come il colore dell'esercizio 2.
Aiutino 3
assert 422 == 200 su una richiesta giusta? Lo stampo rifiuta qualcosa che dovrebbe accettare. Manda lo stesso JSON da /docs: il detail del 422 ti dice quale campo. Molto spesso è la nota senza = None.

Finito? Confronta le tue con le soluzioni: per ogni esercizio ci sono il ragionamento, il codice e le trappole più comuni.