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
参数。
最佳实践建议
- 对于自定义类型的序列化,始终将序列化器放在最外层
- 明确区分验证模式和序列化模式的需求
- 对于复杂类型,考虑实现
__get_pydantic_core_schema__
方法
总结
Pydantic在处理自定义类型的JSON Schema生成时,需要注意序列化器的应用顺序。了解这一机制有助于开发者更好地设计模型和类型适配器,避免潜在的问题。随着Pydantic的版本更新,这一体验将会更加完善。
登录后查看全文
热门项目推荐
- DDeepSeek-V3.1-TerminusDeepSeek-V3.1-Terminus是V3的更新版,修复语言问题,并优化了代码与搜索智能体性能。Python00
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0267cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AudioFly
AudioFly is a text-to-audio generation model based on the LDM architecture. It produces high-fidelity sounds at 44.1 kHz sampling rate with strong alignment to text prompts, suitable for sound effects, music, and multi-event audio synthesis tasks.Python00- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.94 K

deepin linux kernel
C
22
6

React Native鸿蒙化仓库
C++
192
274

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
554

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
887
394

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
512