Comment gérez-vous les paramètres avec Pydantic ?

Question

Accepted Answer

Les applications FastAPI gèrent la configuration avec **`pydantic-settings`** (`BaseSettings`) — une classe qui lit la configuration depuis les **variables d'environnement** (et les fichiers `.env`) avec **validation et conversion de type**, en gardant les secrets en dehors du code et en assurant que la configuration est correcte au démarrage.

## Définir les paramètres

```python
from pydantic_settings import BaseSettings

class Settings(BaseSettings):
    app_name: str = "My API"
    database_url: str                       # required — must be provided
    secret_key: str                          # required (a secret)
    debug: bool = False
    max_connections: int = 10

class Config:
        env_file = ".env"                    # also read from a .env file

settings = Settings()                        # reads & VALIDATES env vars at startup
```

`BaseSettings` lit automatiquement chaque champ à partir d'une **variable d'environnement** correspondante (par exemple `DATABASE_URL`), convertit les types (`"true"` → `bool`, `"10"` → `int`), et **valide** — une valeur requise manquante ou un type incorrect échoue immédiatement au démarrage avec une erreur claire (fail-fast).

## Utiliser les paramètres (via l'injection de dépendances)

```python
from functools import lru_cache
from fastapi import Depends

@lru_cache                              # create the Settings once (cached)
def get_settings():
    return Settings()

@app.get("/info")
def info(settings: Settings = Depends(get_settings)):
    return {"app": settings.app_name, "debug": settings.debug}
```

Injecter les paramètres via une dépendance en cache les rend **testables** (remplacer dans les tests) et assure une seule instance.

## Le fichier .env et les secrets

```bash
# .env — local config, GITIGNORED (never commit secrets)
DATABASE_URL=postgresql://localhost/mydb
SECRET_KEY=dev-secret
DEBUG=true
```

```text
✓ Keep secrets in env vars / .env (gitignored); commit a .env.example documenting keys
✓ In production, inject config via the platform's environment / secret manager
✓ Validation at startup catches misconfiguration immediately (not deep in a request)
```

## Pourquoi c'est important

Une gestion appropriée des paramètres est à la fois une **nécessité opérationnelle** (les applications ont besoin d'une configuration différente entre dev/staging/production) et une **exigence de sécurité** (les secrets comme les URL de base de données et les clés ne doivent jamais être codés en dur dans le contrôle de source — une violation courante et grave).

La `BaseSettings` de Pydantic fournit la solution idiomatique de FastAPI, et la comprendre est une connaissance importante au quotidien.

Ses avantages clés : lire la configuration depuis les **variables d'environnement** (en gardant les secrets en dehors du code, l'approche twelve-factor) avec **conversion de type et validation** automatiques — donc une mauvaise configuration échoue rapidement au démarrage avec une erreur claire plutôt que comme une défaillance confuse à l'exécution.

Combinée avec l'injection de dépendances (rendant les paramètres testables et singleton) et la pratique des fichiers `.env` ignorés par git pour le développement local, cela vous donne une configuration sûre, validée et adaptée à l'environnement.

Savoir comment définir les paramètres, les utiliser via DI, et gérer les secrets en toute sécurité est fondamental pour construire des applications FastAPI prêtes pour la production.