JSON কে Python Pydantic model-এ রূপান্তর করুন!

JSON দিন এবং nested object সহ Python Pydantic model কোড তৈরি করুন! Pydantic v2 BaseModel, dataclass, FastAPI সমর্থিত। SQLAlchemy উপরের ট্যাবে।
JSON
ফলাফল
 

JSON কে Python Pydantic model-এ রূপান্তর করুন!

এই কনভার্টার একটি JSON গঠনকে Pydantic v2 BaseModel ক্লাস বা standard library-র @dataclass কোডে বদলে দেয়। Python স্টাইল অনুযায়ী ফিল্ডের নাম snake_case-এ নতুন করে লেখা হয়, আর প্রতিটি nested অবজেক্ট নিজস্ব ক্লাস পায়।

FastAPI-এর request ও response schema ডিফাইন করার সময়, requests বা httpx দিয়ে আনা ডেটায় type hint যোগ করার সময়, অথবা স্ট্রিং key দিয়ে dict ঘাঁটা ETL ও scraping স্ক্রিপ্ট গোছানোর সময় এটি ব্যবহার করুন।

কীভাবে ব্যবহার করবেন

  1. যে JSON মডেল করতে চান তা পেস্ট করুন।
  2. টাইপের নাম-এ top-level মডেলের নাম দিন (যেমন Forecast)।
  3. স্টাইল-এ validation আর alias-এর জন্য Pydantic (v2), অথবা নির্ভরতা ছাড়া মডেলের জন্য dataclass বেছে নিন।
  4. ফলাফলটি models.py-এর মতো একটি মডিউলে কপি করুন। স্টাইল আর type-এর নাম URL-এ সংরক্ষিত থাকে।

উদাহরণ

ইনপুট (JSON)
{
  "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" }
  ]
}
আউটপুট (Python · Pydantic v2)
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 integer আর দশমিক মিশিয়ে আছে বলে float হয়, আর শুধু দ্বিতীয় আইটেমে থাকা alert হয় str | None = None। ক্লাসগুলো child আগে রেখে লেখা হয়।

সমর্থিত বৈশিষ্ট্য

  • Pydantic v2: নাম বদলানো ফিল্ড Field(alias=...) ব্যবহার করে, আর model_config = ConfigDict(populate_by_name=True) থাকায় Python নাম দিয়েও সেগুলো পূরণ করা যায়।
  • dataclass: TypeError: non-default argument follows default argument এড়াতে default ছাড়া ফিল্ডগুলো = None ফিল্ডের আগে সরিয়ে আনা হয়; মূল key একটি # JSON: "updatedAt" কমেন্ট হিসেবে থাকে।
  • Type: str, int, float, bool, list[...], আর মিশ্র type-এর ভ্যালুর জন্য Any।
  • কিছু আইটেমে না থাকা বা null থাকা ফিল্ড হয় X | None = None।
  • class, from বা type-এর মতো Python keyword-এর শেষে আন্ডারস্কোর যোগ হয় (class_)।
  • from __future__ import annotations যুক্ত থাকে, তাই ক্রম যা-ই হোক ক্লাসগুলো একে অপরকে reference করতে পারে।
  • Top-level array থেকে Root = list[RootItem]-এর মতো একটি alias তৈরি হয়।

ব্যবহারের ক্ষেত্র

FastAPI-এর response মডেল আর request body

ফ্রন্টএন্ডের সাথে একমত হওয়া JSON থেকে BaseModel তৈরি করে response_model=-এ বা endpoint parameter হিসেবে ব্যবহার করুন; OpenAPI ডকুমেন্টেশন স্বয়ংক্রিয়ভাবে সাথে আসে।

থার্ড-পার্টি API response validate করা

কলগুলো Forecast.model_validate(resp.json())-এ মুড়ে দিন, তাহলে প্রোভাইডার কোনো ফিল্ডের type বদলালে ValidationError ঠিক কোন ফিল্ড path ভেঙেছে তা দেখিয়ে দেয়।

স্ক্রিপ্টে dict lookup বদলানো

data["current"]["temp"]-কে forecast.current.temp-এ বদলালে এডিটরে completion পাওয়া যায় এবং mypy বা pyright কোড চেক করতে পারে।

নোট ও সীমাবদ্ধতা

  • @dataclass nested dict-কে অবজেক্টে কনভার্ট করে না। Forecast(**data)-এর পরেও current একটি dict-ই থাকে; nested কনভার্শন দরকার হলে Pydantic বা dacite-এর মতো helper ব্যবহার করুন।
  • Pydantic-এ মূল JSON key (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 ভ্যালু parse হয়।
  • Pydantic v1-এর গঠন (class Config, parse_obj) তৈরি হয় না।

সাধারণ প্রশ্ন

populate_by_name=True কীসের জন্য?

ডিফল্টভাবে alias থাকা ফিল্ড ইনপুট হিসেবে শুধু তার alias (updatedAt) গ্রহণ করে। এই সেটিং থাকলে Forecast(updated_at=...)-ও লেখা যায়, যা টেস্টে কাজে আসে।

ঐচ্ছিক ফিল্ডে আমি Optional[str] পছন্দ করি।

str | None আর Optional[str] একই অর্থ বহন করে। Python 3.9-এর সাথে সামঞ্জস্য দরকার হলে typing থেকে Optional import করে annotation-গুলো বদলে দিন।

এটি কি TypedDict বা attrs ক্লাস তৈরি করতে পারে?

সমর্থিত স্টাইল হলো Pydantic v2 আর dataclass। দরকার হলে dataclass-এর ফিল্ড তালিকা সরাসরি একটি TypedDict বা @attrs.define ক্লাসে নিয়ে যাওয়া যায়।

Key আগে থেকেই snake_case হলে কি alias যোগ হয়?

না। Python নাম মূল key-এর সমান হলে কোনো Field(alias=...) বা ConfigDict লেখা হয় না, তাই rain_mm: float-এর মতো সাধারণ লাইন পাবেন।