开始使用¶

安装 `pytest`¶

pytest 需要：Python 3.8+ 或 PyPy3。

在命令行中运行以下命令

pip install -U pytest

检查您安装的版本是否正确

$ pytest --version
pytest 8.3.5

创建您的第一个测试¶

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

# content of 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。

注意

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

运行多个测试¶

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

断言是否引发了特定异常¶

使用 raises 助手来断言某些代码是否引发异常

# content of test_sysexit.py
import pytest


def f():
    raise SystemExit(1)


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

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

# content of 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

注意

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

在一个类中分组多个测试¶

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

# content of 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
========================= short test summary info ==========================
FAILED test_class.py::TestClass::test_two - AssertionError: assert False
1 failed, 1 passed in 0.12s

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

在类中分组测试可能对以下原因有利

测试组织

仅在该特定类中共享测试的 fixture

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

在类内部对测试进行分组时需要注意的一点是，每个测试都有该类的唯一实例。让每个测试共享同一个类实例将非常不利于测试隔离，并会助长不良的测试实践。下面概述了这一点

# content of 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
========================= short test summary info ==========================
FAILED test_class_demo.py::TestClassDemoInstance::test_two - assert 0 == 1
1 failed, 1 passed in 0.12s

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

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

pytest 提供内置 fixture/函数参数来请求任意资源，例如唯一的临时目录

# content of test_tmp_path.py
def test_needsfiles(tmp_path):
    print(tmp_path)
    assert 0

在测试函数签名中列出名称 tmp_path，pytest 将查找并调用 fixture 工厂以在执行测试函数调用之前创建资源。在测试运行之前，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 fixture

pytest --fixtures   # shows builtin and custom fixtures

请注意，除非添加 -v 选项，否则此命令会省略带有前导 _ 的 fixture。

继续阅读¶

查看其他 pytest 资源，以帮助您为独特的 workflow 自定义测试

“如何调用 pytest” 用于命令行调用示例
“如何将 pytest 与现有测试套件一起使用” 用于使用预先存在的测试
“如何使用属性标记测试函数” 有关 pytest.mark 机制的信息
“Fixture 参考” 为您的测试提供功能基线
“编写插件” 用于管理和编写插件
“良好的集成实践” 用于 virtualenv 和测试布局

开始使用¶

安装 pytest¶

创建您的第一个测试¶

运行多个测试¶

断言是否引发了特定异常¶

在一个类中分组多个测试¶

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

继续阅读¶

安装 `pytest`¶