如何让 Mypy 意识到在某些情况下不会使用默认值

Question

我有以下功能：

#!/usr/bin/env python3
from typing import Union

def foo(b: Union[str, int]) -> int:
    def bar(a: int = b) -> int: # Incompatible default for argument "a" (default has type "Union[str, int]", argument has type "int")
        return a + 1

    if isinstance(b, str):
        return bar(0)
    else:
        return bar()

print(foo(3)) # 4
print(foo("hello")) # 1

在我定义 bar 的那一行，Mypy 说将 b 设置为默认值是行不通的。

但是，由于程序的工作方式，使用默认 b 的唯一方法是 b 是整数。所以这应该可以正常工作。

但 Mypy 没有意识到这一点。

我怎么能

让 Mypy 意识到 int 是 a 的正确类型或
修复这种不会导致太多代码重复的方法。

（例如，我知道我可以编写两个具有不同签名的 foo 函数，但那样会造成太多代码重复。）

TL;下面的 DR 只是我的真实用例，因为至少有一个答案取决于我上面的 MCVE 有多简单。

这是一个接受字典的函数。函数 returns 一个装饰器，在使用时会将装饰函数（装饰函数是 TypeChecker）添加到字典中。装饰器允许指定 name/key 的参数，装饰函数（TypeChecker）在字典中位于该 name/key 之下。如果未指定名称，则它将使用不同的函数 (StringHelper.str_function) 从函数本身的属性中找出名称。

由于装饰器参数的工作方式，装饰器创建者需要接受名称（或什么都不接受）或函数。如果它只接受函数，则没有指定名称，它应该从函数中获取一个名称。如果它只接受名称，那么它将在函数上再次调用，并且应该使用名称。如果它什么都不带，那么它会在函数上再次调用，它应该从函数中获取一个名称。

def get_type_checker_decorator(type_checkers: Dict[str, TypeChecker]) -> Callable[[Union[Optional[str], TypeChecker]], Union[Callable[[TypeChecker], TypeChecker], TypeChecker]]:
    @overload
    def type_checker_decorator(name: Optional[str]) -> Callable[[TypeChecker], TypeChecker]:
        pass
    @overload
    def type_checker_decorator(name: TypeChecker) -> TypeChecker:
        pass
    def type_checker_decorator(name: Union[Optional[str], TypeChecker] = None) -> Union[Callable[[TypeChecker], TypeChecker], TypeChecker]:
        # if name is a function, then the default will never be used
        def inner_decorator(function: TypeChecker, name: Optional[str] = name) -> TypeChecker: # this gives the Mypy error
            if name is None:
                name = StringHelper.str_function(function)
            type_checkers[name] = function
            def wrapper(string: str) -> bool:
                return function(string)
            return wrapper

        if callable(name):
            # they just gave us the function right away without a name
            function = name
            name = None
            return inner_decorator(function, name)
        else:
            assert isinstance(name, str) or name is None
            # should be called with just the function as a parameter
            # the name will default to the given name (which may be None)
            return inner_decorator

    return type_checker_decorator

Answer 1

在写这个问题的时候，我觉得我自己回答了，所以不妨分享一下。

解决方案有点尴尬，但这是我能想到的最好的解决方案，而且似乎可行。首先，输入 a 作为整数或字符串。然后，作为函数的第一行，断言 a 是一个 int.

加起来好像

#!/usr/bin/env python3
from typing import Union

def foo(b: Union[str, int]) -> int:
    def bar(a: Union[int, str] = b) -> int: # Incompatible default for argument "a" (default has type "Union[str, int]", argument has type "int")
        assert isinstance(a, int)
        return a + 1

    if isinstance(b, str):
        return bar(0)
    else:
        return bar()

print(foo(3)) # 4
print(foo("hello")) # 1

虽然这个解决方案并不完美，因为如果您确实遵循函数签名并向其传递一个字符串，它将失败（由于 assert）。所以它需要对函数本身进行一些反省以确定实际可以传递的内容。

Answer 2

如果这不是函数所期望的，强制类型签名感觉很尴尬。您的 bar 函数显然需要一个 int，并且在类型提示上强制使用 Union 只是为了稍后断言您实际上只接受 ints 不需要为了让 mypy 沉默。

由于您接受 b 作为 bar 中的默认值，因此您应该注意 bar 中的 str 情况，因为 b 的类型签名已在 foo 中指定。我认为更适合手头问题的两种替代解决方案：

def foo(b: Union[str, int]) -> int:

    # bar takes care of the str case. Type of b already documented
    def bar(a=b) -> int:
        if isinstance(b, str):
            return bar(0)
        return a + 1

    return bar()

在定义之前先定义一个默认值bar:

def foo(b: Union[str, int]) -> int:

    x: int = 0 if isinstance(b, str) else b

    # bar does not take a default type it won't use.
    def bar(a: int = x) -> int:
        return a + 1

    return bar()

Answer 3

这个默认值根本不应该存在。编写此代码的安全方法是

def foo(b: Union[str, int]) -> int:
    def bar(a) -> int:
        return a + 1

    if isinstance(b, str):
        return bar(0)
    else:
        return bar(b)

我不知道是什么情况促使你问这个问题，但无论你真正想写什么程序，你可能也不应该有默认参数值。

您的代码与尝试做的非常相似

def f(x: Union[int, str]) -> int:
    y: int = x
    if isinstance(x, str):
        return 1
    else:
        return y + 1

这么写，显然y是错误的。我们不应该为静态类型 int 的变量赋值，除非我们在赋值时确实知道它是一个 int。期望类型检查器检查所有可能导致使用 y 的代码路径来确定这是安全的是不合理的。默认参数值类型检查遵循类似的原则；它根据设置默认值时可用的信息进行检查，而不是根据可以使用它的代码路径进行检查。

举一个更极端的例子，考虑

def f(x: Union[int, str]) -> int:
    def g(y: int = x):
        pass
    return 4

y 将 永远不会 使用。类型检查器仍然报告类型不匹配，如果类型检查器不报告它，就会有关于它的错误报告。

如何让 Mypy 意识到在某些情况下不会使用默认值

How to get Mypy to realize that the default value won't be used in certain cases

python

type-hinting

default-parameters

python-3.x

mypy