Pydantic 别名技巧：将现有字段别名指向嵌套键值-Python教程-PHP中文网

pydantic 别名技巧：将现有字段别名指向嵌套键值

本文旨在解决在使用 Pydantic 处理遗留 API 数据时，如何将响应中的嵌套字段值映射到现有字段的问题。通过 computed_field 和 Field(exclude=True) 的组合，以及 serialization_alias 和 validation_alias 属性与 AliasPath 的结合使用，可以优雅地实现字段别名，避免手动删除原始字段，并保持数据模型的清晰和简洁。

在使用 Pydantic 处理来自遗留 API 的数据时，经常会遇到响应字段结构不符合预期的情况。一个常见的场景是，需要将响应中的嵌套字段的值映射到模型中已存在的字段上，而不是保留原始的嵌套结构。本文将介绍两种使用 Pydantic 实现这种字段别名的方法，并提供示例代码。

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

这种方法适用于 Pydantic v1.0 及以上版本。其核心思想是，首先将原始嵌套字段定义为一个 Pydantic 模型，然后使用 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 字段，它包含一个 url 属性。Survey 模型包含一个 logo 字段，类型为 Logo，并且使用 exclude=True 排除在序列化结果之外。logo_url 是一个计算字段，它使用 @computed_field 装饰器标记，并使用 @property 定义为属性。logo_url 属性从 logo 字段的 url 属性中提取值。

优点：

实现简单，易于理解。
不需要修改原始 API 响应数据。

缺点：

Go语言（Golang）1.26.0

Go语言（Golang）1.26.0版本提供 Go 官方 Windows amd64 MSI 安装包下载入口，版本号 1.26.0，可用于旧项目维护、兼容性测试和指定版本开发环境配置。

下载

需要定义额外的 Logo 模型。
logo 字段仍然存在于模型实例中，只是在序列化时被排除。

方法二：使用 serialization_alias 和 validation_alias 以及 AliasPath

这种方法适用于 Pydantic v2.0 及以上版本，使用了 serialization_alias 和 validation_alias 属性，以及 AliasPath。serialization_alias 用于指定序列化时使用的字段名，validation_alias 用于指定验证时使用的字段名。AliasPath 用于指定嵌套字段的路径。

以下是一个示例：

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'}

在这个例子中，logo_url 字段使用了 serialization_alias="logo"，这意味着在序列化时，该字段将被命名为 logo。validation_alias=AliasPath('logo', 'url') 指定了验证时，logo_url 字段的值应该从 logo 字典的 url 键中获取。

优点：

代码更加简洁。
不需要定义额外的模型。
可以直接将嵌套字段的值映射到目标字段。

缺点：

需要理解 serialization_alias 和 validation_alias 的含义。
只适用于 Pydantic v2.0 及以上版本。

总结

本文介绍了两种使用 Pydantic 将现有字段别名指向嵌套键值的方法。第一种方法使用 computed_field 和 Field(exclude=True)，适用于 Pydantic v1.0 及以上版本。第二种方法使用 serialization_alias 和 validation_alias 以及 AliasPath，适用于 Pydantic v2.0 及以上版本。选择哪种方法取决于您的具体需求和 Pydantic 版本。在实际应用中，建议根据 API 响应的结构和复杂度，选择最合适的方法来实现字段别名。

注意事项：