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推断出result变量的类型是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提示result应为哪种类型，以帮助其推断过程。

如果您使用的是Python 3.6以上版本，则可以使用以下替代语法对该行进行注释，该语法使用变量注释（Python 3.6中的新功能）：

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

选项2的类型安全性更高一些-使用可以将值声明为strs或bools，但别无其他Union。这不是完全类型安全的，但是至少您仍然可以对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是最安全的类型，尽管它 确实 要求您使用实验性的“
TypedDict”类型，该类型允许您将特定类型分配给dict中的不同字段。就是说，使用这种类型的风险自负-AFAIK尚未添加到PEP
484中，这意味着其他类型检查工具（例如Pycharm的检查器）没有义务了解这一点。Mypy本身仅在最近才添加了对TypedDict的支持，因此可能仍然存在问题：

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如果要使用此选项，请确保安装该软件包。