Mypy错误-分配中的类型不兼容

Question

我的函数类似于以下简化代码示例：

def my_func() -> dict:
    result = {"success": False}

    if condition:
        result["success"] = True
        return result
    else:
        result["message"] = "error message"
    return result

当我运行Mypy（版本0.52）我得到这个错误：

error: Incompatible types in assignment (expression has type "str", target has type "bool")

错误指向代码示例中的倒数第二行。为什么mypy返回此错误？我的代码是无效的（以任何方式）还是一些mypy错误？

Answer 1

问题是mypy推断出结果变量的类型是Dict[str，bool]，这是因为您第一次在第2行初始化它。

因此，当你稍后尝试插入str时，mypy（理所当然地）会抱怨。您有几个选项来修复您的代码，我将按至少到大多数类型安全的顺序列出这些选项。

选项1是声明字典，使其值的类型为Any——也就是说，您的值根本不会进行类型检查：

from typing import Any, Dict

def my_func(condition: bool) -> Dict[str, Any]:
    result = {"success": False}  # type: Dict[str, Any]

    if condition:
        result["success"] = True
    else:
        result["message"] = "error message"
    return result

请注意，我们需要对第二行进行注释，以给mypy一个提示，说明结果应该是什么类型，以帮助其推理过程。

如果您使用Python 3.6，您可以使用以下替代语法注释该行，该语法使用变量注释（自Python 3.6起是新的）：

result: Dict[str, Any] = {"success": False}

选项2的类型安全性稍高一些——使用Union将值声明为strs或bools，而不是别的。这不是完全的类型html" target="_blank">安全，但至少你还可以对你的dict进行一些检查。

from typing import Any, Dict

def my_func(condition: bool) -> Dict[str, Union[str, bool]]:
    result = {"success": False}  # type: Dict[str, Union[str, bool]]

    if condition:
        result["success"] = True
    else:
        result["message"] = "error message"
    return result

您可能会发现类型注释对类型来说有点长/烦人，因此您可以使用类型别名以提高可读性（并且可以选择使用变量注释语法），如下所示：

ResultJson = Dict[str, Union[str, bool]]

def my_func(condition: bool) -> ResultJson
    result: ResultJson = {"success": False}
    # ...snip...

选项3是类型最安全的，尽管它确实要求您使用实验性的“TypeDector”类型，这可以让您将特定类型分配给判决中的不同字段。也就是说，使用这种类型要自担风险——AFAIK它还没有被添加到PEP 484中，这意味着其他类型检查工具（如皮魅力的检查器）没有义务理解这一点。Mypy本身最近才添加了对TypeDector的支持，因此可能仍然存在缺陷：

from typing import Optional
from mypy_extensions import TypedDict

ResultJson = TypedDict('ReturnJson', {'success': bool, 'message': Optional[str]})

def my_func(condition: bool) -> ResultJson:
    result = {"success": False, "message": None}  # type: ResultJson

    if condition:
        result["success"] = True
    else:
        result["message"] = "error message"
    return result

如果要使用此选项，请务必安装mypy_extensions包。