ਤੁਸੀਂ Pydantic ਵਿੱਚ ਕਸਟਮ ਵੈਲੀਡੇਸ਼ਨ ਕਿਵੇਂ ਲਿਖਦੇ ਹੋ?

Question

Accepted Answer

ਬਿਲਟ-ਇਨ constraints ਤੋਂ ਬਾਹਰ, Pydantic ਤੁਹਾਨੂੰ **ਕਸਟਮ ਵੈਲੀਡੇਸ਼ਨ ਲਾਜਿਕ** field validators (ਇੱਕ ਫੀਲਡ ਦੀ ਜਾਂਚ ਕਰਨਾ) ਅਤੇ model validators (ਮਲਟੀਪਲ ਫੀਲਡ ਦੀ ਜਾਂਚ ਕਰਨਾ) ਦੇ ਨਾਲ ਲਿਖਣ ਦਿੰਦਾ ਹੈ — ਉਨ੍ਹਾਂ ਨਿਯਮਾਂ ਲਈ ਜਿਹਨਾਂ ਨੂੰ ਸਧਾਰਨ constraints ਪ੍ਰਗਟ ਨਹੀਂ ਕਰ ਸਕਦੇ। (ਸਿੰਟੈਕਸ Pydantic v2 ਲਈ ਦਿਖਾਇਆ ਗਿਆ ਹੈ।)

## Field validators — ਇੱਕ ਫੀਲਡ ਨੂੰ ਵੈਲੀਡੇਟ/ਟਰਾਂਸਫਰਮ ਕਰੋ

```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` ਇੱਕ ਫੀਲਡ ਉੱਤੇ ਕਸਟਮ ਲਾਜਿਕ ਚਲਾਉਂਦਾ ਹੈ: ਗਲਤ input ਨੂੰ ਰੱਦ ਕਰਨ ਲਈ `ValueError` ਚਾੜ੍ਹੋ (FastAPI ਇਸਨੂੰ ਸਪਸ਼ਟ 422 ਵਿੱਚ ਬਦਲ ਦਿੰਦਾ ਹੈ), ਜਾਂ ਇੱਕ ਟਰਾਂਸਫਰਮ ਕੀਤਾ ਮੁੱਲ ਵਾਪਸ ਕਰੋ (ਉਦਾਹਰਨ ਲਈ ਛੋਟੇ ਅੱਖਰਾਂ ਵਿੱਚ ਸਧਾਰਨ ਬਣਾਉਣਾ)।

## Model validators — ਕਰਾਸ-ਫੀਲਡ ਵੈਲੀਡੇਸ਼ਨ

```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")` ਸਾਰੀਆਂ ਫੀਲਡਾਂ ਦੀ ਵੈਲੀਡੇਸ਼ਨ ਤੋਂ ਬਾਅਦ ਚਲਾਇਆ ਜਾਂਦਾ ਹੈ, ਪੂਰੇ ਮਾਡਲ ਤੱਕ ਪਹੁੰਚ ਦੇ ਨਾਲ — **ਮਲਟੀਪਲ ਫੀਲਡ** ਸ਼ਾਮਲ ਨਿਯਮਾਂ ਲਈ ਵਰਤਿਆ ਜਾਂਦਾ ਹੈ (ਜਿਵੇਂ ਪਾਸਵਰਡ ਮੇਲ ਖਾਣਾ, ਜਾਂ ਸ਼ੁਰੂਆਤ ਮਿਤੀ ਅੰਤ ਮਿਤੀ ਤੋਂ ਪਹਿਲਾਂ ਹੋਣੀ)।

## ਬਿਲਟ-ਇਨ ਵੈਲੀਡੇਸ਼ਨ ਅਕਸਰ ਪਹਿਲਾਂ ਸਾਫ ਹੁੰਦੀ ਹੈ

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

ਸਧਾਰਨ ਨਿਯਮਾਂ ਲਈ `Field` constraints ਅਤੇ ਸਪੈਸ਼ਲਾਈਜ਼ਡ ਕਿਸਮਾਂ ਤਰਜੀਹ ਦਿਓ; ਪ੍ਰਲੋਭਨ ਲਾਜਿਕ ਲਈ ਕਸਟਮ validators ਵਰਤੋ।

