Преобразуйте JSON в Pydantic model Python!

Введите JSON, чтобы получить код Pydantic model на Python, включая вложенные объекты! Поддержка: Pydantic v2 BaseModel, dataclass, FastAPI. SQLAlchemy — во вкладках выше.
JSON
Результат
 

Преобразуйте JSON в Pydantic model Python!

Этот конвертер превращает структуру JSON в классы Pydantic v2 BaseModel или код @dataclass из стандартной библиотеки. Имена полей переписываются в snake_case, как того требует стиль Python, и каждый вложенный объект получает собственный класс.

Пригодится при описании схем запросов и ответов FastAPI, при добавлении аннотаций типов к данным, получаемым через requests или httpx, или при наведении порядка в ETL- и скрейпинг-скриптах, которые копаются в dict по строковым ключам.

Как пользоваться

  1. Вставьте JSON, который хотите описать моделью.
  2. Введите имя модели верхнего уровня в Имя типа (например, Forecast).
  3. В Стиль выберите Pydantic (v2) для валидации и алиасов или dataclass для модели без зависимостей.
  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, чтобы классы могли ссылаться друг на друга независимо от порядка.
  • Массив верхнего уровня даёт псевдоним вроде Root = list[RootItem].

Сценарии использования

Модели ответов и тела запросов FastAPI

Постройте BaseModel по JSON, согласованному с фронтендом, и используйте их в response_model= или как параметры эндпоинтов — документация OpenAPI подтянется автоматически.

Валидация ответов сторонних API

Оберните вызовы в Forecast.model_validate(resp.json()), и когда провайдер поменяет тип поля, ValidationError укажет точный путь к сломавшемуся полю.

Замена обращений к dict в скриптах

Превращение data["current"]["temp"] в forecast.current.temp даёт автодополнение в редакторе и позволяет mypy или pyright проверять код.

Примечания и ограничения

  • @dataclass не превращает вложенные dict в объекты. После Forecast(**data) поле current всё ещё dict; если нужно вложенное преобразование, используйте Pydantic или вспомогательную библиотеку вроде dacite.
  • Чтобы в Pydantic сериализовать обратно с исходными ключами JSON (updatedAt), вызывайте model_dump(by_alias=True) или model_dump_json(by_alias=True).
  • Вывод использует синтаксис str | None, поэтому модели Pydantic рассчитаны на Python 3.10 и новее.
  • Строки с датой и временем выводятся как str. В Pydantic достаточно сменить аннотацию на datetime, чтобы значения ISO 8601 разбирались.
  • Конструкции Pydantic v1 (class Config, parse_obj) не генерируются.

Частые вопросы

Зачем нужен populate_by_name=True?

По умолчанию поле с алиасом принимает на вход только алиас (updatedAt). С этой настройкой можно писать и Forecast(updated_at=...), что удобно в тестах.

Я предпочитаю Optional[str] для необязательных полей.

str | None и Optional[str] означают одно и то же. Если нужна совместимость с Python 3.9, импортируйте Optional из typing и замените аннотации.

Может ли он выводить TypedDict или классы attrs?

Поддерживаются стили Pydantic v2 и dataclass. Список полей dataclass напрямую переносится в TypedDict или класс @attrs.define, если нужен один из них.

Добавляются ли алиасы, если ключи уже в snake_case?

Нет. Когда имя в Python совпадает с исходным ключом, ни Field(alias=...), ни ConfigDict не выводятся, и вы получаете простые строки вроде rain_mm: float.