Miten kirjoitat mukautettua validointia Pydanticissa?

Question

Accepted Answer

Sisäänrakennettujen rajoitusten lisäksi Pydantic sallii sinun kirjoittaa **mukautettua validointilogiikkaa** kenttävalidaattoreilla (yhden kentän validointi) ja mallividaattoreilla (usean kentän validointi) — säännöille, joita yksinkertaiset rajoitukset eivät pysty ilmaisemaan. (Esitetty syntaksi on Pydantic v2.)

## Kenttävalidaattorit — yhden kentän validointi ja muunnos

```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` suorittaa mukautettua logiikkaa kentässä: nosta `ValueError` hylätäksesi virheellisen syötteen (FastAPI muuttaa sen selkeäksi 422:ksi) tai palauta muunnettu arvo (esim. normalisoiminen pieniksi kirjaimiksi).

## Mallividaattorit — usean kentän validointi

```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")` suoritetaan kaikkien kenttien validoinnin jälkeen, koko mallin käyttöönoton kanssa — käytetään säännöille, jotka sisältävät **useita kenttiä** (esim. salasanojen vastaavuuden varmistaminen tai aloituspäivän varmistaminen ennen päättymispäivää).

## Sisäänrakennettu validointi usein riittää ensin

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

Suosi `Field`-rajoituksia ja erikoistuneita tyyppejä yksinkertaisille säännöille; käytä mukautettuja validaattoreita todelliselle liiketoimintalogiikalle.

## Miksi se on tärkeää

Mukautettu Pydantic-validointi on tärkeää liiketoimintasääntöjen pakottamiselle, jotka menevät yksinkertaisten tyyppitarkistusten ja rajoitusten pidemmälle — ja koska validointi on kriittinen **turvallisuuden ja tietojen eheyden** kannalta, kyvyn ilmaista mikä tahansa sääntö on arvokasta. **Kenttävalidaattorit** käsittelevät yhden kentän logiikkaa (mukautettuja muotojen tarkistuksia, normalisointia/muunnosta), kun taas **mallividaattorit** käsittelevät tavallisen tarpeen **usean kentän validointiin** (salasanojen vastaavuus, päivämäärävällit, ehdolliset vaatimukset), joita kenttätason säännöt eivät pysty ilmaisemaan.

Validaattorit integroituvat saumattomasti FastAPIiin — nostettu `ValueError` muuttuu automaattisesti selkeäksi 422-vastaukseksi.

Ymmärtäminen siitä, milloin käytetään sisäänrakennettuja rajoituksia/tyyppejä (yksinkertaisille säännöille) vai mukautettuja validaattoreita (todelliselle liiketoimintalogiikalle), ja miten kenttä- vs mallividaattorit eroavat toisistaan, antaa sinulle mahdollisuuden varmistaa, että saapuvat tiedot täyttävät täysin sovelluksesi vaatimukset, mikä tekee tästä tärkeää tietoa vankkoja ja oikeita API:ita rakennettaessa.