Ce convertisseur transforme une structure JSON en classes Pydantic v2 BaseModel ou en code @dataclass de la bibliothèque standard. Les noms de champs sont réécrits en snake_case comme le veut le style Python, et chaque objet imbriqué reçoit sa propre classe.
À utiliser pour définir les schémas de requête et de réponse FastAPI, pour ajouter des annotations de type aux données récupérées avec requests ou httpx, ou pour assainir des scripts d'ETL et de scraping qui fouillent des dicts par clés chaînes.
Nom du type (par exemple Forecast).Style, choisissez Pydantic (v2) pour la validation et les alias, ou dataclass pour un modèle sans dépendance.models.py. Le style et le nom du type sont enregistrés dans l'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 devient le champ updated_at, rattaché à la clé d'origine par Field(alias="updatedAt"). Dans hourly, temp mélange entiers et décimaux et devient donc float, et alert, présent seulement dans le deuxième élément, est str | None = None. Les classes sont émises en commençant par les enfants.
Field(alias=...), et model_config = ConfigDict(populate_by_name=True) permet aussi de les renseigner par leur nom Python.= None pour éviter TypeError: non-default argument follows default argument ; la clé d'origine est conservée en commentaire # JSON: "updatedAt".str, int, float, bool, list[...], et Any pour les valeurs de types mélangés.null deviennent X | None = None.class, from ou type reçoivent un tiret bas final (class_).from __future__ import annotations est inclus pour que les classes puissent se référencer quel que soit leur ordre.Root = list[RootItem].Construisez des BaseModel à partir du JSON convenu avec le frontend et utilisez-les dans response_model= ou comme paramètres d'endpoint ; la doc OpenAPI suit automatiquement.
Encapsulez les appels dans Forecast.model_validate(resp.json()) : quand le fournisseur change le type d'un champ, ValidationError indique le chemin exact du champ cassé.
Transformer data["current"]["temp"] en forecast.current.temp vous donne la complétion dans l'éditeur et permet à mypy ou pyright de vérifier le code.
@dataclass ne convertit pas les dicts imbriqués en objets. Après Forecast(**data), current reste un dict ; utilisez Pydantic ou un utilitaire comme dacite s'il vous faut une conversion imbriquée.updatedAt) en Pydantic, appelez model_dump(by_alias=True) ou model_dump_json(by_alias=True).str | None : les modèles Pydantic supposent donc Python 3.10 ou plus récent.str. Avec Pydantic, changer l'annotation en datetime suffit pour analyser les valeurs ISO 8601.class Config, parse_obj) ne sont pas générées.populate_by_name=True ?Par défaut, un champ avec alias n'accepte que son alias (updatedAt) en entrée. Avec ce réglage, vous pouvez aussi écrire Forecast(updated_at=...), pratique dans les tests.
Optional[str] pour les champs optionnels.str | None et Optional[str] signifient la même chose. S'il vous faut la compatibilité Python 3.9, importez Optional depuis typing et remplacez les annotations.
Les styles pris en charge sont Pydantic v2 et dataclass. La liste de champs de la dataclass se transpose directement en TypedDict ou en classe @attrs.define si vous en avez besoin.
Non. Quand le nom Python est identique à la clé d'origine, aucun Field(alias=...) ni ConfigDict n'est émis : vous obtenez des lignes simples comme rain_mm: float.