Python `mypy` / `pyright`：静态类型检查与代码质量

好的，让我们来开一场关于 Python 静态类型检查的讲座，主题就是 mypy 和 pyright。我会尽量用幽默风趣的方式，让大家轻松掌握这些强大的工具。

各位观众，大家好！欢迎来到今天的“告别运行时 Bug，拥抱静态类型检查”研讨会。我是今天的讲师，江湖人称“Bug 终结者”（其实是因为我写的 Bug 太多了，迫使我研究这些工具）。

今天我们要聊聊 Python 的静态类型检查，尤其是 mypy 和 pyright 这两位大神。别听到“静态”、“类型”就觉得枯燥，它们其实是我们的好帮手，能帮我们提前发现代码中的错误，让我们的代码更健壮、更易维护。

为什么要用静态类型检查？

首先，让我们来回顾一下 Python 的动态类型特性。Python 是一门动态类型语言，这意味着我们不需要显式地声明变量的类型，解释器会在运行时推断变量的类型。

这很灵活，对不对？写起来很爽，是不是？

x = 5  # 整数
x = "Hello"  # 字符串

你看，变量 x 可以先是整数，后是字符串，毫无压力！

但是，硬币总有两面。动态类型也意味着一些错误会在运行时才暴露出来。想象一下，你写了一个函数，期望接收一个整数，结果别人传进来一个字符串，你的代码就可能崩掉。

def add(a, b):
  return a + b

result = add(5, "Hello")  # 运行时错误！

上面的代码在运行时会抛出 TypeError 异常，因为你不能把整数和字符串相加。

如果能在编写代码的时候就发现这种错误，那该多好？

这就是静态类型检查的用武之地！它可以帮助我们在代码运行之前，就发现潜在的类型错误。

静态类型检查是什么？

静态类型检查是指在代码运行之前，通过分析代码的类型信息，来验证代码是否符合类型规则。如果发现类型错误，就会发出警告或错误提示。

想象一下，静态类型检查器就像一个严厉的老师，在你交作业之前，仔细检查你的代码，指出你的错误，让你及时改正。

mypy 和 pyright：类型检查界的两大高手

mypy 和 pyright 都是 Python 的静态类型检查器，它们可以帮助我们发现代码中的类型错误。

mypy: 是一个开源的 Python 静态类型检查器，它基于 PEP 484 中定义的类型提示语法。mypy 的历史比较悠久，社区支持也很强大。
pyright: 是 Microsoft 开发的 Python 静态类型检查器。它使用 TypeScript 编写，速度非常快，而且对类型提示的支持也很完善。

简单来说，mypy 就像一位经验丰富的老教授，知识渊博，社区活跃；pyright 就像一位年轻有为的博士后，速度飞快，功能强大。

如何使用 mypy 和 pyright？

安装：

首先，我们需要安装 mypy 或 pyright。可以使用 pip 命令来安装：
```
pip install mypy
pip install pyright
```
添加类型提示：

为了让 mypy 和 pyright 能够进行类型检查，我们需要在代码中添加类型提示。类型提示使用 PEP 484 中定义的语法，例如：
```
def greet(name: str) -> str:
  return "Hello, " + name
```
上面的代码中，: str 表示参数 name 的类型是字符串，-> str 表示函数 greet 的返回值类型是字符串。
运行类型检查器：

安装好 mypy 或 pyright 后，就可以运行它们来检查代码了。
- mypy:
```
mypy your_file.py
```
- pyright:
```
pyright your_file.py
```
如果代码中存在类型错误，mypy 或 pyright 会输出错误信息。

类型提示语法：让代码更清晰

类型提示是静态类型检查的基础。掌握类型提示语法，才能更好地使用 mypy 和 pyright。

下面是一些常用的类型提示语法：

类型	描述	示例
`int`	整数	`x: int = 5`
`float`	浮点数	`y: float = 3.14`
`str`	字符串	`name: str = "Alice"`
`bool`	布尔值	`is_valid: bool = True`
`list[T]`	列表，其中 `T` 是列表元素的类型	`numbers: list[int] = [1, 2, 3]`
`tuple[T1, T2, ...]`	元组，其中 `T1`, `T2` 等是元组元素的类型	`point: tuple[int, int] = (10, 20)`
`dict[K, V]`	字典，其中 `K` 是键的类型，`V` 是值的类型	`ages: dict[str, int] = {"Alice": 30, "Bob": 25}`
`set[T]`	集合，其中 `T` 是集合元素的类型	`unique_numbers: set[int] = {1, 2, 3}`
`Optional[T]`	可选类型，表示 `T` 或 `None`	`address: Optional[str] = None`
`Union[T1, T2, ...]`	联合类型，表示 `T1` 或 `T2` 等	`result: Union[int, str] = 5` # 可以是整数或字符串
`Any`	任意类型，表示可以是任何类型（尽量避免使用，因为它会降低类型检查的有效性）	`data: Any = "some data"`
`Callable[[Arg1Type, Arg2Type, ...], ReturnType]`	可调用类型（函数或方法），表示参数类型和返回类型	`callback: Callable[[int, str], bool] = my_function`
`Literal["value1", "value2", ...]`	字面量类型，表示变量只能取指定的值	`status: Literal["success", "failure"] = "success"`

