Как использовать подтесты

pytest позволяет группировать проверки внутри обычного теста — такие группы называются подтестами.

Подтесты — это альтернатива параметризации. Они особенно полезны, когда точные значения параметров неизвестны на этапе сбора тестов.

# content of test_subtest.py


def test(subtests):
    for i in range(5):
        with subtests.test(msg="custom message", i=i):
            assert i % 2 == 0

Каждый сбой проверки или ошибка перехватывается менеджером контекста и отображается отдельно:

$ pytest -q test_subtest.py
uuuuuF                                                               [100%]
================================= FAILURES =================================
_______________________ test [custom message] (i=1) ________________________

subtests = <_pytest.subtests.Subtests object at 0xdeadbeef0001>

    def test(subtests):
        for i in range(5):
            with subtests.test(msg="custom message", i=i):
>               assert i % 2 == 0
E               assert (1 % 2) == 0

test_subtest.py:6: AssertionError
_______________________ test [custom message] (i=3) ________________________

subtests = <_pytest.subtests.Subtests object at 0xdeadbeef0001>

    def test(subtests):
        for i in range(5):
            with subtests.test(msg="custom message", i=i):
>               assert i % 2 == 0
E               assert (3 % 2) == 0

test_subtest.py:6: AssertionError
___________________________________ test ___________________________________
contains 2 failed subtests
========================= short test summary info ==========================
SUBFAILED[custom message] (i=1) test_subtest.py::test - assert (1 % 2) == 0
SUBFAILED[custom message] (i=3) test_subtest.py::test - assert (3 % 2) == 0
FAILED test_subtest.py::test - contains 2 failed subtests
3 failed, 3 subtests passed in 0.12s

В приведённом выше выводе:

• В компактном выводе о ходе выполнения для успешно пройденных и неудачных подтестов используется u; сведения о каждом неудачном подтесте см. в краткой сводке тестов.
• Сбои подтестов отображаются как SUBFAILED.
• Подтесты отображаются первыми, а «верхнеуровневый» тест — отдельно в конце.

Обратите внимание: в одном тесте можно использовать subtests несколько раз или даже сочетать их с обычными проверками за пределами блока subtests.test:

def test(subtests):
    for i in range(5):
        with subtests.test("stage 1", i=i):
            assert i % 2 == 0

    assert func() == 10

    for i in range(10, 20):
        with subtests.test("stage 2", i=i):
            assert i % 2 == 0

def test(subtests: pytest.Subtests) -> None: ...