Valida i dati Python con Pydantic

​

Introduzione

• Questo articolo ti guida attraverso la validazione dei dati con pydantic, una libreria Python il cui core di validazione (pydantic-core) è scritto in Rust. Gli esempi usano pydantic v2.
• Prima di iniziare, assicurati di avere Python e la libreria pydantic installati nel tuo ambiente. Controlla il comando di installazione di pydantic qui sotto.

pip install pydantic

​

Creare un modello

• Per prima cosa, dovremo importare e far ereditare la nostra classe da pydantic.BaseModel per iniziare a validare. Nel nostro esempio creeremo una classe chiamata Person che avrà un nome, un’età e un’e-mail.

from pydantic import BaseModel

class Person(BaseModel):
    name: str
    age: int
    email: str

• Con questa classe, quando la istanziamo, pydantic verifica che name ed email siano stringhe e che age sia un intero.

​

Usare il modello

• Ora che l’abbiamo creata, istanzieremo la classe. Creeremo un dict contenente i dati e lo spacchetteremo nella nostra classe.

data = {
    "name": "John",
    "age": 19,
    "email": "john@example.com"
}
person = Person(**data)

• L’esempio qui sopra non solleva alcun errore perché tutti i campi sono del tipo corretto. Per impostazione predefinita, pydantic converte anche i valori compatibili: se age è la stringa "19", diventa l’intero 19. Ora invieremo dei dati errati per verificare che la nostra validazione funzioni.

data = {
    "name": "John",
    "age": "nineteen",
    "email": "john@example.com"
}
person = Person(**data)

• L’esempio qui sopra solleva un ValidationError perché age deve essere un intero e "nineteen" non può essere convertito in un intero:

1 validation error for Person
age
  Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='nineteen', input_type=str]

• Per gestire l’errore invece di lasciare che fermi il tuo programma, catturalo con try/except. Il suo metodo errors() elenca ogni campo non valido:

from pydantic import ValidationError

try:
    Person(name="John", age="nineteen", email="john@example.com")
except ValidationError as error:
    for item in error.errors():
        print(item["loc"], item["msg"])
# ('age',) Input should be a valid integer, unable to parse string as an integer

​

Strict mode

• Se vuoi rifiutare anche stringhe come "19", abilita la strict mode nel modello. In questo modo age accetta solo un vero int, e Person(name="John", age="19", email="john@example.com") solleva ValidationError.

from pydantic import BaseModel, ConfigDict

class Person(BaseModel):
    model_config = ConfigDict(strict=True)

    name: str
    age: int
    email: str

​

Creare una dataclass

• Puoi anche creare delle dataclass con pydantic. Sono simili alle dataclass standard di Python, ma validano i loro campi come BaseModel.

from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: str

• Se inviamo la stringa "19" ad age, verrà convertita nell’int 19.

​

Extra

• Pydantic ha alcuni extra, come la validazione delle e-mail e un pacchetto timezone di fallback. Per installarli, esegui i seguenti comandi:

pip install "pydantic[email]"

pip install "pydantic[timezone]"

• Puoi installarli entrambi insieme eseguendo il seguente comando.

pip install "pydantic[email,timezone]"

• pydantic[email] aggiunge il tipo EmailStr, che valida il formato user@domain.tld e normalizza l’indirizzo.

from pydantic import EmailStr
from pydantic.dataclasses import dataclass

@dataclass
class Person:
    name: str
    age: int
    email: EmailStr

​

Validare le variabili d’ambiente all’avvio

• Bot e API leggono token e impostazioni dalle variabili d’ambiente. Con pydantic-settings, una variabile mancante o non valida ferma l’applicazione all’avvio con un errore chiaro, invece di farla fallire più tardi nel mezzo di una richiesta.

pip install pydantic-settings

• Dichiara le variabili di cui ha bisogno la tua applicazione in una classe che eredita da BaseSettings. Ogni campo legge la variabile d’ambiente con lo stesso nome, senza distinguere maiuscole e minuscole: discord_token legge DISCORD_TOKEN.

from pydantic import SecretStr
from pydantic_settings import BaseSettings


class Settings(BaseSettings):
    discord_token: SecretStr  # required: the application doesn't start without it
    port: int = 80  # optional: 80 when PORT isn't set
    debug: bool = False


settings = Settings()

• Se DISCORD_TOKEN non è impostata, Settings() solleva un ValidationError per discord_token con il messaggio Field required. Un valore come PORT=abc fallisce allo stesso modo, perché port deve essere un intero.
• SecretStr nasconde il token quando stampi o registri nei log le impostazioni. Leggi il valore reale con settings.discord_token.get_secret_value().
• Su Square Cloud, imposta le variabili dalla dashboard o con squarecloud app env set, ed elenca pydantic-settings nel tuo requirements.txt. Consulta Variabili d’ambiente.

​

Prossimi passi

​

Ti è piaciuto questo articolo?

• Abbiamo creato questo contenuto con grande cura per offrirti il miglior aiuto possibile. Gli sviluppatori hanno già valutato Square Cloud 4,9/5 su 402 recensioni su Google e Trustpilot: lascia anche tu la tua! Ci aiuta a capire cosa conta di più per te.