آپ Pydantic کے ساتھ سیٹنگز کو کیسے منظم کرتے ہیں؟

Question

Accepted Answer

FastAPI ایپلیکیشنز **`pydantic-settings`** (`BaseSettings`) کے ساتھ کنفیگریشن کو منظم کرتی ہیں — یہ ایک کلاس ہے جو **ماحول کی متغیرات** (اور `.env` فائلوں) سے کنفیگریشن پڑھتی ہے **توثیق اور قسم کی تبدیلی** کے ساتھ، اسرار کو کوڈ سے باہر رکھتی ہے اور شروعات میں کنفیگریشن کو درست رکھتی ہے۔

## سیٹنگز کی تعریف

```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` خودکار طور پر ہر فیلڈ کو ملتی جلتی **ماحول کی متغیر** سے پڑھتا ہے (مثال کے طور پر `DATABASE_URL`)، اقسام کو تبدیل کرتا ہے (`"true"` → `bool`, `"10"` → `int`)، اور **توثیق** کرتا ہے — ایک غائب ضروری قیمت یا غلط قسم فوری طور پر شروعات میں ناکام ہو جاتی ہے ایک واضح غلطی کے ساتھ (تیز ناکامی)۔

## سیٹنگز کا استعمال (منحصر انجکشن کے ذریعے)

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

کیش شدہ منحصر کے ذریعے سیٹنگز کو انجیکٹ کرنا انہیں **آزمائش کے قابل** بناتا ہے (ٹیسٹ میں تبدیل کریں) اور ایک واحد مثال کو یقینی بناتا ہے۔

## .env فائل اور اسرار

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

## یہ کیوں اہم ہے

مناسب سیٹنگز کا انتظام **عملی ضرورت** (ایپس کو dev/staging/production میں مختلف کنفیگریشن کی ضرورت ہے) اور **سیکیورٹی کی ضرورت** (ڈیٹا بیس URLs اور کلیدیں جیسے اسرار کو کبھی بھی سورس کنٹرول میں hardcoded نہیں کیا جانا چاہیے — ایک عام، سنگین خلاف ورزی) دونوں ہے۔

Pydantic کا `BaseSettings` idiomatic FastAPI حل فراہم کرتا ہے، اور اسے سمجھنا روزمرہ کا علم ہے۔

اس کے اہم فوائل: **ماحول کی متغیرات** سے کنفیگریشن پڑھنا (کوڈ سے اسرار رکھنا، بارہ عامل کا طریقہ) خودکار **قسم کی تبدیلی اور توثیق** کے ساتھ — تاکہ غلط کنفیگریشن شروعات میں ایک واضح غلطی کے ساتھ تیز ناکام ہو جاتی ہے بجائے ایک الجھن والی runtime کی خرابی کے۔

منحصر انجکشن (سیٹنگز کو آزمائش کے قابل اور singleton بنانا) اور gitignored `.env` فائلوں کی مشق کے ساتھ (مقامی ترقی کے لیے)، یہ آپ کو محفوظ، توثیق شدہ، ماحول کے لیے موزوں کنفیگریشن دیتا ہے۔

سیٹنگز کی تعریف کرنا، انہیں DI کے ذریعے استعمال کرنا، اور اسرار کو محفوظ طریقے سے سنبھالنا جاننا production-ready FastAPI ایپلیکیشنز بنانے کے لیے بنیادی ہے۔