Pythons：python 3.5， 3.6， 3.7， PyPy3
平台：Linux和Windows
PyPI包名：pytest
PDF文档：最新下载
pytest是一个方便构建简单的和可扩展的测试用例的测试框架。其测试用例不再需要冗余的代码，它们更直观，可读性更好。
1.1 pytest安装
pytest安装非常简单，只要用python自带的安装工具pip，在命令行中执行如下命令即可：
```python
$ pip install -U pytest
```
安装完成之后，使用下面的命令可以查看安装的pytest的版本信息。你可以看到你所安装的pytest版本是否是你所需要的版本。
```
$ pytest --version
This is pytest version 5.x.y, imported from $PYTHON_PREFIX/lib/python3.6/site-packages/pytest.py
```
1.2 创建你的第一个用例
用4行代码写一个简单的测试用例
```python
# content of test_sample.py
def func(x):
return x + 1
def test_answer():
assert func(3) == 5
```
然后我们来运行这个用例
```python
$ pytest
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-5.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR
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
============================ 1 failed in 0.05s =============================
```
运行结果会生成一个失败的报告，因为很明显，func(3)返回的是4，而不是5。
说明：您可以使用assert语句来验证测试的预期结果。pytest的高级断言自省功能会自动帮助您打印出assert语句的中间值，这样您就可以不需要像JUnit一样，使用大量的不同的assert语句。
1.3 运行多个用例
pytest会运行当前目录以及其子目录下的所有以test_*.py或*_test.py的文件，例如：在当前目录下或其子目录下有test_sampy.py或者sampy_test.py文件，pytest就可以找出这个文件，并运行这个文件里的测试用例。如果想要了解更详细的查找test的规则，可以参看23.2节。
1.4 如何对抛出的异常进行断言
有时候程序会抛出一些异常来表示程序执行到了某些非正常的流程，这时候，我们如何实现用例来预期或断言这些抛出的异常呢？
pytest中可以使用raises来做到这点。
```python
# content of test_sysexit.py
import pytest
# 功能函数，抛出一个SystemExit的异常
def f():
raise SystemExit(1)
# 测试用例，用ptest.raises期盼SystemExit异常
def test_mytest():
with pytest.raises(SystemExit):
f()
```
以"quiet"模式运行以上用例，得到如下结果：
```python
$ pytest -q test_sysexit.py
. [100%]
1 passed in 0.01s
1.5 用类来分组多个用例
在我们为某个场景写了多个测试用例的时候，我们也许会觉得给这些测试用例分个组会更好些。用类来进行分组也许是一个好的选择。pytest可以很容易的建一个类并包含多个测试用例：
```python
# 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
$ pytest -q test_class.py
.F [100%]
================================= FAILURES =================================
____________________________ TestClass.test_two ____________________________
self = <test_class.TestClass object at 0xdeadbeef>
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
1 failed, 1 passed in 0.05s
```
第一个用例过了，但第二个失败了。从assert给出的中间值可以看出，我们预期的是"check"， 但实际的确是"hello"，实际与预期不符，所以失败了。
1.6 为测试用例申请一个其专用的临时目录
pytest提供了一些内建的fixture/function参数作为测试用例专用的资源，专用临时目录(tmpdir)就是其中之一 。
```python
# content of test_tmpdir.py
def test_needsfiles(tmpdir):
print(tmpdir)
assert 0
```
pytest一旦检测到测试用例的参数列表中带有tmpdir这个关键字，就会去建一个相应的专用目录，并将这个目录的路径通过tmpdir这个参数传给用例。当测试用例执行完之后，这个目录就会被删除。
```python
$ pytest -q test_tmpdir.py
F [100%]
================================= FAILURES =================================
_____________________________ test_needsfiles ______________________________
tmpdir = local('PYTEST_TMPDIR/test_needsfiles0')
def test_needsfiles(tmpdir):
print(tmpdir)
> assert 0
E assert 0
test_tmpdir.py:3: AssertionError
--------------------------- Captured stdout call ---------------------------
PYTEST_TMPDIR/test_needsfiles0
1 failed in 0.05s
```
想要对tmpdir有更多的了解，可以参看《第8章 临时目录和文件》。
下面这条命令可以查看pytest所有的内置的固有（fixtures）参数：
```python
pytest --fixtures # shows builtin and custom fixtures
```
如果想要查看下划线（_）开头的fixtures参数，需要在上面命令后面加上-v。
附一：pytest用例收集规则
1. 如果没有指定文件，pytest会从当前目录及其子目录收集所有的test_*.py或*_test.py文件；
2. 如果指定文件，pytest从指定文件中去收集用例，文件名的格式需要遵循test_*.py或*_test.py；
3. 类名需要以Test作为前缀；
4. 用例名需要以test_作为前缀。
