Le rotte con psycopg, la palestra
Cinque rotte da scrivere, con i test
- 60–90 minuti di lavoro
Cinque esercizi, dal ★ al ★★★, ambientati sulla Linea Menta. Ognuno è una piccola API in un file solo: la rotta c'è già, con il percorso e il contratto in commento, e il corpo è una riga che risponde 501 («da fare»). Al posto di quella riga scrivi la rotta con psycopg. Quando i test del file sono verdi, 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.
Prima di iniziare
Scompatta lo zip e segui il README.md che c'è dentro: venv, pip install, il tuo database (createdb db_rotte_con_psycopg, poi psql -d db_rotte_con_psycopg -f linea_menta.sql), code .. PostgreSQL deve essere acceso. 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:
- Apri il file in
palestra/. In alto: la storia, cosa fai, come provi. Sopra la rotta, in commento, il contratto: quali codici e qualidetail. - Al posto della riga
raise HTTPException(status_code=501, ...)scrivi il codice. pytest palestra/test_<nome>.py -v, oppure la provetta di VS Code.- Rosso? Leggi l'ultima riga del messaggio. Bloccato da 15 minuti? Apri il primo aiutino, non la soluzione.
All'inizio i test sono rossi, ed è giusto. Il primo esercizio, prima di scrivere una riga, dà questo:
$ pytest palestra/test_stazione_per_id.py -v --tb=no
======================================= test session starts ========================================
platform darwin -- Python 3.12.13, pytest-9.2.0, pluggy-1.7.0 -- ~/corso/db-rotte-con-psycopg/.venv/bin/python3
cachedir: .pytest_cache
rootdir: ~/corso/db-rotte-con-psycopg
configfile: pytest.ini
plugins: anyio-4.16.0
collecting ... collected 4 items
palestra/test_stazione_per_id.py::test_stazione_che_c_e FAILED [ 25%]
palestra/test_stazione_per_id.py::test_stazione_chiusa_ha_aperta_false FAILED [ 50%]
palestra/test_stazione_per_id.py::test_stazione_che_non_c_e_da_404 FAILED [ 75%]
palestra/test_stazione_per_id.py::test_stazione_legge_dal_database FAILED [100%]
===================================== short test summary info ======================================
FAILED palestra/test_stazione_per_id.py::test_stazione_che_c_e - AssertionError: Ancora 501? Togl...
FAILED palestra/test_stazione_per_id.py::test_stazione_chiusa_ha_aperta_false - assert 501 == 200
FAILED palestra/test_stazione_per_id.py::test_stazione_che_non_c_e_da_404 - AssertionError: fetch...
FAILED palestra/test_stazione_per_id.py::test_stazione_legge_dal_database - KeyError: 'tornelli'
======================================== 4 failed in 0.32s =========================================(--tb=no toglie il racconto dettagliato di ogni errore, per tenere l'elenco corto. Tu puoi lasciarlo.)
| # | Esercizio | Cosa scrivi | Difficoltà |
|---|---|---|---|
| 1 | La scheda della stazione | GET, fetchone, il 404 | ★ |
| 2 | Le segnalazioni da chiudere | GET con la query ?risolta=, fetchall, ORDER BY | ★ |
| 3 | Un nuovo collega | POST, INSERT ... RETURNING *, il 201 | ★★ |
| 4 | La segnalazione corretta | PUT, UPDATE ... RETURNING *, il 404 | ★★ |
| 5 | Il treno che esce dall'elenco | DELETE, RETURNING id, il 204, il 404 e il 409 | ★★★ |
1 · La scheda della stazione ★
palestra/stazione_per_id.py
Marta Villa, capostazione di Piazza Query, vuole dal tablet la scheda di una stazione: il nome, se è aperta, quanti tornelli ha. Se la stazione non esiste, il tablet deve saperlo.
GET /stazioni/3 -> 200 {"id": 3, "nome": "Largo Lista", "aperta": true, "tornelli": 6}
GET /stazioni/99 -> 404 {"detail": "Stazione non trovata"}Come provi: pytest palestra/test_stazione_per_id.py -v
Aiutino 1
stazioni al posto di treni.Aiutino 2
SELECT * FROM stazioni WHERE id = %s. E con un solo valore la tupla ha una virgola: (stazione_id,).Aiutino 3
with, un if su quello che ha dato fetchone(): se è None, raise HTTPException(status_code=404, detail=...).2 · Le segnalazioni da chiudere ★
palestra/segnalazioni_aperte.py
Ivo Brambati, il manutentore, apre la lista delle segnalazioni di guasto ogni mattina. Gli servono quelle non ancora risolte. Senza filtro, tutte. Sempre in ordine di id.
GET /segnalazioni -> 200 tutte e nove, in ordine di id
GET /segnalazioni?risolta=false -> 200 quelle non risolte
GET /segnalazioni?risolta=true -> 200 quelle risolteSe nessuna segnalazione passa il filtro, la risposta è [], con 200.
Come provi: pytest palestra/test_segnalazioni_aperte.py -v
Aiutino 1
risolta può valere None (nessun filtro), True o False. Quando è None serve una query diversa da quando c'è un valore: un if dentro il with.Aiutino 2
WHERE risolta = %s, e nella tupla va (risolta,). Senza filtro non ha buchi e non ha tupla.Aiutino 3
fetchall() dà una lista, anche vuota. E senza ORDER BY id il database non promette nessun ordine: uno dei test lo scopre modificando una riga.3 · Un nuovo collega ★★
palestra/nuovo_personale.py
Lucia Ferri, capotreno, tiene l'elenco del personale. Arriva una persona nuova: servono un badge, il nome, il ruolo, e (se c'è) la stazione. L'API risponde con la scheda completa, id compreso. Attento a un nome con l'apostrofo: Anna Dell'Orto.
POST /personale
{"badge": "B-14", "nome": "Rosa Bellini", "ruolo": "addetta ai tornelli", "stazione_id": 5}
-> 201 {"badge": "B-14", "nome": "Rosa Bellini", "ruolo": "addetta ai tornelli", "stazione_id": 5, "id": 13}In questo esercizio il 201 lo scrivi tu, nel decoratore.
Come provi: pytest palestra/test_nuovo_personale.py -v
Aiutino 1
INSERT INTO personale (badge, nome, ruolo, stazione_id) VALUES (%s, %s, %s, %s) RETURNING *.Aiutino 2
dati.badge, dati.nome, dati.ruolo, dati.stazione_id. Tutti dentro una tupla.Aiutino 3
@app.post("/personale", status_code=201). L'apostrofo non è un problema se il nome viaggia nel buco %s e non dentro la stringa della query.4 · La segnalazione corretta ★★
palestra/segnalazione_corretta.py
Ivo ha riparato un guasto e vuole correggere la segnalazione: cambiano la gravità, la descrizione, lo stato risolta. Il PUT porta la scheda intera. Se la segnalazione non esiste, 404.
PUT /segnalazioni/3
{"treno_id": 1, "autore_id": 2, "descrizione": "Motore sostituito", "gravita": 1, "risolta": true}
-> 200 la segnalazione 3, con i dati nuovi
PUT /segnalazioni/99 ... -> 404 {"detail": "Segnalazione non trovata"}Come provi: pytest palestra/test_segnalazione_corretta.py -v
Aiutino 1
UPDATE segnalazioni SET ... WHERE id = %s RETURNING *: cinque colonne nel SET, l'id nel WHERE.Aiutino 2
WHERE: l'ultimo valore della tupla è segnalazione_id.Aiutino 3
UPDATE non cambia niente e RETURNING non riporta niente: fetchone() dà None. Il 404 lo decidi con un if dopo il with.5 · Il treno che esce dall'elenco ★★★
palestra/treno_tolto.py
Ernesto Pozzi, capo deposito, toglie dall'elenco i treni demoliti. Ma un treno che ha delle segnalazioni di guasto non si cancella: il database dice di no, e l'API deve rispondere 409 invece di cadere con un 500.
DELETE /treni/8 -> 204 (M24: nessuna segnalazione, nessun corpo)
DELETE /treni/99 -> 404 {"detail": "Treno non trovato"}
DELETE /treni/2 -> 409 {"detail": "Il treno ha delle segnalazioni"}Qui scrivi tutto: il 204 nel decoratore, il try / except, il 404.
Come provi: pytest palestra/test_treno_tolto.py -v
Aiutino 1
try dell'esempio E: DELETE FROM treni WHERE id = %s RETURNING id, e l'eccezione da prendere è psycopg.errors.ForeignKeyViolation.Aiutino 2
try sta attorno al with. L'except alza HTTPException(status_code=409, detail=...). Il 404 viene dopo, fuori dal try, con un if su tolto is None.Aiutino 3
def finisce senza return. E nel decoratore: @app.delete("/treni/{treno_id}", status_code=204).Finiti tutti e cinque? Le soluzioni spiegano il ragionamento e le trappole. Se qualcosa non va, c'è la pagina se qualcosa va storto.