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

时间:2017-05-11 09:02:07

标签: python mypy

我的函数看起来像这个简化的代码示例:

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 bug?

1 个答案:

答案 0 :(得分:12)

问题在于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稍微更加类型安全 - 使用Union将您的值声明为strs或bool,而不是其他任何内容。这不是完全类型安全的,但至少你仍然可以对你的词典进行一些检查。

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' type,它允许您将特定类型分配给dict中的不同字段。也就是说,使用此类型需要您自担风险--AFAIK尚未添加到PEP 484,这意味着其他类型检查工具(如Pycharm' s checker)没有义务理解这个。 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包。