如何为 Pydantic 模型所有字段创建带别名的可选版本

胖浩小哥_6604

胖浩小哥_6604

2026-10-22

146人浏览

原创

如何为 Pydantic 模型所有字段创建带别名的可选版本

本文介绍在 Pydantic v2 中,如何基于现有模型(含 alias、serialization_alias 等配置)动态生成一个所有字段均为可选且完整保留别名语义的新模型,避免手动重定义或丢失 _id → id 等关键序列化映射。

本文介绍在 pydantic v2 中,如何基于现有模型(含 `alias`、`serialization_alias` 等配置)动态生成一个**所有字段均为可选且完整保留别名语义**的新模型,避免手动重定义或丢失 `_id` → `id` 等关键序列化映射。

在构建 API 响应或数据库更新 DTO 时,常需一个“全可选”版本的模型(例如用于 PATCH 请求),但直接使用 create_model 并简单追加 Optional[...] 会丢失原始字段的元数据(如 alias="_id"、serialization_alias="id"、default=None 等),导致序列化/反序列化行为异常——典型表现为 id 字段在 JSON 中仍以 _id 形式出现,而非预期的 id。

正确做法是:复用原始模型的 model_fields 中完整的 FieldInfo 对象,仅将其类型扩展为 T | None,并显式设置 default=None(因 Field(...) 默认不允许缺失,而 None 是可选字段的合理默认值)。

以下是推荐实现(兼容 Pydantic v2.6+,安全可靠):

import copy
from typing import Any, Optional
from pydantic import create_model, BaseModel, FieldInfo

def make_all_optional(model: type[BaseModel]) -> type[BaseModel]:
    """
    基于输入模型,创建一个所有字段均为可选、且完全继承 alias/serialization_alias/default 等配置的新模型。
    """
    field_definitions: dict[str, tuple[Any, FieldInfo]] = {}

    for field_name, field_info in model.model_fields.items():
        # 深拷贝 FieldInfo,避免污染原模型(尤其当后续调用 model_rebuild 时)
        new_field_info = copy.deepcopy(field_info)
        # 显式设为 None,确保字段可省略;若原字段已有 default(如 default=None),此步可选但更明确
        new_field_info.default = None
        # 扩展类型为 T | None(Python 3.10+ 语法),兼容旧版可改用 Optional[T]
        annotated_type = field_info.annotation | None
        field_definitions[field_name] = (annotated_type, new_field_info)

    return create_model(
        f"Optional{model.__name__}",
        **field_definitions,
        __base__=model.__base__,  # 继承相同基类(如保持 ConfigDict)
    )

# 使用示例
OptionalClientModel = make_all_optional(ClientModel)

✅ 效果验证:

  • OptionalClientModel.model_json_schema() 中,id 字段仍显示 "alias": "_id" 和 "serialization_alias": "id";
  • 序列化时 OptionalClientModel(id="abc123").model_dump() 输出 {"id": "abc123"}(非 {"_id": "abc123"});
  • 反序列化时支持 {"id": "abc123"} 或 {}(全空),均能成功实例化。

⚠️ 注意事项:

  • 必须使用 copy.deepcopy 复制 FieldInfo,否则修改 default 可能意外影响原始模型(尤其在热重载或多次 model_rebuild 场景下);
  • 若模型含泛型(如 List[Item])或复杂嵌套,该方法仍适用,因 field_info.annotation 已包含完整类型信息;
  • 不要依赖 __annotations__ 或自定义递归函数(如问题中 get_annotations),因其无法提取 Field 的别名、校验器等运行时元数据。

总结:model_fields 是 Pydantic v2 提供的权威字段元数据源,结合 create_model 与 copy.deepcopy(FieldInfo),即可零侵入地生成语义完备的可选模型——既保持接口契约,又提升代码复用性与健壮性。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

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

相关专题

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

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

2023.07.20

1791

4

python能做什么
python能做什么

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

2023.07.25

4664

7

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

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

2023.07.31

1749

3

python教程
python教程

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

2023.08.03

27577

23

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

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

2023.08.04

3327

5

python eval
python eval

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

2023.08.04

3327

5

scratch和python区别
scratch和python区别

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

2023.08.11

1203

5

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

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

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2583

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习