แปลง JSON เป็น Pydantic model ของ Python!

ป้อน JSON เพื่อสร้างโค้ด Pydantic model ของ Python รวมถึงออบเจ็กต์ที่ซ้อนกัน! รองรับ Pydantic v2 BaseModel, dataclass, FastAPI SQLAlchemy อยู่ในแท็บด้านบน
JSON
ผลลัพธ์
 

แปลง JSON เป็น Pydantic model ของ Python!

ตัวแปลงนี้เปลี่ยนโครงสร้าง JSON เป็นคลาส BaseModel ของ Pydantic v2 หรือโค้ด @dataclass ของ standard library ชื่อฟิลด์ถูกเขียนใหม่เป็น snake_case ตามสไตล์ของ Python และทุกออบเจ็กต์ที่ซ้อนกันจะได้คลาสของตัวเอง

ใช้ตอนนิยาม schema ของ request และ response ใน FastAPI ตอนเพิ่ม type hint ให้ข้อมูลที่ดึงมาด้วย requests หรือ httpx หรือตอนจัดระเบียบสคริปต์ ETL และ scraping ที่ขุด dict ด้วยคีย์ที่เป็นสตริง

วิธีใช้

  1. วาง JSON ที่ต้องการทำเป็นโมเดล
  2. ใส่ชื่อโมเดลระดับบนสุดใน ชื่อไทป์ (เช่น Forecast)
  3. ใน สไตล์ เลือก Pydantic (v2) ถ้าต้องการ validation และ alias หรือ dataclass สำหรับโมเดลที่ไม่มี dependency
  4. คัดลอกผลลัพธ์ไปใส่โมดูลอย่าง models.py สไตล์และชื่อไทป์ถูกบันทึกไว้ใน 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") ใน hourly ค่า temp มีทั้งจำนวนเต็มและทศนิยมปนกันจึงเป็น float ส่วน alert ที่มีแค่ในรายการที่สองเป็น str | None = None คลาสลูกจะถูกเขียนออกมาก่อน

ฟีเจอร์ที่รองรับ

  • Pydantic v2: ฟิลด์ที่เปลี่ยนชื่อใช้ Field(alias=...) และ model_config = ConfigDict(populate_by_name=True) ทำให้กำหนดค่าด้วยชื่อแบบ Python ได้ด้วย
  • dataclass: ฟิลด์ที่ไม่มีค่าเริ่มต้นถูกย้ายไปไว้ก่อนฟิลด์ = None เพื่อเลี่ยง TypeError: non-default argument follows default argument และเก็บคีย์เดิมไว้ในคอมเมนต์ # JSON: "updatedAt"
  • ไทป์: str, int, float, bool, list[...] และ Any สำหรับค่าที่ไทป์ปนกัน
  • ฟิลด์ที่ขาดไปในบางรายการหรือมีค่า null จะเป็น X | None = None
  • คำสงวนของ Python อย่าง class, from หรือ type จะได้ขีดล่างต่อท้าย (class_)
  • มี from __future__ import annotations ให้ คลาสจึงอ้างถึงกันได้โดยไม่ขึ้นกับลำดับ
  • อาร์เรย์ระดับบนสุดได้ alias อย่าง Root = list[RootItem]

กรณีการใช้งาน

response model และ request body ของ FastAPI

สร้าง BaseModel จาก JSON ที่ตกลงกับ frontend ไว้ แล้วใช้ใน response_model= หรือเป็นพารามิเตอร์ของ endpoint เอกสาร OpenAPI จะตามมาให้อัตโนมัติ

validate response จาก API ภายนอก

ครอบการเรียกด้วย Forecast.model_validate(resp.json()) เมื่อผู้ให้บริการเปลี่ยนไทป์ของฟิลด์ ValidationError จะชี้ไปที่ path ของฟิลด์ที่พังได้ตรงจุด

เลิกใช้การเข้าถึง dict ในสคริปต์

การเปลี่ยน data["current"]["temp"] เป็น forecast.current.temp ทำให้ได้ autocomplete ในเอดิเตอร์ และให้ mypy หรือ pyright ตรวจโค้ดได้

ข้อควรระวังและข้อจำกัด

  • @dataclass ไม่แปลง dict ที่ซ้อนอยู่เป็นออบเจ็กต์ หลัง Forecast(**data) ค่า current ยังเป็น dict อยู่ ถ้าต้องแปลงแบบซ้อนให้ใช้ Pydantic หรือตัวช่วยอย่าง dacite
  • ถ้าจะ serialize กลับด้วยคีย์ JSON เดิม (updatedAt) ใน Pydantic ให้เรียก model_dump(by_alias=True) หรือ model_dump_json(by_alias=True)
  • ผลลัพธ์ใช้ไวยากรณ์ str | None โมเดล Pydantic จึงต้องใช้ Python 3.10 ขึ้นไป
  • สตริงวันที่และเวลาออกมาเป็น str ถ้าใช้ Pydantic แค่เปลี่ยน annotation เป็น datetime ก็พาร์สค่า ISO 8601 ได้
  • ไม่สร้างโครงสร้างของ 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 ให้ import Optional จาก typing แล้วเปลี่ยน annotation

สร้างเป็น TypedDict หรือคลาส attrs ได้ไหม?

สไตล์ที่รองรับคือ Pydantic v2 และ dataclass ถ้าต้องการแบบนั้น รายการฟิลด์ของ dataclass ยกไปใช้กับ TypedDict หรือคลาส @attrs.define ได้ตรง ๆ

ถ้าคีย์เป็น snake_case อยู่แล้ว จะยังเพิ่ม alias ไหม?

ไม่ เมื่อชื่อแบบ Python ตรงกับคีย์เดิม จะไม่มี Field(alias=...) หรือ ConfigDict ออกมา คุณจะได้บรรทัดธรรมดาอย่าง rain_mm: float