Pydantic如何正确获取字段类型提示以调用自定义类型的属性与方法

一、获取字段类型的标准写法 #

你当前用的BaseModel.__fields__['my_field'].type_属于Pydantic V1的合法半公开API，是官方文档中认可的用法。如果使用Pydantic V2，官方提供了更稳定的公开API，规范写法如下：

# Pydantic V2 规范写法
BaseModel.model_fields['my_field'].annotation

这个属性是完全公开的公共接口，不会随版本迭代随意调整，兼容性更好。

二、业务逻辑修正方案 #

你现有代码中Metadata[missing_field]的写法不符合Pydantic的API规范，会直接报错。只需要将这部分替换为上述标准的字段类型获取写法，就可以正常调用你自定义类型的属性和类方法，核心逻辑修正后如下：

new_data = {}
for missing_field in missing_fields:
    # 按Pydantic版本选择对应写法获取字段类型
    # Pydantic V2 写法
    field_type = Metadata.model_fields[missing_field].annotation
    # Pydantic V1 写法
    # field_type = Metadata.__fields__[missing_field].type_

    req_data = field_type.data_required
    data_type = field_type.data_type
    data = get_data(data_type=data_type, required_data=req_data)
    new_data[missing_field] = field_type.determine(data)

三、可选优化方案 #

你当前通过捕获实例化异常获取缺失字段的逻辑可以进一步优化，提前校验输入数据的缺失字段，无需等待抛出错误再处理，逻辑更稳妥：

from typing import Any, Type
from pydantic import BaseModel

def get_required_missing_fields(model_cls: Type[BaseModel], input_data: dict[str, Any]) -> list[str]:
    missing_fields = []
    # Pydantic V2 写法
    for field_name, field_info in model_cls.model_fields.items():
        if field_info.is_required() and field_name not in input_data:
            missing_fields.append(field_name)
    # Pydantic V1 写法
    # for field_name, field_info in model_cls.__fields__.items():
    #     if field_info.required and field_name not in input_data:
    #         missing_fields.append(field_name)
    return missing_fields

使用该方法提前拿到缺失字段后，你可以直接完成数据补全，再实例化模型即可。

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