三周精通FastAPI：32 探索怎样使用pytest举行高效、全面的项目测试！
官方文档：https://fastapi.tiangolo.com/zh/tutorial/testing/举行项目测试¶
感谢 Starlette，测试FastAPI 应用轻松又愉快。
它基于 HTTPX， 而HTTPX又是基于Requests设计的，所以很相似且易懂。
有了它，你可以直接与FastAPI一起使用 pytest。
使用 TestClient¶
"信息"
要使用 TestClient，先要安装 httpx.
例：pip install httpx.
导入 TestClient.
通过传入你的FastAPI应用创建一个 TestClient 。
创建名字以 test_ 开头的函数（这是尺度的 pytest 约定）。
像使用 httpx 那样使用 TestClient 对象。
为你必要查抄的地方用尺度的Python表达式写个简单的 assert 语句（重申，尺度的pytest）。
from fastapi import FastAPI
from fastapi.testclient import TestClient
app = FastAPI()
@app.get("/")
async def read_main():
return {"msg": "Hello World"}
client = TestClient(app)
def test_read_main():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"msg": "Hello World"}
"提示"
留意测试函数是平常的 def，不是 async def。
另有client的调用也是平常的调用，不是用 await。
这让你可以直接使用 pytest 而不会遇到贫苦。
"技术细节"
你也可以用 from starlette.testclient import TestClient。
FastAPI 提供了和 starlette.testclient 一样的 fastapi.testclient，只是为了方便开辟者。但它直接来自Starlette。
"提示"
除了发送请求之外，如果你还想测试时在FastAPI应用中调用 async 函数（比方异步数据库函数）， 可以在高级教程中看下 Async Tests 。
分离测试¶
在实际应用中，你可能会把你的测试放在另一个文件里。
您的FastAPI应用程序也可能由一些文件/模块组成等等。
FastAPI app 文件¶
假设你有一个像 更大的应用 中所描述的文件布局:
.
├── app
│ ├── __init__.py
│ └── main.py 在 main.py 文件中你有一个 FastAPI app:
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def read_main():
return {"msg": "Hello World"}
测试文件¶
然后你会有一个包含测试的文件 test_main.py 。app可以像Python包那样存在（一样是目录，但有个 __init__.py 文件）：
.
├── app
│ ├── __init__.py
│ ├── main.py
│ └── test_main.py
因为这文件在同一个包中，所以你可以通过相对导入从 main 模块（main.py）导入app对象：
from fastapi.testclient import TestClient
from .main import app
client = TestClient(app)
def test_read_main():
response = client.get("/")
assert response.status_code == 200
assert response.json() == {"msg": "Hello World"} ...然后测试代码和之前一样的。
测试：扩展示例¶
现在让我们扩展这个例子，并添加更多细节，看下怎样测试差别部分。
扩展后的 FastAPI app 文件¶
让我们继续之前的文件布局：
.
├── app
│ ├── __init__.py
│ ├── main.py
│ └── test_main.py
假设现在包含FastAPI app的文件 main.py 有些其他路径操纵。
有个 GET 操纵会返回错误。
有个 POST 操纵会返回一些错误。
所有路径操纵 都必要一个X-Token 头。
from typing import Annotated
from fastapi import FastAPI, Header, HTTPException
from pydantic import BaseModel
fake_secret_token = "coneofsilence"
fake_db = {
"foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
"bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
}
app = FastAPI()
class Item(BaseModel):
id: str
title: str
description: str | None = None
@app.get("/items/{item_id}", response_model=Item)
async def read_main(item_id: str, x_token: Annotated):
if x_token != fake_secret_token:
raise HTTPException(status_code=400, detail="Invalid X-Token header")
if item_id not in fake_db:
raise HTTPException(status_code=404, detail="Item not found")
return fake_db
@app.post("/items/", response_model=Item)
async def create_item(item: Item, x_token: Annotated):
if x_token != fake_secret_token:
raise HTTPException(status_code=400, detail="Invalid X-Token header")
if item.id in fake_db:
raise HTTPException(status_code=409, detail="Item already exists")
fake_db = item
return item 扩展后的测试文件¶
然后您可以使用扩展后的测试更新test_main.py：
from fastapi.testclient import TestClient
from .main import app
client = TestClient(app)
def test_read_item():
response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
assert response.status_code == 200
assert response.json() == {
"id": "foo",
"title": "Foo",
"description": "There goes my hero",
}
def test_read_item_bad_token():
response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
assert response.status_code == 400
assert response.json() == {"detail": "Invalid X-Token header"}
def test_read_nonexistent_item():
response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
assert response.status_code == 404
assert response.json() == {"detail": "Item not found"}
def test_create_item():
response = client.post(
"/items/",
headers={"X-Token": "coneofsilence"},
json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
)
assert response.status_code == 200
assert response.json() == {
"id": "foobar",
"title": "Foo Bar",
"description": "The Foo Barters",
}
def test_create_item_bad_token():
response = client.post(
"/items/",
headers={"X-Token": "hailhydra"},
json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
)
assert response.status_code == 400
assert response.json() == {"detail": "Invalid X-Token header"}
def test_create_existing_item():
response = client.post(
"/items/",
headers={"X-Token": "coneofsilence"},
json={
"id": "foo",
"title": "The Foo ID Stealers",
"description": "There goes my stealer",
},
)
assert response.status_code == 409
assert response.json() == {"detail": "Item already exists"}
每当你必要客户端在请求中传递信息，但你不知道怎样传递时，你可以通过搜索（谷歌、百度）怎样用 httpx做，或者是用 requests 做，毕竟HTTPX的设计是基于Requests的设计的。
还可以在FastAPI启动服务后，从docs文档中，点开GET、POST等路径说明，点击右上角的“Try it out”， docs文档会给出curl请求的参数示例。
接着只需在测试中同样操纵。
示例：
[*]传一个路径 或查询 参数，添加到URL上。
[*]传一个JSON体，传一个Python对象(比方一个dict)到参数 json。
[*]如果你必要发送 Form Data 而不是 JSON，使用 data 参数。
[*]要发送 headers，传 dict 给 headers 参数。
[*]对于 cookies，传 dict 给 cookies 参数。
关于怎样传数据给后端的更多信息 (使用httpx 或 TestClient)，请查阅 HTTPX 文档.
"信息"
留意 TestClient 接收可以被转化为JSON的数据，而不是Pydantic模型。
如果你在测试中有一个Pydantic模型，并且你想在测试时发送它的数据给应用，你可以使用在JSON Compatible Encoder介绍的jsonable_encoder 。
运行起来¶
之后，你只必要安装 pytest:
fast →pip install pytest
████████████████████████████████ 80%
他会自动检测文件和测试，执行测试，然后向你报告结果。
执行测试：
fast →pytest
================ test session starts ================
platform linux -- Python 3.6.9, pytest-5.3.5, py-1.8.1, pluggy-0.13.1
rootdir: /home/user/code/superawesome-cli/app
plugins: forked-1.1.3, xdist-1.31.0, cov-2.8.1
collected 6 items
██████████████████████████████████████ 95%
https://i-blog.csdnimg.cn/direct/f0235b459bb24827b3212759b4143bf8.png
实践
首先安装httpx
pip install httpx 写文件代码
将下面代码存为main.py
from typing import Annotated
from fastapi import FastAPI, Header, HTTPException
from pydantic import BaseModel
fake_secret_token = "coneofsilence"
fake_db = {
"foo": {"id": "foo", "title": "Foo", "description": "There goes my hero"},
"bar": {"id": "bar", "title": "Bar", "description": "The bartenders"},
}
app = FastAPI()
class Item(BaseModel):
id: str
title: str
description: str | None = None
@app.get("/items/{item_id}", response_model=Item)
async def read_main(item_id: str, x_token: Annotated):
if x_token != fake_secret_token:
raise HTTPException(status_code=400, detail="Invalid X-Token header")
if item_id not in fake_db:
raise HTTPException(status_code=404, detail="Item not found")
return fake_db
@app.post("/items/", response_model=Item)
async def create_item(item: Item, x_token: Annotated):
if x_token != fake_secret_token:
raise HTTPException(status_code=400, detail="Invalid X-Token header")
if item.id in fake_db:
raise HTTPException(status_code=409, detail="Item already exists")
fake_db = item
return item 将下面代码存为test_main.py
from fastapi.testclient import TestClient
from .main import app
client = TestClient(app)
def test_read_item():
response = client.get("/items/foo", headers={"X-Token": "coneofsilence"})
assert response.status_code == 200
assert response.json() == {
"id": "foo",
"title": "Foo",
"description": "There goes my hero",
}
def test_read_item_bad_token():
response = client.get("/items/foo", headers={"X-Token": "hailhydra"})
assert response.status_code == 400
assert response.json() == {"detail": "Invalid X-Token header"}
def test_read_nonexistent_item():
response = client.get("/items/baz", headers={"X-Token": "coneofsilence"})
assert response.status_code == 404
assert response.json() == {"detail": "Item not found"}
def test_create_item():
response = client.post(
"/items/",
headers={"X-Token": "coneofsilence"},
json={"id": "foobar", "title": "Foo Bar", "description": "The Foo Barters"},
)
assert response.status_code == 200
assert response.json() == {
"id": "foobar",
"title": "Foo Bar",
"description": "The Foo Barters",
}
def test_create_item_bad_token():
response = client.post(
"/items/",
headers={"X-Token": "hailhydra"},
json={"id": "bazz", "title": "Bazz", "description": "Drop the bazz"},
)
assert response.status_code == 400
assert response.json() == {"detail": "Invalid X-Token header"}
def test_create_existing_item():
response = client.post(
"/items/",
headers={"X-Token": "coneofsilence"},
json={
"id": "foo",
"title": "The Foo ID Stealers",
"description": "There goes my stealer",
},
)
assert response.status_code == 409
assert response.json() == {"detail": "Item already exists"} 创建空白__init__.py文件
在当前目录创建文件：
touch __init__.py
启动服务
uvicorn main:app --reload
测试：
在当前目录执行pytest
pytest 测试输出：
/Users/skywalk/py311/lib/python3.11/site-packages/pytest_asyncio/plugin.py:208: PytestDeprecationWarning: The configuration option "asyncio_default_fixture_loop_scope" is unset.
The event loop scope for asynchronous fixtures will default to the fixture caching scope. Future versions of pytest-asyncio will default the loop scope for asynchronous fixtures to function scope. Set the default fixture loop scope explicitly in order to avoid unexpected behavior in the future. Valid fixture loop scopes are: "function", "class", "module", "package", "session"
warnings.warn(PytestDeprecationWarning(_DEFAULT_FIXTURE_LOOP_SCOPE_UNSET))
========================= test session starts =========================
platform darwin -- Python 3.11.4, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/skywalk/work/fastapi/test
plugins: asyncio-0.24.0, anyio-3.5.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 6 items
test_main.py ......
========================== 6 passed in 0.99s ==========================
可以见到6项测试都通过了。
总结
pytest 提供了轻便的语法、机动的夹具、丰富的插件和具体的调试信息，使得编写和维护测试变得更加容易和高效。无论是小型项目还是大型项目，pytest 都是一个非常强大且机动的测试框架。
pytest 可以自动发现测试文件和测试用例，用户只需按照约定的命名规则（如以test_开头）命名文件和函数，pytest 会自动辨认和运行这些测试。
具体pytest可以参考：测试框架pytest学习与实践_怎么使用 flake8-pytest-style-CSDN博客
调试
pytest报错
=============================== ERRORS ================================
____________________ ERROR collecting test_main.py ____________________
ImportError while importing test module '/Users/skywalk/work/fastapi/test/test_main.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
../../../py311/lib/python3.11/importlib/__init__.py:126: in import_module
return _bootstrap._gcd_import(name, package, level)
test_main.py:3: in <module>
from .main import app
E ImportError: attempted relative import with no known parent package
======================= short test summary info =======================
ERROR test_main.py
!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!
========================== 1 error in 1.14s ===========================
原来是目录下必要一个__init__.py文件，touch一个：
touch __init__.py 再执行pytest， 测试通过：
========================= test session starts =========================
platform darwin -- Python 3.11.4, pytest-8.3.3, pluggy-1.5.0
rootdir: /Users/skywalk/work/fastapi/test
plugins: asyncio-0.24.0, anyio-3.5.0
asyncio: mode=Mode.STRICT, default_loop_scope=None
collected 6 items
test_main.py ......
========================== 6 passed in 0.99s ==========================
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
页:
[1]