类型提示条件可变参数应用程序

Question

我正在尝试对构造函数的部分应用进行类型提示，一旦提供了 "tag" 实例，它就会完全应用。这是通过包装 class 实现的，它存储构造函数和任何部分应用的参数。由于包装器适用于多种类型，因此它必须采用可变参数 *args.

这创建了两种情况，它们的参数不同：

申请：(tag: Tag, ...) -> Cls
商店：(...) -> Partial[Cls]

值得注意的是，案例 2. 可能会或可能不会收到第一个参数。两者在数量上有重叠，因为它们是可变的。这很容易实现。我尝试使用 @overload:

来输入提示

from typing import TypeVar, Generic

#: the class to partially construct
Cls = TypeVar('Cls')

class Tag:
    """Instances of this class complete the partial application"""

class Partial(Generic[Cls]):
    """Partially construct ``ctor`` until a :py:class:`~.Tag` is applied"""
    def __init__(self, ctor: Type[Cls], *args):
        self.ctor = ctor
        self.args = args

    # type hints
    @overload
    def __call__(self, tag: Tag, *args) -> Cls:
        ...

    @overload
    def __call__(self, *args) -> 'Partial[Cls]':
        ...

    # implementation
    def __call__(self, *args):
        if args and isinstance(args[0], Tag):
            return self.ctor(args[0], *self.args, *args[1:])
        return Partial(self.ctor, *self.args, *args)

然而，mypy 和 PyCharm 对此都不满意（PyCharm 目前需要显式方法调用，但这不是我的问题）。使用显式非标记 (tag: Any, ...) -> Partial[Cls] 扩展第二个重载并不能解决问题。这两个工具要么报告类型不匹配、不兼容的重载，要么退回到 Any 或 Union.

这个场景的正确注释是什么？

类型检查代码示例：

class VariadicString(str):
    def __new__(cls, *args):
        return str(args)


a = RecursivePartial(VariadicString, 1, 2, 3)
b = a(4, 5, 6)
c = b(Tag(), 7, 8, 9)
reveal_locals()  # absent for PyCharm

mypy 正确识别了 a、b 和 c 的类型，但由于不兼容的重载重叠而拒绝了程序：

test.py:17: error: Overloaded function signatures 1 and 2 overlap with incompatible return types
test.py:38: error: Revealed local types are:
test.py:38: error: a: test.Partial[test.VariadicString*]
test.py:38: error: b: test,Partial[test.VariadicString*]
test.py:38: error: c: test.VariadicString*

PyCharm 不会拒绝该程序，但会将 c 错误识别为 return 类型的 Union：

a: Partial[VariadicString]
b: Partial[VariadicString]
c: Union[VariadicString, Partial[VariadicString]]

Answer 1

我不是打字专家，但我认为您无法仅通过更改类型提示来使它正常工作。 Mypy 无法知道在包含 Tag 时调用了哪个重载方法，因为它可能属于任一用例。

例如，在任何情况下，您的代码都允许将 Tag 变量传递给 *args 变量，因此类型提示中没有任何内容告诉用户您不能尝试构造一个存储多个 Tag 变量的部分实例。

我不知道这是否适用于您的解决方案，但由于您已经对第一个 args 变量的类型进行了手动检查，您可以坚持调用该方法标记或显式 None，将第二个重载更改为：

@overload
    def __call__(self, tag: None, *args) -> 'Partial[Cls]':
        ...

和实施到：

# implementation
def __call__(self, *args):
    if args and isinstance(args[0], Tag):
        return self.ctor(args[0], *self.args, *args[1:])
    # Don't add the None to the args.
    return Partial(self.ctor, *self.args, *args[1:])

类型提示条件可变参数应用程序

Type hint conditional variadic application

python

type-hinting

pycharm

mypy