如何同步Pydantic模型类的Field属性并支持None值？

核心思路 #

利用Pydantic模型的字段元数据属性，复用TargetBase的Field配置，同时将字段类型修改为支持None值，避免重复定义导致的配置不一致。

具体实现（Pydantic v2） #

from pydantic import BaseModel, Field, Optional
from typing import Union

class TargetBase(BaseModel):
    url: str = Field(
        default="google.com", 
        title="Target URL",
    )
    port: int = Field(
        default=443, 
        gt=0,
        title="Target URL port number",
    )

class TargetPatch(BaseModel):
    # 复用TargetBase的url字段配置，同时允许为None
    url: Union[str, None] = TargetBase.model_fields['url'].field_info
    # 复用TargetBase的port字段配置，同时允许为None
    port: Union[int, None] = TargetBase.model_fields['port'].field_info

简化写法（用Optional） #

Optional[T]是Union[T, None]的语法糖，代码可以更简洁：

class TargetPatch(BaseModel):
    url: Optional[str] = TargetBase.model_fields['url'].field_info
    port: Optional[int] = TargetBase.model_fields['port'].field_info

批量复用的工具函数（可选） #

如果字段较多，可以封装工具函数减少重复代码：

def get_optional_field(model_cls, field_name):
    field = model_cls.model_fields[field_name]
    return Optional[field.annotation], field.field_info

class TargetPatch(BaseModel):
    url: Optional[str] = get_optional_field(TargetBase, 'url')[1]
    port: Optional[int] = get_optional_field(TargetBase, 'port')[1]

Pydantic v1版本适配 #

如果使用Pydantic v1，将model_fields替换为__fields__即可：

class TargetPatch(BaseModel):
    url: Optional[str] = TargetBase.__fields__['url'].field_info
    port: Optional[int] = TargetBase.__fields__['port'].field_info

关于访问默认值的问题 #

可以直接通过模型的字段元数据获取默认值：

# 获取TargetBase中url的默认值
url_default = TargetBase.model_fields['url'].default  # 输出: "google.com"
# 获取port的默认值
port_default = TargetBase.model_fields['port'].default  # 输出: 443

内容的提问来源于stack exchange，提问作者niyaz