一些实用的例子

让我们通过一些例子来演示如何使用 mypy 和 pyright。

例子 1：函数参数类型检查

def calculate_area(length: int, width: int) -> int:
  return length * width

area = calculate_area(5, 10)
print(area)

area = calculate_area(5, "10")  # 类型错误！
print(area)

如果我们运行 mypy 或 pyright，会发现第二行调用 calculate_area 时存在类型错误，因为我们传递了一个字符串作为 width 参数。

例子 2：列表类型检查

def process_numbers(numbers: list[int]) -> int:
  total = 0
  for number in numbers:
    total += number
  return total

numbers = [1, 2, 3, 4, 5]
result = process_numbers(numbers)
print(result)

numbers = [1, 2, "3", 4, 5]  # 类型错误！
result = process_numbers(numbers)
print(result)

同样，mypy 或 pyright 会指出第二行 numbers 列表中的字符串 "3" 导致类型错误。

例子 3：可选类型检查

def get_name(user_id: int) -> Optional[str]:
  # 模拟从数据库获取用户姓名
  if user_id == 1:
    return "Alice"
  else:
    return None

name = get_name(1)
if name:
  print("User name:", name.upper())
else:
  print("User not found")

name = get_name(2)
if name:
  print("User name:", name.upper())
else:
  print("User not found")

在这个例子中，get_name 函数可能返回一个字符串，也可能返回 None。我们使用 Optional[str] 来表示这种类型。

高级用法：泛型和协议

mypy 和 pyright 还支持泛型和协议，这可以让我们编写更灵活、更通用的代码。

泛型 (Generics): 允许我们编写可以处理多种类型的函数或类，而无需为每种类型都编写单独的代码。

from typing import TypeVar, List

T = TypeVar('T')

def first(items: List[T]) -> T:
    return items[0]

numbers: List[int] = [1, 2, 3]
first_number: int = first(numbers)

strings: List[str] = ["hello", "world"]
first_string: str = first(strings)

协议 (Protocols): 允许我们定义一个接口，而不必强制类继承特定的基类。

from typing import Protocol

class SupportsRead(Protocol):
    def read(self, size: int) -> str:
        ...

def read_data(reader: SupportsRead, size: int) -> str:
    return reader.read(size)

class FileReader:
    def __init__(self, filename: str):
        self.filename = filename

    def read(self, size: int) -> str:
        with open(self.filename, 'r') as f:
            return f.read(size)

file_reader = FileReader("my_file.txt")
data = read_data(file_reader, 100)

mypy 和 pyright 的比较

特性	`mypy`	`pyright`
速度	相对较慢	非常快
类型提示支持	完善	完善
社区支持	强大	活跃，但相对较新
错误提示	详细	简洁
配置	灵活，可以通过配置文件进行详细配置	相对简单，可以通过配置文件进行配置
集成	与各种编辑器和 IDE 集成良好	与 VS Code 集成非常好，也支持其他编辑器
开发语言	Python	TypeScript

如何选择 mypy 或 pyright？

选择哪个工具取决于你的具体需求：

如果你的项目对性能要求很高，或者你喜欢使用 VS Code，那么 pyright 是一个不错的选择。
如果你的项目需要更详细的错误提示，或者你需要更灵活的配置选项，那么 mypy 可能更适合你。
或者，你可以同时使用 mypy 和 pyright，以获得最佳的类型检查效果。

一些小技巧

逐步添加类型提示： 不要试图一次性为所有代码添加类型提示。可以先从核心模块或容易出错的地方开始，逐步添加类型提示。
使用 Any 类型要谨慎： 尽量避免使用 Any 类型，因为它会降低类型检查的有效性。如果实在无法确定变量的类型，可以考虑使用 Union 类型或 Optional 类型。
配置 mypy 或 pyright： 可以通过配置文件来定制 mypy 或 pyright 的行为，例如忽略某些错误或警告。
与编辑器或 IDE 集成： 将 mypy 或 pyright 与你的编辑器或 IDE 集成，可以让你在编写代码的时候就看到类型错误提示。

总结

mypy 和 pyright 是 Python 的静态类型检查利器，它们可以帮助我们提前发现代码中的类型错误，提高代码质量。虽然添加类型提示需要一些额外的工作，但它可以带来长期的好处，例如减少运行时错误、提高代码可读性、方便代码重构。

希望今天的讲座能帮助大家更好地理解和使用 mypy 和 pyright。记住，静态类型检查不是万能的，但它可以帮助我们编写更健壮、更可靠的 Python 代码。

感谢大家的参与！现在是自由提问时间，大家有什么问题都可以提出来。

发表回复 取消回复

发表回复取消回复