教你用Type Hint提高Python程序开发效率


Posted in Python onAugust 08, 2016

简介

Type Hint(或者叫做PEP-484)提供了一种针对Python程序的类型标注标准。

为什么使用Type Hint?对于动态语言而言,常常出现的情况是当你写了一段代码后,隔段时间你可能忘记这个方法的原型是什么样子的了,你也不清楚具体应该传入什么类型的参数,这样往往需要你去阅读代码才能定义每个类型具体是什么。或者当你使用一个文档并不是特别完全的第三方库,你不知道这个库应该如何使用,这都会很痛苦。

现在,借助Type Hint,你可以实现:

     1、实现类型检查,防止运行时出现的类型不符合情况。

     2、作为文档附加属性,方便开发者调用时传入传出的参数类型。

     3、提升IDE的检查机制,在智能提示时更快给出提示和类型检查结果。

实现这个过程中,你需要使用Python 3.5+中提供的新模块typing值得注意的是,这个改动并不会影响程序运行,仅仅是为了方便类型检查器实现的。

Type Hint类型检查器

目前,比如JetBrains家的PyCharm已经支持Type Hint语法检查功能,如果你使用了这个IDE,可以通过IDE功能进行实现。如果你像我一样,使用了SublimeText编辑器,那么第三方工具mypy可以帮助到你。AnacondaST3最近要发布的2.0版本也内置了mypy功能的支持,具体的进度可以看一下这个issue。一些其它的Python工具(比如代码提示工具jedi 0.10+)也支持了Type Hint功能。

从简单的例子开始

从简单的例子开始,我们先从一个简单的程序开始,运行环境为Python 3.5.2,使用mypy工具进行检查。

首先通过pip install mypy-lang命令安装mypy工具。注意是mypy-lang,之所以是这样,是因为在pypi里mypy这个名字已经被占用掉了。

接下来,通过mypy检查下面这个文件

# fib.py
from typing import Iterator


def fib(n: int) -> Iterator[int]:
  a, b = 0, 1
  while a < n:
    yield a
    a, b = b, a + b

i = fib(3.2)
print(next(i))
print(next(i))

在命令行中执行命令mypy fib.py,获取返回结果:

➜ mypy fib.py
fib.py:11: error: Argument 1 to "fib" has incompatible type "float"; expected "int"

但是在实际的应用过程中,这个功能在Python里是可以正常运行的:

➜ mypy python fib.py
0
1

可以看到,mypy工具提示了我们的代码中存在一处类型不匹配的问题,但是如果不进行检查,代码有可能执行出不可预知的结果。

在这个例子里面,我们使用了两种类型,一种是Python基础数据类型,比如str、int等等,这些类型数据是可以直接使用的;另外一种是来自于typing中引入的Iterator,用来表示迭代器类型。另外一个值得注意的是,typing中部分类型也会随时添加,一般我们以演示版本为准。

从简单到复杂,类型组合怎么办?

实际上,在我们使用过程中还有可能传递一些更加复杂的参数类型,比如list类型,tuple类型等等,这类型的数据如何声明呢?我们可以先看一个例子:

def foo(strings, string_list, count, total):

这个函数的参数我们从字面可以看出来分别是str,元素为str的list类型和两个整数参数。我们假定一个返回值为((int, int), str),那么这个类型检查可以这样定义:

from typing import List, Tuple

Result = Tuple[Tuple[int, int], str]

def foo(strings: str, lines: List[str], line_number: int, total_lines: int) -> Result:

其它的一些类型提示、协程等等的支持都可以在官方的typing模块文档中进行查看。

关于生产的一些闲扯

我们现在也在进行一些mypy工具在生产环境中的具体使用测试,但是我们也发现了一些存在的问题,比如Python本身的动态语言特性给类型标注就带来了一些麻烦。另外,变量复用导致的类型变换有可能会提示采用新的变量实现。这对于一个已经存在的线上项目来说相对成本较高,我们后续也会在一些新项目中采用这种方式。另外mypy还是一个比较新的项目,本身是拥有一些bug。另外一个是在某些mypy的非类型错误提示其实非常的模糊,导致很多错误有时需要进行人工排查。

