Pydantic中TypedDict联合类型的验证行为解析

在Python类型系统中，TypedDict是一种用于描述字典结构的类型注解工具，而Pydantic库则提供了强大的数据验证功能。本文将深入探讨Pydantic V2在处理TypedDict联合类型时的一个有趣验证行为。

问题现象

当使用Pydantic的TypeAdapter验证一个字典对象时，如果该字典不符合TypedDict联合类型中的任何一个选项，Pydantic会静默地移除不符合要求的字段，而不是抛出验证错误。例如：

from typing import NotRequired, TypedDict
import pydantic

class Option1(TypedDict):
    one: NotRequired[int]

class Option2(TypedDict):
    two: NotRequired[bool]

# 这个字典不符合Option1或Option2的定义
invalid = {"two": "foo"}
result = pydantic.TypeAdapter(Option1 | Option2).validate_python(invalid, strict=True)
# 输出: {}

行为分析

这个现象看似是联合类型的验证问题，但实际上与Pydantic处理TypedDict的方式有关。核心原因在于：

1. Pydantic默认情况下会忽略TypedDict中未定义的额外字段
2. 当验证失败时，Pydantic会尝试其他联合选项
3. 由于Option1没有定义two字段，Pydantic会忽略这个额外字段
4. 最终得到一个空字典，因为所有字段都被忽略了

解决方案

要改变这种行为，可以通过配置强制Pydantic禁止额外字段：

from pydantic import with_config

@with_config({'extra': 'forbid'})
class Option1(TypedDict):
    one: NotRequired[int]

# 现在会抛出验证错误

未来随着PEP 728的引入，这种配置将变得更加简洁直观。

技术背景

TypedDict在Python中用于描述具有特定键值类型的字典。Pydantic通过以下方式增强其功能：

1. 运行时验证：确保字典结构与类型注解匹配
2. 数据转换：自动将输入数据转换为正确的类型
3. 严格模式：可配置是否允许额外字段

在联合类型场景下，Pydantic会依次尝试每个可能的类型，直到找到匹配的类型或全部失败。

最佳实践

在使用Pydantic验证TypedDict时，建议：

1. 明确指定extra配置，避免意外行为
2. 对于关键数据验证，考虑使用严格模式
3. 联合类型中的各个TypedDict最好有互斥的字段，减少歧义
4. 考虑使用Pydantic的BaseModel替代TypedDict，获得更严格的验证

理解这些底层行为有助于开发者更好地利用Pydantic构建健壮的数据验证逻辑。