如何在FastAPI中将Request参数定义为可选变量类型避免报错
错误原因
FastAPI 会自动识别路径操作函数的参数类型:如果是Request这类特殊类型,会直接从请求上下文注入,不走Pydantic校验;如果参数带默认值,就会被识别为普通请求参数,需要通过Pydantic做类型校验。
你给Request类型参数设置了默认值None后,FastAPI不再把它归类为自动注入的特殊类型,反而尝试用Pydantic解析Optional[Request],而Request本身不是Pydantic支持的字段类型,因此抛出报错。
解决方案
分两种场景选择对应方案:
场景1:仅在FastAPI请求逻辑中使用该函数
这种场景下Request对象一定会被FastAPI自动注入,不会为空,不需要设为可选,直接删掉Optional修饰和默认值即可:
# 只需修改路径函数参数定义即可,其余代码保持不变 @router.get('/pcinfo/', tags=['pcinfo']) def get_users(req: Request): if req: print(type(req)) print(req.query_params) para = dict(req.query_params) return para else: print(req) return {'message': 'hello'}
场景2:需要复用该函数,手动调用时可以不传req参数
需要用Depends明确告诉FastAPI该参数的注入逻辑,首先导入Depends:
from fastapi import APIRouter, Request, Depends
再修改参数定义:
@router.get('/pcinfo/', tags=['pcinfo']) def get_users(req: Optional[Request] = Depends(lambda: None)): # 原有逻辑保持不变 if req: print(type(req)) print(req.query_params) para = dict(req.query_params) return para else: print(req) return {'message': 'hello'}
内容的提问来源于stack exchange,提问作者Ken Hsieh
相关产品推荐
相关产品推荐

