Python类型标注

机器学习越来越火,大量的机器学习包都支持Python,导致了Python近几年非常火爆,入手门槛低,编程简单,概念非常少。越来越多的新手小白加入到Python编程。

Python虽然简单,但也带来很多问题。尤其是弱类型一直被诟病,平时在写代码时,经常也会模糊参数的类型,导致debug难度增加。

自从Python3.5以来,发布了typing包,推荐标注类型,并且IDE会检查类型,让Python看起来有点静态语言的感觉了。本文主要参考Python3.7.5的官方文档 [1]

常用的类型

常用的几种类型,如int, float, str, List, Tuple, Dict。接下来看几个例子:
首先必须从typing中导入类型

from typing import List, Dict, Tuple
def greeting(name: str) -> str:
    return 'Hello ' + name
    
print(greeting(188))

如果你输入的参数不是str,IDE就会提示。

image

如果传入List, Tuple, Dict,需要用[]来指定内部基础类型.

def do_nothing(a: List[int], b: Tuple[int, str], c: Dict[str, int]) -> Dict[str, str]:
    return {'key': 'value'}

# 调用
do_nothing([19], (14, 'some'), {"ha": 10})

除此之外基础类型是可以相互嵌套的,比如字典的值是列表,列表中存放元组,于是可以这样标注:

def do_nothing(a: Dict[str, List[Tuple[int, int, int]]], ):
    pass

比较复杂的类型标注用起来并不是很方便,我们可以根据业务指定别名。比如计算一个点与多个点的距离,List中存放的Tuple是点Point,坐标就是三维的浮点数,于是可以定义别名

Point = Tuple[float, float, float]


def compute_distance(p1: Point, points: List[Point]):
    pass

多种类型

不是多个参数,而是多类型,是输入参数可能存在多种类型,这种情况在Java中多态来解决。而Python本身是弱类型,输入参数没有强制规定,这个时候该怎么办?比如传入参数可能为int, str, float.typing包给我们提供了办法,可以用Union来定义:

Union[int, str, float]

输入参数必须是必须是int, str, float.其中之一。如果不确定数据的类型,可以标示为Any类型,表示任意类型。如果输入参数可能是None值,也可以用Union定义:

Union[str, None]
# 或者
Optional[str]

函数作为输入参数

如果函数作为输入参数,如何标记类型呢?其实也不复杂,函数是callable的类型,同样指定传入和传出参数即可。我们来看一个求和的函数,第一个参数就是函数。add_all只是把所有的元素相加,至于对每个元素做什么操作,取决于传入的函数了。

def add_all(f: Callable[[int], int], params: List[int]):
    return sum(map(f, params))

print(add_all(lambda x: x**2, list(range(1, 10))))

这里要注意的是函数作为参数,有输入和输出值。定义较为麻烦,func: Callable[[int], int],输入参数内部嵌套了中括号,仔细想想也能明白,如果func: Callable[int, int]定义,那么输入参数和输出参数该怎么理解呢?想明白了,你就理解了。

返回生成器

生成器在Python是非常常用的,可以很大提高程序的运行效率。如果需要返回生成器对象该怎么做呢?从typing包中导入Generator.我们来看一下例子,输入列表list,需要每次返回num个数据块。

from typing import List, Generator
import math


def get_data(l: List[int], num: int) -> Generator:
    """
    输入list, 每次按照num个数 返回数据块
    :param l: list data
    :param num: batch size
    """
    epochs = math.ceil(len(l) / num)

    for epoch in range(epochs):
        yield l[epoch * num:(epoch + 1) * num]


for each in get_data(list(range(98)), 5):
    print(each)

小结

本文分别列举了常用参数的类型标注方法,同时也给出了多种参数类型,以及函数和生成器作为参数输入的类型标注方法。参数的类型标注是很重要的,一方面可以帮助你理解每个参数的类型,另一方面也增强了代码的可读性。尤其是别人读到你的代码,调用起来会清晰很多。更多详细的说明可以查看官方文档或者源码。

觉得我的内容还不错,可以关注我的微信公众号:数学编程。定期更新Python编程,深度学习和自然语言处理的文章。


  1. https://docs.python.org/zh-cn/3.7/library/typing.html#

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