使用Pytest进行单元测试

大家好，欢迎来到IT知识分享网。

PyTest简介

基本用法

`pytest` 是一个非常流行的 Python 测试框架，提供了简单易用的测试功能。以下是 `pytest` 的基本使用方法：

1. 安装 `pytest`

pip install pytest

2. 创建测试文件

`pytest` 会自动发现以 `test_` 开头或 `_test` 结尾的文件。你可以创建一个名为 `test_example.py` 的文件。

# test_example.py def add(a, b): return a + b def test_add(): assert add(1, 2) == 3 assert add(-1, 1) == 0 assert add(0, 0) == 0

3. 运行测试

在命令行中，导航到包含测试文件的目录，然后运行以下命令：

pytest

`pytest` 会自动查找以 `test_` 开头的测试文件，并执行其中的测试函数。

4. 查看测试结果

运行 `pytest` 后，你会看到测试的结果，包括通过的测试和失败的测试。如果测试失败，`pytest` 会提供详细的错误信息，帮助你调试。

5. 测试夹具（Fixtures）

`pytest` 还支持测试夹具，用于设置测试环境。可以使用 `@pytest.fixture` 装饰器定义夹具。例如：

import pytest @pytest.fixture def sample_data(): return [1, 2, 3] def test_sum(sample_data): assert sum(sample_data) == 6

6. 参数化测试

你可以使用 `@pytest.mark.parametrize` 来参数化测试函数。例如：

import pytest @pytest.mark.parametrize("a, b, expected", [ (1, 2, 3), (-1, 1, 0), (0, 0, 0) ]) def test_add(a, b, expected): assert add(a, b) == expected

7. 运行特定测试

如果你只想运行特定的测试，可以使用以下命令：

pytest -k "test_add"

8. 生成测试报告

你还可以生成测试报告，比如 HTML 格式的报告。首先安装 `pytest-html`：

pip install pytest-html

然后运行测试并生成报告：

pytest --html=report.html

`pytest` 是一个功能强大且灵活的测试框架，适合用于单元测试和集成测试。通过上述方法，你可以快速上手并编写测试用例。

实践

这里有一个基于Alchemy 访问MySQL的类，要对其中的方法进行测试，使用pytest输出测试报告。写了三个单元测试文件，应用了夹具和参数进行测试，最终的结果如下：

三个测试文件的执行结果

输出的测试报告

测试代码如下：

# hanzi_test.py import os import sys # 添加当前文件所在目录到Python路径中 current_dir = os.path.dirname(os.path.abspath(__file__)) sys.path.append(current_dir) # 添加包的父目录到Python路径中 parent_dir = os.path.dirname(current_dir) sys.path.append(parent_dir) from interface.mysql.db_dictation.service.HanziService import HanziService from interface.mysql.db_dictation.entity.Hanzi import Hanzi def test_hanzi(): obj = HanziService() res = obj.getByHanzi('好') for itm in res: assert itm.f_hanzi == '好' print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") def test_hanzi_pinyin(): obj = HanziService() res = obj.getByHanziAndPinyin('好', 'hào') assert res.f_hanzi == '好' assert res.f_pinyin == 'hào' itm = res print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") def test_pinyin(): obj = HanziService() res = obj.getByPinyin('hào') for itm in res: assert itm.f_pinyin == 'hào' print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}")

# fixture_test.py import os import sys # 添加当前文件所在目录到Python路径中 current_dir = os.path.dirname(os.path.abspath(__file__)) sys.path.append(current_dir) # 添加包的父目录到Python路径中 parent_dir = os.path.dirname(current_dir) sys.path.append(parent_dir) import pytest @pytest.fixture def getObj(): from interface.mysql.db_dictation.service.HanziService import HanziService from interface.mysql.db_dictation.entity.Hanzi import Hanzi return HanziService() def test_fixture_hanzi(getObj): res = getObj.getByHanzi('好') for itm in res: assert itm.f_hanzi == '好' print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") def test_fixture_hanzi_pinyin(getObj): res = getObj.getByHanziAndPinyin('好', 'hào') assert res.f_hanzi == '好' assert res.f_pinyin == 'hào' itm = res print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") def test_fixture_pinyin(getObj): res = getObj.getByPinyin('hào') for itm in res: assert itm.f_pinyin == 'hào' print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}")

# parametrize_test.py import os import sys # 添加当前文件所在目录到Python路径中 current_dir = os.path.dirname(os.path.abspath(__file__)) sys.path.append(current_dir) # 添加包的父目录到Python路径中 parent_dir = os.path.dirname(current_dir) sys.path.append(parent_dir) from interface.mysql.db_dictation.service.HanziService import HanziService from interface.mysql.db_dictation.entity.Hanzi import Hanzi import pytest @pytest.mark.parametrize("hanzi, pinyin, expected", [ ('好', 'hào','好'), ('耗', 'hào','耗'), ('浩', 'hào','浩'), ('颢', 'hào','颢'), ]) def test_parametrize_hanzi(hanzi,pinyin,expected): obj = HanziService() res = obj.getByHanzi(hanzi) for itm in res: assert itm.f_hanzi == expected print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") @pytest.mark.parametrize("hanzi, pinyin, expected", [ ('好', 'hào','好'), ('耗', 'hào','耗'), ('浩', 'hào','浩'), ('颢', 'hào','颢'), ]) def test_parametrize_hanzi_pinyin(hanzi,pinyin,expected): obj = HanziService() res = obj.getByHanziAndPinyin(hanzi, pinyin) assert res.f_hanzi == hanzi assert res.f_pinyin == pinyin itm = res print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}") @pytest.mark.parametrize("hanzi, pinyin, expected", [ ('好', 'hào','好'), ('耗', 'hào','耗'), ('浩', 'hào','浩'), ('颢', 'hào','颢'), ]) def test_parametrize_pinyin(hanzi,pinyin,expected): obj = HanziService() res = obj.getByPinyin(pinyin) for itm in res: assert itm.f_pinyin == pinyin print(f"{itm.f_hanzi} {itm.f_pinyin} {itm.f_meaning} {itm.f_sound_url} {itm.f_writing_url}")

参考文章：

1. Python技术架构 https://www.toutiao.com/article//
2. PyTest ： https://docs.pytest.org/en/stable/index.html