讲师中心 微信公众号
AI工具推荐 视频效率加速

Pydantic v2 中复用 Decimal 字段定义的三种专业实践

胖枫同学_7355

胖枫同学_7355

发布时间:2026-09-02 20:07:22

|

323人浏览过

|

来源于php中文网

原创

Pydantic v2 中复用 Decimal 字段定义的三种专业实践

在 Pydantic v2 中,可通过 Annotated 结合 Field 和自定义类型别名,高效复用带约束的 Decimal | None 字段定义,避免重复声明 max_digits、decimal_places、json_schema_extra 等参数,同时灵活注入 description。

在 pydantic v2 中,可通过 `annotated` 结合 `field` 和自定义类型别名,高效复用带约束的 `decimal | none` 字段定义,避免重复声明 `max_digits`、`decimal_places`、`json_schema_extra` 等参数,同时灵活注入 `description`。

在构建多个结构相似的模型时(如金融、计量类业务中大量共享精度与格式要求的数值字段),硬编码重复的 Field(..., max_digits=80, decimal_places=5, json_schema_extra={"type": "display"}) 不仅冗余,更易引发维护不一致风险。Pydantic v2 原生支持通过 typing.Annotated 实现字段定义的模块化封装——它允许你将类型注解与元数据(如 Field 配置)解耦组合,从而实现真正意义上的“可复用字段类型”。

✅ 推荐方案:Annotated + 预设 Field + WithJsonSchema

最清晰、可读性高且语义明确的方式是定义一个带固定约束的可空 Decimal 类型别名,再按需叠加描述信息:

from decimal import Decimal
from typing import Annotated, Any
from pydantic import BaseModel, Field, WithJsonSchema

# 共享基础约束与 JSON Schema 扩展
DECIMAL_CONFIG = {"max_digits": 80, "decimal_places": 5}
DISPLAY_SCHEMA = WithJsonSchema({"type": "display"})

# 复用类型:NullableDecimal = Decimal | None + 公共约束 + display schema
NullableDecimal = Annotated[
    Decimal | None,
    Field(**DECIMAL_CONFIG),
    DISPLAY_SCHEMA
]

# 使用示例:仅需为每个字段指定 description(通过 Annotated 第二参数)
class ModelA(BaseModel):
    benchmark2: Annotated[NullableDecimal, "Benchmark 2"] = None
    benchmark3: Annotated[NullableDecimal, "Benchmark 3"] = None
    benchmark4: Annotated[NullableDecimal, "Benchmark 4"] = None

⚠️ 注意:Annotated[T, ...] 中的字符串字面量(如 "Benchmark 2")会被 Pydantic 自动识别为 Field(description=...),这是 v2 的隐式约定(详见文档)。若需显式控制,也可直接写 Field(description="...")

? 替代方案:函数式字段工厂(适用于动态描述)

description 来源于变量或需运行时生成时,可封装为字段工厂函数(注意:返回的是 Field 实例,不是类型):

def BenchmarkField(description: str) -> Field:
    return Field(
        default=None,
        max_digits=80,
        decimal_places=5,
        description=description,
        json_schema_extra={"type": "display"},
    )

class ModelB(BaseModel):
    benchmark2: Decimal | None = BenchmarkField("Benchmark 2")
    benchmark3: Decimal | None = BenchmarkField("Benchmark 3")
    benchmark4: Decimal | None = BenchmarkField("Benchmark 4")

✅ 优势:逻辑集中、易于单元测试;
❌ 局限:无法复用 Decimal | None 类型本身(仍需重复写类型注解)。

? 进阶技巧:组合 Annotated 支持多级复用

你还可以进一步抽象出「带描述的基准字段」类型,实现零重复:

def BenchmarkField(description: str) -> Any:
    return Annotated[
        Decimal | None,
        Field(default=None, **DECIMAL_CONFIG),
        WithJsonSchema({"type": "display"}),
        Field(description=description),  # 显式覆盖 description
    ]

class ModelC(BaseModel):
    benchmark2: BenchmarkField("Benchmark 2") = None
    benchmark3: BenchmarkField("Benchmark 3") = None
    benchmark4: BenchmarkField("Benchmark 4") = None

✅ 验证与最佳实践

  • 所有方案均生成符合预期的 JSON Schema("type": "display" 出现在 properties.xxx.type);
  • model_dump() 行为完全一致,支持 None、字符串/数字输入自动转换;
  • 强烈建议避免使用 Field(...) 作为类型别名的值(如原答案中 NullableDecimal = Annotated[..., Field(...)] 是合法的,但 Field 本身不是类型,仅用于元数据注入);
  • 若项目中存在大量同类字段,推荐将 DECIMAL_CONFIGDISPLAY_SCHEMA 提取至配置模块统一管理。

通过 Annotated,你不仅消除了代码重复,更将领域语义(如“这是一个展示用的高精度基准值”)提升为类型系统的一部分——这才是 Pydantic v2 强大类型表达力的核心体现。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1551

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

3664

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1569

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

20937

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2587

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2647

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1083

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

576

2023.08.10

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

0

2026.09.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn