pytest 核心功能-调用pytest

通常，pytest 使用命令 ​pytest ​调用。这将执行当前目录及其子目录中名称遵循 ​test_*.py​ 或 ​\*_test.py​ 形式的所有文件中的所有测试。 更一般地说，pytest 遵循标准的测试发现规则。

指定要运行的测试

Pytest 支持多种从命令行运行和选择测试的方法。

在模块中运行测试

pytest test_mod.py

在目录中运行测试

pytest testing/

通过关键字表达式运行测试

pytest -k "MyClass and not method"

这将运行包含与给定字符串表达式匹配的名称（不区分大小写）的测试，其中可以包括使用文件名、类名和函数名作为变量的 Python 运算符。 上面的示例将运行 ​TestMyClass.test_something​ 但不是 ​TestMyClass.test_method_simple​

按节点ID运行测试

每个收集到的测试都分配有一个唯一的 ​nodeid​，它由模块文件名和后面的说明符组成，如类名、函数名和来自参数化的参数，用​::​字符分隔。

要在模块中运行特定测试：

pytest test_mod.py::test_func

在命令行中指定测试方法的另一个示例：

pytest test_mod.py::TestClass::test_method

通过标记表达式运行测试

pytest -m slow

将运行所有使用 ​@pytest.mark.slow​ 装饰器装饰的测试。

从包运行测试

pytest --pyargs pkg.testing

这将导入 ​pkg.testing​ 并使用其文件系统位置来查找和运行测试。

获取有关版本、选项名称、环境变量的帮助

pytest --version   # shows where pytest was imported from
pytest --fixtures  # show available builtin function arguments
pytest -h | --help # show help on command line and config file options

分析测试执行时间

要获得超过1.0秒的最慢10个测试持续时间的列表：

pytest --durations=10 --durations-min=1.0

默认情况下，除非在命令行上传递了​ -vv​，否则 pytest 不会显示太小（<0.005s）的测试持续时间。

管理插件的加载

提前加载插件

您可以使用 ​-p​ 选项在命令行中显式地提前加载插件（内部和外部）：

pytest -p mypluginmodule

该选项接收一个​name​参数，可以是：

• 完整的模块名称，例如 ​myproject.plugins​。 这个带点的名称必须是可导入的。
• 插件的入口点名称。 这是注册插件时传递给 ​setuptools ​的名称。 例如，要提前加载 ​pytest-cov​ 插件，您可以使用：

pytest -p pytest_cov

禁用插件

要在调用时禁用加载特定插件，请使用 ​-p​ 选项和前缀 ​no:​

示例：要禁用加载插件 ​doctest​，该插件负责从文本文件执行 ​doctest ​测试，请像这样调用 ​pytest​：

pytest -p no:doctest

调用pytest的其他方式

通过 python -m pytest 调用 pytest

您可以从命令行通过 Python 解释器调用测试：

python -m pytest [...]

这几乎等同于直接调用命令行脚本 ​pytest [...]​，只是通过 python 调用还会将当前目录添加到 ​sys.path​ 中。

从 Python 代码调用 pytest

您可以直接从 Python 代码调用 ​pytest​：

retcode = pytest.main()

这就像您从命令行调用​pytest​一样。 它不会引发 ​SystemExit ​而是返回退出代码。 您可以传入选项和参数：

retcode = pytest.main(["-x", "mytestdir"])

您可以为​ pytest.main​ 指定其他插件：

# content of myinvoke.py
import pytest
import sys


class MyPlugin:
    def pytest_sessionfinish(self):
        print("*** test run reporting finishing")


if __name__ == "__main__":
    sys.exit(pytest.main(["-qq"], plugins=[MyPlugin()]))

运行它将显示 ​MyPlugin ​已添加并且它的钩子已被调用：

$ python myinvoke.py
*** test run reporting finishing

注解

调用 ​pytest.main()​ 将导致导入您的测试以及它们导入的任何模块。 由于 python 导入系统的缓存机制，从同一进程对 ​pytest.main()​ 的后续调用将不会反映调用之间对这些文件的更改。 因此，不建议从同一进程多次调用 ​pytest.main()​（例如，为了重新运行测试）。