自定义 pytest 参数化测试名称

Question

我有以下测试：

@pytest.mark.parametrize(
    "nums",
    [[3, 1, 5, 4, 2], [2, 6, 4, 3, 1, 5], [1, 5, 6, 4, 3, 2]]
)
def test_cyclic_sort(nums):
    pass


@pytest.mark.parametrize(
    "nums, missing",
    [([4, 0, 3, 1], 2)]
)
def test_find_missing_number(nums, missing):
    pass

我想自定义测试名称以包含输入数组。 我已经阅读了pytest 文档，以及这个问题和这个问题，但没有人回答以下问题：

1. 传递给 id 函数的是什么？ 在我上面的代码中，第一个测试需要一个参数，第二个测试需要两个。
2. pytest 文档使用顶级 function 作为 id，而我想将我的测试放在 class 中并使用@staticmethod 。 尝试从TestClass内部使用TestClass.static_method引用 static 方法会导致 PyCharm 出现错误； 这样做的正确语法是什么？

编辑：创建https://github.com/pytest-dev/pytest/issues/8448 。

Answer 1

当为ids关键字使用可调用对象时，将使用单个参数调用它：被参数化的测试参数的值。 可调用的ids返回一个字符串，该字符串将在方括号中用作测试名称后缀。

如果测试对多个值进行参数化，则 function 仍将使用单个参数调用，但每次测试将调用多次。 生成的名称将与破折号相连，例如

"-".join([idfunc(val) for val in parameters])

例如：

test_something[val1-val2-val3]

这是 pytest 源中的连接。

要使用 static 方法，此语法有效：

class TestExample:

    @staticmethod
    def idfunc(val):
        return f"foo{val}"

    @pytest.mark.parametrize(
        "x, y",
        [
            [1, 2],
            ["a", "b"],
        ],
        ids=idfunc.__func__,
    )
    def test_vals(self, x, y):
        assert x
        assert y

这将生成两个测试，如上所述调用idfunc四次。

TestExample::test_vals[foo1-foo2]
TestExample::test_vals[fooa-foob]

Answer 2

我喜欢wims的回答，这是对他的回答的评论（我没有发表评论的要点）。 这对我来说似乎更pythonic。 它还有助于避免使用 static 方法。

class TestExample:
    @pytest.mark.parametrize(
        "x, y",
        [
            [1, 2],
            ["a", "b"],
        ],
        ids= lamba val : f"foo{val}"
    )
    def test_vals(self, x, y):
        assert x
        assert y

这将具有相同的 output：

TestExample::test_vals[foo1-foo2]
TestExample::test_vals[fooa-foob]