یہ converter JSON ڈھانچے کو Pydantic v2 کی BaseModel کلاسز یا standard library کے @dataclass کوڈ میں بدلتا ہے۔ فیلڈز کے نام Python انداز کے مطابق snake_case میں دوبارہ لکھے جاتے ہیں، اور ہر nested آبجیکٹ کو اپنی کلاس ملتی ہے۔
اسے FastAPI کے request اور response schemas بیان کرتے وقت، requests یا httpx سے حاصل کیے گئے ڈیٹا میں type hints شامل کرتے وقت، یا string keys سے dicts کھنگالنے والے ETL اور scraping scripts کی صفائی کرتے وقت استعمال کریں۔
ٹائپ کا نام میں سب سے اوپر والے ماڈل کا نام لکھیں (مثلاً Forecast)۔اسٹائل کے نیچے validation اور aliases کے لیے Pydantic (v2) چنیں، یا بغیر dependency والے ماڈل کے لیے dataclass۔models.py جیسے module میں کاپی کریں۔ اسٹائل اور ٹائپ کا نام URL میں محفوظ رہتے ہیں۔{
"city": "Seoul",
"updatedAt": "2024-05-01T09:00:00+09:00",
"current": { "temp": 18.5, "humidity": 40 },
"hourly": [
{ "hour": 10, "temp": 19, "rain_mm": 0 },
{ "hour": 11, "temp": 20.5, "rain_mm": 0.4, "alert": "shower" }
]
}from __future__ import annotations
from pydantic import BaseModel, ConfigDict, Field
class Hourly(BaseModel):
hour: int
temp: float
rain_mm: float
alert: str | None = None
class Current(BaseModel):
temp: float
humidity: int
class Forecast(BaseModel):
model_config = ConfigDict(populate_by_name=True)
city: str
updated_at: str = Field(alias="updatedAt")
current: Current
hourly: list[Hourly]
updatedAt بنتا ہے updated_at فیلڈ، جسے Field(alias="updatedAt") سے اصل key سے جوڑا جاتا ہے۔ hourly میں temp کے اندر integers اور decimals ملے ہیں اس لیے یہ float بنتا ہے، اور صرف دوسرے item میں موجود alert بنتا ہے str | None = None۔ کلاسز child سے پہلے لکھی جاتی ہیں۔
Field(alias=...) استعمال کرتے ہیں، اور model_config = ConfigDict(populate_by_name=True) آپ کو انہیں Python نام سے بھی بھرنے دیتا ہے۔TypeError: non-default argument follows default argument سے بچنے کے لیے بغیر defaults والے فیلڈز = None والے فیلڈز سے پہلے رکھے جاتے ہیں؛ اصل key کو # JSON: "updatedAt" comment کے طور پر رکھا جاتا ہے۔str، int، float، bool، list[...]، اور ملی جلی types والی values کے لیے Any۔null والے فیلڈز بنتے ہیں X | None = None۔class، from یا type جیسے Python keywords کے آخر میں underscore لگتا ہے (class_)۔from __future__ import annotations شامل ہے تاکہ کلاسز ترتیب سے قطع نظر ایک دوسرے کا حوالہ دے سکیں۔Root = list[RootItem] جیسا alias بنتا ہے۔فرنٹ اینڈ کے ساتھ طے شدہ JSON سے BaseModels بنائیں اور انہیں response_model= میں یا endpoint parameters کے طور پر استعمال کریں؛ OpenAPI docs خودکار طور پر ساتھ چلتی ہیں۔
calls کو Forecast.model_validate(resp.json()) میں لپیٹیں، اور جب provider کسی فیلڈ کی type بدلے تو ValidationError ٹھیک اس فیلڈ path کی نشاندہی کرتا ہے جو ٹوٹا۔
data["current"]["temp"] کو forecast.current.temp میں بدلنے سے ایڈیٹر completion ملتی ہے اور mypy یا pyright کوڈ چیک کر سکتے ہیں۔
@dataclass nested dicts کو objects میں نہیں بدلتا۔ Forecast(**data) کے بعد current اب بھی dict ہے؛ nested تبدیلی چاہیے تو Pydantic یا dacite جیسا helper استعمال کریں۔updatedAt) کے ساتھ واپس serialize کرنے کے لیے model_dump(by_alias=True) یا model_dump_json(by_alias=True) کال کریں۔str | None syntax استعمال کرتا ہے، اس لیے Pydantic ماڈلز Python 3.10 یا نئے ورژن فرض کرتے ہیں۔str کی صورت میں آتی ہیں۔ Pydantic میں annotation کو datetime کر دینا ISO 8601 values parse کرنے کے لیے کافی ہے۔class Config، parse_obj) نہیں بنائی جاتیں۔populate_by_name=True کس لیے ہے؟بطور ڈیفالٹ alias والا فیلڈ ان پٹ کے طور پر صرف اپنا alias (updatedAt) قبول کرتا ہے۔ اس setting کے ساتھ آپ Forecast(updated_at=...) بھی لکھ سکتے ہیں، جو ٹیسٹس میں کارآمد ہے۔
Optional[str] پسند ہے۔str | None اور Optional[str] کا مطلب ایک ہی ہے۔ اگر آپ کو Python 3.9 مطابقت چاہیے تو typing سے Optional import کر کے annotations بدل دیں۔
سپورٹ شدہ انداز Pydantic v2 اور dataclass ہیں۔ اگر آپ کو TypedDict یا @attrs.define کلاس چاہیے تو dataclass کے فیلڈز کی فہرست سیدھی ان میں منتقل ہو جاتی ہے۔
نہیں۔ جب Python نام اصل key کے برابر ہو تو کوئی Field(alias=...) یا ConfigDict نہیں لکھا جاتا، اس لیے آپ کو rain_mm: float جیسی سادہ لائنیں ملتی ہیں۔