Bagaimana anda menguruskan tetapan dengan Pydantic?

Question

Accepted Answer

Aplikasi FastAPI menguruskan konfigurasi dengan **`pydantic-settings`** (`BaseSettings`) — satu kelas yang membaca konfigurasi daripada **pemboleh ubah persekitaran (environment variables)** (dan fail `.env`) dengan **validasi dan penukaran jenis**, mengasingkan rahsia daripada kod dan memastikan konfigurasi adalah betul semasa permulaan.

## Mentakrifkan tetapan

```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` secara automatik membaca setiap medan daripada **pemboleh ubah persekitaran** yang sepadan (cth. `DATABASE_URL`), menukar jenis (`"true"` → `bool`, `"10"` → `int`), dan **mengesahkan** — nilai diperlukan yang hilang atau jenis yang salah gagal serta-merta semasa permulaan dengan ralat yang jelas (fail-fast).

## Menggunakan tetapan (melalui suntikan kebergantungan)

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

Menyuntik tetapan melalui kebergantungan yang dicache menjadikannya **boleh diuji** (ganti dalam ujian) dan memastikan satu instans tunggal.

## Fail .env dan rahsia

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

## Mengapa ia penting

Pengurusan tetapan yang betul adalah kedua-dua **keperluan operasi** (aplikasi memerlukan konfigurasi yang berlainan merentas dev/staging/produksi) dan **keperluan keselamatan** (rahsia seperti URL pangkalan data dan kunci tidak boleh sekali-kali dikodkan keras dalam kawalan sumber — pelanggaran biasa yang serius).

`BaseSettings` Pydantic menyediakan penyelesaian idiomatik FastAPI, dan memahaminya ialah pengetahuan harian yang penting.

Kelebihan utamanya: membaca konfigurasi daripada **pemboleh ubah persekitaran** (mengasingkan rahsia daripada kod, pendekatan twelve-factor) dengan **penukaran jenis dan validasi** automatik — jadi salah konfigurasi gagal pantas semasa permulaan dengan ralat yang jelas dan bukannya sebagai kegagalan masa jalan yang mengelirukan.

Digabungkan dengan suntikan kebergantungan (menjadikan tetapan boleh diuji dan singleton) serta amalan fail `.env` yang digitignore untuk pembangunan tempatan, ini memberi anda konfigurasi yang selamat, disahkan, dan sesuai dengan persekitaran.

Mengetahui cara mentakrifkan tetapan, menggunakannya melalui DI, dan mengendalikan rahsia dengan selamat adalah asas untuk membina aplikasi FastAPI yang sedia untuk produksi.