Bagaimana anda menulis pengesahan adat dalam Pydantic?

Question

Accepted Answer

Melampaui kekangan bawaan, Pydantic memungkinkan anda menulis **logik pengesahan adat** dengan field validator (mengesahkan satu bidang) dan model validator (mengesahkan beberapa bidang) — untuk peraturan yang kekangan sederhana tidak boleh mengungkapkan. (Sintaks yang ditunjukkan adalah Pydantic v2.)

## Pengesah bidang — mengesahkan/mengubah satu bidang

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

A `@field_validator` menjalankan logik adat pada bidang: naikkan `ValueError` untuk menolak input tidak sah (FastAPI mengubahnya menjadi 422 yang jelas), atau kembalikan nilai yang diubah (cth. normalisasi ke huruf kecil).

## Pengesah model — pengesahan lintas bidang

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

A `@model_validator(mode="after")` dijalankan selepas semua bidang disahkan, dengan akses ke seluruh model — digunakan untuk peraturan yang melibatkan **pelbagai bidang** (cth. mengesahkan kata laluan sepadan, atau bahawa tarikh mula mendahului tarikh akhir).

## Pengesahan bawaan sering cukup terlebih dahulu

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

Lebih suka kekangan `Field` dan jenis khusus untuk peraturan sederhana; gunakan pengesah adat untuk logik perniagaan sebenarnya.

## Mengapa ini penting

Pengesahan adat Pydantic penting untuk menguatkuasakan peraturan perniagaan yang melampaui pemeriksaan jenis sederhana dan kekangan — dan memandangkan pengesahan adalah kritikal untuk **keselamatan dan integriti data**, kemampuan untuk mengekspresikan sebarang peraturan adalah berharga. **Pengesah bidang** mengendalikan logik bidang tunggal (pemeriksaan format adat, normalisasi/penjelmaan), manakala **pengesah model** mengendalikan keperluan biasa untuk **pengesahan lintas bidang** (kata laluan sepadan, julat tarikh, keperluan bersyarat) yang peraturan peringkat bidang tidak boleh mengungkapkan.

Pengesah bersepadu dengan lancar dengan FastAPI — `ValueError` yang dinaikkan secara automatik menjadi respons 422 yang jelas.

Memahami bila menggunakan kekangan/jenis bawaan (untuk peraturan sederhana) berbanding pengesah adat (untuk logik perniagaan sebenarnya), dan bagaimana pengesah bidang berbeza dengan pengesah model, memungkinkan anda memastikan data masuk sepenuhnya memenuhi keperluan aplikasi anda, menjadikan ini pengetahuan penting untuk membina API yang kukuh dan betul.