如何集中定义Pydantic通用字段并在模型中复用?
解决方案
针对你遇到的重复定义变量、维护成本高的问题,推荐通过集中定义变量的类型/字段配置,在Pydantic模型中直接引用的方式解决,完全适配零散多样的字段组合需求,具体实现如下:
1. 集中定义所有模板变量
将所有邮件模板用到的变量(类型、验证规则、元数据等)统一放在一个模块中,比如template_fields.py:
from typing import Annotated from pydantic import Field # 基础类型定义(仅指定类型) CUST_NAME = str BILL_ADDRESS = str SHIP_ADDRESS = str REF_NUM = int # 带验证规则/元数据的定义(按需使用) # CUST_NAME = Annotated[str, Field(title="客户名称", min_length=1, max_length=50)] # BILL_ADDRESS = Annotated[str, Field(title="账单地址", description="需包含详细街道信息")] # REF_NUM = Annotated[int, Field(title="参考编号", ge=1, le=999999)]
2. 在模板模型中引用变量
所有Pydantic模板类直接使用集中定义的变量,无需重复编写类型:
from pydantic import BaseModel from .template_fields import CUST_NAME, BILL_ADDRESS, SHIP_ADDRESS, REF_NUM class TemplateA(BaseModel): cust_name: CUST_NAME bill_address: BILL_ADDRESS class TemplateB(BaseModel): cust_name: CUST_NAME ref_num: REF_NUM class TemplateC(BaseModel): bill_address: BILL_ADDRESS ship_address: SHIP_ADDRESS
优势说明
- 统一维护:修改变量的类型、验证规则时,仅需修改
template_fields.py中的定义,所有引用该变量的模板模型会自动同步更新。 - 避免重复:彻底消除重复的类型定义,减少代码冗余。
- 灵活适配:不管模板的字段组合多么零散,都可以自由选择引用需要的变量,不受继承关系限制。
如果需要动态生成模板(比如根据配置文件生成),还可以使用Pydantic的create_model函数,基于集中定义的字段动态构建模型:
from pydantic import create_model from .template_fields import CUST_NAME, REF_NUM # 动态生成TemplateB TemplateB = create_model( "TemplateB", cust_name=(CUST_NAME, ...), ref_num=(REF_NUM, ...) )
这种方式适合模板数量极多或需要动态调整的场景,静态定义则更适合结构固定的模板。
内容的提问来源于stack exchange,提问作者FlightPlan
相关产品推荐
相关产品推荐

