使用Pydantic BaseSettings出现KeyError: 'my_obj'错误的求助

核心原因 #

出现KeyError: 'my_obj'的本质是：my_obj字段未通过Pydantic的验证流程，因此没有被纳入root_validator接收的values字典中。结合你的代码和BaseSettings特性，主要有以下几个触发点：

1. 类型注解错误 #

你代码中my_obj: obj的obj如果是自定义类，必须确保这个类已经被正确定义并导入，且拼写完全一致（比如类名是Obj而你写了小写的obj）。Pydantic无法识别未定义的类型，会直接判定该字段验证失败，从而不会将其加入values。

2. Root Validator 未配置跳过失败字段 #

在Pydantic V1中，root_validator默认不会跳过验证失败的字段。如果my_obj的类型验证未通过（比如上述的类型注解错误），values字典里就不会包含这个字段，自然会触发KeyError。

3. BaseSettings 的自动加载特性干扰 #

BaseSettings会自动从环境变量、.env文件等来源加载配置，如果你没有明确禁用这个特性，当my_obj无法从这些来源解析时（自定义类型通常无法从字符串解析），可能会干扰你传入的实例，导致验证失败。

修复步骤 #

步骤1：修正类型注解 #

确保my_obj的类型注解指向正确的自定义类，示例：

# 先定义自定义类
class MyObj:
    def __init__(self, enabled: bool):
        self.enabled = enabled

# 正确注解字段
class Settings(BaseSettings):
    my_obj: MyObj  # 使用正确的类名
    age: int = 25
    old_person: bool = False

    @root_validator(skip_on_failure=True)
    def validate_old_person(cls, values):
        values['old_person'] = values['my_obj'].enabled
        return values

步骤2：为Root Validator 添加skip_on_failure=True #

这个参数确保即使其他字段验证失败，只要my_obj验证通过，就会被包含在values中，避免KeyError：

@root_validator(skip_on_failure=True)
def validate_old_person(cls, values):
    values['old_person'] = values['my_obj'].enabled
    return values

步骤3：禁用BaseSettings的自动环境加载（可选） #

如果不需要从环境变量加载配置，可以通过Config类禁用，避免干扰传入的实例：

class Settings(BaseSettings):
    my_obj: MyObj
    age: int = 25
    old_person: bool = False

    class Config:
        env_file = None  # 禁用.env文件加载
        env_prefix = ""  # 禁用环境变量前缀匹配

    @root_validator(skip_on_failure=True)
    def validate_old_person(cls, values):
        values['old_person'] = values['my_obj'].enabled
        return values

为什么其他Settings类正常？ #

其他类的字段应该是Pydantic原生支持的类型（如str、int、bool等），这些类型能顺利通过验证并被加入values，所以root_validator能正常获取到字段值。而my_obj是自定义类型，一旦类型注解或验证环节出问题，就会触发KeyError。

内容的提问来源于stack exchange，提问作者J. Donič