如何在Pydantic嵌套子模型中动态排除指定字段？

首先，你的原代码存在一个小问题：重写dict方法时没有返回父类方法的结果，导致调用时实际返回None，需要修正为：

class MyModel(BaseModel):
  field: str

  def dict(self, **kwargs):
    if 'exclude_special_fields' in kwargs:
       # 弹出自定义参数，避免传递给父类
       kwargs.pop('exclude_special_fields')
       return super().dict(exclude={"field": True}, **kwargs)

    return super().dict(**kwargs)

但嵌套场景下，父模型的自定义参数无法传递给子模型，以下是两种无需逐个重写父模型的解决方案：

方案一：通用基类（适用于Pydantic v1） #

编写一个自定义基类，所有模型继承它，重写dict方法实现参数传递和递归处理嵌套模型：

from pydantic import BaseModel
from typing import List, Iterable

class CustomBaseModel(BaseModel):
    def dict(self, **kwargs):
        # 取出自定义开关，避免传递给父类dict方法
        exclude_special = kwargs.pop('exclude_special_fields', False)
        
        # 合并当前模型的排除规则
        current_exclude = kwargs.get('exclude', {})
        if exclude_special:
            if isinstance(current_exclude, dict):
                current_exclude['field'] = True
            else:
                current_exclude = set(current_exclude) | {'field'}
            kwargs['exclude'] = current_exclude
        
        # 递归处理所有嵌套模型，传递自定义开关
        for field_name, field in self.__fields__.items():
            value = getattr(self, field_name)
            # 处理单个嵌套模型
            if isinstance(value, CustomBaseModel):
                setattr(self, field_name, value.dict(exclude_special_fields=exclude_special, **kwargs))
            # 处理模型列表/可迭代对象
            elif isinstance(value, Iterable) and not isinstance(value, (str, bytes)):
                updated_items = []
                for item in value:
                    if isinstance(item, CustomBaseModel):
                        updated_items.append(item.dict(exclude_special_fields=exclude_special, **kwargs))
                    else:
                        updated_items.append(item)
                setattr(self, field_name, updated_items)
        
        return super().dict(**kwargs)

# 子模型继承自定义基类
class MyModel(CustomBaseModel):
    field: str

# 任意父模型都继承该基类即可
class AnotherModel(CustomBaseModel):
    models: List[MyModel]

# 测试调用
instance = AnotherModel(models=[MyModel(field="foo"), MyModel(field="bar")])
print(instance.dict(exclude_special_fields=True))
# 输出: {'models': [{}, {}]}

方案二：序列化器+上下文（适用于Pydantic v2） #

利用Pydantic v2的model_dump上下文参数，通过字段序列化器动态控制字段输出：

from pydantic import BaseModel, field_serializer
from typing import List

class MyModel(BaseModel):
    field: str

    @field_serializer('field')
    def handle_field(self, value, info):
        # 从上下文读取开关，决定是否返回字段值
        if info.context.get('exclude_special_fields'):
            return None
        return value

class AnotherModel(BaseModel):
    models: List[MyModel]

# 调用时传递上下文，并排除None值
instance = AnotherModel(models=[MyModel(field="foo"), MyModel(field="bar")])
print(instance.model_dump(context={'exclude_special_fields': True}, exclude_none=True))
# 输出: {'models': [{}, {}]}

两种方案的优势：

• 方案一兼容Pydantic v1，所有模型只需继承一次基类，无需逐个编写重写逻辑；
• 方案二更贴合Pydantic v2的设计，无实例属性修改的副作用，代码更简洁。

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