Pydantic 模型导出时忽略额外字段

在 Pydantic 中，extra="allow" 配置允许模型接收未在字段定义中声明的额外数据。然而，在某些场景下，例如数据序列化或导出时，我们可能希望忽略这些额外字段，只保留模型定义中明确声明的字段。本文将介绍一种优雅的方法，通过自定义基础模型类和使用 model_serializer 装饰器，来实现这一目标。

使用 model_serializer 忽略 extra 字段

Pydantic 的 model_serializer 装饰器允许我们自定义模型的序列化行为。我们可以创建一个自定义的基础模型类，并在该类中使用 model_serializer 来过滤掉 extra 字段。

from typing import Any
from pydantic import BaseModel, ConfigDict, model_serializer, SerializerFunctionWrapHandler, FieldSerializationInfo


class MyBaseModel(BaseModel):
    @model_serializer(mode="wrap")
    def _serialize(self, handler):
        d = handler(self)
        d = {k:v for k, v in d.items() if k in self.model_fields}
        return d

在这个 MyBaseModel 类中，_serialize 方法被 model_serializer(mode="wrap") 装饰器修饰。mode="wrap" 表示我们将在 Pydantic 默认序列化逻辑的基础上进行修改。

_serialize 方法首先调用 handler(self) 来执行默认的序列化过程，得到一个字典 d。然后，我们使用字典推导式，只保留 d 中键存在于 self.model_fields 中的键值对。self.model_fields 是 Pydantic 提供的一个属性，包含了模型中所有声明的字段。

应用到实际模型

现在，我们可以将 MyBaseModel 作为我们所有模型的基类。

Brev AI

Brev.ai：搭载Suno AI V3.5技术的免费AI音乐生成器

125

查看详情

class Nested(MyBaseModel):

    model_config = ConfigDict(extra="allow")

    baz: str


class Root(MyBaseModel):

    foo: int = 10
    bar: int
    nested: Nested

在这个例子中，Nested 和 Root 都继承自 MyBaseModel。这意味着它们在序列化时都会应用我们自定义的逻辑，忽略 extra 字段。

示例代码及验证

以下是完整的示例代码，展示了如何使用 MyBaseModel 来忽略 extra 字段。

from typing import Any
from pydantic import BaseModel, ConfigDict, model_serializer, SerializerFunctionWrapHandler, FieldSerializationInfo


class MyBaseModel(BaseModel):
    @model_serializer(mode="wrap")
    def _serialize(self, handler):
        d = handler(self)
        d = {k:v for k, v in d.items() if k in self.model_fields}
        return d


class Nested(MyBaseModel):

    model_config = ConfigDict(extra="allow")

    baz: str


class Root(MyBaseModel):

    foo: int = 10
    bar: int
    nested: Nested


if __name__ == "__main__":

    model = Root(foo=10, bar=20, nested={"baz": "boing", "extra": "so special"})

    dumped_data = model.model_dump()

    assert "extra" not in dumped_data["nested"]

运行这段代码，assert 语句将会通过，证明 dumped_data["nested"] 中不包含 extra 字段。

注意事项

• 这种方法需要在所有需要忽略 extra 字段的模型中继承 MyBaseModel。
• model_serializer 的 mode 参数有多种选择，wrap 模式是最常用的，因为它允许我们在默认序列化逻辑的基础上进行修改。

总结

通过自定义基础模型类和使用 model_serializer 装饰器，我们可以方便地控制 Pydantic 模型的序列化行为，忽略 extra 字段，从而简化代码并提高效率。这种方法尤其适用于处理包含多层嵌套和大量 extra 数据的复杂模型。

以上就是Pydantic 模型导出时忽略额外字段的详细内容，更多请关注php中文网其它相关文章！

相关标签：

ai 键值对 继承