mypy

Mypy是Python的可选静态类型检查器。您可以在Python程序中添加类型提示（PEP 484），并使用mypy进行静态类型检查。查找程序中的错误，甚至不运行它们！

安装

pip3 install mypy

Test继承ABC

1.

class ABC(object):

    def prt(self):
        print(self)
        print(self.__class__)


class Test(ABC):
    def prt(self):
        print(self)
        print(self.__class__)

    def prc(self):
        print("abc")


g: "ABC" = Test()
g.prt()

运行结果:

(venv) D:\idea\flask_learn>mypy learn.py
Success: no issues found in 1 source file

2

class ABC(object):

    def prt(self):
        print(self)
        print(self.__class__)


class Test(ABC):
    def prt(self):
        print(self)
        print(self.__class__)

    def prc(self):
        print("abc")


g: "ABC" = Test()
g.prc()

运行结果：

(venv) D:\idea\flask_learn>mypy learn.py
learn.py:18: error: "ABC" has no attribute "prc"
Found 1 error in 1 file (checked 1 source file)

3

class Person(object):  # 定义一个父类

    def talk(self):  # 父类中的方法
        print("person is talking....")


class Chinese(Person):  # 定义一个子类， 继承Person类

    def walk(self):  # 在子类中定义其自身的方法
        print('is walking...')


g: "Person" = Chinese()
g.walk()

运行结果：

(venv) D:\idea\flask_learn>mypy learn.py
learn.py:14: error: "Person" has no attribute "walk"
Found 1 error in 1 file (checked 1 source file)

平时我们代码大概都是下面的样子

# 参数name的类型是未知的
# 返回的类型也是未知的
def greeting(name):
    return 'Hello ' + name

稍微修改一些

# 参数name后面跟了:str 代表name期望是str类型
# 参数括号后面跟了->str代表返回类型为str类型
def greeting(name: str) -> str:
    return 'Hello ' + name
x: str = 'xxx' # 声明一个变量为str类型
greeting(x) # Hello xxx
greeting(123) # TypeError: can only concatenate str (not "int") to str

到目前为止仅有str、float等基本类型，使用list、tuple复杂类型需要引用typing中的类型

LIST

数组类型

from typing import List

# 参数names为list类型并且元素都是str类型
# 返回为None
def greet_all(names: List[str]) -> None:
    for name in names:
        print('Hello ' + name)

names = ["Alice", "Bob", "Charlie"]
ages = [10, 20, 30]

greet_all(names)   # Ok!
greet_all(ages)    #出错了 Error due to incompatible types 

Dict

字典类型

from typing import Dict

# Dict[int, str] int代表key类型， str代表val类型
def test(t: Dict[int, str]) -> Dict:
    return t

test({1: '234'}) # {1: '234'}

Iterable

可以迭代类型包括 List、Set、Tuple、Str、Dict

def greeting(names: Iterable[str]) -> None:
    for name in names:
        print(name)

greeting(['aaa', 'bbb']) # list aaa bbb
greeting(('ccc', 'ddd')) # tuple ccc ddd
greeting({'eee', 'fff'}) # set eee fff
greeting({'ggg': 'hhh'}) # dict ggg
greeting('123') # str 1 2 3 
greeting(678) # error: Argument 1 to "greeting" has incompatible type "int"; expected "Iterable[str]"

Union

接受多个指定类型，但不接受除此外的类型

from typing import Union
# user_id 只能为int或者str
def normalize_id(user_id: Union[int, str]) -> str:
    if isinstance(user_id, int):
        return 'user-{}'.format(100000 + user_id)
    else:
        return user_id
normalize_id(1) # user-100001
normalize_id('2') # 2

Optional

可选类型，给参数设置默认值

from typing import Optional

# Optional[str]只是Union [str，None]的简写或别名。它主要是为了方便帮助功能签名看起来更清洁
# Optional[str, int] 只能包含一个类型, 这样是不正确的
def greeting(name: Optional[str] = None) -> str:
    if name is None:
        name = 'stranger'
    return 'Hello, ' + name
