Hur hanterar du inställningar med Pydantic?

Question

Accepted Answer

FastAPI-applikationer hanterar konfiguration med **`pydantic-settings`** (`BaseSettings`) — en klass som läser konfiguration från **miljövariabler** (och `.env`-filer) med **validering och typkonvertering**, vilket håller hemligheter utanför koden och säkerställer att konfigurationen är korrekt vid uppstart.

## Definiera inställningar

```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` läser automatiskt varje fält från en motsvarande **miljövariabel** (t.ex. `DATABASE_URL`), konverterar typer (`"true"` → `bool`, `"10"` → `int`), och **validerar** — ett saknat obligatoriskt värde eller fel typ misslyckas omedelbar vid uppstart med ett tydligt felmeddelande (fail-fast).

## Använd inställningar (via beroendeinjektion)

```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}
```

Att injicera inställningar via ett cachad beroende gör dem **testbara** (åsidosätt i tester) och säkerställer en enda instans.

## .env-filen och hemligheter

```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)
```

## Varför det är viktigt

Korrekt hantering av inställningar är både en **operativ nödvändighet** (applikationer behöver olika konfiguration mellan utveckling/staging/produktion) och ett **säkerhetskrav** (hemligheter som databastexter och nycklar får aldrig kodas hårdkodade i versionskontroll — ett vanligt, allvarligt intrång).

Pydantics `BaseSettings` tillhandahåller den idiomatiska FastAPI-lösningen, och det är viktigt att förstå den.

Dess huvudsakliga fördelar: läsa konfiguration från **miljövariabler** (håller hemligheter utanför koden, twelve-factor-metoden) med automatisk **typkonvertering och validering** — så felaktig konfiguration misslyckas snabbt vid uppstart med ett tydligt felmeddelande istället för som ett förvirrande körningsfel.

Tillsammans med beroendeinjektion (gör inställningar testbara och singleton) och praxis med `.env`-filer som ignoreras av git för lokal utveckling, ger detta dig säker, validerad, miljöanpassad konfiguration.

Att veta hur man definierar inställningar, använder dem via DI, och hanterar hemligheter säkert är grundläggande för att bygga produktionsklara FastAPI-applikationer.