python静态类型检查工具mypy

mypy介绍

mypy 是 Python 的一个可选静态类型检查器，旨在结合动态（或“鸭子”）类型和静态类型的优点。mypy 将 Python 的表达能力和便利性与强大的类型系统和编译时类型检查相结合。mypy 类型检查标准 Python 程序；使用任何 Python VM 运行它们，基本上没有运行时开销。

安装和使用

mypy需要python3.6+，然后使用pip直接安装即可。

pip3 install mypy

接下来就可以直接在使用mypy了，例如:

mypy type_annotations.py

就可以实现对代码进行静态类型检查，但是前提是你的代码使用了类型注解，否则mypy什么也检查不出来。mypy检查的结果是基于类型注解的，这意味你可以忽略mypy所提示的错误，只把它当做警告。

默认情况下，mypy不会对动态类型函数进行类型检查。例如下面的代码：

def add(a:int, b:int) -> int:
    "整数相加"
    return a + b

add(1, 2)           # 静态类型检查通过
add("123", "qwe")   # 静态类型检查失败

使用mypy进行静态类型检查，结果如下所示：

test.py:17: error: Argument 1 to "add" has incompatible type "str"; expected "int"
test.py:17: error: Argument 2 to "add" has incompatible type "str"; expected "int"
Found 2 errors in 1 file (checked 1 source file)

mypy给出了错误提示，但是我们都知道add("123", "qwe")这行代码并不会出错，这就是Python的鸭子类型。如果我们想要上面的代码通过静态类型检查，可以有两种方式。

from typing import Any
def add(a:Any, b:Any) -> Any:
    return a + b

add(1, 2) 
add("123", "qwe") 

另外一种方式是告知mypv忽略此处的类型检查。

def add(a:int, b:int) -> int:
    return a + b

add(1, 2) 
add("123", "qwe")   # type: ignore

使用# type: ignore可以让mypy忽略对代码的静态类型检查。

如果mypy的错误提示是Skipping analyzing ‘xxx’: module is installed, but missing library stubs or py.typed marker，那么可以在使用mypy的时候加上–ignore_missing_imports参数来忽略这些模块。

目前，mypy依旧处于beta版本。关于mypy的更多信息，可以查看mypy.