La forma della chiamata, la palestra
Otto rotte da scrivere, con i test
- 60–90 minuti di lavoro
Allo sportello informazioni di Porta Codice arriva ogni giorno Rosa Bellini, che lavora in un'agenzia di viaggi e prepara le gite dei suoi clienti sulla Linea Menta. Ogni sua domanda è una rotta: otto rotte, in un file solo, dal ★ al ★★★, una cosa nuova per rotta.
Le rotte non salvano niente: rispondono con un conto fatto sui dati che arrivano (un saluto, dei minuti, un prezzo). Così vedi solo la cosa che conta in questo capitolo: dove arriva ogni dato.
Gli esercizi da scaricare
Una cartella con i file da completare e i test già pronti. Come si usa: la guida in cinque passi.
Prima di iniziare
Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt, code .. Se è la prima volta, la pagina Come si usa un esercizio lo fa con te, un comando alla volta.
Il file è uno solo: palestra/sportello.py. Una rotta alla volta, sempre gli stessi passi:
- Leggi il commento sopra la rotta: la richiesta, la risposta, la cosa nuova.
- Nelle rotte 1 e 2 decoratore e
defci sono già: al posto della riga del 501 scrivi ilreturn. Dalla 3 in poi scrivi tu anche il decoratore e la riga deldef, sotto il commento. - Lancia i test di quella rotta sola:
pytest palestra/test_sportello.py -v -k rotta_1(poirotta_2,rotta_3…). Oppure la provetta di VS Code. - Rosso? Leggi il messaggio: dice anche cosa ha risposto la tua API. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.
Per vederla dal vivo, nel primo terminale (venv acceso):
fastapi dev palestra/sportello.pypoi apri http://127.0.0.1:8000/docs: ogni rotta che scrivi compare lì, con Try it out ed Execute. Guarda dove la mette FastAPI: (path), (query) o Request body. I test, invece, non hanno bisogno del server acceso: chiamano l'API da soli.
| # | La richiesta | La cosa nuova | Difficoltà |
|---|---|---|---|
| 1 | GET /saluto/Bruno | un pezzo di percorso | ★ |
| 2 | GET /minuti/4 | un numero nel percorso | ★ |
| 3 | GET /giornaliero?persone=3 | una query obbligatoria, e il def lo scrivi tu | ★★ |
| 4 | GET /cartello?gruppo=Classe%203B | una query facoltativa: = None | ★★ |
| 5 | GET /tragitto?da=1&a=5 | due query | ★★ |
| 6 | GET /treni/M12/annuncio?binario=2 | percorso e query insieme | ★★★ |
| 7 | POST /preventivo + corpo | il corpo: uno stampo | ★★★ |
| 8 | PUT /gruppi/3 + corpo | percorso e corpo insieme | ★★★ |
Un test è verde da subito
Prima di scrivere una riga, lancia i test della rotta 2:
pytest palestra/test_sportello.py -v -k rotta_2palestra/test_sportello.py::test_rotta_2_un_numero_nel_percorso FAILED [ 50%]
palestra/test_sportello.py::test_rotta_2_una_parola_al_posto_del_numero PASSED [100%]
…
E AssertionError: GET /minuti/4 deve rispondere 200. Ha risposto 501 {"detail":"Da fare: al posto di questa riga, il tuo codice"}
E assert 501 == 200
…
============================ 1 failed, 1 passed, 14 deselected in 0.18s ============================Il primo è rosso, ed è giusto: c'è ancora la riga del 501. Il secondo è già verde, e non hai fatto niente. Il test chiede /minuti/quattro e vuole un 422: lo dà FastAPI da solo, perché nel def c'è fermate: int, e la tua funzione non parte nemmeno. È la teoria, vista in un test.
1 · Il saluto ★
Sul foglio di viaggio di ogni cliente, Rosa stampa un saluto con il suo nome.
GET /saluto/Bruno -> 200 {"messaggio": "Buon viaggio, Bruno!"}
GET /saluto/Carla -> 200 {"messaggio": "Buon viaggio, Carla!"}Come provi: pytest palestra/test_sportello.py -v -k rotta_1
Aiutino 1
Aiutino 2
return e un dizionario con la chiave "messaggio". Per mettere il nome dentro il testo, un'f-string. E il punto esclamativo in fondo: il test confronta il testo lettera per lettera.2 · I minuti ★
«Quanto ci metto, se sono quattro fermate?» Tre minuti a fermata: nel file c'è già MINUTI_PER_FERMATA.
GET /minuti/4 -> 200 {"fermate": 4, "minuti": 12}
GET /minuti/quattro -> 422 (questo lo fa FastAPI da solo)Come provi: pytest palestra/test_sportello.py -v -k rotta_2
Aiutino 1
def c'è fermate: int: quando la tua funzione parte, fermate è già il numero 4, non il testo "4". Puoi moltiplicarlo.Aiutino 2
MINUTI_PER_FERMATA. E return, non print.3 · Il giornaliero ★★
Il biglietto giornaliero costa 7 euro a persona (EURO_GIORNALIERO). Rosa chiede il conto per un gruppo. Da qui in poi il decoratore e il def li scrivi tu: la funzione chiamala giornaliero.
GET /giornaliero?persone=3 -> 200 {"persone": 3, "euro": 21}
GET /giornaliero -> 422 (senza le persone non si fa il conto)Come provi: pytest palestra/test_sportello.py -v -k rotta_3
Aiutino 1
?, e cosa dopo? Il decoratore contiene solo quello che sta prima.Aiutino 2
"/giornaliero", niente graffe. Nel def un argomento persone, senza default (è obbligatorio) e con il tipo giusto per moltiplicarlo.Aiutino 3
{'euro': '3333333'} != {'euro': 21}, persone è arrivato come testo: "3" * 7 in Python ripete il testo sette volte. Manca : int.4 · Il cartello ★★
Alla stazione, chi accompagna un gruppo tiene in alto un cartello. Se Rosa dice il nome del gruppo, il cartello lo riporta; se no, c'è solo il nome dell'agenzia. La funzione chiamala cartello.
GET /cartello?gruppo=Classe%203B -> 200 {"cartello": "Agenzia Bellini - Classe 3B"}
GET /cartello -> 200 {"cartello": "Agenzia Bellini"}Come provi: pytest palestra/test_sportello.py -v -k rotta_4
Aiutino 1
def perché il client possa non mandarla?Aiutino 2
gruppo: str | None = None. Poi, dentro, la prima riga è la domanda: if gruppo is None:. Due return, uno per strada.Aiutino 3
'Agenzia Bellini - None'? Manca la strada del None: l'f-string ha scritto quello che ha trovato. È la trappola dell'esempio C.5 · Il tragitto ★★
«Da Porta Codice a Piazza Query, quante fermate?» Le stazioni sono in fila sulla linea, con gli id da 1 (Porta Codice) a 6 (Vecchia Fiera). Le fermate sono la distanza tra i due id, sempre positiva. La funzione chiamala tragitto.
GET /tragitto?da=1&a=5 -> 200 {"fermate": 4, "minuti": 12}
GET /tragitto?da=5&a=2 -> 200 {"fermate": 3, "minuti": 9}Come provi: pytest palestra/test_sportello.py -v -k rotta_5
Aiutino 1
?, separati da &: nel def sono due argomenti, uno per nome. L'ordine nell'indirizzo non conta.Aiutino 2
abs(a - da) (il prontuario). Mettila in una variabile fermate: ti serve due volte.6 · L'annuncio ★★★
Rosa vuole sapere cosa sentiranno i clienti dagli altoparlanti quando arriva il loro treno. Il codice del treno sta nel percorso, il binario nella query. La funzione chiamala annuncio.
GET /treni/M12/annuncio?binario=2 -> 200 {"annuncio": "Il treno M12 arriva al binario 2"}
GET /treni/M12/annuncio -> 422 (manca il binario)Come provi: pytest palestra/test_sportello.py -v -k rotta_6
Aiutino 1
treni e annuncio) e uno che cambia, in mezzo, tra graffe. Il binario non va nel decoratore.Aiutino 2
def devono essere identici. Se il test mostra un 422 con "query" e il nome del treno nel loc, non lo sono.7 · Il preventivo ★★★
Rosa manda il gruppo intero, nome e persone, in un JSON, e vuole il preventivo dei giornalieri. Lo stampo Gruppo è già scritto in cima al file. La funzione chiamala preventivo. Risponde 200, non 201: non crea niente, fa solo un conto.
POST /preventivo con il corpo {"nome": "Classe 3B", "persone": 20}
-> 200 {"nome": "Classe 3B", "persone": 20, "euro": 140}
POST /preventivo con il corpo {"nome": "Classe 3B"}
-> 422 (manca persone)Come provi: pytest palestra/test_sportello.py -v -k rotta_7
Da /docs: apri la rotta, Try it out, scrivi il JSON nel riquadro Request body, Execute.
Aiutino 1
@app.post. E i dati, nel def, in quanti argomenti?Aiutino 2
dati: Gruppo. Dentro, dati.nome e dati.persone, con il punto.Aiutino 3
"query" nel loc? Hai scritto nome e persone come due argomenti sciolti: per FastAPI sono query, e il JSON non lo guarda nessuno.8 · Il gruppo cambia ★★★
Il gruppo numero 3 ha due iscritti in più. Rosa rimanda il gruppo intero, con il numero nell'indirizzo. Lo sportello non salva niente: risponde con il gruppo come diventa, e il preventivo nuovo. (Salvarlo davvero è il capitolo CRUD su un dizionario.) La funzione chiamala sostituisci_gruppo.
PUT /gruppi/3 con il corpo {"nome": "Classe 3B", "persone": 22}
-> 200 {"id": 3, "nome": "Classe 3B", "persone": 22, "euro": 154}
PUT /gruppi/tre con lo stesso corpo
-> 422 (l'id è un numero)Come provi: pytest palestra/test_sportello.py -v -k rotta_8
Aiutino 1
Aiutino 2
def due argomenti: prima l'id (tra graffe nel decoratore, e int), poi lo stampo.Aiutino 3
{'id': '3'} != {'id': 3}, con le virgolette intorno al 3? L'id è arrivato come testo: manca : int.Finito? Confronta le tue con le soluzioni: per ogni rotta ci sono il ragionamento, il codice e le trappole più comuni, tutte provate contro i test.