如何安装和使用插件

How to install and use plugins

本节介绍了安装和使用第三方插件的内容。要编写自己的插件，请参阅 编写插件。

可以使用 pip 轻松安装第三方插件：

pip install pytest-NAME
pip uninstall pytest-NAME

如果插件已安装，pytest 会自动找到并集成它，无需手动激活。

以下是一些流行插件的简短注释列表：

  • pytest-django：为 django 应用程序编写测试，并集成 pytest。

  • pytest-twisted：为 twisted 应用程序编写测试，启动反应器并处理测试函数中的延迟。

  • pytest-cov：提供测试覆盖率报告，兼容分布式测试。

  • pytest-xdist：分发测试到多个 CPU 和远程主机，支持分箱模式以应对段错误，并可在文件变更时自动重跑失败测试。

  • pytest-instafail：在测试运行时即时报告失败。

  • pytest-bdd：使用行为驱动的测试编写测试。

  • pytest-timeout：根据函数标记或全局定义设置测试超时时间。

  • pytest-pep8：提供 --pep8 选项以启用 PEP8 合规性检查。

  • pytest-flakes：使用 pyflakes 检查源代码。

  • allure-pytest：通过 allure-framework 报告测试结果。

要查看所有插件的完整列表及其在不同 pytest 和 Python 版本下的最新测试状态，请访问 Pytest 插件列表。您还可以通过 pytest- pypi.org search 发现更多插件。

在测试模块或 conftest 文件中请求/加载插件

Requiring/Loading plugins in a test module or conftest file

可以在测试模块或 conftest 文件中使用 pytest_plugins 来要求插件：

pytest_plugins = ("myapp.testsupport.myplugin",)

当加载该测试模块或 conftest 插件时，指定的插件也会被加载。

Note

在非根目录的 conftest.py 文件中使用 pytest_plugins 变量来要求插件的做法已被弃用。请参阅编写插件部分的 详细解释。

Note

pytest_plugins 名称已被保留，不应将其用作自定义插件模块的名称。

找出哪些插件处于活动状态

Finding out which plugins are active

如果您想查看环境中哪些插件是活跃的，可以输入：

pytest --trace-config

这将显示一个扩展的测试头，其中列出了激活的插件及其名称。同时还会在加载时打印出本地插件，也就是 conftest.py 文件。

按名称停用/取消注册插件

Deactivating / unregistering a plugin by name

您可以阻止插件加载或注销它们：

pytest -p no:NAME

这表示任何后续激活/加载指定插件的尝试都将无效。

如果您想在项目中无条件禁用某个插件，可以将以下选项添加到 pytest.ini 文件中：

[pytest]
addopts = -p no:NAME

或者，您也可以仅在特定环境中禁用插件（例如在 CI 服务器中），为此可以将环境变量 PYTEST_ADDOPTS 设置为 -p no:name。

关于如何获取插件名称，请参见 找出哪些插件处于活动状态。