Vai al contenuto
code-to-code

Apro l'indice…

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

HTTP e API7. CRUD su un dizionariop. 195

CRUD su un dizionario, la palestra

Sette rotte da scrivere, con i test

  • 90–120 minuti di lavoro

Sette esercizi, dal ★ al ★★★, ambientati sulla Linea Menta. Ognuno è una piccola API in un file, con le rotte da completare e il suo file di test: quando è tutto verde, hai finito. Le prime due sono GET, poi arrivano la POST, la PUT, la DELETE e il 409; l'ultima mette tutto insieme.

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-crud-su-un-dizionario.zip30 KB

Nello stesso zip c'è anche la storia del capitolo, La centrale della Linea Menta: la trovi nella pagina dopo.

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install -r requirements.txt (FastAPI è grande: qualche minuto), code .. 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. Scrivi il codice al posto della riga «da fare» (raise HTTPException(status_code=501, …), oppure pass). Sopra ogni rotta, un commento dice la richiesta e la risposta che il test si aspetta. Quando sotto il commento non c'è niente, scrivi tu anche il decoratore e la riga del def: il commento te li dà già.
  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. Per vedere la tua API dal vivo, in un secondo terminale (con cd e il venv acceso anche lì):

Terminale
fastapi dev palestra/smarriti.py

Poi, nel browser, http://127.0.0.1:8000/docs: clicca la rotta, Try it out, riempi i campi, Execute. (Da Windows con WSL: il server gira nel terminale di Ubuntu, il browser è quello di Windows.) Per spegnere: Ctrl+C. Ogni volta che salvi il file il server riparte, e il dizionario torna com'era all'inizio.

#EsercizioLa cosa nuovaDifficoltà
1Gli oggetti smarritiGET lista con un filtro: il setaccio★
2I turni del personaleGET con l'id e il 404★
3Le segnalazioni dei guastiPOST, il 201 e l'id scelto dal server★★
4I tornelliPUT: la scatola nuova★★
5Gli annunciDELETE e il 204★★
6L'ufficio badgeil 409, nella POST e nella PUT★★★
7Le biciclette di Ponte Ciclole cinque rotte insieme, con due filtri★★★

1 · Gli oggetti smarriti ★

palestra/smarriti.py

All'ufficio oggetti smarriti arriva di tutto, da tutte le stazioni. Marta Villa, capostazione di Piazza Query (la 5), vuole vedere solo i suoi: GET /oggetti?stazione_id=5.

GET /oggetti                ->  200 e tutti gli oggetti
GET /oggetti?stazione_id=5  ->  200 e solo quelli trovati nella stazione 5
GET /oggetti?stazione_id=6  ->  200 e una lista vuota

Nella rotta lista_oggetti, al posto della riga del 501, scrivi il setaccio.

Come provi: pytest palestra/test_smarriti.py -v

Aiutino 1
Il filtro è facoltativo: nella richiesta può non esserci, e allora stazione_id vale None. Quel caso va trattato per primo: se non c'è filtro, restituisci tutti gli oggetti.
Aiutino 2
Per tutti gli oggetti: list(oggetti.values()). Per gli altri: una lista vuota, un for sugli oggetti, un if sulla stazione, append. Il return della lista va fuori dal for.
Aiutino 3
Quando nessun oggetto passa il filtro la risposta è una lista vuota, con 200: niente 404.

2 · I turni del personale ★

palestra/turni.py

Sul tablet di Ernesto Pozzi ci sono i turni della settimana. Tocca un turno e l'app chiede GET /turni/3. Il turno 4 è stato cancellato: l'app deve ricevere un 404, non un errore del server.

GET /turni/3  ->  200 e il turno 3
GET /turni/4  ->  404 con il detail "Turno non trovato"

Nella rotta leggi_turno, al posto della riga del 501, scrivi il tuo codice.

Come provi: pytest palestra/test_turni.py -v

Aiutino 1
Le quadre (turni[turno_id]) su un id che manca danno un KeyError, che nel server vero è un 500. Quale lettura dà None invece di fermarsi?
Aiutino 2
Tre righe: leggi il turno con get; se è None, raise HTTPException(status_code=404, detail="Turno non trovato"); altrimenti return.

