Miten hallitset asetuksia Pydanticin avulla?

Question

Accepted Answer

FastAPI-sovellukset hallitsevat konfiguraatiota **`pydantic-settings`**-kirjastolla (`BaseSettings`) — luokka, joka lukee konfiguraation **ympäristömuuttujista** (ja `.env`-tiedostoista) **validoinnin ja tyypin muunnoksen** kanssa, pitää salaisuudet koodin ulkopuolella ja varmistaa, että konfiguraatio on oikea käynnistyksen yhteydessä.

## Asetusten määrittäminen

```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` lukee automaattisesti jokaisen kentän vastaavasta **ympäristömuuttujasta** (esim. `DATABASE_URL`), muuntaa tyypit (`"true"` → `bool`, `"10"` → `int`) ja **validoi** — puuttuva vaadittu arvo tai väärä tyyppi epäonnistuu välittömästi käynnistyksen yhteydessä selkeällä virheellä (nopeasti epäonnistuu).

## Asetusten käyttäminen (riippuvuuden injektoimisen kautta)

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

Asetusten injektoiminen välimuistoidun riippuvuuden kautta tekee ne **testattaviksi** (ohita testeissä) ja varmistaa yhden instanssin.

## .env-tiedosto ja salaisuudet

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

## Miksi se on tärkeää

Oikea asetusten hallinta on sekä **operatiivinen välttämättömyys** (sovelluksilla on oltava eri konfiguraatiot dev/staging/production-ympäristöissä) että **turvallisuusvaatimus** (salaisuudet kuten tietokannan URL:t ja avaimet eivät saa koskaan olla kovakoodattuja lähdehallinnan tiedostoissa — yleinen, vakava loukkaanto).

Pydanticin `BaseSettings` tarjoaa idiomatisen FastAPI-ratkaisun, ja sen ymmärtäminen on tärkeää päivittäistä tietoa.

Sen keskeisiä etuja: konfiguraation lukeminen **ympäristömuuttujista** (salaisuuksien pitäminen koodin ulkopuolella, twelve-factor-menetelmä) automaattisen **tyypin muunnoksen ja validoinnin** kanssa — joten väärä konfiguraatio epäonnistuu nopeasti käynnistyksen yhteydessä selkeällä virheellä sen sijaan että se epäonnistuisi sekavalla ajonaikaisella virheellä.

Yhdessä riippuvuuden injektoimisen kanssa (mikä tekee asetuksista testattavia ja singletoneja) ja git-jätettyjen `.env`-tiedostojen käytännön kanssa paikallista kehitystä varten, tämä antaa sinulle turvallisen, validoidun, ympäristölle sopivan konfiguraation.

Tietäminen siitä, kuinka määrittää asetuksia, käyttää niitä riippuvuuden injektoimisen kautta ja hallita salaisuuksia turvallisesti, on perustavanlaatuista tuotantoevalmiin FastAPI-sovellusten rakentamista varten.