如何在Pydantic嵌套模型的model_dump中排除额外元素？

需要获取嵌套Pydantic模型的字典表示，且不包含任何额外元素。model_dump方法提供了多个exclude相关参数，但没有直接的exclude_extras选项。以下是最简示例，目标是让断言成立，实际场景会处理多层嵌套且每层都可能存在额外数据的复杂模型：

from pydantic import BaseModel, ConfigDict


class Nested(BaseModel):
    model_config = ConfigDict(extra="allow")
    baz: str


class Root(BaseModel):
    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"]  # 当前断言失败

解决方案 #

方法1：通过model_dump的exclude参数递归排除model_extra #

Pydantic会将额外字段存储在模型的model_extra属性中，因此可以直接在model_dump时指定排除该属性，结合默认开启的递归处理，就能自动清理所有嵌套层级的额外字段：

if __name__ == "__main__":
    model = Root(foo=10, bar=20, nested={"baz": "boing", "extra": "so special"})
    # 递归排除所有层级的model_extra
    dumped_data = model.model_dump(exclude={"model_extra": True}, recurse=True)
    assert "extra" not in dumped_data["nested"]  # 断言成立

方法2：自定义全局基类统一处理 #

如果多个模型都需要排除额外字段的导出行为，可以定义一个基类，封装排除逻辑，避免重复代码：

from pydantic import BaseModel, ConfigDict

class BaseNoExtraModel(BaseModel):
    def dump_without_extras(self, **kwargs):
        return self.model_dump(exclude={"model_extra": True}, recurse=True, **kwargs)

class Nested(BaseNoExtraModel):
    model_config = ConfigDict(extra="allow")
    baz: str

class Root(BaseNoExtraModel):
    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.dump_without_extras()
    assert "extra" not in dumped_data["nested"]

方法3：JSON序列化中转（不推荐） #

如果临时需要转换，可先转成JSON字符串再解析回字典，但这种方法对复杂模型效率较低，仅适合简单场景：

import json

if __name__ == "__main__":
    model = Root(foo=10, bar=20, nested={"baz": "boing", "extra": "so special"})
    json_str = model.model_dump_json(exclude={"model_extra": True}, recurse=True)
    dumped_data = json.loads(json_str)
    assert "extra" not in dumped_data["nested"]

最优选择：方法1直接利用Pydantic内置机制，无需额外封装，且天然支持多层嵌套场景，是最简便高效的解决方案。

内容的提问来源于stack exchange，提问作者NiklasMM