本节讨论安装和使用第三方插件。关于编写自己的插件,我们下一章继续。
一、pip 安装
就像安装一些其他第三方库一样,使用pip
也可以很容易地安装第三方插件,pytest-NAME
这是你要安装的插件名称:
# 安装
pip install pytest-NAME
#卸载
pip uninstall pytest-NAME
比如我这里安装一个pytest-xdist
的插件:
第三方插件装完就可以直接用了,pytest
会自动找到并集成它,不需要我们手动激活它。
二、查找可用插件
pytest
的第三方插件非常丰富,所以功能也是多种多样的。下面列举一些流行的插件:
pytest-django
: 为django应用程序编写测试,使用pytest集成。pytest-cov
: 覆盖报告,兼容分布式测试pytest-xdist
: 将测试分发到cpu和远程主机,提高执行效率pytest-instafail
: 在测试运行时报告失败pytest-bdd
: 使用行为驱动测试编写测试用例pytest-timeout
: 根据函数标记或全局定义测试超时。pytest-pep8
: 启用pep8合规性检查
…
官方有一个完整插件列表,里面有针对不同pytest
和Python
版本的最新测试状态,传送门 在此。
此外,我们也可以在pytest- pypi.org search搜索插件。
插件非常多,后续遇到一些很实用或者很有趣的插件会单独进行分享。上面关于pytest-xdist
分布式执行的插件之前有过介绍,都添加到文章末尾的pytest合集
里了,有需要的自取。
三、在测试模块或者conftest文件中加载指定插件
我们可以使用pytest_plugins
在测试模块或conftest文件
中加载指定插件:
# 可以是单个插件,就是一个字符串
pytest_plugins = "myapp.testsupport.myplugin"
# 也可以加载多个,字符串的队列
pytest_plugins = ("myapp.testsupport.tools", "myapp.testsupport.regression")
当测试模块或conftest插件被加载时,指定的插件也会被加载。
值得注意的是:
- 尽量不要在非根目录的
conftest.py
文件中使用pytest_plugins
变量来加载插件(开发插件时候继续展开) - 自定义插件模块的名称不要使用
pytest_plugins
来命名
四、查看被激活的插件
如果想知道哪些插件在本地环境中是激活的,可以通过该命令:
pytest --trace-config
在测试头部信息中会显示激活的插件,它还会在加载本地插件时打印出conftest.py文件
。
五、注销插件
我们可以阻止插件加载或注销它们:
pytest -p no:NAME
这样,后续就没办法进行插件的激活/加载了。
如果想无条件地禁用一个项目的插件,可以在项目配置文件pytest.ini
中添加这个选项即可:
[pytest]
addopts = -p no:NAME
文末附上合集的传送门
pytest合集见链接