Vai al contenuto
code-to-code

Apro l'indice…

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

HTTP e API7. CRUD su un dizionariop. 219

CRUD su un dizionario, se qualcosa va storto

Gli errori che vedrai, e le uscite

Questo è il capitolo dove i test restano rossi più a lungo. Ed è normale: ogni rotta ha una riga sola sbagliata, e il messaggio dice dove guardare, se sai leggerlo. Per ognuno: cosa leggi, cosa vuol dire, cosa fai.

La regola per partire: leggi l'ultima riga del messaggio di pytest, e le due righe E sopra. Di solito è lì: assert 404 == 200 vuol dire «mi aspettavo 200, è arrivato 404».

LeggiVuol direCosa fai
assert 501 == 200 (o == 201, == 204)Nella rotta c'è ancora la riga «da fare»: raise HTTPException(status_code=501, …). Il 501 vuol dire «non ancora fatto»Al posto di quella riga, il tuo codice
assert 404 == 200 e il detail è Not FoundLa rotta non esiste: il percorso nel decoratore è diverso da quello della richiestaConfronta lettera per lettera, barre comprese: /oggetti e /oggetti/ non sono uguali, e /biciclette non è /bicicletta
assert 404 == 200 e il detail è il tuo (per esempio Turno non trovato)La rotta c'è, ma non trova l'oggetto: l'id è sbagliato, oppure cerchi nel posto sbagliatoGuarda cosa cerchi e dove: in e get guardano le chiavi (gli id), non i valori. Stai passando l'id, o un'altra cosa?
assert 405 == 201 (o == 204, == 200)Il percorso c'è, ma con un altro verbo. Per esempio hai scritto la GET e il test fa una POST. Oppure la rotta manca del tutto@app.get, @app.post, @app.put, @app.delete: quale serve? Controlla il decoratore
assert 200 == 201 (o == 204)La rotta risponde, ma manca il codice nel decoratorestatus_code=status.HTTP_201_CREATED (o HTTP_204_NO_CONTENT), dentro le parentesi del decoratore, dopo il percorso
assert 200 == 404Manca il controllo: la rotta ha lavorato anche con un id che non c'è (per esempio una PUT che crea l'oggetto, perché scrivere in una chiave nuova la aggiunge)Prima riga della rotta: trova_…(id), oppure il get con is None e il raise. Prima il 404, poi il lavoro
assert 422 == 200FastAPI ha rifiutato i dati prima di entrare nella funzioneNella risposta, detail è una lista: loc dice dove (path, query, body), msg dice cosa. Le cause più comuni: nel decoratore e nel def il nome tra graffe è scritto diverso, oppure nel corpo manca un campo (la PUT li vuole tutti)
KeyError: 4 dentro il testLa rotta legge con le quadre una chiave che non c'è. Nel server vero sarebbe un 500get e if … is None, poi il 404 (vedi sotto)
ResponseValidationErrorStai restituendo qualcosa che non ha la forma dichiarata nel ->: per esempio un return HTTPException(…)Per fermare con un errore si lancia: raise. E return restituisce solo un oggetto della forma giusta (o list(…) per le liste)
UnboundLocalError: cannot access local variableUsi una variabile in un ramo dove non è ancora stata creata (per esempio trovati solo dentro l'else)Crea la variabile prima del if o del for
Il server risponde 500 e nel terminale c'è un tracebackUn errore dentro la tua funzione, non nel clientLeggilo dal basso: l'ultima riga dice cosa, la riga File "…/palestra/…py" dice dove. Vedi Leggere un traceback
Quello che hai creato da /docs non c'è piùHai salvato un file e fastapi dev è ripartito: il dizionario è tornato com'era nel codiceÈ normale: i dati vivono in un dizionario. Rifai le richieste senza salvare in mezzo
Address already in useC'è già un server acceso in un altro terminaleCtrl+C di là, oppure fastapi dev … --port 8001

Il KeyError, visto da vicino

Quando una rotta legge con le quadre e l'id non c'è, il test si ferma così. Questo è l'esercizio 2 con return turni[turno_id]:

>       return turni[turno_id]
               ^^^^^^^^^^^^^^^
E       KeyError: 4

palestra/turni.py:52: KeyError
=========================== short test summary info ============================
FAILED palestra/test_turni.py::test_turno_che_non_esiste - KeyError: 4
1 failed, 2 passed in 0.25s

Il pezzo che interessa a te: palestra/turni.py:52 (il file e la riga), la riga con le quadre, e KeyError: 4 (la chiave che mancava). Sopra c'è un traceback lungo che passa dentro FastAPI e le sue librerie: non è roba tua, si legge solo la fine. Lo schema è sempre lo stesso: l'ultima riga del tuo file è il colpevole.

La cura è la stessa dell'esercizio: get, poi if turno is None:, poi il 404.

Il 405 con lo scheletro

Se lanci il test di un esercizio dove devi scrivere anche il decoratore (dal 3 in poi), e non hai ancora scritto niente, non vedi un 501: la rotta non c'è proprio, e FastAPI risponde 405 (il percorso esiste con un altro verbo) o 404 (non esiste affatto). Per esempio, con lo scheletro dell'esercizio 3:

>       assert risposta.status_code == 201, "Manca la rotta POST /segnalazioni, oppure lo status_code 201 nel decoratore"
E       AssertionError: Manca la rotta POST /segnalazioni, oppure lo status_code 201 nel decoratore
E       assert 405 == 201
E        +  where 405 = <Response [405 Method Not Allowed]>.status_code

È il momento di scrivere il decoratore: il commento in fondo al file te lo dà. Leggi sempre la riga con la >: è l'assert che ha fallito, con il messaggio in italiano.

Gli errori che non danno errori

I più difficili sono quelli senza traceback: il programma gira, la risposta sembra giusta, il test è rosso. In questo capitolo sono quasi sempre uno di questi.

La POST che non salva. La risposta è 201 e la segnalazione è giusta, ma nel dizionario non c'è. Il test non guarda la risposta, guarda il dizionario:

E       AssertionError: La segnalazione nuova va messa nel dizionario, alla chiave del suo id
E       assert 5 in {1: Segnalazione(treno='M12', testo='luce del vagone 2 spenta', gravita=1, id=1), 2: Segnalazione(treno='T09', testo='porte bloccate', gravita=4, id=2), 4: Segnalazione(treno='M16', testo='freno che fischia', gravita=3, id=4)}

Cura: la riga segnalazioni[segnalazione.id] = segnalazione. E attento a mettere l'oggetto con l'id (la segnalazione), non il corpo arrivato (dati).

L'id che sovrascrive. (Qui è il livello 5 della storia.) Si vede quando due oggetti diventano uno, oppure quando il numero atteso e quello ricevuto sono diversi:

E       AssertionError: L'id nuovo è il più grande che c'è più uno: 7. Hai contato i treni?
E       assert {'codice': 'X...e_id': 9, ...} == {'id': 7, 'co...goni': 3, ...}
E     …
E     Differing items:
E     {'id': 5} != {'id': 7}

Cura: non len(dizionario) + 1. Gli id di un archivio hanno dei buchi (un oggetto tolto non restituisce il suo numero): si usa prossimo_id(dizionario).

Il 404 al posto della lista vuota. Un filtro che non trova niente non è un errore:

E       AssertionError: Nessun oggetto non è un errore: 200 e una lista vuota, non un 404
E       assert 404 == 200

Cura: togli il raise dopo il for. Il 404 si usa quando l'oggetto chiesto per id non c'è, non quando un filtro non trova niente.

La lista sempre vuota. Il for non trova mai nulla. Controlla: il caso «nessun filtro» è trattato per primo, con is None? Il return della lista è fuori dal for, allineato con lui? I due confronti usano == (non =)?

La risposta giusta con il dizionario sbagliato. Una PUT che ritocca solo un campo, una DELETE che risponde 204 senza togliere niente: il test guarda il dizionario dopo. Per trovarli, il debugger.

Per trovarli: il debugger

Quando un test è rosso e non sai perché, ferma il server dentro la tua rotta e guarda cosa c'è nelle scatole. Un breakpoint sulla prima riga della rotta, il test lanciato dal pannello Testing con Debug Test, poi F10 una riga alla volta, e in WATCH il dizionario (armadietti, biciclette…): lo vedi crescere o restringersi a ogni riga. Come si fa, passo per passo: Il debugger su FastAPI e nei test.

La sala controllo dice 403

Nella storia, la sala controllo risponde 403 quando il piano non è fatto, o quando le cifre non tornano. I due messaggi sono diversi, e il primo dice cosa manca:

Il detail comincia conVuol direCosa fai
Il piano non è fatto: …Manca un pezzo: l'M30 (livello 5), un treno guasto da spostare (livello 6), il treno di servizio da togliere (livello 7). Il messaggio li elencaFai quello che manca, poi riprova
… è al Deposito, ma è cambiato qualcos'altroHai spostato il treno ma con la PUT hai cambiato anche altro (per esempio il guasto è diventato null)Rifai la PUT con tutti i campi com'erano, cambiando solo stazione_id
Il piano è fatto, ma le cifre non tornanoIl piano va bene, ma le quattro cifre sono sbagliate. Le cifre si leggono con la rete com'era alle 4:30, prima del livello 5Ricontrolla le quattro risposte (livelli 1–4). Se hai salvato centrale.py il server è ripartito: la rete è com'era, ma il piano va rifatto
La rete è tornata com'eraHai salvato centrale.py mentre facevi il piano: il server riparte a ogni salvataggioRifai il piano da capo, senza salvare in mezzo

Se il problema non è il codice

pytest: command not found, No module named pytest, il pannello Testing vuoto, No module named 'smarriti', command not found: fastapi: non è il tuo codice, è l'ambiente. Ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente.

Per tutto il resto del server (/docs che non si apre da Windows, Address already in use), c'è il Pronto soccorso.