如何在pytest参数化测试中使用解包参数对mypy进行工作类型注释?

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

分隔测试也可能是有意义的——您可能在这里过度使用了parameterize，为固定参数设置一组测试，为可选参数设置另一组测试(而不是试图用parameterize将所有这些测试塞在一起)——可能像这样:

@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