greeting() # Hello, stranger
greeting('123') # Hello, 123

Any

有时候我们不确定是什么类型的时候可以用到Any

from typing import Any

def greeting(name: Any = None) -> str:
    if name is None:
        name = 'stranger'

    return 'Hello, ' + str(name)

greeting() # Hello, stranger
greeting('123') # Hello, 123
greeting(234) # Hello, 234
greeting([345]) # Hello, [345]

TypeVar

自定义类型

from typing import TypeVar

T = TypeVar('T') # 任意类型
A = TypeVar('A', int, str) # A类型只能为int或str
def test(t: A) -> None:
    print(t)
test(1)

Mypy 是 Python 的静态类型检查器，用于检查代码中类型注解的正确性。虽然 Python 是动态类型语言，允许在运行时检查类型，但 Mypy 提供了一种工具，可以在 编译（静态分析）阶段发现可能的类型错误，从而提高代码的可靠性和可维护性。

---

Mypy 的主要用途：

1. 类型检查
   它通过分析代码中的类型注解来检查函数、变量和参数的类型是否匹配。如果发现类型不匹配，Mypy 会在编译前报错。

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

result = add_numbers(1, "2")  # Mypy 会提示类型错误

1. 提高代码质量
   Mypy 有助于捕获隐藏的逻辑错误或潜在的类型不匹配，尤其是当代码基变得复杂时，静态类型检查有助于更清晰地了解函数的输入和输出。

2. 与 IDE 集成
   像 PyCharm、VSCode 等 IDE 可以利用 Mypy 的检查功能，在代码编辑时实时反馈类型错误，提升开发效率。

3. 团队协作的规范性
   在团队开发中，类型注解和 Mypy 可以确保代码库的一致性，避免由于误解导致的类型错误。

4. 便于重构
   类型注解能帮助开发者在重构时快速识别影响范围，避免引入新问题。

---

如何使用 Mypy？

1. 安装 Mypy
   使用 pip 安装：

   pip install mypy

2. 添加类型注解
   在代码中使用 Python 的内置类型注解（PEP 484 标准）：

   from typing import List
   
   def greet(names: List[str]) -> None:
       for name in names:
           print(f"Hello, {name}!")
   
   greet(["Alice", "Bob"])  # 正常
   greet("Charlie")  # Mypy 会提示类型错误

3. 运行 Mypy
   对代码进行类型检查：

   mypy your_script.py

4. 处理类型错误
   根据 Mypy 输出的错误提示修改代码，确保类型一致。

---

Mypy 的高级特性

1. Optional 和 Union 类型

   from typing import Optional, Union
   
   def process(value: Optional[int]) -> Union[int, str]:
       if value is None:
           return "No value"
       return value * 2

2. TypedDict 用于检查字典的类型

   from typing import TypedDict
   
   class User(TypedDict):
       name: str
       age: int
   
   def get_user_info(user: User) -> str:
       return f"{user['name']} is {user['age']} years old."
   
   get_user_info({"name": "Alice", "age": 30})  # 正常
   get_user_info({"name": "Bob"})  # Mypy 会提示缺少键 "age"

3. Any 和 动态类型
   使用 Any 跳过类型检查：

   from typing import Any
   
   def accept_any(value: Any) -> None:
       print(value)

---

Mypy 的局限性

1. 动态特性的覆盖不足
   Mypy 对动态类型的代码检查能力有限，无法检查运行时修改类型的代码。

2. 增加了额外的工作量
   添加类型注解和维护类型检查可能增加初期开发的成本。

3. 与第三方库的兼容性问题
   某些库可能没有类型注解，导致 Mypy 难以精确推断类型。

---

通过使用 Mypy，可以让动态语言 Python 获得类似静态语言的类型安全性，同时保持灵活性，是开发中非常实用的工具！