使用 Python 进行测试（2）前进到pytest

总结

pytest一个宝藏框架，减少了我们对测试蔬菜的抗拒，并让测试更有效率。
将上一节的使用unittest编写的测试使用pytest重写：

import pytest
from the_code_to_test import add@pytest.fixture()
def setup_and_tear_down():print('This is run before each test')yieldprint('This is run after each test')def test_add_integers(setup_and_tear_down):result = add(1, 2)assert result == 3result = add(1, -2)assert result == -1def test_add_strings(setup_and_tear_down):result = add("1", "2")assert result == "12"def test_add_floats(setup_and_tear_down):result = add(0.1, 0.2)assert result == pytest.approx(0.3)def test_add_mixed_types(setup_and_tear_down):with pytest.raises(TypeError):add(1, "2")

使用pytest -s the_tests.py 执行测试并获得报告。

感恩pytest

大多数人认为测试是一件苦差事。如果你需要做一些有益但不喜欢的事情，你可以增强你的意志，或是让事情更容易。对我来说，pytest是第二种策略：它使得测试更容易。
pytest很好，让我们记住它，并在未来使用pytest进行测试。

迁移到pytest

我们以上一篇的最终代码为例。
文件的结构仍然是

basic_project
├── the_code_to_test.py
└── the_tests.py

the_code_to_test.py包含：

def add(a, b):return a + b

“the_tests.py”:

import unittestfrom the_code_to_test import addclass TestAddFunction(unittest.TestCase):def setUp(self):# Anything you attach to self here is available# in other testsprint('This is run before each test')def tearDown(self):print('This is run after each test')def test_add_integers(self):result = add(1, 2)self.assertEqual(result, 3)result = add(1, -2)self.assertEqual(result, -1)def test_add_strings(self):result = add("1", "2")self.assertEqual(result, "12")def test_add_floats(self):result = add(0.1, 0.2)self.assertAlmostEqual(result, 0.3)def test_add_mixed_types(self):with self.assertRaises(TypeError):add(1, "2")

让我们将其转换成pytest。

首先需要使用在虚拟环境(venv)中pip install pytest，不要使用全局pytest，不要使用其他地方的pytest，否则将埋下痛苦的种子。

现在，我们可以使用pytest简化代码了：

import pytest
from the_code_to_test import add@pytest.fixture()
def setup_and_tear_down():print('This is run before each test')yieldprint('This is run after each test')def test_add_integers(setup_and_tear_down):result = add(1, 2)assert result == 3result = add(1, -2)assert result == -1def test_add_strings(setup_and_tear_down):result = add("1", "2")assert result == "12"def test_add_floats(setup_and_tear_down):result = add(0.1, 0.2)assert result == pytest.approx(0.3)def test_add_mixed_types(setup_and_tear_down):with pytest.raises(TypeError):add(1, "2")

走到basic_project目录下，运行pytest测试：

pytest the_tests.py
================= test session starts ================
platform linux -- Python 3.10.13, pytest-8.1.1, pluggy-1.4.0
rootdir: /path/to/basic_project
plugins: anyio-3.7.1
collected 4 itemsthe_tests.py ....[100%]================= 4 passed in 0.01s  ================

在 pytest 中，测试只是一个名称以test 开头的函数。你不需要一个类，你只需要一个特定名字的函数。此外，不需要 assertStuff 方法，它使用常规的 assert 关键字：

def test_add_integers(setup_and_tear_down):result = add(1, 2)assert result == 3result = add(1, -2)assert result == -1

不过，这不是正常的 Python 行为。为了得到这个结果，pytest实际上在幕后执行了很多魔术。我不是魔术的忠实粉丝，但我已经容忍了这一点，因为权衡是如此巨大：你可以使用常规的 Python 运算符，如 == 、 != 、 > 、 >= 或 in is, ， assert 并将作为测试的一部分。

事实上，它的作用远不止于此，因为在失败的情况下，它会分析表达式并为您提供有关出了什么问题的线索。假设我用一个错误的断言编写测试：

def test_add_integers(setup_and_tear_down):result = add(1, 2)assert result == 2result = add(1, -2)assert result == -1

执行pytest会得到

pytest the_tests.py
================= test session starts ================
platform linux -- Python 3.10.13, pytest-8.1.1, pluggy-1.4.0
rootdir: /path/to/basic_project
plugins: anyio-3.7.1
collected 4 itemsthe_tests.py F...                                                           [100%]================= FAILURES =================
_________________ test_add_integers _________________setup_and_tear_down = Nonedef test_add_integers(setup_and_tear_down):result = add(1, 2)
>       assert result == 2
E       assert 3 == 2the_tests.py:14: AssertionError
...

我们得到了一些非常明确的迹象：

由于断言失败，未成功的测试位于文件“the_tests.py”第 14 行
这个assert 正在检查 result == 2
result 实际值 3