3 · Le segnalazioni dei guasti ★★

palestra/segnalazioni.py

I capotreno segnalano i guasti dal tablet di bordo: POST /segnalazioni, con il treno, cosa non va e quanto è grave (da 1 a 5). L'id della segnalazione lo sceglie la centrale. Gli id che ci sono sono 1, 2 e 4: la 3 è stata chiusa e tolta.

POST /segnalazioni, con il corpo {"treno": "M14", "testo": "aria condizionata rotta", "gravita": 2}
  ->  201 e la segnalazione nuova, con il suo id

Questa volta scrivi tu anche il decoratore e la riga del def: il commento in fondo al file te li dà. Nel dizionario ci va la segnalazione con l'id.

Come provi: pytest palestra/test_segnalazioni.py -v

Aiutino 1
Il def riceve dati: SegnalazioneNuova (il corpo, senza id) e restituisce una Segnalazione (con l'id). Il 201 sta nel decoratore, con status_code=status.HTTP_201_CREATED.
Aiutino 2
Quattro mosse: l'id con prossimo_id(segnalazioni); costruisci la Segnalazione(id=…, treno=dati.treno, …); mettila in segnalazioni[…]; restituiscila.
Aiutino 3
Il test guarda anche il dizionario dopo la richiesta. Se il test «resta nell'archivio» è rosso, hai dimenticato di salvare, oppure hai salvato dati (senza id) e non la segnalazione.

4 · I tornelli ★★

palestra/tornelli.py

Ivo Brambati ha riparato il tornello 2 di Porta Codice e ci è passato dieci volte per provarlo. Adesso lo manda alla centrale com'è, tutto intero: PUT /tornelli/2.

PUT /tornelli/2, con il corpo {"stazione_id": 1, "stato": "aperto", "passaggi": 310}
  ->  200 e il tornello 2 com'è adesso: tutti i campi dal corpo, l'id dal percorso
PUT /tornelli/9
  ->  404 con il detail "Tornello non trovato" (e il tornello 9 non va creato)

Scrivi tu decoratore, def e corpo. trova_tornello è già pronta, in cima al file.

Come provi: pytest palestra/test_tornelli.py -v

Aiutino 1
Il def ha due argomenti: l'id dal percorso (tornello_id: int) e il corpo (dati: TornelloNuovo). Il decoratore è @app.put("/tornelli/{tornello_id}").
Aiutino 2
Prima il 404: basta chiamare trova_tornello(tornello_id) come prima riga. Se il tornello non c'è, la funzione si ferma lì.
Aiutino 3
Poi costruisci un Tornello(id=tornello_id, …) con tutti i campi presi da dati, e mettilo in tornelli[tornello_id]: scatola nuova, stessa chiave. Non cambiare solo un campo del vecchio.

5 · Gli annunci ★★

palestra/annunci.py

Gli altoparlanti ripetono gli annunci registrati nella centrale. Marta Villa toglie quelli vecchi: DELETE /annunci/2. Se lo chiede due volte, la seconda volta l'annuncio non c'è più.

DELETE /annunci/2                 ->  204, senza corpo
DELETE /annunci/2, la seconda volta  ->  404 con il detail "Annuncio non trovato"
DELETE /annunci/9                 ->  404 con lo stesso detail

Scrivi tu decoratore, def e corpo. Il decoratore ha due cose dentro le parentesi: il percorso e lo status_code.

Come provi: pytest palestra/test_annunci.py -v

Aiutino 1
La funzione restituisce None: il 204 non ha corpo. Non scrivere nessun return. Il codice 204 sta nel decoratore: status_code=status.HTTP_204_NO_CONTENT.
Aiutino 2
Prima chiedi se c'è, con in (che guarda le chiavi, e le chiavi sono gli id): if annuncio_id not in annunci: e il 404. Poi, e solo dopo, del annunci[annuncio_id].

6 · L'ufficio badge ★★★

palestra/ufficio_badge.py

All'ufficio del personale Ernesto Pozzi stampa i badge. Due badge con lo stesso codice sono un guaio: il tornello non sa più chi è passato. La centrale li deve rifiutare, con un 409.

POST /badge con un codice già usato     ->  409 con il detail "Codice già usato da un altro badge"
PUT /badge/4 con il codice del badge 2  ->  409, stesso detail
PUT /badge/4 con il suo codice, B-04    ->  200: il codice è il suo, non di un altro

Tre pezzi, nell'ordine: (1) scrivi codice_gia_usato, al posto di pass; (2) nella POST, dove dice «Da fare (2)», il controllo con il 409; (3) lo stesso nella PUT, dove dice «Da fare (3)». Attento: nel dizionario badge la chiave è l'id (1, 2, 3, 4), il codice ("B-01") sta dentro il badge.

Come provi: pytest palestra/test_ufficio_badge.py -v

Aiutino 1
codice_gia_usato è un for sui valori (badge.values()): se un badge ha quel codice e un id diverso da tranne_id, return True. Alla fine, return False.
Aiutino 2
Il return False va fuori dal for: dentro, il primo badge diverso farebbe già rispondere «no». E per sapere se un badge è «un altro» confronta altro.id != tranne_id: con tranne_id uguale a None (la POST), ogni badge è un altro.
Aiutino 3
Nella POST: if codice_gia_usato(dati.codice):. Nella PUT: if codice_gia_usato(dati.codice, tranne_id=badge_id):. In tutte e due, dentro l'if, raise HTTPException(status_code=409, detail="Codice già usato da un altro badge").

7 · Le biciclette di Ponte Ciclo ★★★

palestra/biciclette.py

A Ponte Ciclo (il nome non è un caso) la Linea Menta presta biciclette. Pietro Galli, che le ripara, vuole un'API tutta sua: le cinque rotte, e la lista con due filtri. Gli id sono 1, 2, 3 e 5 (la 4 è stata rubata).

GET /biciclette                               ->  200 e tutte
GET /biciclette?stazione_id=4                 ->  200 e solo quelle della stazione 4
GET /biciclette?libera=false                  ->  200 e solo quelle in uso
GET /biciclette?stazione_id=4&libera=true     ->  200 e quelle che passano tutti e due i filtri
GET /biciclette/3                             ->  200 e la bicicletta 3
GET /biciclette/4                             ->  404 con il detail "Bicicletta non trovata"
POST /biciclette                              ->  201 e la bicicletta nuova, con il suo id
PUT /biciclette/2, con tutti i campi          ->  200 e la bicicletta 2 com'è adesso
PUT /biciclette/4                             ->  404
DELETE /biciclette/5                          ->  204; la seconda volta 404

Sotto i dati, in fondo al file, ci sono cinque commenti: uno per rotta. Per ognuno scrivi decoratore, def e corpo. Consiglio: comincia da una funzione trova_bicicletta, come trova_tornello dell'esercizio 4: ti serve in tre rotte.

Come provi: pytest palestra/test_biciclette.py -v, oppure una rotta alla volta, con -k: pytest palestra/test_biciclette.py -v -k lista.

Aiutino 1
Comincia dalla seconda rotta (GET con l'id e il 404), poi scrivi trova_bicicletta e riusala nella PUT e nella DELETE. Per la POST, prossimo_id c'è già.
Aiutino 2
Per i due filtri, una domanda per filtro: passa_stazione = stazione_id is None or bicicletta.stazione_id == stazione_id, e uguale per libera. Poi if passa_stazione and passa_libera:. Il filtro libera=false vuol dire False: non scambiarlo per «nessun filtro».
Aiutino 3
Il nome tra graffe nel decoratore e il nome nel def devono essere identici, lettera per lettera: /biciclette/{bicicletta_id} e bicicletta_id: int. Se sono diversi, FastAPI tratta il parametro come una query e risponde 422.

Finite le sette? La storia ti fa scrivere un'API a sette livelli, con una sala controllo finale. Le soluzioni, con le trappole di ogni esercizio, sono qui. E se un test resta rosso e non sai perché: Se qualcosa va storto.