首页
/ Pydantic中自定义类型的JSON Schema序列化问题解析

Pydantic中自定义类型的JSON Schema序列化问题解析

2025-05-09 23:38:33作者:邓越浪Henry

在Pydantic V2版本中,开发者在使用自定义类型时可能会遇到JSON Schema生成时默认值序列化的问题。本文将通过一个典型场景,深入分析问题原因并提供解决方案。

问题场景

假设我们有一个外部定义的Voltage类,无法修改其源代码。我们希望在Pydantic模型中使用这个类,并为其生成正确的JSON Schema。

class Voltage:
    def __init__(self, value: float):
        self.__value = value

    def get(self) -> float:
        return self.__value

    def __str__(self):
        return f"{self.__value}V"

初步实现方案

按照Pydantic文档的建议,我们使用Annotated来包装这个类,添加序列化器和验证器:

PydanticVoltage = Annotated[
    Voltage,
    pydantic.WithJsonSchema({"type": "number"}),
    pydantic.PlainSerializer(lambda v: v.get()),
    pydantic.BeforeValidator(lambda v: Voltage(v)),
]

class MyClass(pydantic.BaseModel):
    model_config = pydantic.ConfigDict(arbitrary_types_allowed=True)
    voltage: PydanticVoltage = Voltage(17)

遇到的问题

此时生成JSON Schema会出现警告:"Default value 0V is not JSON serializable; excluding default from JSON schema"。这表明虽然我们定义了序列化器,但在生成Schema时并未被正确应用。

问题根源

经过分析,发现问题的关键在于序列化器的位置。Pydantic的JSON Schema生成器在默认情况下不会自动应用内层定义的序列化器。

解决方案

临时解决方案

PlainSerializer移到最外层可以解决当前问题:

PydanticVoltage = Annotated[
    Voltage,
    pydantic.WithJsonSchema({"type": "number"}),
    pydantic.BeforeValidator(lambda v: Voltage(v)),
    pydantic.PlainSerializer(lambda v: v.get()),
]

未来版本改进

在Pydantic 2.12版本中,这个问题将得到修复。对于需要验证模式的情况,开发者需要显式指定json_schema_input_type参数。

最佳实践建议

  1. 对于自定义类型的序列化,始终将序列化器放在最外层
  2. 明确区分验证模式和序列化模式的需求
  3. 对于复杂类型,考虑实现__get_pydantic_core_schema__方法

总结

Pydantic在处理自定义类型的JSON Schema生成时,需要注意序列化器的应用顺序。了解这一机制有助于开发者更好地设计模型和类型适配器,避免潜在的问题。随着Pydantic的版本更新,这一体验将会更加完善。

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512