Vai al contenuto
code-to-code

Apro l'indice…

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

Il database nell'API5. La sessionep. 117

La sessione, la palestra

Sette esercizi da scaricare, con i test

  • 90–120 minuti di lavoro

Sette esercizi, dal ★ al ★★★. Sono le stesse tabelle del capitolo Le rotte con psycopg (stazioni, personale, segnalazioni, treni), ma ogni rotta si scrive con la sessione. Ognuno è una piccola API da completare, con 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.

db-sessione.zip35 KB

Nello stesso zip c'è anche la storia del capitolo, L'archivio del commissario: la trovi nella pagina dopo.

Prima di iniziare

Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install, il tuo database, 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 passi:

  1. Apri il file in palestra/. In alto: la storia, cosa fai, come provi. Sotto, gli stampi già scritti e la rotta, con il suo contratto in commento.
  2. Al posto della riga raise HTTPException(status_code=501, …) scrivi il codice della rotta.
  3. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code.
  4. Rosso? Leggi l'ultima riga del messaggio: i test dicono cosa manca, in italiano. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.

I test non hanno bisogno del server acceso: usano TestClient e un database tutto loro (db_sessione_test), che torna come nuovo prima di ogni test. Dopo ogni scrittura guardano anche dentro il database: una rotta che risponde 201 senza aver fatto il commit non passa.

Se invece vuoi vedere l'API al lavoro, accendila e prova sul tuo database:

Terminale
fastapi dev palestra/treno_nuovo.py                                       # poi http://127.0.0.1:8000/docs
psql -d db_sessione -c "SELECT id, codice, vagoni FROM treni ORDER BY id"

Quello che salvi resta anche dopo Ctrl+C. Per riavere i dati di partenza: psql -d db_sessione -f linea_menta.sql.

#EsercizioLe mosseDifficoltà
1La stazione per numeroget e il 404★
2Le stazioni aperteselect, where, order_by, scalars★
3Chi ha questo badge?scalar e il 404★★
4Un treno nuovoadd, commit, refresh, il 201★★
5Sposta il trenocambiare un attributo, commit★★
6La segnalazione sbagliatadelete, commit, il 204★★
7Il badge doppioil controllo con scalar, il 409, poi scrivere★★★

1 · La stazione per numero ★

palestra/stazione.py

Marta Villa, capostazione di Piazza Query, vuole la scheda di una stazione dal suo numero. Se il numero non c'è, la risposta è un 404 chiaro.

RichiestaRisposta
GET /stazioni/3200, {"id": 3, "nome": "Largo Lista", "aperta": true, "tornelli": 6}
GET /stazioni/99404, {"detail": "Stazione non trovata"}

Come provi: pytest palestra/test_stazione.py -v

Aiutino 1
Cerchi per id: quale delle sei mosse cerca per chiave primaria? Il primo argomento è la classe-tabella (StazioneDB), non lo stampo Stazione.
Aiutino 2
db.get dà l'oggetto, oppure None. Se è None, la stazione non c'è: il 404 lo decidi tu, con un if e un raise HTTPException(…).

2 · Le stazioni aperte ★

palestra/stazioni_aperte.py

Sul tabellone di Piazza Query devono comparire solo le stazioni aperte al pubblico, in ordine alfabetico. Vecchia Fiera, chiusa, non c'è.

RichiestaRisposta
GET /stazioni200, la lista delle stazioni con aperta vera, in ordine di nome: Largo Lista, Piazza Query, Ponte Ciclo, Porta Codice, Via Variabile

Come provi: pytest palestra/test_stazioni_aperte.py -v

Aiutino 1
Questa volta non cerchi per id: serve una domanda con select, un where e un order_by. Tre pezzi, uno dopo l'altro.
Aiutino 2
La colonna aperta è già vera o falsa: nel where basta StazioneDB.aperta, senza == True.
Aiutino 3
La domanda va eseguita: db.scalars(domanda).all() dà la lista di oggetti. Non execute: darebbe le righe intere.

3 · Chi ha questo badge? ★★

palestra/persona_per_badge.py

Lucia Ferri, capotreno, trova un badge dimenticato sul sedile: B-09. A chi appartiene? Il badge non è l'id: sulla targhetta c'è scritto B-09, nel database la riga ha un altro numero.

RichiestaRisposta
GET /personale/B-09200, la persona con quel badge (Ernesto Pozzi, la riga con id 8)
GET /personale/B-99404, {"detail": "Persona non trovata"}

Come provi: pytest palestra/test_persona_per_badge.py -v

Aiutino 1
db.get cerca solo per chiave primaria, cioè per id. Il badge è un'altra colonna: serve una domanda con select e where.
Aiutino 2
Una domanda che dà una persona (il badge è unico) si esegue con db.scalar(…): dà l'oggetto, oppure None.
Aiutino 3
Nel where si confronta la colonna con il parametro: PersonaDB.badge == badge. Poi il solito if … is None per il 404.

