Vai al contenuto
code-to-code

Apro l'indice…

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

Il database nell'API2. psycopgp. 36

psycopg, le soluzioni

Il ragionamento, il codice, le trappole

Per ogni esercizio, sempre lo stesso ordine: in italiano → il codice → le trappole. Per i più difficili, anche il passo per passo.

La tua soluzione è diversa ma i test sono verdi? Probabilmente va bene: spesso ci sono più strade giuste. Confronta il ragionamento, non le singole parole. E leggi comunque le trappole: alcune passano qualche test e si rompono su un altro.

Le soluzioni complete

La stessa cartella, con il codice al posto di pass. Aprila dopo averci provato: i test sono gli stessi.

db-psycopg-soluzioni.zip22 KB

1 · Il collega per badge

In italiano. Chiedo al database la riga del personale con quel badge. Il badge va in un buco, e il valore in una tupla di un elemento. Ritiro una riga: un dizionario, oppure None se il badge non c'è.

Python
def persona_per_badge(badge: str) -> dict | None:
    with connetti() as conn:
        return conn.execute("SELECT * FROM personale WHERE badge = %s", (badge,)).fetchone()

Il return dentro il with va bene: all'uscita il blocco fa comunque il commit e chiude la connessione.

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
(badge) al posto di (badge,)TypeError: query parameters should be a sequence or a mapping, got strtutti e quattro
.fetchall() al posto di .fetchone()Torna una lista di una riga: persona["stazione_id"] dà TypeError: list indices must be integers or slices, not str, e per il badge che non c'è torna [], non Nonetutti e quattro
WHERE badge = '%s', con gli apicipsycopg.errors.IndeterminateDatatype: could not determine data type of parameter $1: tra apici il buco non è più un bucotutti e quattro
return conn.execute(...) senza fetchone()Torna il vassoio, non la riga: nessun confronto tornatutti e quattro

La prima è la più comune. La virgola è piccola, e il messaggio parla di «sequenza» e «str»: l'unica cosa che hai passato è la stringa.


2 · Le segnalazioni aperte di un treno

In italiano. Voglio le segnalazioni di quel treno che non sono risolte, in ordine di id. Sono tante, quindi fetchall(): se non ce n'è nessuna, è la lista vuota, senza errori. Il numero del treno va nel buco, risolta = false si scrive direttamente nella query: non cambia mai.

Python
def segnalazioni_aperte(treno_id: int) -> list[dict]:
    with connetti() as conn:
        query = "SELECT * FROM segnalazioni WHERE treno_id = %s AND risolta = false ORDER BY id"
        return conn.execute(query, (treno_id,)).fetchall()

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
.fetchone() al posto di .fetchall()Torna una riga (un dizionario) invece di una lista, e None invece di [] quando non ce ne sonotutti e quattro
Senza AND risolta = falseLe segnalazioni già risolte ricompaiono: per il M12 ce ne sono tre invece di duetest_le_segnalazioni_aperte_del_m12, test_le_risolte_non_ci_sono
AND risolta = %s con un solo valorepsycopg.ProgrammingError: the query has 2 placeholders but 1 parameters were passed: un buco in più, un valore in menotutti e quattro

La seconda è la più insidiosa: niente errori, e la lista sembra a posto. Il test dei treni con solo segnalazioni risolte (il M16) la prende subito.


3 · I treni da mandare in officina

In italiano. Voglio codice e km dei treni con km uguali o oltre la soglia, dal più stanco. La soglia è un valore, quindi un buco: non la scrivo nella query. «Almeno» vuol dire >=: il M24 ha 5000 km e con soglia 5000 ci deve essere.

Python
def treni_da_revisionare(soglia: int) -> list[dict]:
    with connetti() as conn:
        query = "SELECT codice, km FROM treni WHERE km >= %s ORDER BY km DESC"
        return conn.execute(query, (soglia,)).fetchall()

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
km > %sIl M24, con 5000 km giusti, resta a terra: l'errore di un'unità sul confinetest_i_treni_da_mandare_in_officina_dal_piu_stanco, test_il_confine_e_compreso
km >= 5000 scritto nella query, e execute(query) senza valoriCon soglia 5000 funziona. Con qualunque altra soglia dà sempre la stessa listatest_nessun_treno_sopra_la_soglia_da_lista_vuota, test_la_soglia_arriva_dal_parametro
ORDER BY km senza DESCDal meno stanco al più stanco: l'ordine è rovesciatotest_i_treni_da_mandare_in_officina_dal_piu_stanco, test_la_soglia_arriva_dal_parametro

La seconda è il tipo di errore che nessun errore mostra: una funzione con un parametro che non usa. I test che cambiano i dati con una scrittura diretta (sql(…)) e poi richiamano la funzione servono proprio a questo.


4 · Una segnalazione nuova

In italiano. Scrivo una riga con quattro valori, e chiedo al database di restituirmela com'è: con l'id, e con risolta a false, che l'ho lasciata decidere a lui. Il with fa il commit all'uscita: senza, la riga non resterebbe.

