如何测试 FastAPI 的异步代码？

推荐答案

使用 pytest 和 httpx 测试 FastAPI 的异步代码

// www.javascriptcn.com code example
from fastapi import FastAPI
from fastapi.testclient import TestClient
import pytest
import httpx

app = FastAPI()

@app.get("/async-endpoint")
async def async_endpoint():
    return {"message": "Hello, async world!"}

@pytest.mark.asyncio
async def test_async_endpoint():
    async with httpx.AsyncClient(app=app, base_url="http://test") as client:
        response = await client.get("/async-endpoint")
        assert response.status_code == 200
        assert response.json() == {"message": "Hello, async world!"}

使用 TestClient 测试 FastAPI 的异步代码

// www.javascriptcn.com code example
from fastapi import FastAPI
from fastapi.testclient import TestClient

app = FastAPI()

@app.get("/async-endpoint")
async def async_endpoint():
    return {"message": "Hello, async world!"}

def test_async_endpoint_with_testclient():
    client = TestClient(app)
    response = client.get("/async-endpoint")
    assert response.status_code == 200
    assert response.json() == {"message": "Hello, async world!"}

本题详细解读

1. 使用 pytest 和 httpx 测试异步代码

• pytest.mark.asyncio: 这是一个 pytest 的标记，用于标记异步测试函数。它允许你在测试中使用 async 和 await 关键字。
• httpx.AsyncClient: httpx 是一个支持异步 HTTP 请求的库。AsyncClient 允许你异步地发送 HTTP 请求，并处理响应。
• async with: 用于管理异步上下文管理器，确保资源在使用后被正确释放。

2. 使用 TestClient 测试异步代码

• TestClient: 这是 FastAPI 提供的一个同步测试客户端，用于测试 FastAPI 应用。它允许你发送 HTTP 请求并检查响应。
• 同步测试: 尽管 TestClient 是同步的，但它仍然可以用于测试异步端点。FastAPI 内部会处理异步代码的执行。

3. 选择哪种测试方式？

• pytest + httpx: 适用于需要完全异步的测试场景，特别是当你需要测试复杂的异步逻辑时。
• TestClient: 适用于简单的异步端点测试，或者当你不想引入额外的依赖时。

4. 注意事项

• 异步测试的复杂性: 异步测试可能会引入更多的复杂性，特别是在处理并发和资源管理时。
• 测试覆盖率: 确保你的测试覆盖了所有可能的异步路径，包括错误处理和超时情况。

通过这两种方式，你可以有效地测试 FastAPI 中的异步代码，确保其在不同场景下的正确性和稳定性。