入门

Get Started

安装 pytest

Install pytest

pytest 需要：Python 3.8+ 或 PyPy3。

  1. 在命令行中运行以下命令：

pip install -U pytest

  1. 检查是否安装了正确的版本：

$ pytest --version
pytest 8.3.3

创建你的第一个测试

Create your first test

创建一个名为 test_sample.py 的新文件，其中包含一个函数和一个测试：

# test_sample.py 的内容
def func(x):
    return x + 1


def test_answer():
    assert func(3) == 5

测试

$ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-8.x.y, pluggy-1.x.y
rootdir: /home/sweet/project
collected 1 item

test_sample.py F                                                     [100%]

================================= FAILURES =================================
_______________________________ test_answer ________________________________

    def test_answer():
>       assert func(3) == 5
E       assert 4 == 5
E        +  where 4 = func(3)

test_sample.py:6: AssertionError
========================= short test summary info ==========================
FAILED test_sample.py::test_answer - assert 4 == 5
============================ 1 failed in 0.12s =============================

[100%] 指的是运行所有测试用例的总体进度。完成后，pytest 会显示失败报告，因为 func(3) 没有返回 5。

Note

您可以使用 assert 语句来验证测试预期。pytest 的 高级断言自省 将智能地报告断言表达式的中间值，这样您就可以避免 JUnit 遗留方法 的许多名称。

运行多个测试

Run multiple tests

pytest 将在当前目录及其子目录中运行所有形式为 test_*.py 或 *_test.py 的文件。更一般地，它遵循: 标准测试发现规则。

断言引发了某个异常

Assert that a certain exception is raised

使用 raises 辅助程序断言某些代码引发了异常：

# test_sysexit.py的内容
import pytest


def f():
    raise SystemExit(1)


def test_mytest():
    with pytest.raises(SystemExit):
        f()

您还可以使用 raises 提供的上下文来断言预期异常是引发的 ExceptionGroup 的一部分：

# test_exceptiongroup.py的内容
import pytest


def f():
    raise ExceptionGroup(
        "Group message",
        [
            RuntimeError(),
        ],
    )


def test_exception_in_group():
    with pytest.raises(ExceptionGroup) as excinfo:
        f()
    assert excinfo.group_contains(RuntimeError)
    assert not excinfo.group_contains(TypeError)

使用“安静(quiet)”报告模式执行测试函数：

$ pytest -q test_sysexit.py
.                                                                    [100%]
1 passed in 0.12s

Note

-q/--quiet 标志可在此示例和后续示例中保持简短的输出。

在一个类(class)中对多个测试进行分组

Group multiple tests in a class

一旦您开发了多个测试，您可能希望将它们分组到一个类中。pytest 使得创建包含多个测试的类变得简单：

# test_class.py 的内容
class TestClass:
    def test_one(self):
        x = "this"
        assert "h" in x

    def test_two(self):
        x = "hello"
        assert hasattr(x, "check")

pytest 会发现所有遵循其 Python 测试发现约定 的测试，因此它会找到两个以 test_ 为前缀的函数。无需继承任何类，但请确保将类名前缀为 Test，否则该类将被跳过。我们可以简单地通过传递文件名来运行该模块：

$ pytest -q test_class.py
.F                                                                   [100%]
================================= FAILURES =================================
____________________________ TestClass.test_two ____________________________

self = <test_class.TestClass object at 0xdeadbeef0001>

    def test_two(self):
        x = "hello"
>       assert hasattr(x, "check")
E       AssertionError: assert False
E        +  where False = hasattr('hello', 'check')

test_class.py:8: AssertionError
========================= 测试摘要信息 ==========================
FAILED test_class.py::TestClass::test_two - AssertionError: assert False
1 failed, 1 passed in 0.12s

第一个测试通过，第二个测试失败。您可以轻松查看断言中的中间值，以帮助您理解失败的原因。

将测试分组到类中可以带来以下好处：

  • 测试组织

  • 仅在特定类中共享夹具

  • 在类级别应用标记，并使其隐式适用于所有测试

在类中分组测试时需要注意的是，每个测试都有一个唯一的类实例。 让每个测试共享相同的类实例将对测试隔离产生非常不利的影响，并会促进不良的测试实践。 这一点在下面阐述：

# test_class_demo.py 的内容
class TestClassDemoInstance:
    value = 0

    def test_one(self):
        self.value = 1
        assert self.value == 1

    def test_two(self):
        assert self.value == 1

$ pytest -k TestClassDemoInstance -q
.F                                                                   [100%]
================================= FAILURES =================================
______________________ TestClassDemoInstance.test_two ______________________

self = <test_class_demo.TestClassDemoInstance object at 0xdeadbeef0002>

    def test_two(self):
>       assert self.value == 1
E       assert 0 == 1
E        +  where 0 = <test_class_demo.TestClassDemoInstance object at 0xdeadbeef0002>.value

test_class_demo.py:9: AssertionError
========================= 测试摘要信息 ==========================
FAILED test_class_demo.py::TestClassDemoInstance::test_two - assert 0 == 1
1 failed, 1 passed in 0.12s

请注意，在类级别添加的属性是 类属性(class attributes)，因此它们将在测试之间共享。

为功能测试请求唯一的临时目录

Request a unique temporary directory for functional tests

pytest 提供了 内置夹具/函数参数 来请求任意资源，比如一个唯一的临时目录：

# test_tmp_path.py 的内容
def test_needsfiles(tmp_path):
    print(tmp_path)
    assert 0

在测试函数签名中列出名称 tmp_path ， pytest 会查找并调用夹具工厂，在执行测试函数调用之前创建资源。在测试运行之前， pytest 会为每次测试调用创建一个唯一的临时目录：

$ pytest -q test_tmp_path.py
F                                                                    [100%]
================================= FAILURES =================================
_____________________________ test_needsfiles ______________________________

tmp_path = PosixPath('PYTEST_TMPDIR/test_needsfiles0')

    def test_needsfiles(tmp_path):
        print(tmp_path)
>       assert 0
E       assert 0

test_tmp_path.py:3: AssertionError
--------------------------- Captured stdout call ---------------------------
PYTEST_TMPDIR/test_needsfiles0
========================= short test summary info ==========================
FAILED test_tmp_path.py::test_needsfiles - assert 0
1 failed in 0.12s

有关临时目录处理的更多信息，请参见 临时目录和文件。

使用以下命令查找存在的内置 pytest 夹具 的类型：

pytest --fixtures   # 显示内置和自定义夹具

请注意，此命令省略以 _ 开头的夹具，除非添加了 -v 选项。

继续阅读

Continue reading

查看其他 pytest 资源，以帮助您根据自己的独特工作流程自定义测试：