4 · Un treno nuovo ★★

palestra/treno_nuovo.py

Ernesto Pozzi, capo deposito, registra un treno appena arrivato. L'id non lo sceglie lui: lo sceglie il database, e la risposta lo deve dire.

RichiestaRisposta
POST /treni con {"codice": "M26", "vagoni": 5, "km": 0, "in_servizio": false, "stazione_id": null}201, lo stesso treno con "id": 10

Come provi: pytest palestra/test_treno_nuovo.py -v

Aiutino 1
Le quattro mosse sono nel commento sopra la rotta: l'oggetto TrenoDB, add, commit, refresh. Poi restituisci l'oggetto.
Aiutino 2
TrenoDB(codice=…, vagoni=…): gli argomenti hanno i nomi delle colonne, e i valori li prendi da dati. id non lo scrivi: lo sceglie il database.
Aiutino 3
Il test «è nel database» guarda con psql per te. Se è rosso e la risposta è 201, quale mossa hai dimenticato? Una sola consegna fa partire il carrello.

5 · Sposta il treno ★★

palestra/sposta_treno.py

Il T28 è fermo a Vecchia Fiera. Ernesto Pozzi lo vuole spostare: in un'altra stazione, o al deposito. Non si cambia tutto il treno: si cambia una cosa sola, dove si trova.

RichiestaRisposta
PUT /treni/9/stazione con {"stazione_id": 2}200, il T28 con "stazione_id": 2
PUT /treni/1/stazione con {"stazione_id": null}200, il treno al deposito (null)
PUT /treni/99/stazione404, {"detail": "Treno non trovato"}
PUT /treni/9/stazione con {"stazione_id": 42}404, {"detail": "Stazione non trovata"}, e il treno non si muove

Come provi: pytest palestra/test_sposta_treno.py -v

Aiutino 1
Due ricerche per id, e due 404 diversi: prima il treno, poi la stazione. Per entrambe db.get.
Aiutino 2
Quando stazione_id è None il treno va al deposito, e lì non c'è nessuna stazione da cercare: controlla la stazione solo se dati.stazione_id is not None.
Aiutino 3
Per cambiare non serve nessun comando: treno.stazione_id = …, con il punto. Poi db.commit(). Il test «è nel database» è rosso anche se la risposta sembra giusta? Manca una consegna.

6 · La segnalazione sbagliata ★★

palestra/togli_segnalazione.py

Ivo Brambati, manutentore, ha trovato una segnalazione scritta per sbaglio. Va tolta dal database. Quando è tolta, la risposta è un 204: niente corpo, niente da dire. E se non c'è, 404.

RichiestaRisposta
DELETE /segnalazioni/4204, senza corpo; la riga 4 non c'è più, le altre sì
DELETE /segnalazioni/99404, {"detail": "Segnalazione non trovata"}
DELETE /segnalazioni/4, una seconda volta404

Come provi: pytest palestra/test_togli_segnalazione.py -v

Aiutino 1
Tre mosse: db.get per trovare l'oggetto, db.delete per segnarlo, db.commit per consegnare. db.delete vuole l'oggetto, non l'id.
Aiutino 2
Il 204 non ha corpo: nella funzione non c'è nessun return. Il codice lo mette già il decoratore.
Aiutino 3
Se db.get dà None e lo passi a db.delete, ottieni UnmappedInstanceError: Class 'builtins.NoneType' is not mapped. Prima dell'if, niente delete.

7 · Il badge doppio ★★★

palestra/persona_nuova.py

Una nuova assunzione alla Linea Menta: la persona entra nell'elenco del personale. Il badge è unico, come la chiave di un tornello: due persone con lo stesso badge non possono esistere. Due con lo stesso nome sì.

RichiestaRisposta
POST /personale con {"badge": "B-20", "nome": "Anna Neri", "ruolo": "capotreno", "stazione_id": 1}201, la persona con "id": 13
POST /personale con il badge B-09409, {"detail": "Badge già usato da un'altra persona"}, e non si scrive niente
POST /personale con il nome «Marta Villa» e il badge B-20201: il nome già c'è, il badge no

Come provi: pytest palestra/test_persona_nuova.py -v

Aiutino 1
Prima controlli, poi scrivi. Il controllo è una domanda: «c'è già una persona con questo badge?». Si fa con db.scalar(select(PersonaDB).where(…)).
Aiutino 2
Se la domanda trova qualcuno, raise HTTPException(status_code=409, …) e la funzione finisce lì: nessun add. Se non trova nessuno, vai avanti.
Aiutino 3
Dopo il controllo, la scrittura è quella del treno nuovo: l'oggetto PersonaDB(…), add, commit, refresh. Il controllo è sul badge, non sul nome.

Finiti tutti e sette? Passa alla storia: le stesse mosse, su un archivio vero.