如何使用 skip 和 xfail 处理无法成功的测试¶

您可以标记在某些平台上无法运行或您预期会失败的测试函数，以便 pytest 可以相应地处理它们并提供测试会话的摘要，同时保持测试套件绿色。

skip 意味着您期望您的测试仅在满足某些条件时才通过，否则 pytest 应该完全跳过运行测试。常见的例子包括在非 Windows 平台上跳过仅限 Windows 的测试，或者跳过依赖于当前不可用的外部资源（例如数据库）的测试。

xfail 意味着您期望测试因某种原因而失败。常见的例子是针对尚未实现的功能或尚未修复的 bug 的测试。当一个测试尽管预期会失败（用 pytest.mark.xfail 标记）但仍然通过时，它就是一个 xpass，并将在测试摘要中报告。

pytest 会分别计数和列出 skip 和 xfail 测试。默认情况下，不显示有关跳过/xfail 测试的详细信息，以避免输出混乱。您可以使用 -r 选项来查看与测试进度中显示的“短”字母相对应的详细信息

pytest -rxXs  # show extra info on xfailed, xpassed, and skipped tests

有关 -r 选项的更多详细信息，可以通过运行 pytest -h 找到。

(请参阅内置配置文件选项)

跳过测试函数¶

跳过测试函数的最简单方法是用 skip 装饰器标记它，该装饰器可以传递一个可选的 reason

@pytest.mark.skip(reason="no way of currently testing this")
def test_the_unknown(): ...

或者，也可以通过调用 pytest.skip(reason) 函数在测试执行或设置期间命令式地跳过

def test_function():
    if not valid_config():
        pytest.skip("unsupported configuration")

当在导入时无法评估跳过条件时，命令式方法很有用。

也可以在模块级别使用 pytest.skip(reason, allow_module_level=True) 跳过整个模块

import sys

import pytest

if not sys.platform.startswith("win"):
    pytest.skip("skipping windows-only tests", allow_module_level=True)

参考： pytest.mark.skip

`skipif`¶

如果您希望有条件地跳过某些内容，则可以使用 skipif。这是一个标记测试函数的示例，当在早于 Python 3.10 的解释器上运行时跳过该测试函数

import sys


@pytest.mark.skipif(sys.version_info < (3, 10), reason="requires python3.10 or higher")
def test_function(): ...

如果条件在收集期间评估为 True，则将跳过测试函数，并且在使用 -rs 时，指定的理由将出现在摘要中。

您可以在模块之间共享 skipif 标记。考虑以下测试模块

# content of test_mymodule.py
import mymodule

minversion = pytest.mark.skipif(
    mymodule.__versioninfo__ < (1, 1), reason="at least mymodule-1.1 required"
)


@minversion
def test_function(): ...

您可以导入标记并在另一个测试模块中重用它

# test_myothermodule.py
from test_mymodule import minversion


@minversion
def test_anotherfunction(): ...

对于较大的测试套件，通常最好有一个文件，您在其中定义标记，然后在整个测试套件中一致地应用这些标记。

或者，您可以使用条件字符串而不是布尔值，但它们不能在模块之间轻松共享，因此主要出于向后兼容性原因而支持它们。

参考： pytest.mark.skipif

跳过类或模块的所有测试函数¶

您可以在类上使用 skipif 标记（与任何其他标记一样）

@pytest.mark.skipif(sys.platform == "win32", reason="does not run on windows")
class TestPosixCalls:
    def test_function(self):
        "will not be setup or run under 'win32' platform"

如果条件为 True，则此标记将为该类的每个测试方法生成跳过结果。

如果您想跳过模块的所有测试函数，您可以使用 pytestmark 全局变量

# test_module.py
pytestmark = pytest.mark.skipif(...)

如果将多个 skipif 装饰器应用于测试函数，则只要任何跳过条件为真，就会跳过它。

跳过文件或目录¶

有时您可能需要跳过整个文件或目录，例如，如果测试依赖于特定于 Python 版本的功能，或者包含您不希望 pytest 运行的代码。在这种情况下，您必须从收集中排除文件和目录。有关更多信息，请参阅自定义测试收集。

在缺少导入依赖项时跳过¶

您可以通过在模块级别、测试内部或测试设置函数中使用 pytest.importorskip 来跳过缺少导入的测试。

docutils = pytest.importorskip("docutils")

如果此处无法导入 docutils，这将导致测试的跳过结果。您也可以根据库的版本号跳过

docutils = pytest.importorskip("docutils", minversion="0.3")

版本将从指定模块的 __version__ 属性中读取。

总结¶

这是一个关于如何在不同情况下跳过模块中测试的快速指南

无条件跳过模块中的所有测试

pytestmark = pytest.mark.skip("all tests still WIP")

根据某些条件跳过模块中的所有测试

pytestmark = pytest.mark.skipif(sys.platform == "win32", reason="tests for linux only")

