如何使用属性标记测试函数

通过使用 pytest.mark 助手，你可以轻松地在测试函数上设置元数据。你可以在 API 参考 中找到内置标记的完整列表。或者，你可以使用 CLI 列出所有标记，包括内置标记和自定义标记 - pytest --markers。

以下是一些内置标记

• usefixtures - 在测试函数或类上使用固定装置

• filterwarnings - 过滤测试函数的某些警告

• skip - 始终跳过测试函数

• skipif - 如果满足某个条件，则跳过测试函数

• xfail - 如果满足某个条件，则产生“预期失败”结果

• parametrize - 对同一个测试函数执行多次调用。

创建自定义标记或将标记应用于整个测试类或模块非常容易。这些标记可以被插件使用，并且通常用于在命令行上使用 -m 选项选择测试。

请参阅 使用自定义标记 以获取作为文档的示例。

注意

标记只能应用于测试，对固定装置没有影响。

注册标记

你可以在 pytest.ini 文件中像这样注册自定义标记

[pytest]
markers =
    slow: marks tests as slow (deselect with '-m "not slow"')
    serial

或者在 pyproject.toml 文件中像这样注册自定义标记

[tool.pytest.ini_options]
markers = [
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
    "serial",
]

请注意，标记名称后 : 之后的任何内容都是可选描述。

或者，你可以在 pytest_configure 钩子中以编程方式注册新标记

def pytest_configure(config):
    config.addinivalue_line(
        "markers", "env(name): mark test to run only on named environment"
    )

已注册的标记出现在 pytest 的帮助文本中，并且不会发出警告（请参阅下一节）。建议第三方插件始终注册其标记。

对未知标记引发错误

使用 @pytest.mark.name_of_the_mark 装饰器应用的未注册标记将始终发出警告，以避免由于名称输入错误而默默地执行令人惊讶的操作。如上一节所述，你可以通过在 pytest.ini 文件中注册自定义标记或使用自定义 pytest_configure 钩子来禁用警告。

当传递 --strict-markers 命令行标志时，使用 @pytest.mark.name_of_the_mark 装饰器应用的任何未知标记都将触发错误。你可以在项目中添加 --strict-markers 到 addopts 来强制执行此验证

[pytest]
addopts = --strict-markers
markers =
    slow: marks tests as slow (deselect with '-m "not slow"')
    serial