JSONからPythonへ
JSONのサンプルから、Pydanticモデルまたは標準ライブラリのデータクラスとしてPythonクラスを生成します。ネストされたオブジェクトにはそれぞれ専用のクラスが作られ、使用箇所より前に宣言されます。キーが存在しない場合があるオプションおよびnull許容フィールドには、デフォルト値NoneのOptionalを使い、型が混在する値にはUnionを使います。フィールド名はsnake_caseになります。
よくある質問
ネストされたオブジェクトにはどのような名前が付けられますか?
ネストされたオブジェクトはそれぞれ独立したPython型になり、それを含むキーをもとにPascalCaseで命名されます。たとえばaddressはAddressになります。配列内のオブジェクトには、配列キーの単数形が使われるため、usersはUserになります。フィールドが完全に同じオブジェクトは、同じ型を共有します。
フィールドがオプションになるのはどのような場合ですか?
配列に複数のオブジェクトがあり、一部のオブジェクトにキーがない場合、そのフィールドはオプションになります。型はOptionalでラップされ、デフォルト値はNoneになります。すべてのサンプルに存在するキーは必須です。単一のオブジェクトでは比較対象がないため、すべてのキーが必須になります。
null値はどのように扱われますか?
一部のサンプルではnullで、ほかのサンプルでは値が入っているキーは、その型のOptionalになります。常にnullのキーからは実際の型を判断できないため、Optional[Any]になります。正確な型を得るには、実際の値を含むサンプルを貼り付けてください。
どの数値型が使われますか?
整数はintになり、小数を含む数値はfloatになります。両方の値を持つフィールドはfloatになります。
有効な名前ではないキーはどうなりますか?
フィールド名はsnake_caseに変換されます。PydanticモデルではField(alias=...)で元のキーを保持するため、model_validateはJSONをそのまま読み取ります。データクラスにはエイリアスがないため、有効なPython名ではないキーを持つJSONからデータクラスを作る場合は、キーの名前を自分で変更してください。classなどのPython予約語には末尾にアンダースコアが付きます。
JSONはアップロードまたは保存されますか?
JSONはこのリクエストのコード生成にのみ使用するためサーバーに送信され、保存されません。ジェネレーターが読み取るのはサンプルの構造と値の型だけなので、貼り付ける前に、機密性の高い値を同じ型のプレースホルダーに置き換えることができます。