不过，我还没有解释这个 setup_and_tear_down 参数到底是什么，但我需要一整节来解释。

Fixtures，pytest的秘密武器

pytest的表现力已经使其具有竞争力，而pytest在setup和tear down方面更加出色。再一次，pytest使用黑魔法来实现。

您可以使用 @fixture 装饰器标记任何生成器：

@pytest.fixture()
# 函数名"setup_and_tear_down"非必要, 可以是任何名称 
def setup_and_tear_down():print('This is run before each test')yieldprint('This is run after each test')

在这个例子中，Fixture（夹具）什么也不做。

但是，一旦你想要执行测试，并且测试函数有与夹具函数名称相同的参数：

# 参数名和夹具函数名"setup_and_tear_down"相同
def test_add_integers(setup_and_tear_down):...

Python就会在测试test_add_integers时自动调用setup_and_tear_down()生成器。

当然，这根本不是典型的 Python 行为，而是我所说的黑魔法：pytest 将函数名称链接到参数名称，并在测试运行时将它们放在一起。这很奇怪。它有一个名字，叫做“依赖注入”。

在我们看到一个关于它是如何工作的完整示例之前，让我们分解一下 pytest 将如何使用它：

它会调用setup_and_tear_down() ，直到它yield
然后运行test_add_integers()，将yield结果作为参数传递
接下来，它将在yield 之后恢复生成器（即使测试失败）

这个过程相当于：

在测试前执行 yield 之前的代码，类似unittest的self.setUp()
在yield右侧的值作为参数传递给test，就像unittest中给self附加一些东西
在测试后执行yield 之后的代码，类似unittest的self.tearDown()

你可能需要一个示例来解除我们之间的误会。我们先创建两个夹具，然后在测试中以不同的姿势使用它们：

import pytest
import random
from the_code_to_test import add# 创建2个fixtures@pytest.fixture()
def random_number():yolo = random.randint(0, 10)yield yoloprint(f"\nWe tested with {yolo}")@pytest.fixture()
def setup_and_tear_down():print("\nThis is run before each test")yieldprint("\nThis is run after each test")# 使用2个夹具
def test_add_integers(setup_and_tear_down, random_number):result = add(1, 2)assert result == 3result = add(1, -2)assert result == -1# The result of the fixture is used in the testassert add(0, random_number) >= 0# 使用1个夹具
def test_add_strings(setup_and_tear_down):result = add("1", "2")assert result == "12"# 不使用夹具
def test_add_floats():result = add(0.1, 0.2)assert result == pytest.approx(0.3)def test_add_mixed_types():with pytest.raises(TypeError):add(1, "2")

现在运行测试

pytest the_tests.py
================= test session starts ================
platform linux -- Python 3.10.13, pytest-8.1.1, pluggy-1.4.0
rootdir: /path/to/basic_project
plugins: anyio-3.7.1
collected 4 itemsthe_tests.py ....[100%]================= 4 passed in 0.01s  ================

什么输出都没有？
这是 pytest 的一个典型陷阱，每个初学者都会被它抓住：pytest默认捕获stdout。我们需要用-s指示它不要这样做：

pytest the_tests.py -s
================= test session starts ================
platform linux -- Python 3.10.13, pytest-7.3.0, pluggy-1.0.0
rootdir: /path/to/basic_project
plugins: django-4.5.2, clarity-1.0.1
collected 4 itemsthe_tests.py
This is run before each test
.
We tested with 10This is run after each testThis is run before each test
.
This is run after each test
..================= 4 passed in 0.01s  ================

现在，我们可以清楚地看到夹具setup_and_tear_down 被调用进行 2 次测试，并在之前和之后运行代码。我们还可以看到夹具random_number 被调用一次。

Pytest 带有大量命令行标志，我们可以使用 -v 详细（verbose）地查看每个测试的名称…

pytest the_tests.py -s -v
================= test session starts ================
platform linux -- Python 3.10.13, pytest-7.3.0, pluggy-1.0.0
rootdir: /path/to/basic_project
plugins: django-4.5.2, clarity-1.0.1
collected 4 itemsthe_tests.py::test_add_integers
This is run before each test
PASSED
We tested with 3This is run after each testthe_tests.py::test_add_strings
This is run before each test
PASSED
This is run after each testthe_tests.py::test_add_floats PASSED
the_tests.py::test_add_mixed_types PASSED================= 4 passed in 0.01s  ================

夹具系统非常灵活，允许您将设置和拆卸组合在一起，共享它们，随心所欲地激活/停用一个…
事实上，您甚至可以在夹具中使用夹具：

@pytest.fixture()
def random_number():yolo = random.randint(0, 10)yield yoloprint(f"\nWe tested with {yolo}")# if setup_and_tear_down runs, it runs random_number
@pytest.fixture()
def setup_and_tear_down(random_number):print("\nThis is run before each test")yield random_number + 1print("\nThis is run after each test")