JSON 转 Python
根据 JSON 示例生成 Python 类,可选择 Pydantic model 或标准库 dataclass。嵌套对象会生成单独的类,并在使用前声明;键可能缺失时,可选字段和可空字段会使用 Optional,并将默认值设为 None;混合值会使用 Union。字段名会转换为 snake_case。
常见问题
嵌套对象如何命名?
每个嵌套对象都会成为独立的 Python 类型,并以包含它的键名转换为 PascalCase 后命名,例如 address 会变为 Address。数组中的对象会使用数组键名的单数形式,例如 users 会变为 User。字段完全相同的对象会共用同一个类型。
字段在什么情况下会是可选的?
当数组中包含多个对象,且某个键在部分对象中缺失时,该字段就是可选的:其类型会包装在 Optional 中,默认值为 None。每个示例中都存在的键为必填项。单个对象没有可供比较的对象,因此其中所有键都是必填项。
如何处理 null 值?
如果某个键在部分示例中为 null,在其他示例中有值,它会变为该类型的 Optional。如果某个键始终为 null,工具就无法得知它的实际类型,因此会将其变为 Optional[Any];粘贴包含实际值的示例即可生成精确类型。
会使用哪些数字类型?
整数会变为 int,带小数的数字会变为 float。同时包含两者的字段会变为 float。
如何处理无效名称的键?
字段名会转换为 snake_case。Pydantic model 会通过 Field(alias=...) 保留原始键名,因此 model_validate 会按原样读取 JSON。Dataclass 没有别名,因此如果 JSON 中的键不是有效的 Python 名称,请在创建 dataclass 前自行重命名这些键。Python 关键字(例如 class)会在末尾加下划线。
我的 JSON 会被上传或存储吗?
JSON 仅会发送到服务器以便为此次请求生成代码,不会被存储。生成器只会读取示例的结构和值类型,因此你可以在粘贴前将敏感值替换为类型相同的占位值。