Valider des données Python avec Pydantic

​

Introduction

• Cet article vous guide dans la validation de données avec pydantic, une bibliothèque Python dont le cœur de validation (pydantic-core) est écrit en Rust. Les exemples utilisent pydantic v2.
• Avant de commencer, assurez-vous d’avoir Python et la bibliothèque pydantic installés dans votre environnement. Consultez la commande d’installation de pydantic ci-dessous.

pip install pydantic

​

Créer un modèle

• Tout d’abord, nous devons importer et faire hériter notre classe de pydantic.BaseModel pour commencer la validation. Dans notre exemple, nous allons créer une classe nommée Person qui aura un nom, un âge et un e-mail.

from pydantic import BaseModel

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

• Avec cette classe, lorsque nous l’instancions, pydantic vérifiera que name et email sont des chaînes de caractères et que age est un entier.

​

Utiliser le modèle

• Maintenant que nous l’avons créée, nous allons instancier la classe. Nous allons créer un dict contenant les données et le décompacter dans notre classe.

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

• L’exemple ci-dessus ne déclenchera aucune erreur puisque tous les champs sont du bon type. Par défaut, pydantic convertit aussi les valeurs compatibles : si age est la chaîne "19", elle devient l’entier 19. Nous allons maintenant fournir des données incorrectes pour confirmer que notre validation fonctionne.

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

• L’exemple ci-dessus déclenche une ValidationError car age doit être un entier et "nineteen" ne peut pas être converti en entier :

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]

• Pour gérer l’erreur au lieu de laisser votre programme s’arrêter, interceptez-la avec try/except. Sa méthode errors() liste chaque champ invalide :

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

​

Mode strict

• Si vous voulez aussi rejeter les chaînes comme "19", activez le mode strict dans le modèle. age n’accepte alors qu’un vrai int, et Person(name="John", age="19", email="john@example.com") déclenche ValidationError.

from pydantic import BaseModel, ConfigDict

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

    name: str
    age: int
    email: str

​

Créer une dataclass

• Vous pouvez également créer des dataclasses avec pydantic. Elles sont similaires aux dataclasses standard de Python, mais valident leurs champs comme BaseModel.

from pydantic.dataclasses import dataclass

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

• Si nous envoyons la chaîne "19" à age, elle sera convertie en int 19.

​

Extras

• Pydantic propose quelques extras, comme la validation des e-mails et un paquet de repli pour les fuseaux horaires. Pour les installer, exécutez les commandes suivantes :

pip install "pydantic[email]"

pip install "pydantic[timezone]"

• Vous pouvez installer les deux ensemble en exécutant la commande suivante.

pip install "pydantic[email,timezone]"

• pydantic[email] ajoute le type EmailStr, qui valide le format user@domain.tld et normalise l’adresse.

from pydantic import EmailStr
from pydantic.dataclasses import dataclass

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

​

Valider les variables d’environnement au démarrage

• Les bots et les API lisent leurs tokens et leurs paramètres depuis des variables d’environnement. Avec pydantic-settings, une variable manquante ou invalide arrête l’application au démarrage avec une erreur claire, au lieu d’échouer plus tard en pleine requête.

pip install pydantic-settings

• Déclarez les variables dont votre application a besoin dans une classe qui hérite de BaseSettings. Chaque champ lit la variable d’environnement du même nom, sans tenir compte de la casse : discord_token lit 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()

• Si DISCORD_TOKEN n’est pas définie, Settings() déclenche une ValidationError pour discord_token avec le message Field required. Une valeur comme PORT=abc échoue de la même façon, car port doit être un entier.
• SecretStr masque le token lorsque vous affichez ou journalisez les paramètres. Lisez la vraie valeur avec settings.discord_token.get_secret_value().
• Sur Square Cloud, définissez les variables dans le tableau de bord ou avec squarecloud app env set, et listez pydantic-settings dans votre requirements.txt. Consultez Variables d’environnement.

​

Prochaines étapes

​

Avez-vous aimé cet article ?

• Nous avons créé ce contenu avec le plus grand soin afin d’offrir la meilleure aide possible. Si cet article vous a aidé d’une quelconque manière, soutenez notre travail ! Les développeurs ont déjà noté Square Cloud 4,9/5 sur 402 avis sur Google et Trustpilot, laissez le vôtre aussi ! Cela nous aide à comprendre ce qui compte le plus pour vous.