快速上手¶
安装 pytest
¶
pytest
需要:Python 3.7+ or PyPy3。
在命令行中执行如下命令:
pip install -U pytest
检查你安装的版本是否正确:
$ pytest --version
pytest 7.1.3
创建第一个测试¶
创建新文件 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-7.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()
使用 “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
第一次测试通过了,第二次失败了。您可以很容易地看到断言中的中间值,以帮助您理解失败的原因。
将测试分组到类中可能有以下好处:
有组织的 Test
仅在该特定类中为测试共享 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/function arguments 来请求任意资源,比如一个唯一的临时目录:
# 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 fixtures 存在的类型:
pytest --fixtures # shows builtin and custom fixtures
注意,这个命令省略了以 _
开头的 fixture,除非添加了 -v
选项。
继续阅读¶
查阅其他 pytest 资源,以帮助您为独特的工作流定制测试:
“如何调用 pytest” 对于命令行调用示例
“How to use pytest with an existing test suite” 用于处理已存在的测试
“如何用属性标记测试函数” 是
pytest.mark
机制有关 pytest 的信息“Fixtures reference” 为您的测试提供功能基线
“Writing plugins” 用于管理和编写插件
“Good Integration Practices” 用于virtualenv和测试布局