کلاس داده (dataclass) و ماژول pydantic

یکی از امکانات جالب در پایتون ۳.۷ به بعد اضافه شدن dataclass هست. امروز و در این پست نگاهی به این کتابخوانه می‌کنیم و از ماژول مورد علاقه خودم برای مدل‌سازی pydantic هم خواهم گفت.

کلاس داده (Dataclass)

در بسیاری از پروژه ها قالب های داده داریم مثلا شخصی که در سیستم ثبت می‌شود دارای فیلد های داده مانند نام، نشانی، سن، آدرس ایمیل و … است (جداً برای فیلد هیچ معادل فارسی درستی پیدا نکردم!). یکی از روش های نگهداری و استفاده از این داده ها که ساختار و فیلد های مشخصی دارند استفاده از dataclass است.

در واقع dataclass یک decorator از کتاب‌خانه‌ی dataclasses است. کلاس داده تفاوت یا محدودیتی نسبت به یک کلاس معمولی پایتون ندارد اما می‌تواند کار را ساده‌تر کند چون که این دکوریتور خودش توابع __init__() و __repr__() را ایجاد می‌کند.

from dataclasses import dataclass, field

@dataclass
class Person:
    name:str
    lastname:str
    age:int = 0
    address:str = ""
    children: list["person"] = field(default_factory=list)

کد بالا یک مدل داده برای یک فرد را می‌سازد. دکوریتور dataclass همراه با توابع دیگر یک تابع init مانند زیر ایجاد می‌کند:

def __init__(self, name:str, lastname:str, age:int = 0, address="", children=[]):
    self.name = name
    self.lastname = lastname
    self.age = age
    ...

دقت کنید که هنگام ایجاد کلاس داده استفاده از typehint ضروری است. typehint (راهنمای نوع؟!) یک شیوه نوشتار در پایتون برای اشاره به نوع داده یک متغیر است. مثلا:

age:int

فاروق در همین مورد این مطلب رو نوشته:

تعیین نوع متغیرها در پایتون 3

استفاده از تابع field در کلاس های داده

همونطور که در مثال بالا آمده برخی فیلدها می‌توانند داده پیشفرض داشته باشند (در مثال age, address و children) اما باید دقت کنید که برای داده هایی که اسطلاحاً mutable هستند مانند list, dict ,… برای این که مشکلی پیش نیاد باید از تابع field استفاده کنید تا یک تابع مثلا list() را هنگام ایجاد یک نمونه صدا بزند و خروجی را در فیلد ذخیره کند (در غیر این صورت یک لیست مشترک بین همه نمونه ها خواهید داشت که می‌تواند برای‌تان ایجاد مشکل کند).

from datetime import datetime

@dataclass
class book:
    name:str
    author:str
    was_added_at:datetime = field(default_factory=datetime.now)
    owners:list[Person] = field(default_factory=list)

در کد بالا برای فیلد «تاریخ اضافه شدن» هنگام ایجاد یک نمونه تابع now() صدا زده می‌شود که تاریخ فعلی را باز می‌گرداند (البته اگه در ورودی ها تاریخ دیگری داده شد جایگزین می‌شود)

ماژول pydantic

اگر امکانات بیشتری نیاز داشتید حتما نگاهی به ماژول pydantic بیاندازید. این ماژول کامل با هدف مدل‌سازی داده و اعتبارسنجی داده هاست. این ماژول امکانات زیادی داره مثل خواندن و خروجی به فرمت های مختلف مثل json، تولید schema و …

جدا از این که با linter ها و ویرایشگر های کد به خوبی کار می‌کند در بسیاری از ماژول های دیگر مانند FastAPI, Beanie و … استفاده شده.

from datetime import datetime
from pydantic import BaseModel, PositiveInt

class User(BaseModel):
    id: int  
    name: str = 'John Doe'  
    signup_ts: datetime | None  
    tastes: dict[str, PositiveInt]

این ماژول علاوه بر این که همانند یک dataclass به شما امکان دسترسی به فیلد ها مختلف با نوشتار نقطه‌ای می‌دهد (dot notation) و ویرایشگر کد شما نیز به خوبی شما را راهنمایی می‌کند، صحت داده ها را می‌سنجد، مثلا نمی‌توانید برای فیلد id که از جنس عدد است یه متن وارد کنید. (البته pydantic دوست داشتنی، رشته "12" را به عدد تبدیل می‌کنه و گیر نمیده ولی اجازه نمیده که مثلا "foobar" ذخیره بشه)

مقایسه pydantic با dataclass

ماژول pydantic تمام نیاز هایی که هنگام استفاده از dataclass دارید را به خوبی پاسخگو هست و به شما بسیاری امکانات بهتر و مفید‌تر می دهد، برای مثال تبدیل یک نمونه به JSON و بلعکس به همراه اعتبارسنجی داده ها به سادگی انجام می‌شود و نوع داده های مختلفی مثل آدرس ایمیل، عدد مثبت و حتی نوع داده سفارشی شما را پشتیبانی می‌کند. کلی امکانات دیگر نیز هستند که همه‌ی آن ها را در مستندات کامل این ماژول در سایت‌شون می‌تونید بخونید.

docs.pydantic.dev