JSON の構造を Pydantic v2 の BaseModel クラスか、標準ライブラリの @dataclass のコードに変換します。フィールド名は Python のスタイルに合わせて snake_case に書き換え、ネストしたオブジェクトにはそれぞれ専用のクラスを作ります。
FastAPI のリクエスト/レスポンスのスキーマを定義するとき、requests や httpx で取得したデータに型ヒントを付けるとき、文字列キーで辞書を掘り進める ETL やスクレイピングのスクリプトを整理するときに使ってください。
型名 にトップレベルのモデル名を入力します(例: Forecast)。スタイル で、検証やエイリアスが必要なら Pydantic (v2)、依存関係のないモデルなら dataclass を選びます。models.py などのモジュールにコピーします。スタイルと型名は URL に保存されます。{
"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" }
]
}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 になり、2つ目の要素にしかない alert は str | None = None です。クラスは子から先に出力されます。
Field(alias=...) を使い、model_config = ConfigDict(populate_by_name=True) により Python 側の名前でも値を入れられます。TypeError: non-default argument follows default argument を避けるため、デフォルト値のないフィールドを = None のフィールドより前に移します。元のキーは # JSON: "updatedAt" というコメントで残します。str、int、float、bool、list[...]、型が混在する値は Any。null を含むフィールドは X | None = None になります。class、from、type のような Python のキーワードには末尾にアンダースコアが付きます(class_)。from __future__ import annotations を含めます。Root = list[RootItem] のようなエイリアスを出力します。フロントエンドと取り決めた JSON から BaseModel を作り、response_model= やエンドポイントの引数に使えば、OpenAPI のドキュメントも自動でついてきます。
呼び出しを Forecast.model_validate(resp.json()) で包んでおけば、提供元がフィールドの型を変えたときに、ValidationError が壊れたフィールドのパスを正確に指し示します。
data["current"]["temp"] を forecast.current.temp にすれば、エディターの補完が効き、mypy や pyright でコードをチェックできるようになります。
@dataclass はネストした辞書をオブジェクトに変換しません。Forecast(**data) のあとも current は辞書のままです。ネストした変換が必要なら、Pydantic か dacite のようなヘルパーを使ってください。updatedAt)に戻してシリアライズするには、model_dump(by_alias=True) か model_dump_json(by_alias=True) を呼びます。str | None 構文を使うので、Pydantic のモデルは Python 3.10 以降を前提にしています。str で出力されます。Pydantic なら、アノテーションを datetime に変えるだけで ISO 8601 の値を解析できます。class Config、parse_obj)は生成しません。populate_by_name=True は何のためにありますか?既定では、エイリアス付きのフィールドは入力としてエイリアス(updatedAt)しか受け付けません。この設定があれば Forecast(updated_at=...) とも書けるので、テストで便利です。
Optional[str] で書きたいです。str | None と Optional[str] は同じ意味です。Python 3.9 との互換性が必要なら、typing から Optional を import してアノテーションを置き換えてください。
対応しているスタイルは Pydantic v2 と dataclass です。それらが必要なら、dataclass のフィールド一覧をそのまま TypedDict や @attrs.define のクラスに移せます。
付きません。Python の名前が元のキーと同じなら Field(alias=...) も ConfigDict も出力されず、rain_mm: float のようなシンプルな行になります。