TypedDict不支持设置单字段可选?搭配Pydantic做校验如何解决
解决方案
方案1:保留TypedDict实现单字段可选
TypedDict中的Optional仅用于标注字段值可以为None,不控制字段本身是否可以省略。要实现单个字段可选、其余必填,需要使用NotRequired标注可选字段:
from typing import List, Optional from pydantic import BaseModel # Python 3.11+可直接从typing导入NotRequired from typing_extensions import TypedDict, NotRequired class _trending(TypedDict): # NotRequired表示该字段可以不传,Optional表示字段值可以为None allStores: NotRequired[Optional[bool]] category: str date: str average: List[int] class RequestSchema(BaseModel): storeId: str trending: _trending class Config: # 开启Pydantic对TypedDict类型的自动校验 arbitrary_types_allowed = True
注意:TypedDict仅作类型注解,字段默认值不会自动生效,如果需要allStores不传时默认设为False,可以在RequestSchema中配置字段默认工厂处理。
方案2:直接使用Pydantic嵌套模型(更推荐)
你之前的写法错误点在于滥用Dict类型注解,固定结构的嵌套字段直接引用BaseModel子类作为类型即可,不需要套Dict:
from typing import List, Optional from pydantic import BaseModel class _trending(BaseModel): allStores: Optional[bool] = False category: str date: str average: List[int] class RequestSchema(BaseModel): storeId: str # 直接用_trending作为类型,Pydantic会自动校验嵌套结构 trending: _trending
该写法自动满足需求:
allStores字段可选,不传时默认值为False,传值时仅接受布尔值或Nonecategory/date/average为必填字段,必须传入对应类型的值- 不需要额外配置即可直接运行校验
你之前Dict[_trending]报错的原因是:Dict泛型需要传入两个参数分别定义键类型和值类型,例如Dict[str, int]表示键为字符串、值为整数的字典,仅适用于描述键名不固定的字典结构,不适合固定字段的结构化数据校验。
内容的提问来源于stack exchange,提问作者Jake
相关产品推荐
相关产品推荐

