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.
Pangalan ng type ang pangalan ng top-level model (halimbawa Forecast).Estilo, piliin ang Pydantic (v2) para sa validation at alias, o dataclass para sa model na walang dependency.models.py. Naka-save sa URL ang estilo at type name.{
"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]
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.
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.= 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".str, int, float, bool, list[...], at Any para sa mga value na halo ang type.X | None = None ang mga field na wala sa ilang item o may laman na null.class, from o type (class_).from __future__ import annotations para makapag-reference ang mga class sa isa't isa anuman ang pagkakasunod.Root = list[RootItem] ang lumalabas.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.
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.
Kapag ginawang forecast.current.temp ang data["current"]["temp"], may completion ka sa editor at masusuri ng mypy o pyright ang code.
@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.updatedAt) sa Pydantic, tawagin ang model_dump(by_alias=True) o model_dump_json(by_alias=True).str | None, kaya ipinapalagay ng mga Pydantic model ang Python 3.10 o mas bago.str ang mga date at time string. Sa Pydantic, sapat nang palitan ang annotation ng datetime para ma-parse ang mga ISO 8601 value.class Config, parse_obj).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.
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.
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.
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.