JSON in Python-Pydantic model umwandeln!

Gib JSON ein, um Python-Pydantic model-Code inklusive verschachtelter Objekte zu erzeugen! Unterstützt Pydantic v2 BaseModel, dataclass, FastAPI. SQLAlchemy: in den Tabs oben.
JSON
Ergebnis
 

JSON in Python-Pydantic model umwandeln!

Dieser Konverter macht aus einer JSON-Struktur Pydantic-v2-Klassen auf Basis von BaseModel oder @dataclass-Code aus der Standardbibliothek. Feldnamen werden in snake_case umgeschrieben, wie es der Python-Stil erwartet, und jedes verschachtelte Objekt bekommt seine eigene Klasse.

Greif darauf zurück, wenn du Request- und Response-Schemas für FastAPI definierst, Daten, die du mit requests oder httpx abrufst, mit Type Hints versehen willst oder ETL- und Scraping-Skripte aufräumst, die sich über String-Keys durch Dicts hangeln.

So funktioniert es

  1. Füge das JSON ein, das du modellieren willst.
  2. Gib den Namen des obersten Modells in Typname ein (zum Beispiel Forecast).
  3. Wähle unter Stil Pydantic (v2) für Validierung und Aliase oder dataclass für ein Modell ohne Abhängigkeiten.
  4. Kopiere das Ergebnis in ein Modul wie models.py. Stil und Typname werden in der URL gespeichert.

Beispiel

Eingabe (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" }
  ]
}
Ausgabe (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 wird zum Feld updated_at und mit Field(alias="updatedAt") an den ursprünglichen Key gebunden. In hourly mischt temp Ganzzahlen und Dezimalzahlen und wird daher zu float, und alert, das nur im zweiten Element vorkommt, ist str | None = None. Die Klassen werden mit den Kindklassen zuerst ausgegeben.

Unterstützte Funktionen

  • Pydantic v2: Umbenannte Felder verwenden Field(alias=...), und model_config = ConfigDict(populate_by_name=True) erlaubt es, sie auch über ihren Python-Namen zu befüllen.
  • dataclass: Felder ohne Standardwert werden vor = None-Felder verschoben, um TypeError: non-default argument follows default argument zu vermeiden; der ursprüngliche Key bleibt als Kommentar # JSON: "updatedAt" erhalten.
  • Typen: str, int, float, bool, list[...] und Any für Werte mit gemischten Typen.
  • Felder, die in manchen Elementen fehlen oder null enthalten, werden zu X | None = None.
  • Python-Schlüsselwörter wie class, from oder type bekommen einen angehängten Unterstrich (class_).
  • from __future__ import annotations ist enthalten, damit Klassen unabhängig von der Reihenfolge aufeinander verweisen können.
  • Ein Array auf oberster Ebene erzeugt einen Alias wie Root = list[RootItem].

Anwendungsfälle

FastAPI-Response-Modelle und Request-Bodies

Baue BaseModels aus dem JSON, das du mit dem Frontend vereinbart hast, und verwende sie in response_model= oder als Endpoint-Parameter; die OpenAPI-Doku zieht automatisch nach.

Antworten von Drittanbieter-APIs validieren

Verpacke Aufrufe in Forecast.model_validate(resp.json()), und wenn der Anbieter einen Feldtyp ändert, zeigt ValidationError genau auf den Feldpfad, der kaputtgegangen ist.

Dict-Zugriffe in Skripten ersetzen

Wird aus data["current"]["temp"] ein forecast.current.temp, bekommst du Autovervollständigung im Editor, und mypy oder pyright können den Code prüfen.

Hinweise und Einschränkungen

  • @dataclass wandelt verschachtelte Dicts nicht in Objekte um. Nach Forecast(**data) ist current immer noch ein Dict; nimm Pydantic oder einen Helfer wie dacite, wenn du verschachtelte Umwandlung brauchst.
  • Um in Pydantic wieder mit den ursprünglichen JSON-Keys (updatedAt) zu serialisieren, rufe model_dump(by_alias=True) oder model_dump_json(by_alias=True) auf.
  • Die Ausgabe verwendet die Syntax str | None, die Pydantic-Modelle setzen also Python 3.10 oder neuer voraus.
  • Datums- und Zeit-Strings kommen als str heraus. Mit Pydantic genügt es, die Annotation auf datetime zu ändern, um ISO-8601-Werte zu parsen.
  • Konstrukte aus Pydantic v1 (class Config, parse_obj) werden nicht erzeugt.

Häufige Fragen

Wofür ist populate_by_name=True da?

Standardmäßig akzeptiert ein Feld mit Alias nur seinen Alias (updatedAt) als Eingabe. Mit dieser Einstellung kannst du auch Forecast(updated_at=...) schreiben, was in Tests praktisch ist.

Ich bevorzuge Optional[str] für optionale Felder.

str | None und Optional[str] bedeuten dasselbe. Brauchst du Kompatibilität mit Python 3.9, importiere Optional aus typing und tausche die Annotationen aus.

Kann es TypedDict- oder attrs-Klassen ausgeben?

Unterstützt werden die Stile Pydantic v2 und dataclass. Die Feldliste der dataclass lässt sich direkt in ein TypedDict oder eine @attrs.define-Klasse übernehmen, falls du eines davon brauchst.

Werden Aliase ergänzt, wenn die Keys schon snake_case sind?

Nein. Wenn der Python-Name dem ursprünglichen Key entspricht, wird weder Field(alias=...) noch ConfigDict ausgegeben, und du bekommst einfache Zeilen wie rain_mm: float.