如果缺少某些导入，则跳过模块中的所有测试

pexpect = pytest.importorskip("pexpect")

XFail：将测试函数标记为预期失败¶

您可以使用 xfail 标记来指示您期望测试失败

@pytest.mark.xfail
def test_function(): ...

此测试将运行，但当它失败时不会报告回溯。相反，终端报告会将其列在“预期失败” (XFAIL) 或“意外通过” (XPASS) 部分。

或者，您也可以从测试内部或其设置函数中命令式地将测试标记为 XFAIL

def test_function():
    if not valid_config():
        pytest.xfail("failing configuration (but should work)")

def test_function2():
    import slow_module

    if slow_module.slow_function():
        pytest.xfail("slow_module taking too long")

这两个示例说明了您不想在模块级别检查条件的情况，在这种情况下，否则将为标记评估条件。

这将使 test_function XFAIL。请注意，与标记不同，在调用 pytest.xfail() 之后，不会执行任何其他代码。这是因为它在内部通过引发已知异常来实现。

参考： pytest.mark.xfail

`condition` 参数¶

如果仅在特定条件下预期测试失败，则可以将该条件作为第一个参数传递

@pytest.mark.xfail(sys.platform == "win32", reason="bug in a 3rd party library")
def test_function(): ...

请注意，您还必须传递一个理由（请参阅 pytest.mark.xfail 的参数描述）。

`reason` 参数¶

您可以使用 reason 参数指定预期失败的动机

@pytest.mark.xfail(reason="known parser issue")
def test_function(): ...

`raises` 参数¶

如果您想更具体地说明测试失败的原因，您可以在 raises 参数中指定单个异常或异常元组。

@pytest.mark.xfail(raises=RuntimeError)
def test_function(): ...

然后，如果测试因 raises 中未提及的异常而失败，则该测试将被报告为常规失败。

`run` 参数¶

如果测试应标记为 xfail 并如此报告，但不应执行，请使用 run 参数为 False

@pytest.mark.xfail(run=False)
def test_function(): ...

这对于 xfail 那些使解释器崩溃并应稍后调查的测试特别有用。

`strict` 参数¶

默认情况下，XFAIL 和 XPASS 都不会使测试套件失败。您可以通过将 strict 仅关键字参数设置为 True 来更改此行为

@pytest.mark.xfail(strict=True)
def test_function(): ...

这将使此测试的 XPASS（“意外通过”）结果导致测试套件失败。

您可以使用 xfail_strict ini 选项更改 strict 参数的默认值

[pytest]
xfail_strict=true

忽略 xfail¶

通过在命令行中指定

pytest --runxfail

您可以强制运行和报告标记为 xfail 的测试，就好像它根本没有被标记一样。这也会导致 pytest.xfail() 不起作用。

示例¶

这是一个简单的测试文件，其中包含多种用法

from __future__ import annotations

import pytest

xfail = pytest.mark.xfail

@xfail
def test_hello():
    assert 0

@xfail(run=False)
def test_hello2():
    assert 0

@xfail("hasattr(os, 'sep')")
def test_hello3():
    assert 0

@xfail(reason="bug 110")
def test_hello4():
    assert 0

@xfail('pytest.__version__[0] != "17"')
def test_hello5():
    assert 0

def test_hello6():
    pytest.xfail("reason")

@xfail(raises=IndexError)
def test_hello7():
    x = []
    x[1] = 1

使用 report-on-xfail 选项运行它会给出此输出

! pytest -rx xfail_demo.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-1.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache
rootdir: $REGENDOC_TMPDIR/example
collected 7 items

xfail_demo.py xxxxxxx                                                [100%]

========================= short test summary info ==========================
XFAIL xfail_demo.py::test_hello
XFAIL xfail_demo.py::test_hello2
  reason: [NOTRUN]
XFAIL xfail_demo.py::test_hello3
  condition: hasattr(os, 'sep')
XFAIL xfail_demo.py::test_hello4
  bug 110
XFAIL xfail_demo.py::test_hello5
  condition: pytest.__version__[0] != "17"
XFAIL xfail_demo.py::test_hello6
  reason: reason
XFAIL xfail_demo.py::test_hello7
============================ 7 xfailed in 0.12s ============================

使用 parametrize 进行 Skip/xfail¶

当使用 parametrize 时，可以将 skip 和 xfail 等标记应用于单个测试实例

import sys

import pytest


@pytest.mark.parametrize(
    ("n", "expected"),
    [
        (1, 2),
        pytest.param(1, 0, marks=pytest.mark.xfail),
        pytest.param(1, 3, marks=pytest.mark.xfail(reason="some bug")),
        (2, 3),
        (3, 4),
        (4, 5),
        pytest.param(
            10, 11, marks=pytest.mark.skipif(sys.version_info >= (3, 0), reason="py2k")
        ),
    ],
)
def test_increment(n, expected):
    assert n + 1 == expected