如何在Pydantic Base Model中定义可选字段避免验证报错？

两种常用解决方案 #

场景1：允许字段缺失，缺失时设为None #

导入Optional并标记字段类型为Optional[float]，Pydantic会自动处理字段缺失的情况：

from typing import Optional, List
from pydantic import BaseModel
import json

# 模拟无d字段的API响应
request_response = '{"a": 1, "b": "abc", "c": ["a", "b", "c"]}'
response: dict = json.loads(request_response)

class Model(BaseModel):
    a: int
    b: str
    c: List[str]
    d: Optional[float]  # 标记为可选字段，缺失时自动赋值为None

# 验证通过
instance = Model(**response)
print(instance.d)  # 输出: None

场景2：允许字段缺失，缺失时使用默认值 #

直接给字段设置默认值，缺失时Pydantic会自动填充该值：

from typing import List
from pydantic import BaseModel
import json

request_response = '{"a": 1, "b": "abc", "c": ["a", "b", "c"]}'
response: dict = json.loads(request_response)

class Model(BaseModel):
    a: int
    b: str
    c: List[str]
    d: float = 0.0  # 设置默认值，缺失时自动填充

# 验证通过
instance = Model(**response)
print(instance.d)  # 输出: 0.0

常见误区排查 #

• 未导入Optional：如果代码中使用了Optional但没从typing（Python版本<3.10）或typing_extensions/pydantic导入，会导致语法错误，误以为Optional无效。
• 版本兼容问题：Pydantic V1和V2均支持上述写法；若需更显式配置，可使用Field工具，效果一致：

  from pydantic import BaseModel, Field
  from typing import List
  
  class Model(BaseModel):
      a: int
      b: str
      c: List[str]
      d: float = Field(default=None)  # 等价于Optional[float]
  

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