Tukar JSON kepada Pydantic model Python!

Masukkan JSON untuk menjana kod Pydantic model Python, termasuk objek bersarang! Menyokong Pydantic v2 BaseModel, dataclass, FastAPI. SQLAlchemy ada dalam tab di atas.
JSON
Hasil
 

Tukar JSON kepada Pydantic model Python!

Penukar ini mengubah struktur JSON kepada kelas Pydantic v2 BaseModel atau kod @dataclass daripada pustaka standard. Nama medan ditulis semula kepada snake_case mengikut gaya Python, dan setiap objek bersarang mendapat kelasnya sendiri.

Gunakannya semasa mentakrifkan skema permintaan dan respons FastAPI, semasa menambah type hint pada data yang diambil dengan requests atau httpx, atau semasa mengemas skrip ETL dan scraping yang menggali dict melalui kunci rentetan.

Cara menggunakan

  1. Tampal JSON yang ingin dimodelkan.
  2. Masukkan nama model peringkat atas dalam Nama jenis (contohnya Forecast).
  3. Di bawah Gaya, pilih Pydantic (v2) untuk validasi dan alias, atau dataclass untuk model tanpa kebergantungan.
  4. Salin hasilnya ke dalam modul seperti models.py. Gaya dan nama jenis disimpan dalam URL.

Contoh

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]

updatedAt menjadi medan updated_at, dipautkan semula kepada kunci asal dengan Field(alias="updatedAt"). Dalam hourly, temp bercampur antara integer dan perpuluhan maka ia menjadi float, dan alert yang hanya wujud dalam item kedua ialah str | None = None. Kelas anak dijana terlebih dahulu.

Ciri yang disokong

  • Pydantic v2: medan yang dinamakan semula menggunakan Field(alias=...), dan model_config = ConfigDict(populate_by_name=True) membolehkan anda turut mengisinya dengan nama Python.
  • dataclass: medan tanpa nilai lalai dipindahkan ke hadapan medan = None untuk mengelakkan TypeError: non-default argument follows default argument; kunci asal dikekalkan sebagai komen # JSON: "updatedAt".
  • Jenis: str, int, float, bool, list[...], dan Any untuk nilai yang jenisnya bercampur.
  • Medan yang tiada dalam sesetengah item atau mengandungi null menjadi X | None = None.
  • Kata kunci Python seperti class, from atau type diberi garis bawah di hujung (class_).
  • from __future__ import annotations disertakan supaya kelas boleh merujuk satu sama lain tanpa mengira susunan.
  • Tatasusunan peringkat atas menghasilkan alias seperti Root = list[RootItem].

Kes penggunaan

Model respons dan badan permintaan FastAPI

Bina BaseModel daripada JSON yang telah dipersetujui dengan pasukan frontend dan gunakannya dalam response_model= atau sebagai parameter endpoint; dokumentasi OpenAPI akan menyusul secara automatik.

Mengesahkan respons API pihak ketiga

Balut panggilan dalam Forecast.model_validate(resp.json()), dan apabila penyedia menukar jenis sesuatu medan, ValidationError menunjukkan laluan medan tepat yang rosak.

Menggantikan carian dict dalam skrip

Menukar data["current"]["temp"] kepada forecast.current.temp memberi anda autolengkap dalam editor dan membolehkan mypy atau pyright memeriksa kod.

Nota dan had

  • @dataclass tidak menukar dict bersarang kepada objek. Selepas Forecast(**data), current masih dict; gunakan Pydantic atau helper seperti dacite jika anda perlukan penukaran bersarang.
  • Untuk menyiri semula dengan kunci JSON asal (updatedAt) dalam Pydantic, panggil model_dump(by_alias=True) atau model_dump_json(by_alias=True).
  • Output menggunakan sintaks str | None, jadi model Pydantic mengandaikan Python 3.10 atau lebih baharu.
  • Rentetan tarikh dan masa dijana sebagai str. Dengan Pydantic, menukar anotasi kepada datetime sudah memadai untuk menghurai nilai ISO 8601.
  • Binaan Pydantic v1 (class Config, parse_obj) tidak dijana.

Soalan lazim

Apakah fungsi populate_by_name=True?

Secara lalai, medan beralias hanya menerima aliasnya (updatedAt) sebagai input. Dengan tetapan ini anda juga boleh menulis Forecast(updated_at=...), yang berguna dalam ujian.

Saya lebih suka Optional[str] untuk medan pilihan.

str | None dan Optional[str] membawa maksud yang sama. Jika anda perlukan keserasian Python 3.9, import Optional daripada typing dan tukar anotasinya.

Bolehkah ia menjana kelas TypedDict atau attrs?

Gaya yang disokong ialah Pydantic v2 dan dataclass. Senarai medan dataclass boleh dipindahkan terus ke TypedDict atau kelas @attrs.define jika anda memerlukannya.

Adakah alias ditambah apabila kunci sudah dalam snake_case?

Tidak. Apabila nama Python sama dengan kunci asal, tiada Field(alias=...) atau ConfigDict dijana, jadi anda mendapat baris ringkas seperti rain_mm: float.