آپ Pydantic میں کسٹم validation کیسے لکھتے ہیں؟

Question

Accepted Answer

بلٹ ان constraints کے علاوہ، Pydantic آپ کو field validators (ایک فیلڈ کو validate کریں) اور model validators (متعدد فیلڈز میں validate کریں) کے ساتھ **کسٹم validation logic** لکھنے دیتا ہے — وہ rules کے لیے جو سادہ constraints نہیں کر سکتے۔ (دکھایا گیا syntax Pydantic v2 کا ہے۔)

## Field validators — ایک واحد فیلڈ کو validate/تبدیل کریں

```python
from pydantic import BaseModel, field_validator

class User(BaseModel):
    username: str
    password: str

@field_validator("username")
    @classmethod
    def username_alphanumeric(cls, v: str) -> str:
        if not v.isalnum():
            raise ValueError("username must be alphanumeric")   # → a 422 error
        return v.lower()                                         # can also TRANSFORM the value
```

ایک `@field_validator` ایک فیلڈ پر کسٹم logic چلاتا ہے: invalid input کو مسترد کرنے کے لیے `ValueError` کو raise کریں (FastAPI اسے ایک واضح 422 میں بدل دیتا ہے)، یا ایک تبدیل شدہ value return کریں (جیسے lowercase میں نارمل کرنا)۔

## Model validators — cross-field validation

```python
from pydantic import model_validator

class SignupForm(BaseModel):
    password: str
    confirm_password: str

@model_validator(mode="after")
    def passwords_match(self):
        if self.password != self.confirm_password:    # compare MULTIPLE fields
            raise ValueError("passwords do not match")
        return self
```

ایک `@model_validator(mode="after")` تمام فیلڈز کے validate ہونے کے بعد چلتا ہے، پورے model تک رسائی کے ساتھ — **متعدد فیلڈز** سے متعلق rules کے لیے استعمال ہوتا ہے (جیسے passwords کا match کرنا تصدیق کرنا، یا start date کو end date سے پہلے ہونا)۔

## بلٹ ان validation اکثر پہلے کافی ہوتا ہے

```python
class Product(BaseModel):
    price: float = Field(gt=0)          # use Field constraints for simple rules
    sku: str = Field(pattern=r"^[A-Z]{3}-\d+$")
    email: EmailStr                      # specialized types for formats
# reach for custom validators only when constraints/types can't express the rule
```

سادہ rules کے لیے `Field` constraints اور specialized types کو ترجیح دیں؛ حقیقی business logic کے لیے کسٹم validators استعمال کریں۔

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

کسٹم Pydantic validation اہم ہے کیونکہ یہ business rules کو enforce کرتا ہے جو سادہ type checks اور constraints سے آگے جاتے ہیں — اور چونکہ validation **security اور data integrity** کے لیے critical ہے، کسی بھی rule کو express کرنے کی صلاحیت قیمتی ہے۔ **Field validators** single-field logic کو سنبھالتے ہیں (کسٹم format checks، normalization/transformation)، جبکہ **model validators** **cross-field validation** کی عام ضرورت کو سنبھالتے ہیں (passwords کا match کرنا، date ranges، conditional requirements) جو field-level rules نہیں کر سکتے۔

validators FastAPI کے ساتھ بغیر کسی رکاوٹ کے integrate ہوتے ہیں — ایک raised `ValueError` خودکار طور پر ایک واضح 422 response بن جاتا ہے۔

یہ سمجھنا کہ بلٹ ان constraints/types (سادہ rules کے لیے) بمقابلہ کسٹم validators (حقیقی business logic کے لیے) کب استعمال کریں، اور field بمقابلہ model validators کا کیا فرق ہے، آپ کو یقینی بنانے دیتا ہے کہ incoming data آپ کی application کی تمام requirements کو پورا کرتا ہے، یہ مضبوط اور صحیح APIs بنانے کے لیے اہم معلومات ہے۔