Giới thiệu

Trong Python, việc lựa chọn giữa pydantic.BaseModel và dataclasses.dataclass là điều thường gặp đối với các lập trình viên. Cả hai đều được sử dụng để định nghĩa cấu trúc dữ liệu với các thuộc tính có kiểu, nhưng chúng có những mục đích và đặc điểm khác nhau. Trong bài viết này, chúng ta sẽ khám phá những ưu điểm của việc sử dụng pydantic.BaseModel so với dataclasses.dataclass và khi nào nên sử dụng từng loại.

Tại sao chọn pydantic.BaseModel?

1. Xác thực dữ liệu tự động

• BaseModel của Pydantic thực hiện xác thực dữ liệu tự động dựa trên các kiểu đã được định nghĩa. Ví dụ, nếu bạn định nghĩa một thuộc tính kiểu str nhưng lại truyền vào một số nguyên, Pydantic sẽ ném ra một ngoại lệ (ValidationError) với thông tin chi tiết.
• Ví dụ:

from pydantic import BaseModel

class Request(BaseModel):
    text: str

# Hợp lệ
req = Request(text="Xin chào")
print(req)  # Request(text='Xin chào')

# Không hợp lệ
req = Request(text=123)  # Gây ra ValidationError

• Ngược lại, với dataclass, bạn có thể gán bất kỳ kiểu dữ liệu nào cho thuộc tính mà không có xác thực tự động.

2. Chuyển đổi kiểu tự động

• Pydantic sẽ cố gắng chuyển đổi giá trị sang kiểu mong đợi khi có thể. Ví dụ, nếu thuộc tính text mong đợi một chuỗi (str), nhưng bạn truyền vào số như 123, Pydantic sẽ tự động chuyển đổi nó thành chuỗi.
• Ví dụ:

req = Request(text=123)  # Tự động chuyển đổi 123 thành "123"

• Trong khi đó, dataclass không có khả năng chuyển đổi tự động này.

3. Hỗ trợ các kiểu phức tạp và tùy chỉnh

• Pydantic hỗ trợ nhiều kiểu dữ liệu phức tạp như List, Dict, Optional, Union, và thậm chí là các mô hình lồng nhau, với khả năng xác thực tự động ở mọi cấp độ.
• Ví dụ:

from pydantic import BaseModel
from typing import List

class Item(BaseModel):
    name: str

class Request(BaseModel):
    text: str
    items: List[Item]

req = Request(text="test", items=[{"name": "item1"}, {"name": "item2"}])

• Đối với dataclass, bạn sẽ cần phải tự thực hiện xác thực cho các dữ liệu lồng nhau.

4. Chuẩn hóa và giải nén dữ liệu

• Pydantic giúp dễ dàng chuyển đổi các đối tượng sang các định dạng như JSON và từ JSON về đối tượng thông qua các phương thức như model_dump() hoặc model_dump_json().
• Ví dụ:

req = Request(text="test")
print(req.model_dump())  # {'text': 'test'}
print(req.model_dump_json())  # '{"text":"test"}'

• Với dataclass, bạn sẽ cần các thư viện bổ sung hoặc phải tự triển khai các phương thức để thực hiện việc này.

5. Tích hợp với APIs và frameworks web

• Pydantic được sử dụng rộng rãi trong các frameworks như FastAPI vì nó tích hợp hoàn hảo với việc xác thực dữ liệu đầu vào/ra của APIs, phân tích cú pháp JSON và tự động tạo các sơ đồ OpenAPI.
• Ví dụ với FastAPI:

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Request(BaseModel):
    text: str

@app.post("/request")
async def create_request(req: Request):
    return req

• Đối với dataclass, bạn sẽ cần thêm logic để xác thực và phân tích cú pháp dữ liệu đầu vào.

6. Cấu hình linh hoạt và tùy chỉnh

• Pydantic cho phép cấu hình nâng cao, chẳng hạn như xác thực tùy chỉnh bằng cách sử dụng decorators (@field_validator) hoặc cấu hình toàn cục thông qua ConfigDict.
• Ví dụ:

from pydantic import BaseModel, field_validator

class Request(BaseModel):
    text: str

    @field_validator("text")
    def text_must_not_be_empty(cls, v):
        if not v.strip():
            raise ValueError("Text không được để trống")
        return v

• Với dataclass, bạn sẽ phải thực hiện xác thực một cách thủ công, thường trong phương thức __post_init__, có thể kém thanh lịch hơn.

7. Hỗ trợ sơ đồ JSON

• Pydantic tự động tạo sơ đồ JSON cho các mô hình của bạn, điều này rất hữu ích cho tài liệu và xác thực APIs.
• Ví dụ:

print(Request.model_json_schema())

• Đối với dataclass, bạn sẽ cần các thư viện bổ sung hoặc phải tự thực hiện để tạo sơ đồ JSON.

8. Xử lý dữ liệu tùy chọn và mặc định

• Pydantic xử lý tốt các giá trị tùy chọn, giá trị mặc định và các trường bắt buộc, với xác thực tự động.
• Ví dụ:

from pydantic import BaseModel
from typing import Optional

class Request(BaseModel):
    text: str
    optional_field: Optional[str] = None

• Trong dataclass, bạn có thể định nghĩa các giá trị mặc định, nhưng không có xác thực tự động để đảm bảo tính hợp lệ với các kiểu tùy chọn.

Khi nào nên sử dụng dataclass thay vì BaseModel?

• Các trường hợp đơn giản không cần xác thực: Nếu bạn chỉ cần một cấu trúc dữ liệu nhẹ mà không cần xác thực hoặc chuỗi hóa tự động, dataclass là lựa chọn đơn giản hơn và ít tốn kém hơn.
• Hiệu suất: dataclass thường nhẹ hơn về hiệu suất vì không thực hiện xác thực tự động.
• Dự án không có phụ thuộc bên ngoài: dataclass là một phần của thư viện tiêu chuẩn của Python (từ Python 3.7), trong khi Pydantic là một phụ thuộc bên ngoài.

Kết luận

Lợi thế chính của việc sử dụng pydantic.BaseModel so với dataclasses.dataclass trong lớp Request của bạn là xác thực tự động, chuyển đổi kiểu, chuẩn hóa/giải nén và tích hợp với APIs. Nếu bạn đang làm việc với dữ liệu đầu vào (như trong các APIs REST, phân tích cú pháp JSON hoặc biểu mẫu), Pydantic là lựa chọn tốt hơn vì nó giảm thiểu nhu cầu viết mã boilerplate cho xác thực và phân tích cú pháp. Tuy nhiên, nếu bạn chỉ cần một cấu trúc dữ liệu đơn giản và không muốn có các phụ thuộc bên ngoài, dataclass có thể là đủ.