Python
def nuova_segnalazione(treno_id: int, autore_id: int, descrizione: str, gravita: int) -> dict:
    with connetti() as conn:
        query = "INSERT INTO segnalazioni (treno_id, autore_id, descrizione, gravita) VALUES (%s, %s, %s, %s) RETURNING *"
        return conn.execute(query, (treno_id, autore_id, descrizione, gravita)).fetchone()

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
Niente RETURNING *, e poi fetchone()psycopg.ProgrammingError: the last operation didn't produce records (command status: INSERT 0 1)test_la_segnalazione_nuova_torna_con_il_suo_id, test_la_segnalazione_nuova_e_nel_database, test_una_descrizione_con_l_apostrofo
conn = connetti() senza withLa funzione risponde con la riga giusta, id 10 compreso, ma nel database non c'è niente: nessun commit, e la riga spariscetest_la_segnalazione_nuova_e_nel_database
Una f-string con i valori dentroFunziona finché la descrizione non ha un apostrofo. Con Sedile dell'ultimo vagone strappato: psycopg.errors.SyntaxError: syntax error at or near "ultimo"test_una_descrizione_con_l_apostrofo

La seconda è la trappola del capitolo: risponde bene, e non salva. Un test che guarda solo la risposta è verde, e il bug esce in produzione. Per questo ci sono due test: uno guarda cosa risponde, l'altro guarda cosa c'è nel database.


5 · Chiudere una segnalazione

In italiano. Metto risolta = true alla riga con quell'id e chiedo la riga indietro con RETURNING *. Se nessuna riga ha quell'id, non torna niente: fetchone() dà None, ed è esattamente la risposta richiesta. Non serve nessun if.

Python
def chiudi_segnalazione(segnalazione_id: int) -> dict | None:
    with connetti() as conn:
        query = "UPDATE segnalazioni SET risolta = true WHERE id = %s RETURNING *"
        return conn.execute(query, (segnalazione_id,)).fetchone()

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
UPDATE senza WHERETutte le segnalazioni risultano risolte. Per l'id 3 torna comunque una riga (la prima), per l'id 99 anchetest_chiude_una_segnalazione_aperta, test_una_segnalazione_che_non_c_e_da_none, test_le_altre_segnalazioni_restano_aperte
conn = connetti() senza withTorna la riga giusta, ma nel database la segnalazione è ancora apertatest_la_chiusura_e_nel_database, test_le_altre_segnalazioni_restano_aperte
.fetchall() al posto di .fetchone()Torna una lista: [{…}] invece del dizionario, e [] invece di Nonetest_chiude_una_segnalazione_aperta, test_una_segnalazione_che_non_c_e_da_none

La prima è quella che nei giornali diventa una notizia. Un UPDATE senza WHERE non dà nessun errore: fa quello che gli hai detto, su tutte le righe.


6 · Ritirare un treno

In italiano.

  1. Apro una connessione, un solo with.
  2. Metto il treno fuori servizio, e mi faccio restituire il suo id con RETURNING id.
  3. Se non è tornato niente (None), quel codice non esiste: restituisco None. Non ho scritto niente da annullare.
  4. Altrimenti scrivo la segnalazione con l'id del treno, e la restituisco.
  5. Se la INSERT fallisce, l'errore esce dal with: rollback, e anche il treno torna com'era.
Python
def ritira_treno(codice: str, autore_id: int, gravita: int, descrizione: str) -> dict | None:
    with connetti() as conn:
        treno = conn.execute("UPDATE treni SET in_servizio = false WHERE codice = %s RETURNING id", (codice,)).fetchone()
        if treno is None:
            return None
        query = "INSERT INTO segnalazioni (treno_id, autore_id, descrizione, gravita) VALUES (%s, %s, %s, %s) RETURNING *"
        return conn.execute(query, (treno["id"], autore_id, descrizione, gravita)).fetchone()

Il disegno.

inizio ritira_treno(codice, ...) passo UPDATE ... RETURNING id se treno is None sì: restituisci None passo INSERT della segnalazione se CheckViolation sì: errore rollback anche dell'UPDATE restituisci la segnalazioneritira_treno(codice, ...)UPDATE ... RETURNING idtreno is Nonerestituisci NoneINSERT della segnalazioneCheckViolationrollback anche dell'UPDATErestituisci la segnalazionenosìnosì
Ritirare un treno

Passo per passo, con ritira_treno("M10", 2, 7, "…"): la gravità 7 non è accettata dal database (le gravità vanno da 1 a 3).

PassoCosa succedeStato provvisorio
1UPDATE … RETURNING id: il M10 è fuori servizio, torna {'id': 1}M10 fuori servizio
2treno non è None: si va avantiM10 fuori servizio
3INSERT con gravità 7: CheckViolation—
4L'errore esce dal blocco: il with fa il rollbackM10 di nuovo in servizio
5L'errore arriva a chi ha chiamato la funzioneniente è stato salvato

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
Due with separati: uno per l'UPDATE, uno per l'INSERTIl primo with finisce bene: commit. Quando il secondo salta, il treno è già fuori servizio per sempretest_se_la_seconda_scrittura_fallisce_la_prima_si_annulla
conn = connetti() senza withLe due scritture ci sono nella risposta, ma nel database non c'è nientetest_ritira_treno_scrive_nel_database
Niente if treno is NoneCon il codice M99: TypeError: 'NoneType' object is not subscriptable su treno["id"]test_un_codice_che_non_c_e_da_none_e_non_scrive_niente

