Pydantic 模型序列化时忽略额外字段

在 Pydantic 中，extra = "allow" 配置允许模型接收未在字段定义中声明的额外数据。但在某些情况下，我们希望在将模型序列化为字典时，忽略这些额外字段，只保留模型中明确定义的字段。本文将介绍一种优雅的方法来实现这一需求，避免手动遍历和删除额外字段。

使用 model_serializer 实现自动过滤

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

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" 表示该方法将包装默认的序列化过程。

在 _serialize 方法中，我们首先调用 handler(self) 来获取默认的序列化结果，然后使用字典推导式过滤掉不在 self.model_fields 中的字段。self.model_fields 是一个字典，包含了模型中所有已定义的字段。

应用到具体模型

现在，我们可以让我们的模型继承 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。Nested 模型允许额外字段，但当我们调用 model.model_dump() 时，额外字段会被自动过滤掉。

完整示例

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"]

在这个示例中，我们创建了一个 Root 模型，其中包含一个 Nested 模型。Nested 模型允许额外字段，但当我们调用 model.model_dump() 时，dumped_data["nested"] 中不会包含 extra 字段。

注意事项

• model_serializer 装饰器是 Pydantic v2 版本引入的，请确保你的 Pydantic 版本符合要求。
• 该方法通过自定义基类实现，所有继承自该基类的模型都会应用相同的序列化逻辑。
• mode="wrap" 确保了我们只是修改默认的序列化过程，而不是完全替换它。

总结

通过使用 model_serializer 装饰器和自定义基类，我们可以轻松地在 Pydantic 模型序列化时忽略额外字段，从而获得一个干净的字典表示。这种方法避免了手动遍历和删除额外字段的繁琐过程，提高了代码的可读性和可维护性。这在处理复杂嵌套模型时尤其有用。

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

相关标签：

ai 继承