Bagaimana cara menulis validasi kustom di Pydantic?

Question

Accepted Answer

Selain batasan bawaan, Pydantic memungkinkan Anda menulis **logika validasi kustom** dengan field validators (memvalidasi satu field) dan model validators (memvalidasi di seluruh beberapa field) — untuk aturan yang tidak dapat diungkapkan dengan batasan sederhana. (Sintaks yang ditunjukkan adalah Pydantic v2.)

## Field validators — validasi/transformasi satu field

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

Sebuah `@field_validator` menjalankan logika kustom pada field: naikkan `ValueError` untuk menolak input yang tidak valid (FastAPI mengubahnya menjadi 422 yang jelas), atau kembalikan nilai yang ditransformasi (misalnya normalisasi ke huruf kecil).

## Model validators — validasi lintas field

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

Sebuah `@model_validator(mode="after")` berjalan setelah semua field divalidasi, dengan akses ke seluruh model — digunakan untuk aturan yang melibatkan **beberapa field** (misalnya mengonfirmasi password cocok, atau bahwa tanggal mulai mendahului tanggal akhir).

## Validasi bawaan sering kali 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
```

Lebihkan batasan `Field` dan tipe khusus untuk aturan sederhana; gunakan validator kustom untuk logika bisnis yang sebenarnya.

## Mengapa ini penting

Validasi Pydantic kustom penting untuk menegakkan aturan bisnis yang melampaui pemeriksaan tipe sederhana dan batasan — dan karena validasi sangat penting untuk **keamanan dan integritas data**, kemampuan untuk mengungkapkan aturan apa pun sangat berharga. **Field validators** menangani logika single-field (pemeriksaan format kustom, normalisasi/transformasi), sementara **model validators** menangani kebutuhan umum untuk **validasi lintas field** (password cocok, rentang tanggal, persyaratan bersyarat) yang tidak dapat diungkapkan oleh aturan tingkat field.

Validator terintegrasi dengan mulus dengan FastAPI — `ValueError` yang dinaikkan otomatis menjadi respons 422 yang jelas.

Memahami kapan harus menggunakan batasan/tipe bawaan (untuk aturan sederhana) versus validator kustom (untuk logika bisnis nyata), dan bagaimana perbedaan field versus model validators, memungkinkan Anda memastikan data masuk sepenuhnya memenuhi persyaratan aplikasi Anda, menjadikan pengetahuan ini penting untuk membangun API yang robust dan benar.