Pydantic, se qualcosa va storto
Lo stampo scritto male, i dati sbagliati, gli errori muti
Gli errori di questo capitolo sono di due famiglie, e conviene capire subito di quale si tratta.
- Lo stampo è scritto male: un import, i due punti, le quadre, le stelle. Lo dice Python, con un traceback, spesso prima ancora che arrivi un dato.
- I dati sono sbagliati: lo stampo è giusto e fa il suo lavoro. Lo dice Pydantic: un
ValidationErrorin Python, un 422 in FastAPI.
Ricorda come si legge un traceback: dal basso. L'ultima riga dice cosa, la riga File … line … dice dove. Tutto il resto è nel capitolo Leggere un traceback.
Lo stampo scritto male
| Leggi | Vuol dire | Cosa fai |
|---|---|---|
NameError: name 'Field' is not defined | Usi Field ma non l'hai importato | In cima: from pydantic import BaseModel, Field |
NameError: name 'Literal' is not defined | Literal non arriva da Pydantic: arriva da typing | In cima: from typing import Literal |
PydanticUserError: A non-annotated attribute was detected: `gravita = <class 'int'>` | Hai scritto un campo con l'uguale al posto dei due punti: gravita = int, oppure colore = None senza tipo | Il campo è nome, due punti, tipo: gravita: int, colore: str | None = None |
TypeError: Cannot instantiate typing.Literal | Literal con le tonde: Literal("mattina", "notte") | Con le quadre: Literal["mattina", "notte"] |
TypeError: BaseModel.__init__() takes 1 positional argument but 3 were given | Hai creato l'oggetto senza i nomi: Segnalazione("M12", 3) | Sempre nome=valore: Segnalazione(treno="M12", gravita=3) |
AttributeError: 'Abbonamento' object has no attribute 'titolare' | Lo stampo non ha quel campo: c'è ancora pass, oppure il nome è scritto diverso | Il nome del campo come nel test, lettera per lettera |
Failed: DID NOT RAISE ValidationError | Il test manda dati sbagliati e lo stampo li accetta | Manca una regola: il tipo giusto, un limite in Field, un Literal |
Un ValidationError in un test che doveva passare | Lo stampo rifiuta dati giusti | Leggi il campo e il type: una regola troppo stretta (lt al posto di le), un tipo sbagliato, un facoltativo senza = None |
PydanticDeprecatedSince20: The `dict` method is deprecated; use `model_dump` instead | Hai copiato .dict() da un tutorial vecchio | .model_dump() |
Le due stelle e il punto
| Leggi | Vuol dire | Cosa fai |
|---|---|---|
TypeError: … argument after ** must be a mapping, not SegnalazioneNuova | **dati su un oggetto: le stelle aprono solo i dizionari | **dati.model_dump() |
TypeError: BaseModel.__init__() takes 1 positional argument but 2 were given | L'id senza nome: Segnalazione(8, **dati.model_dump()) | Segnalazione(id=8, **dati.model_dump()) |
1 validation error for Segnalazione, poi id e Field required | Le stelle ci sono, l'id no: Segnalazione(**dati.model_dump()). Il dizionario ha tutti i campi di SegnalazioneNuova, ma l'id non c'è mai stato | Davanti alle stelle, l'id con il suo nome: Segnalazione(id=8, **dati.model_dump()) |
TypeError: … got multiple values for keyword argument 'id' | Il dizionario ha già un id, e tu ne scrivi un altro: stai aprendo una Segnalazione invece di una SegnalazioneNuova | Le stelle sui dati che arrivano dal client, quelli senza id |
AttributeError: 'dict' object has no attribute 'treno' | Usi il punto su un dizionario, per esempio sul risultato di model_dump() | Su un dizionario le quadre: d["treno"]. Oppure usa l'oggetto, prima di model_dump() |
TypeError: 'SegnalazioneNuova' object is not subscriptable | Usi le quadre su un oggetto: dati["treno"] | Su un oggetto il punto: dati.treno |
L'ultima, dentro una rotta, non è un 422: i dati erano giusti, e l'errore è nel tuo codice. Il client riceve 500 Internal Server Error, e il traceback lo trovi nel terminale del server. Come seguirlo riga per riga: Il debugger su FastAPI e nei test.
Il 422 letto bene
Ogni elemento di detail ha un type. È il nome dell'errore, lo stesso che vedi tra quadre in un ValidationError ([type=…]). Quelli che incontri di più:
type | Il msg (un esempio) | Vuol dire | Cosa fai |
|---|---|---|---|
missing | Field required | Il campo non è arrivato | Il client lo deve mandare. Se è facoltativo: = None nello stampo. Controlla anche il nome: una lettera diversa e il campo «non c'è» |
int_parsing | Input should be a valid integer, unable to parse string as an integer | Un testo che non si legge come intero: "tanti" | Il client manda un numero ("3" va bene) |
int_from_float | Input should be a valid integer, got a number with a fractional part | Un numero con la virgola dove serve un intero | Il client manda un intero; oppure, se la virgola ha senso, float nello stampo |
string_type | Input should be a valid string | Dove serve un testo è arrivato un numero, o null | Se null deve passare: str | None = None |
greater_than_equal | Input should be greater than or equal to 1 | Sotto il limite di ge | Il dato è sbagliato; oppure il limite: ge o gt? |
greater_than | Input should be greater than 0 | Uguale o sotto il limite di gt | Come sopra: lo zero è ammesso? |
less_than_equal | Input should be less than or equal to 5 | Sopra il limite di le | Il dato è sbagliato; oppure il limite |
less_than | Input should be less than 100 | Uguale o sopra il limite di lt | Il 100 è ammesso? Allora le=100 |
literal_error | Input should be 'porte', 'freni', 'luci' or 'clima' | Non è uno dei valori ammessi | Spesso è una maiuscola: "Porte". Il msg elenca quelli giusti |
string_too_short | String should have at least 3 characters | Testo più corto di min_length | Il client manda il testo intero |
string_too_long | String should have at most 3 characters | Testo più lungo di max_length | Come sopra |
model_attributes_type | Input should be a valid dictionary or object to extract fields from | Il corpo non è JSON: quasi sempre curl con -d ma senza l'header | Aggiungi -H "Content-Type: application/json" |
E loc, l'indirizzo dell'errore: ["body", "gravita"] vuol dire «nel corpo della richiesta, il campo gravita». Se loc è solo ["body"], il problema è il corpo intero, non un campo. E se il primo pezzo è "path" o "query", lo stampo non c'entra: il guaio è nell'indirizzo, e lo racconta La forma della chiamata.
Un test rosso con il 422
Nell'esercizio dei rimborsi i test chiamano la rotta con TestClient. Ecco cosa si legge se la nota dello stampo è str | None, senza = None:
palestra/test_rimborsi.py::test_un_rimborso_giusto FAILED [ 14%]
palestra/test_rimborsi.py::test_un_ora_di_ritardo_rimborsa_tutto PASSED [ 28%]
…
> assert risposta.status_code == 200, "Dati giusti, senza nota: 200. Se è 422, leggi il detail: quale campo?"
E AssertionError: Dati giusti, senza nota: 200. Se è 422, leggi il detail: quale campo?
E assert 422 == 200
E + where 422 = <Response [422 Unprocessable Content]>.status_codeSi legge così:
| Leggi | Vuol dire | Cosa fai |
|---|---|---|
assert 422 == 200 | Il test manda dati giusti, e lo stampo li rifiuta: una regola è troppo stretta | Manda lo stesso JSON da /docs e leggi il detail: loc dice il campo. Molto spesso è un facoltativo senza = None |
assert 200 == 422 | Il test manda dati sbagliati, e lo stampo li accetta: manca una regola | Guarda il nome del test (test_canale_sconosciuto, test_ritardo_troppo_corto): ti dice quale campo, e quale regola manca |
assert 'greater_than' == 'greater_than_equal' | Il 422 c'è, il campo è quello giusto, ma la regola no: hai scritto gt=15 al posto di ge=15 | Il confine è ammesso? 15 minuti di ritardo danno il rimborso: ge |
assert ['body', 'nota'] == ['body', 'ritardo'] | Il 422 c'è, ma il primo errore di detail è su un altro campo: qui la nota, obbligatoria per sbaglio, scritta per prima nello stampo | Sistema il campo che compare a sinistra (qui: nota: str | None = None), poi rilancia |
AttributeError: 'RichiestaRimborso' object has no attribute 'ritardo' | Lo stampo è ancora vuoto, o un campo ha un altro nome: la rotta legge richiesta.ritardo e non lo trova | I cinque campi, con i nomi della docstring |
Nel test leggi Unprocessable Content, nel terminale del server Unprocessable Entity: sono due nomi dello stesso 422, quello nuovo e quello vecchio.
Gli errori che non danno errori
I più difficili sono quelli senza traceback: tutto gira, e un dato è sbagliato.
Il campo scritto male nel JSON. Lo stampo butta via i campi che non conosce. Se il client manda "note" invece di "nota", e la nota è facoltativa, nessun errore: la nota vale None, e quello che c'era scritto sparisce. Se un dato «si perde», confronta i nomi del JSON con quelli dello stampo, lettera per lettera.
Il campo dimenticato nella versione lunga. Treno(id=7, codice=dati.codice, tipo=dati.tipo, vagoni=dati.vagoni): il guasto, facoltativo, diventa None in silenzio. Con **dati.model_dump() non succede.
Il confine sbagliato. ge al posto di gt (o lt al posto di le): tutti i dati normali passano, e solo il confine fa la cosa sbagliata. I test sul confine (0, 100) sono lì per questo.
Il tipo quasi giusto. zone: float al posto di int: "3" diventa 3.0, e 3.0 == 3 è vero. Passa tutto, anche 2,5 zone.
Il facoltativo a metà. nota: str = None funziona finché il client non manda la nota. Il giorno che arriva "nota": null, è un 422.
Se il problema non è il codice
No module named 'pydantic' (o 'fastapi'), pytest: command not found, il pannello Testing vuoto: non è il tuo codice, è il venv spento o il Python sbagliato. Ha una pagina sua nel Pronto soccorso: pytest non parte, o non trova niente. Address already in use e /docs che da Windows non si apre sono nel Pronto soccorso, alla voce FastAPI.