了解 Python 中的类型注解

Python被高度认可为动态类型语言，这意味着变量的数据类型是在运行时确定的。换句话说，作为 Python 开发人员，您不需要声明变量接受的值的数据类型，因为 Python 根据它持有的当前值实现此变量的数据类型。

但是，此功能的灵活性带来了一些缺点，这些缺点在使用静态类型语言（如 Java 或 C++）时通常不会遇到：

• 在运行时将检测到更多本可以在开发时避免的错误
• 缺少编译可能会导致代码性能不佳
• 详细变量使代码更难阅读
• 关于特定函数行为的错误假设
• 由于类型不匹配而导致的错误

Python 3.5 引入了类型提示，您可以使用 Python 3.0 中引入的类型注解将其添加到代码中。使用类型提示，您可以使用数据类型批注变量和函数。mypy、pyright、pytypes 或 pyre 等工具执行静态类型检查功能，并在这些类型使用不一致时提供提示或警告。

本教程将探讨类型提示以及如何将它们添加到 Python 代码中。它将重点介绍 mypy 静态类型检查工具及其在代码中的操作。您将学习如何注解变量、函数、列表、字典和元组。您还将学习如何使用类、函数重载和批注常量。Protocol

• 什么是静态类型检查？
• 什么啥啥？
• 向变量添加类型提示
• 向函数添加类型提示
• 使用 mypy 进行静态类型检查“任意”类型配置 mypy 进行类型检查
• 向不带 return 语句的函数添加类型提示
• 在函数参数中添加联合类型提示
• 向列表添加类型提示何时使用 Iterable 类型批注函数参数何时使用序列类型
• 向词典添加类型提示何时使用映射类使用 MutableMapping 类作为类型提示使用 TypedDict 类作为类型提示
• 向元组添加类型提示
• 创建和使用协议
• 注重载函数
• 使用 Final 注解常量
• 处理第三方软件包中的类型检查

开始之前

要充分利用本教程，您应该具备：

• 已安装 Python ≥3.10
• 了解如何编写函数、f 字符串和运行 Python 代码
• 了解如何使用命令行

我们建议使用 Python ≥3.10，因为这些版本具有新的和更好的类型提示功能。如果您使用的是 Python ≤3.9，Python 提供了一种替代类型提示语法，我将在本教程中演示该语法。

什么是静态类型检查？

在静态类型语言（如 C 和 Java）中声明变量时，您需要声明变量的数据类型。因此，不能分配不符合为变量指定的数据类型的值。例如，如果将变量声明为整数，则在任何时间点都无法为其分配字符串值。

int x = 4;
x = "hello";  // this would trigger a type error

在静态类型语言中，编译器在编写代码时监视代码，并严格确保开发人员遵守语言规则。如果未发现任何问题，则可以运行该程序。

使用静态类型检查器有许多优点;其中一些包括：

• 检测类型错误
• 防止错误
• 记录您的代码 — 任何想要使用带注解函数的人都会一目了然地知道它接受的参数类型和返回值类型
• 此外，IDE 可以更好地理解您的代码，并提供良好的自动完成建议

Python 中的静态类型是可选的，可以逐步引入（这称为渐进类型）。通过逐步键入，可以选择指定应动态或静态类型的代码部分。静态类型检查器将忽略代码的动态类型部分，并且不会对没有类型提示的代码发出警告，也不会阻止在运行时编译不一致的类型。

什么是mypy？

由于Python默认是一种动态类型的语言，因此创建mypy等工具是为了给您提供静态类型环境的好处。mypy是由Jukka Lehtosalo创建的可选静态类型检查器。它会检查 Python 中的带批注的代码，并在批注类型使用不一致时发出警告。

mypy 还会检查代码语法，并在遇到无效语法时发出语法错误。此外，支持逐步键入，允许您按照自己的节奏在代码中缓慢添加类型提示。

向变量添加类型提示

在 Python 中，您可以使用以下语法定义带有类型提示的变量：

variable_name: type = value

让我们看一下以下变量：

name = "rocket”

为变量赋值。"rocket"name

要注解变量，您需要在变量名后附加一个冒号 （），并声明一个类型：:str

name: str = "rocket"

在 Python 中，您可以使用字典读取在变量上定义的类型提示：__annotations__

>>> name: str = "rocket"
>>> __annotations__
{'name': <class 'str'>}

字典将显示所有全局变量的类型提示。__annotations__

如前所述，Python 解释器不强制类型，因此使用错误类型定义变量不会触发错误：

>>> name: int = "rocket"
>>>

另一方面，像 mypy 这样的静态类型检查器会将其标记为错误：

error: Incompatible types in assignment (expression has type "str", variable has type "int")

声明其他数据类型的类型提示遵循相同的语法。以下是可用于批注变量的一些简单类型：

• float：浮点值，例如3.10
• int：整数，例如 ，37
• str：字符串，例如'hello'
• bool：布尔值，可以是 或TrueFalse
• bytes：表示字节值，例如b'hello'

用简单类型（如 ）注解变量可能不是必需的，因为 mypy 可以推断类型。但是，在处理列表、字典或元组等复杂数据类型时，向相应的变量声明类型提示非常重要，因为 mypy 可能很难推断这些变量的类型。intstr

向函数添加类型提示

要对函数进行注解，请在每个参数和返回值之后声明注解：

def function_name(param1: param1_type, param2: param2_type) -> return_type:

让我们注解返回消息的以下函数：

def announcement(language, version):
    return f"{language} {version} has been released"

announcement("Python", 3.10)

该函数接受字符串作为第一个参数，一个浮点数作为第二个参数，并返回一个字符串。为了注解函数参数，我们将在每个参数后附加一个冒号（），并在它后面加上参数类型：:

• language: str
• version: float

要注解返回值类型，请在关闭参数括号后立即添加，就在函数定义 colon（） 之前：->:

def announcement(language: str, version: float) -> str:
    ...

该函数现在具有类型提示，显示它接收和参数，并返回 .strfloatstr

调用函数时，输出应类似于获得的内容，如下所示：

result = announcement("Python", 4.11)
print(result) # Python 4.11 has been released

尽管我们的代码有类型提示，但如果使用错误的参数调用函数，Python 解释器不会提供警告：

result = announcement(True, "Python")
print(result) # True Python has been released

该函数成功执行，即使您传递了一个布尔值作为第一个参数，将一个字符串作为第二个参数。要收到有关这些错误的警告，我们需要使用像mypy这样的静态类型检查器。True"Python"

使用 mypy 进行静态类型检查

我们现在将使用 mypy 开始我们的静态类型检查教程，以获取有关代码中类型错误的警告。

创建一个名为的目录并将其移动到该目录中：type_hints

mkdir type_hints && cd type_hints

创建并激活虚拟环境：

python3.10 -m venv venv
source venv/bin/activate

使用以下命令安装最新版本的 mypy：pip

pip install mypy

安装 mypy 后，创建一个名为的文件并输入以下代码：announcement.py

def announcement(language, version):
    return f"{language} {version} has been released"

announcement("Python", 3.10)

保存文件并退出。我们将重用上一节中的相同函数。

接下来，使用 mypy 运行文件：

mypy announcement.py
Success: no issues found in 1 source file

如您所见，mypy 不会发出任何警告。Python 中的静态类型是可选的，使用渐进式类型时，除非您通过向函数添加类型提示来选择加入，否则不应收到任何警告。这允许您慢慢批注代码。

现在让我们了解为什么mypy没有向我们显示任何警告。