0

0

使用 Pydantic 将字段别名指向现有键

心靈之曲

心靈之曲

发布时间:2025-10-10 13:14:01

|

925人浏览过

|

来源于php中文网

原创

使用 pydantic 将字段别名指向现有键

第一段引用上面的摘要:

本文介绍了在使用 Pydantic 处理 API 响应时,如何将一个字段别名指向响应中已存在的键,从而实现数据结构的转换和清理。通过 computed_field 和 Field(exclude=True) 的组合,以及 serialization_alias 和 validation_alias 属性,可以优雅地解决字段冲突和数据重塑的问题,避免手动删除键值对的繁琐操作。

当处理来自 API 的数据时,经常会遇到数据结构不符合预期的情况。例如,API 返回的数据中,某个字段嵌套在对象中,而我们希望将其直接提取到顶层,或者 API 使用的字段名与我们已有的字段名冲突。Pydantic 提供了多种方式来解决这些问题,本文将介绍如何使用 Pydantic 的 computed_field、Field(exclude=True)、serialization_alias 和 validation_alias 属性来实现字段别名和数据重塑。

方法一:使用 computed_field 和 Field(exclude=True)

如果 API 返回的数据中,我们希望将嵌套在对象中的字段提取到顶层,并且移除原有的嵌套对象,可以使用 computed_field 和 Field(exclude=True) 的组合。

以下是一个示例:

from pydantic import BaseModel, Field, computed_field

class Logo(BaseModel):
    url: str = ''


class Survey(BaseModel):
    logo: Logo = Field(exclude=True)

    @computed_field
    @property
    def logo_url(self) -> str:
        return self.logo.url

# 示例用法
a = Survey(logo={'url': 'foo'})
print(a.model_dump())
# {'logo_url': 'foo'}

在这个例子中,Logo 类表示 API 返回的 logo 对象的结构。Survey 类包含一个 logo 字段,类型为 Logo,并使用 Field(exclude=True) 标记,表示在序列化时排除该字段。同时,Survey 类还定义了一个 logo_url 属性,使用 @computed_field 装饰器标记为计算字段。logo_url 属性的值是从 logo 对象的 url 属性获取的。

通过这种方式,我们可以将 API 返回的 logo 对象的 url 属性提取到 logo_url 字段,并在序列化时排除 logo 字段,从而实现数据结构的转换。

注意事项:

ReRoom AI
ReRoom AI

专为室内设计打造的AI渲染工具,可以将模型图、平面图、草图、照片转换为高质量设计效果图。

下载
  • computed_field 是 Pydantic v1.9 及以上版本引入的特性。
  • Field(exclude=True) 表示在序列化时排除该字段,但在反序列化时仍然会使用该字段。

方法二:使用 serialization_alias 和 validation_alias

如果 API 返回的数据中,我们希望将某个字段的值赋给一个已存在的字段,可以使用 serialization_alias 和 validation_alias 属性。

以下是一个示例:

from pydantic import BaseModel, Field, AliasPath

class Survey(BaseModel):
    logo_url: str = Field(
        ...,
        serialization_alias="logo",
        validation_alias=AliasPath('logo', 'url')
    )

# 示例用法
a = Survey.model_validate({'logo': {'url': 'foo'}})
print(a.model_dump(by_alias=True))
# {'logo': 'foo'}

在这个例子中,Survey 类包含一个 logo_url 字段,类型为 str。Field 函数的 serialization_alias 参数设置为 "logo",表示在序列化时,logo_url 字段的值将被赋给 logo 字段。validation_alias 参数设置为 AliasPath('logo', 'url'),表示在反序列化时,从 logo 对象的 url 属性获取 logo_url 字段的值。

通过这种方式,我们可以将 API 返回的 logo 对象的 url 属性的值赋给 logo_url 字段,并在序列化时将 logo_url 字段的值赋给 logo 字段,从而实现字段别名。

注意事项:

  • serialization_alias 和 validation_alias 是 Pydantic v1.0 及以上版本引入的特性。
  • AliasPath 用于指定嵌套对象的路径。

总结

本文介绍了两种使用 Pydantic 将字段别名指向现有键的方法。第一种方法使用 computed_field 和 Field(exclude=True) 的组合,适用于将嵌套在对象中的字段提取到顶层,并移除原有的嵌套对象的情况。第二种方法使用 serialization_alias 和 validation_alias 属性,适用于将某个字段的值赋给一个已存在的字段的情况。根据实际情况选择合适的方法,可以更方便地处理 API 返回的数据,并将其转换为符合预期的结构。

相关专题

更多
treenode的用法
treenode的用法

​在计算机编程领域,TreeNode是一种常见的数据结构,通常用于构建树形结构。在不同的编程语言中,TreeNode可能有不同的实现方式和用法,通常用于表示树的节点信息。更多关于treenode相关问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

536

2023.12.01

C++ 高效算法与数据结构
C++ 高效算法与数据结构

本专题讲解 C++ 中常用算法与数据结构的实现与优化,涵盖排序算法(快速排序、归并排序)、查找算法、图算法、动态规划、贪心算法等,并结合实际案例分析如何选择最优算法来提高程序效率。通过深入理解数据结构(链表、树、堆、哈希表等),帮助开发者提升 在复杂应用中的算法设计与性能优化能力。

17

2025.12.22

深入理解算法:高效算法与数据结构专题
深入理解算法:高效算法与数据结构专题

本专题专注于算法与数据结构的核心概念,适合想深入理解并提升编程能力的开发者。专题内容包括常见数据结构的实现与应用,如数组、链表、栈、队列、哈希表、树、图等;以及高效的排序算法、搜索算法、动态规划等经典算法。通过详细的讲解与复杂度分析,帮助开发者不仅能熟练运用这些基础知识,还能在实际编程中优化性能,提高代码的执行效率。本专题适合准备面试的开发者,也适合希望提高算法思维的编程爱好者。

24

2026.01.06

C++ 高级模板编程与元编程
C++ 高级模板编程与元编程

本专题深入讲解 C++ 中的高级模板编程与元编程技术,涵盖模板特化、SFINAE、模板递归、类型萃取、编译时常量与计算、C++17 的折叠表达式与变长模板参数等。通过多个实际示例,帮助开发者掌握 如何利用 C++ 模板机制编写高效、可扩展的通用代码,并提升代码的灵活性与性能。

9

2026.01.23

php远程文件教程合集
php远程文件教程合集

本专题整合了php远程文件相关教程,阅读专题下面的文章了解更多详细内容。

25

2026.01.22

PHP后端开发相关内容汇总
PHP后端开发相关内容汇总

本专题整合了PHP后端开发相关内容,阅读专题下面的文章了解更多详细内容。

18

2026.01.22

php会话教程合集
php会话教程合集

本专题整合了php会话教程相关合集,阅读专题下面的文章了解更多详细内容。

19

2026.01.22

宝塔PHP8.4相关教程汇总
宝塔PHP8.4相关教程汇总

本专题整合了宝塔PHP8.4相关教程,阅读专题下面的文章了解更多详细内容。

10

2026.01.22

PHP特殊符号教程合集
PHP特殊符号教程合集

本专题整合了PHP特殊符号相关处理方法,阅读专题下面的文章了解更多详细内容。

11

2026.01.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 4.1万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号