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

注意事项：

NameGPT名称生成器

免费AI公司名称生成器，AI在线生成企业名称，注册公司名称起名大全。

0

查看详情

• 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 将字段别名指向现有键的详细内容，更多请关注php中文网其它相关文章！