当前位置:首页 > 文章列表 > 文章 > python教程 > Pydantic字段别名映射旧键方法

Pydantic字段别名映射旧键方法

2025-10-31 08:33:49 0浏览 收藏

欢迎各位小伙伴来到golang学习网,相聚于此都是缘哈哈哈!今天我给大家带来《Pydantic 字段别名映射现有键方法》,这篇文章主要讲到等等知识,如果你对文章相关的知识非常感兴趣或者正在自学,都可以关注我,我会持续更新相关文章!当然,有什么建议也欢迎在评论留言提出!一起学习!

使用 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 字段,从而实现数据结构的转换。

注意事项:

  • 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 返回的数据,并将其转换为符合预期的结构。

今天关于《Pydantic字段别名映射旧键方法》的内容就介绍到这里了,是不是学起来一目了然!想要了解更多关于的内容请关注golang学习网公众号!

通义千问官网入口及在线体验地址通义千问官网入口及在线体验地址
上一篇
通义千问官网入口及在线体验地址
Golang标准库为何常用指针接收者
下一篇
Golang标准库为何常用指针接收者
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    1100次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    1095次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    1265次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    1204次使用
  • MMBench详解:多模态大模型基准测试、功能特点与使用指南
    MMBench
    MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
    1051次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码