## ਇਸ ਦਾ ਮਹੱਤਵ

Custom Pydantic ਵੈਲੀਡੇਸ਼ਨ ਵਪਾਰਕ ਨਿਯਮਾਂ ਨੂੰ ਲਾਗੂ ਕਰਨ ਲਈ ਮਹੱਤਵਪੂਰਨ ਹੈ ਜੋ ਸਧਾਰਨ ਕਿਸਮ ਦੀਆਂ ਜਾਂਚਾਂ ਅਤੇ constraints ਤੋਂ ਪਾਰ ਹਾਂ — ਅਤੇ ਕਿਉਂਕਿ ਵੈਲੀਡੇਸ਼ਨ **ਸੁਰੱਖਿਆ ਅਤੇ ਡਾਟਾ ਇਕਸਾਰਤਾ** ਲਈ ਅਹਾਮ ਹੈ, ਕਿਸੇ ਵੀ ਨਿਯਮ ਨੂੰ ਪ੍ਰਗਟ ਕਰਨ ਦੀ ਯੋਗਤਾ ਕੀਮਤੀ ਹੈ। **Field validators** ਸਿੰਗਲ-ਫੀਲਡ ਲਾਜਿਕ (ਕਸਟਮ ਫਾਰਮੈਟ ਜਾਂਚ, ਸਧਾਰਨ/ਟਰਾਂਸਫਰਮੇਸ਼ਨ) ਹੈਂਡਲ ਕਰਦੇ ਹਨ, ਜਦਕਿ **model validators** **ਕਰਾਸ-ਫੀਲਡ ਵੈਲੀਡੇਸ਼ਨ** ਦੀ ਆਮ ਲੋੜ ਨੂੰ ਹੈਂਡਲ ਕਰਦੇ ਹਨ (ਪਾਸਵਰਡ ਮੇਲ ਖਾਣਾ, ਮਿਤੀ ਰੇਜ, ਸ਼ਰਤੀ ਲੋੜਾਂ) ਜੋ field-level ਨਿਯਮ ਪ੍ਰਗਟ ਨਹੀਂ ਕਰ ਸਕਦੇ।

Validators FastAPI ਦੇ ਨਾਲ ਅਚਨਚੁਸਤੀ ਏਕੀਕ੍ਰਿਤ ਹਨ — ਇੱਕ ਉਠਾਇਆ ਗਿਆ `ValueError` ਸਵੈਚਾਲਤ ਤੌਰ ਤੇ ਸਪਸ਼ਟ 422 ਰੈਸਪਾਂਸ ਬਣ ਜਾਂਦਾ ਹੈ।

ਇਹ ਸਮਝਣਾ ਕਿ ਬਿਲਟ-ਇਨ constraints/ਕਿਸਮਾਂ (ਸਧਾਰਨ ਨਿਯਮਾਂ ਲਈ) ਬਨਾਮ ਕਸਟਮ validators (ਅਸਲ ਵਪਾਰਕ ਲਾਜਿਕ ਲਈ) ਕਦੋਂ ਵਰਤਣਾ ਹੈ, ਅਤੇ field ਬਨਾਮ model validators ਕਿਵੇਂ ਵੱਖ ਹਨ, ਤੁਹਾਨੂੰ ਯਕੀਨੀ ਬਣਾਉਂਦਾ ਹੈ ਕਿ ਆਉਂਦਾ ਡਾਟਾ ਤੁਹਾਡੀ ਐਪਲੀਕੇਸ਼ਨ ਦੀਆਂ ਲੋੜਾਂ ਨੂੰ ਪੂਰੀ ਤਰ੍ਹਾਂ ਪੂਰਾ ਕਰਦਾ ਹੈ, ਇਸ ਨੂੰ ਮਜ਼ਬੂਤ, ਸਹੀ APIs ਬਣਾਉਣ ਲਈ ਮਹੱਤਵਪੂਰਨ ਜਾਣਕਾਰੀ ਬਣਾਉਂਦਾ ਹੈ।