如何让Pydantic的Annotated自定义类型在实例化时运行验证?
问题描述
我正在用FastAPI和Pydantic开发项目,通过Annotated定义标准库类型的子类型,示例代码如下:
def check_negative(v: int) -> int: assert v >= 0, f"{v} is negative" return v PositiveInt = Annotated[int, AfterValidator(check_negative)] class DemoModel(BaseModel): numbers: list[PositiveInt]
当前的问题是,验证逻辑仅在实例化DemoModel时才执行,导致numbers列表在传入模型前可能包含无效值。我希望在FastAPI接口路由中直接完成验证,而非等到传入模型时才触发:
numbers = [PositiveInt(2), PositiveInt(-3)] <--- 期望在此处抛出验证错误 print(numbers) demo = DemoModel(numbers=numbers) <--- 当前在此处抛出验证错误
疑问:是否有办法让AfterValidator这类验证逻辑在PositiveInt类型实例化时就运行,而非仅在BaseModel类实例化时执行?
解决方案
原因说明
Annotated本身只是给类型添加元数据的标记,并不是可实例化的类型——直接调用PositiveInt(2)其实只是创建了一个普通int实例,完全不会触发Pydantic的验证逻辑,这些元数据只有在Pydantic处理模型字段时才会被读取。
方法一:用TypeAdapter包装Annotated类型
Pydantic的TypeAdapter可以把带验证元数据的Annotated类型转换成可直接调用验证的工具,这样就能在创建值时立即触发验证:
from pydantic import AfterValidator, BaseModel, TypeAdapter from typing import Annotated def check_negative(v: int) -> int: assert v >= 0, f"{v} is negative" return v # 用TypeAdapter包装Annotated类型 PositiveInt = TypeAdapter(Annotated[int, AfterValidator(check_negative)]) # 调用validate_python方法触发验证 numbers = [PositiveInt.validate_python(2), PositiveInt.validate_python(-3)] # 此处立即抛出AssertionError
这种方法可以复用你已有的Annotated元数据定义,同时在FastAPI路由中也能直接使用:
from fastapi import FastAPI app = FastAPI() @app.post("/demo") async def create_demo(numbers: list[Annotated[int, AfterValidator(check_negative)]]): # 这里的numbers已经经过验证,不会包含负数 return {"valid_numbers": numbers}
方法二:自定义继承原生类型的类
如果你希望PositiveInt像原生类型一样直接实例化,可以自定义一个继承int的类,在构造阶段执行验证:
from pydantic import BaseModel def check_negative(v: int) -> int: assert v >= 0, f"{v} is negative" return v class PositiveInt(int): def __new__(cls, value): # 在创建实例前先执行验证 validated_value = check_negative(value) return super().__new__(cls, validated_value) # 直接实例化就会触发验证 numbers = [PositiveInt(2), PositiveInt(-3)] # 此处立即抛出AssertionError # 同时可以正常在BaseModel中使用 class DemoModel(BaseModel): numbers: list[PositiveInt]
这种方式语法更接近原生类型,无需额外调用验证方法,Pydantic也能自动识别并处理这个自定义类型。
内容的提问来源于stack exchange,提问作者Lucien Chardon
相关产品推荐
相关产品推荐

