如何通过解包参数在 mypy 上输入注释以进行 pytest 参数化测试？

Question

我在

my_module.py

上有一个简单的方法，带有签名：

def my_method(value: float, extra: str = "something") -> str:
    pass

然后我对

test_my_module.py

进行了参数化测试：

from typing import List
from typing import Union

import pytest

import my_module

@pytest.mark.parametrize(
    "params, expected",
    [
        ([1.0], "result1"),
        ([2.0], "result2"),
        ([2.0, "extra"], "result3")
    ],
)
def test_my_method(params: List[Union[int, str]], expected: str) -> None:
    assert my_module.my_method(*params) == expected

当我运行诸如

typeguard

之类的动态类型测试时，它会通过。但是使用

mypy

我得到了这些

[arg-type]

错误：

tests/test_my_module.py: note: In function "test_my_method":
tests/test_my_module.py:50:30: error: Argument 1 to "my_method" has incompatible type "*List[Union[int, str]]"; expected "float" 
[arg-type]
        assert my_module.my_method(*params) == expected
                                   ^
tests/test_my_module.py:50:30: error: Argument 1 to "my_method" has incompatible type "*List[Union[int, str]]"; expected "str" 
[arg-type]
        assert my_module.my_method(*params) == expected
                                   ^

不太确定我应该如何注释这些类型才能使其通过。请注意，这是一个最小的示例，因此我想在我创建的列表中解压参数列表

params

以参数化测试。

有什么想法吗？

Answer 1

您可以使用

Tuple

代替

List

进行注释：

@pytest.mark.parametrize(
    "params, expected",
    [
        ([1.0], "result1"),
        ([2.0], "result2"),
        ([2.0, "extra"], "result3")
    ],
)
def test_my_method(params: Union[Tuple[float], Tuple[float, str]], expected: str) -> None:
    assert my_module.my_method(*params) == expected

这保证了固定数量的元素，因此静态类型检查器可以推断签名是兼容的。

Answer 2

我建议将变量参数表示为元组而不是列表。 打字目前不允许列表在特定索引处具有特定类型，但是固定大小的元组可以为其维度指定类型

您当前拥有的两个形状要么是单个浮点：

Tuple[float]

，要么是浮点和字符串：

Tuple[float, str]

——通过将参数化调用和参数转换为此它应该可以很好地工作：

from typing import Tuple
from typing import Union

import pytest

import my_module

@pytest.mark.parametrize(
    "params, expected",
    [
        ((1.0,), "result1"),
        ((2.0,), "result2"),
        ((2.0, "extra"), "result3")
    ],
)
def test_my_method(params: Union[Tuple[float], Tuple[float, str]], expected: str) -> None:
    assert my_module.my_method(*params) == expected

分割你的测试也可能是有意义的——你可能在这里过度使用参数化，并且对你的固定参数进行一组测试，对你的可选参数进行另一组测试可能会更清楚（而不是尝试将所有这些测试与参数化混在一起）——也许是这样的：

@pytest.mark.parametrize(
    "arg, expected",
    [
        (1.0, "result1"),
        (2.0, "result2"),
    ],
)
def test_my_method_one_arg(arg: float, expected: str) -> None:
    assert my_module.my_method(arg) == expected


@pytest.mark.parametrize(
    "arg, extra, expected",
    [
        (1.0, "extra", "result3"),
        (2.0, "extra", "result4"),
    ],
)
def test_my_method_extra_arg(arg: float, extra: str, expected: str) -> None:
    assert my_module.my_method(arg, extra) == expected