不管怎样,即便在mypy存在一些缺陷,但是仍旧是未来非常有潜力的工具,提前了解和应用也能有效的提升程序的强壮性。以上就是利用Type Hint提升Python程序开发效率的全部内容,希望本文对大家使用python有所帮助。

Python 相关文章推荐
把项目从Python2.x移植到Python3.x的经验总结
Apr 20 Python
python脚本设置超时机制系统时间的方法
Feb 21 Python
Python2.x利用commands模块执行Linux shell命令
Mar 11 Python
Python实现查询某个目录下修改时间最新的文件示例
Aug 29 Python
python3实现逐字输出的方法
Jan 23 Python
Python使用sqlalchemy模块连接数据库操作示例
Mar 13 Python
Python中断多重循环的思路总结
Oct 04 Python
Python OrderedDict的使用案例解析
Oct 25 Python
解决django后台管理界面添加中文内容乱码问题
Nov 15 Python
Python for循环与getitem的关系详解
Jan 02 Python
Python实现实时数据采集新型冠状病毒数据实例
Feb 04 Python
python中turtle库的简单使用教程
Nov 11 Python
Python如何实现文本转语音
Aug 08 #Python
Python脚本处理空格的方法
Aug 08 #Python
基于Python实现对PDF文件的OCR识别
Aug 05 #Python
利用Python实现命令行版的火车票查看器
Aug 05 #Python
Python处理JSON数据并生成条形图
Aug 05 #Python
用Python解决计数原理问题的方法
Aug 04 #Python
快速入手Python字符编码
Aug 03 #Python
You might like
咖啡豆分级制度 咖啡豆等级分类 咖啡豆是按口感分类的吗?
2021/03/05 新手入门
Javascript 更新 JavaScript 数组的 uniq 方法
2008/01/23 Javascript
javascript parseInt() 函数的进制转换注意细节
2013/01/08 Javascript
深入理解javascript原型链和继承
2014/09/23 Javascript
javascript学习笔记(六)数据类型和JSON格式
2014/10/08 Javascript
Dojo Javascript 编程规范 规范自己的JavaScript书写
2014/10/26 Javascript
一看就懂:jsonp详解
2015/06/01 Javascript
javascript实现控制的多级下拉菜单
2015/07/05 Javascript
基于React.js实现原生js拖拽效果引发的思考
2016/03/30 Javascript
javascript原生ajax写法分享
2016/04/10 Javascript
js 获取范围内的随机数实例代码
2016/08/02 Javascript
JQuery中Ajax的操作完整例子
2017/03/07 Javascript
JavaScript实现简单的四则运算计算器完整实例
2017/04/28 Javascript
VUE长按事件需求详解
2017/10/18 Javascript
动态统计当前输入内容的字节、字符数的实例详解
2017/10/27 Javascript
微信小程序模板(template)使用详解
2018/01/31 Javascript
原来JS还可以这样拆箱转换详解
2019/02/01 Javascript
小程序开发踩坑:页面窗口定位(相对于浏览器定位)(推荐)
2019/04/25 Javascript
Node.js系列之安装配置与基本使用(1)
2019/08/30 Javascript
Python常用列表数据结构小结
2014/08/06 Python
Python中使用item()方法遍历字典的例子
2014/08/26 Python
python生成随机密码或随机字符串的方法
2015/07/03 Python
Django框架使用内置方法实现登录功能详解
2019/06/12 Python
Python配置文件处理的方法教程
2019/08/29 Python
Python3实现飞机大战游戏
2020/04/24 Python
Pytorch转keras的有效方法,以FlowNet为例讲解
2020/05/26 Python
Keras 切换后端方式(Theano和TensorFlow)
2020/06/19 Python
python 下载文件的几种方法汇总
2021/01/06 Python
网上常见的一份Linux面试题(多项选择部分)
2015/02/07 面试题
代码中finally中的代码会不会执行
2012/02/06 面试题
信息总监管理职责范本
2014/03/08 职场文书
房屋转让协议书
2014/04/11 职场文书
基层党建工作宣传标语
2014/06/24 职场文书
婚姻出轨保证书
2015/05/08 职场文书
最美劳动诗,致敬所有的劳动者!
2019/07/12 职场文书
java objectUtils 使用可能会出现的问题
2022/02/28 Java/Android