I-convert ang JSON sa Python Pydantic model!

Maglagay ng JSON para gumawa ng Python Pydantic model code, kasama ang mga nested object! Sinusuportahan ang Pydantic v2 BaseModel, dataclass, FastAPI. Nasa mga tab sa itaas ang SQLAlchemy.
JSON
Resulta
 

I-convert ang JSON sa Python Pydantic model!

Ginagawa ng converter na ito na Pydantic v2 BaseModel class o standard-library na @dataclass code ang isang JSON structure. Isinusulat ulit sa snake_case ang mga field name ayon sa inaasahang istilo ng Python, at may sariling class ang bawat nested object.

Gamitin ito kapag nagde-define ng mga FastAPI request at response schema, kapag nagdadagdag ng type hint sa data na kinukuha mo gamit ang requests o httpx, o kapag nililinis ang mga ETL at scraping script na naghuhukay sa mga dict gamit ang string key.

Paano gamitin

  1. I-paste ang JSON na gusto mong i-model.
  2. Ilagay sa Pangalan ng type ang pangalan ng top-level model (halimbawa Forecast).
  3. Sa ilalim ng Estilo, piliin ang Pydantic (v2) para sa validation at alias, o dataclass para sa model na walang dependency.
  4. Kopyahin ang resulta papunta sa isang module gaya ng models.py. Naka-save sa URL ang estilo at type name.

Halimbawa

Input (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" }
  ]
}
Output (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]

Nagiging field na updated_at ang updatedAt, na nakatali pabalik sa orihinal na key gamit ang Field(alias="updatedAt"). Sa hourly, halo ang integer at decimal ng temp kaya nagiging float ito, at ang alert, na nasa pangalawang item lang, ay str | None = None. Inilalabas muna ang mga child class.

Mga sinusuportahang feature

  • Pydantic v2: gumagamit ng Field(alias=...) ang mga field na pinalitan ng pangalan, at hinahayaan ng model_config = ConfigDict(populate_by_name=True) na punan din sila gamit ang Python name nila.
  • dataclass: inililipat sa unahan ng mga field na = None ang mga field na walang default para maiwasan ang TypeError: non-default argument follows default argument; napapanatili ang orihinal na key bilang comment na # JSON: "updatedAt".
  • Mga type: str, int, float, bool, list[...], at Any para sa mga value na halo ang type.
  • Nagiging X | None = None ang mga field na wala sa ilang item o may laman na null.
  • Nilalagyan ng underscore sa dulo ang mga Python keyword gaya ng class, from o type (class_).
  • Kasama ang from __future__ import annotations para makapag-reference ang mga class sa isa't isa anuman ang pagkakasunod.
  • Kapag array ang top level, alias gaya ng Root = list[RootItem] ang lumalabas.

Mga gamit

Mga FastAPI response model at request body

Bumuo ng mga BaseModel mula sa JSON na napagkasunduan ninyo ng frontend at gamitin sila sa response_model= o bilang endpoint parameter; awtomatikong sumusunod ang OpenAPI docs.

Pag-validate ng mga third-party API response

Ibalot ang mga call sa Forecast.model_validate(resp.json()) at kapag binago ng provider ang type ng isang field, tinuturo ng ValidationError ang eksaktong field path na nasira.

Pagpapalit sa mga dict lookup sa mga script

Kapag ginawang forecast.current.temp ang data["current"]["temp"], may completion ka sa editor at masusuri ng mypy o pyright ang code.

Mga paalala at limitasyon

  • Hindi kino-convert ng @dataclass ang mga nested dict sa object. Pagkatapos ng Forecast(**data), dict pa rin ang current; gumamit ng Pydantic o ng helper gaya ng dacite kung kailangan mo ng nested conversion.
  • Para mag-serialize pabalik gamit ang orihinal na JSON key (updatedAt) sa Pydantic, tawagin ang model_dump(by_alias=True) o model_dump_json(by_alias=True).
  • Gumagamit ang output ng syntax na str | None, kaya ipinapalagay ng mga Pydantic model ang Python 3.10 o mas bago.
  • Lumalabas na str ang mga date at time string. Sa Pydantic, sapat nang palitan ang annotation ng datetime para ma-parse ang mga ISO 8601 value.
  • Hindi ginagawa ang mga construct ng Pydantic v1 (class Config, parse_obj).

Mga madalas itanong

Para saan ang populate_by_name=True?

Bilang default, alias lang nito (updatedAt) ang tinatanggap na input ng field na may alias. Sa setting na ito, puwede mo ring isulat ang Forecast(updated_at=...), na magagamit sa mga test.

Mas gusto ko ang Optional[str] para sa mga optional na field.

Pareho ang ibig sabihin ng str | None at Optional[str]. Kung kailangan mo ng compatibility sa Python 3.9, i-import ang Optional mula sa typing at palitan ang mga annotation.

Kaya ba nitong maglabas ng TypedDict o attrs class?

Pydantic v2 at dataclass ang mga suportadong istilo. Direktang nalilipat ang listahan ng field ng dataclass sa isang TypedDict o @attrs.define class kung kailangan mo ang isa sa mga iyon.

Nagdadagdag ba ng alias kapag snake_case na ang mga key?

Hindi. Kapag kapareho ng orihinal na key ang Python name, walang inilalabas na Field(alias=...) o ConfigDict, kaya simpleng linya gaya ng rain_mm: float ang makukuha mo.