本文主要介绍Python中类型标注的作用,以及最常用的类型标注应该怎么写。
由于Python属于动态类型语言,所以只有在运行代码的时候才能够知道变量类型,而这往往会让我们在调用其他人的代码,或者自己很久以前(昨天)写的代码时传入错误的变量类型,导致bug产生。
所以在Python3.5的时候开始引入了类型标注(Type Hint),让我们能够显式地标注变量类型。
类型标注的优点
下面就是一个简单的带有类型标注的函数:
进行类型标注之后,有什么优点呢?
- 函数的可读性会增强。
- 使用这个函数时,IDE会显示这个函数的输入参数跟输出值是什么类型。
- 能帮我们解决一些由类型导致的逻辑问题,不用运行代码时就能够对代码进行分析。
静态分析工具mypy
不用运行代码时就能够对代码进行分析的工具,我们称为静态分析工具,这里介绍的是mypy
。
要使用mypy
之前,需要先通过pip
进行安装:
pip install mypy
安装好之后有以下两种使用方法。
方法一 在命令行中输入命令对文件进行检查
mypy example.py
方法二 在vscode中直接启用mypy
检查
打开“settings.json”文件,增加下面这行设置:
"python.linting.mypyEnabled": true,
修改完之后再返回代码编辑,可以发现直接在编辑过程中就能显示错误了:
自定义数据类型的类型标注
Python的内置数据类型都是可以拿来做类型标注的,例入int
、float
、list
等等。
这里不做赘述,主要介绍自定义数据类型应该如何处理。
可以看到,在第9行函数的输入是类本身的时候是会报错的,而第10行的时候函数的输入类的实例化对象是没有任何问题的。
下面再介绍一种特殊情况,就是在类的方法里面需要用到这个类的类型的时候,但是这个类在写这个方法时还没有被定义,也就是遇到了“先有鸡还是先有蛋”的问题,这样写是会报错的:
这种情况下可以在Node
加上双引号,把他变成String
,就能解决循环依赖的问题:
列表类型标注
在很多场景下,我们不仅要求参数类型是list
,还要求list
内的对象是int
类型,那么可以这样写:
from typing import List
def my_sum(lst: List[int]) -> int:
total = 0
for i in lst:
total += i
return total
对于Python3.9及更新版本,可以这样写:
def my_sum(lst: list[int]) -> int:
total = 0
for i in lst:
total += i
return total
在实际使用中,我们可能会允许一个参数可以是list
或者tuple
,那么我们可以引入更抽象的Sequence
:
可以看到,Sequence
不仅支持list
和tuple
,还支持byte
和range
。
字典类型标注
由于dict
是有key和value的,因此需要同时对两者进行类型注解,中间用,
隔开:
允许多种数据类型的标注
在很多情况下,我们允许一个参数传入int
/None
多种数据类型,那么可以这样表示:
而在Python3.10之后也可以简写为:
由于参数允许None
是很常见的,所以Python也提供了Optional
,默认是包含None
类型的,这样写起来更简洁:
也就是说,以上这3种写法都是等价的(注意第二种写法仅在Python3.10之后支持)。
小结
本文是对Python类型标注的一个基础用法进行简单讲解,看完之后就可以尝试着在我们的Python项目中增加类型标注了。