Python 带参数约束的类型提示函数args>；tuple[args]

发布于02月18日

我们想要键入一个提示函数

def f(*args:float)->tuple[float,...]:
   ...
   return tuple(args)

使得指定元组中的元素的数目与参数的数目匹配. 当然，这里的返回值是更复杂逻辑的占位符.

我们希望使用mypy或pylance来判断我们是否总是返回a)正确的元素数量和b)所有元素的正确类型.

使用TypeVarTuple(https://peps.python.org/pep-0646/#args-as-a-type-variable-tuple)可以指定我们返回相同数量的元素，但不返回类型.

除了为1个参数、2个参数、3个参数等编写许多重载之外，在当前的python(3.12)中有没有其他方法可以做到这一点？

推荐答案

是的，您可以编写一个no-op修饰符来签名f次拒绝try 传递您不想要的类型.下面的示例使f拒绝任何传递与float不兼容的值的try .

演示:mypy Playground,Pyright Playground

import typing_extensions as t

if t.TYPE_CHECKING:
    import collections.abc as cx

    F = t.TypeVar("F", bound=cx.Callable[..., t.Any])
    Ts = t.TypeVarTuple("Ts")
 
    class _FloatOnlyCallable(t.Protocol):
        def __call__(self, /, *args: float) -> t.Any: ...

def asFloatOnlyCallable(f: F, /) -> F | _FloatOnlyCallable:
    """Decorate a function to make it only accept variadic positional float arguments"""
    return f

@asFloatOnlyCallable
def f(*args: *Ts) -> tuple[*Ts]:
    return args

>>> a, b = f(1.0, 2.0)  # OK
>>> c, d = f("3.0", 4.0)  # Error: Incompatible type "str", expected "float"
>>> e, g, h = f(5.0, 6.0)  # Error: Need more values to unpack