Python类型标注入门与初探

本文主要介绍Python中类型标注的作用,以及最常用的类型标注应该怎么写。

由于Python属于动态类型语言,所以只有在运行代码的时候才能够知道变量类型,而这往往会让我们在调用其他人的代码,或者自己很久以前(昨天)写的代码时传入错误的变量类型,导致bug产生。

所以在Python3.5的时候开始引入了类型标注(Type Hint),让我们能够显式地标注变量类型。

类型标注的优点

下面就是一个简单的带有类型标注的函数:


进行类型标注之后,有什么优点呢?

  1. 函数的可读性会增强。
  2. 使用这个函数时,IDE会显示这个函数的输入参数跟输出值是什么类型。
  3. 能帮我们解决一些由类型导致的逻辑问题,不用运行代码时就能够对代码进行分析。

静态分析工具mypy

不用运行代码时就能够对代码进行分析的工具,我们称为静态分析工具,这里介绍的是mypy

要使用mypy之前,需要先通过pip进行安装:

pip install mypy

安装好之后有以下两种使用方法。

方法一 在命令行中输入命令对文件进行检查

mypy example.py

方法二 在vscode中直接启用mypy检查

打开“settings.json”文件,增加下面这行设置:

"python.linting.mypyEnabled": true,

修改完之后再返回代码编辑,可以发现直接在编辑过程中就能显示错误了:


自定义数据类型的类型标注

Python的内置数据类型都是可以拿来做类型标注的,例入intfloatlist等等。

这里不做赘述,主要介绍自定义数据类型应该如何处理。

可以看到,在第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不仅支持listtuple,还支持byterange

字典类型标注

由于dict是有key和value的,因此需要同时对两者进行类型注解,中间用,隔开:

允许多种数据类型的标注

在很多情况下,我们允许一个参数传入int/None多种数据类型,那么可以这样表示:

而在Python3.10之后也可以简写为:

由于参数允许None是很常见的,所以Python也提供了Optional,默认是包含None类型的,这样写起来更简洁:

也就是说,以上这3种写法都是等价的(注意第二种写法仅在Python3.10之后支持)。

小结

本文是对Python类型标注的一个基础用法进行简单讲解,看完之后就可以尝试着在我们的Python项目中增加类型标注了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容