pytest.ini 配置文件详解与实战应用

一、pytest.ini 配置文件概述

• pytest.ini 是 pytest 框架的全局配置文件，通常建议放置在项目的根目录下，以便所有测试用例都能读取到统一的配置。
• 该配置文件名为固定的 pytest.ini，不支持修改文件名，否则 pytest 将无法识别。
• 通过修改此文件，可以改变 pytest 的默认运行行为、设置全局配置信息，pytest 读取配置后将按照设定内容执行测试。

二、pytest.ini 核心配置项详解

1. addopts：设置自定义执行参数

在 pytest 运行时，addopts 中设置的参数将作为默认的命令行执行条件。

配置示例如下：

[pytest]
# 命令行参数，用空格分隔
addopts = -v -s --reruns 1 --html=report.html

具体参数说明如下：

• --reruns：指定测试失败后的重跑次数。
• --count：设置测试用例重复执行的总次数。
• -v：启用详细模式，显示错误发生的位置及详细的错误信息。
• -s：等价于 pytest --capture=no，允许捕获并输出 print 函数的打印内容。
• -q：简化输出信息，减少冗余显示。
• -m：用于运行指定标记（marker）的测试用例。
• -x：一旦遇到第一个错误，立即停止后续测试的执行。
• --maxfail：设置允许的最大失败次数，当失败数量超过此阈值时，停止执行剩余测试用例。
• --html=report.html：指定生成 HTML 格式的测试报告文件。

注意：当 ini 配置文件中的参数与命令行运行时传入的参数发生重复时，命令行参数的值优先级更高，会覆盖 ini 文件中定义的参数值。

2. testpaths：设置测试用例执行路径

配置示例如下：

[pytest]
# 读取测试用例的起始文件夹，多个路径用空格分隔。注意：这些目录下不能出现相同文件名，否则会报错
testpaths = ./testcase

3. markers：标记分组参数定义

配置示例如下：

[pytest]
markers =
    smoking :
    high    :
    medium  :
    lower   :

在测试用例中使用标识，例如运行 pytest -v -m smoking，将只执行含有 smoking 标记的测试用例。

测试用例代码示例如下：

@pytest.mark.smoking
def test_01():
    pass

4. 修改文件匹配规则

pytest 默认查找用例的匹配规则如下：

• 测试文件名必须以 test_ 开头（或以 _test 结尾）。
• 测试类名必须以 Test 开头，且该类不能包含 __init__ 方法。
• 测试函数名必须以 test_ 开头。

如果希望匹配以 My_*.py 命名的文件，只需在 pytest.ini 文件中添加 python_files 配置项即可。

[pytest]

python_files =  My_*.py

至此，关于 pytest 中配置文件 pytest.ini 的使用介绍完毕，更多相关 pytest 及 pytest.ini 内容可参考本站其他文章。