La prima è quella da ricordare: un with è una transazione. Ciò che deve riuscire insieme o fallire insieme sta nello stesso with. Il test che la prende deve fare fallire davvero la seconda scrittura (qui con una gravità impossibile) e poi guardare nel database.


7 · L'indirizzo del database, senza la password

In italiano. Leggo la password: se non c'è mi fermo con un errore che dice quale variabile manca. Gli altri pezzi hanno un valore di riserva, e li leggo con get. Alla fine metto tutto insieme in una f-string: qui è giusta, perché non è una query.

Python
def stringa_di_connessione() -> str:
    password = os.environ.get("PGPASSWORD")
    if password is None:
        raise RuntimeError("Manca la variabile PGPASSWORD: la password non si scrive nel codice")
    utente = os.environ.get("PGUSER", "menta")
    host = os.environ.get("PGHOST", "localhost")
    porta = os.environ.get("PGPORT", "5432")
    database = os.environ.get("MENTA_DB", "db_psycopg")
    return f"postgresql://{utente}:{password}@{host}:{porta}/{database}"

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
password = "menta123" scritta nel codiceIl test con s3greta non torna, e senza variabile non si ferma nessuno. Ma soprattutto: la password è nel file, e il file finisce su GitHubtutti e quattro
os.environ["PGUSER"], ["PGHOST"]… senza il valore di riservaSenza la variabile: KeyError: 'PGUSER'. I valori di riserva non servivano proprio a questo?test_con_la_sola_password_valgono_i_valori_di_riserva, test_la_password_cambia_con_la_variabile
os.environ["PGPASSWORD"]Senza password si ferma, sì, ma con KeyError: 'PGPASSWORD', non con il RuntimeError che spiega cosa faretest_senza_password_si_ferma_e_nomina_la_variabile

os.environ["X"] si ferma se manca, os.environ.get("X") risponde None: come i dizionari, di cui è un parente stretto.


8 · Cercare per nome, senza farsi fregare

In italiano. La f-string costruisce un testo di SQL con il nome dentro: se il nome contiene un apostrofo o un pezzo di SQL, il database lo legge come SQL. Al suo posto, un buco senza apici e la tupla di un elemento. Il valore viaggia a parte, e resta un nome qualunque cosa contenga.

Python
def persone_per_nome(nome: str) -> list[dict]:
    with connetti() as conn:
        query = "SELECT * FROM personale WHERE nome = %s ORDER BY id"
        return conn.execute(query, (nome,)).fetchall()

Cambia una riga e la chiamata a execute: il resto, il with e il fetchall(), c'era già.

Passo per passo, con tre nomi:

NomeCon la f-string (lo scheletro)Con %s
Lucia Ferrila query va, una personauna persona
Gino D'AlessioSyntaxErrorB-11
x' OR '1'='1la query diventa … = 'x' OR '1'='1': tutte e 12 le personelista vuota
x'; DELETE FROM segnalazioni; --il DELETE viene eseguito: le 9 segnalazioni sparisconolista vuota, segnalazioni intatte

Le trappole.

Il codice sbagliatoCosa succedeIl test rosso
Lasciare la f-stringTutto come nello scheletro: l'apostrofo rompe la query, Bobby Tables trova tutti, il DELETE cancellatest_si_trova_anche_chi_ha_l_apostrofo, test_bobby_tables_non_trova_nessuno, test_un_nome_con_un_comando_dentro_non_cancella_niente
nome = '%s', con gli apicipsycopg.errors.IndeterminateDatatype: could not determine data type of parameter $1: tra apici il buco non è più un bucotutti e cinque

Con la f-string, il test dei nomi semplici (Lucia Ferri) è verde. Per questo è il test più pericoloso da scrivere da solo: la funzione sembra giusta finché non arriva un valore strano. I test dell'apostrofo e di Bobby Tables ci sono apposta.


Tre errori che non fanno diventare rosso niente

Provati davvero contro i test dello zip: restano verdi, e il codice è comunque sbagliato.

  • conn.commit() scritto a mano invece del with. Funziona, e salva. Ma devi ricordarti di farlo dopo ogni scrittura, e di chiudere la connessione, e non c'è il rollback automatico se qualcosa va storto prima. In questo libro si usa sempre il with.
  • Una f-string con i numeri. f"... WHERE treno_id = {treno_id}" funziona, perché un numero non ha apostrofi. Ma è la stessa abitudine che con un testo ti fa male: oggi è treno_id, domani sarà nome. Con %s non devi più chiederti «questo valore è pericoloso?».
  • Niente ORDER BY nelle segnalazioni aperte. Oggi PostgreSQL le restituisce nell'ordine in cui le ha scritte, e il test è verde. Ma non lo promette: se un giorno una riga viene modificata o la tabella viene riorganizzata, l'ordine può cambiare. Se un ordine ti serve, chiedilo.