在 PyCharm 中进行类型提示

PyCharm 提供多种方法来帮助检查和验证脚本中对象的类型。 PyCharm 支持在函数注解和类型注释中使用 类型提示 ，使用 typing 模块和 PEP 484 定义的格式。

添加类型提示

尽管 PyCharm 支持 PEP 484 中支持的所有添加类型的方法，但通过意图操作使用类型提示是最方便的方式。根据所使用的解释器，类型将作为注解（Python 3）或注释（Python 2）添加：

您还可以使用 Python 存根来指定变量、函数和类字段的类型。

您可以使用 Python 3 注解为函数的返回类型添加注解。PyCharm 会为您插入返回类型注解，之后您可以根据需要调整类型： PyCharm 会为您插入返回类型注解，之后您可以根据需要调整类型：

对于基于注释的类型提示，PyCharm 提供了一种意图操作，允许您将基于注释的类型提示转换为变量注解。此意图的名称为转换为变量注解，其工作方式如下：

之前	之后
from typing import List, Optional xs = [] # type: List[Optional[str]]	from typing import List, Optional xs: List[Optional[str]] = []

每当您应用类型提示时，PyCharm 会根据支持的 PEP 检查类型是否正确使用。如果存在使用错误，将显示相应的警告并建议推荐的操作。以下是验证示例。

验证错误	建议的操作
类型声明重复。	移除其中一个类型声明。
类型声明中的参数数量与函数参数数量不匹配。	调整参数数量。
带有解包的类型注释与相应的目标不匹配。	检查目标格式并相应修改类型注释。
`Callable` 参数的语法不正确。	使用建议的格式并添加必要的括号以包裹 `Callable` 参数。
赋值表达式中的类型意外。	调整类型以匹配预期模式。
为 `Final` 变量赋值。	您不能更改标注为 `Final` 的变量。考虑更改变量的类型。
继承标注为 `Final` 的类。	您不能继承带有 `Final` 标注的类。考虑创建另一个类。
重写带有 `@final` 装饰的方法。	您不能重写带有 `@final` 装饰的方法。考虑定义另一个方法。
函数参数的类型不正确。	将字典传递给 `foo()` 函数，而不是列表。
为 `TypedDict` 类型中的键分配了错误类型的值。	将 `year` 的值提供为 `int`： `add_movie({'title': 'Blade Runner', 'year': 1982})`
在 `TypedDict` 类型中使用了错误的键：	按照类型定义中指定的方式分配键： `add_movie({'title': 'Blade Runner', 'year': 1982})`
装饰函数的使用不正确。 PyCharm 根据装饰器的类型验证装饰函数的类型：	根据需要修改装饰器或使用函数返回值的语句。