0

0

如何在 FastAPI 单元测试中正确 await HTTP 客户端请求

碧海醫心

碧海醫心

发布时间:2026-01-24 22:32:02

|

484人浏览过

|

来源于php中文网

原创

如何在 FastAPI 单元测试中正确 await HTTP 客户端请求

fastapi 测试中 `client.get()` 是同步方法,不能直接 `await`;需改用 `async with client.get(...) as response:` 语法获取异步响应对象,避免 `typeerror: object response can't be used in 'await' expression`。

在 FastAPI 的异步测试场景中(如使用 pytest-asyncio),一个常见误区是误将测试客户端的 .get() 方法当作协程函数调用。实际上,TestClient(来自 fastapi.testclient.TestClient)是完全同步的 HTTP 客户端,其所有方法(包括 .get(), .post() 等)均返回普通 Response 对象,不支持 await —— 这正是报错 TypeError: object Response can't be used in 'await' expression 的根本原因。

✅ 正确做法是:改用 httpx.AsyncClient 配合 @pytest.mark.asyncio,它才是为异步测试设计的官方推荐方案。TestClient 仅适用于同步测试;若需真正异步发起请求(例如测试中间件、流式响应或依赖事件循环的行为),必须切换到 AsyncClient。

以下是修正后的完整示例:

UXbot
UXbot

AI产品设计工具

下载
import pytest
from httpx import AsyncClient
from your_app.main import app  # 替换为你的 FastAPI 实例路径

@pytest.mark.asyncio
async def test_get_report(report_service, headers):
    """Test Report GET Response with true async client"""
    report_id = "sample-report-id"

    # Mock 服务层(确保其异步方法可被 await)
    report_service.query_db.query_fetchone = mock.AsyncMock(
        return_value={
            "id": "sample-id",
            "reportId": "sample-report-id",
            "reportName": "sample-report-name",
            "report": [],
        }
    )

    # 使用 httpx.AsyncClient(非 TestClient!)
    async with AsyncClient(app=app, base_url="http://test") as ac:
        response = await ac.get(f"/v2/report/{report_id}", headers=headers)

    assert response.status_code == 200
    assert response.json()["reportId"] == "sample-report-id"

⚠️ 注意事项:

  • 确保已安装 httpx:pip install httpx
  • AsyncClient(app=app, ...) 会自动挂载 FastAPI 应用到异步测试环境,无需运行真实服务器;
  • 若仍使用 TestClient,则不应加 await,也不应尝试 async with(它不支持上下文协议),否则会引发 AttributeError;
  • mock.AsyncMock 的返回值需与实际调用链匹配(如 query_fetchone 被 await 调用,因此必须是真正的协程模拟);
  • 原始代码中 response.status_code 在 AsyncClient 中对应 response.status_code(保持兼容),但响应体需用 .json() 或 .text 显式解析。

总结:await 错误的本质是客户端类型不匹配。坚持「同步测试用 TestClient + 普通调用」,「异步测试用 AsyncClient + await」,即可彻底规避此类问题。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

178

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

214

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

417

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

76

2025.09.10

Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

27

2025.12.22

pip安装使用方法
pip安装使用方法

安装步骤:1、确保Python已经正确安装在您的计算机上;2、下载“get-pip.py”脚本;3、按下Win + R键,然后输入cmd并按下Enter键来打开命令行窗口;4、在命令行窗口中,使用cd命令切换到“get-pip.py”所在的目录;5、执行安装命令;6、验证安装结果即可。大家可以访问本专题下的文章,了解pip安装使用方法的更多内容。

339

2023.10.09

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

25

2026.01.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号