教你用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 相关文章推荐
windows下wxPython开发环境安装与配置方法
Jun 28 Python
python使用threading获取线程函数返回值的实现方法
Nov 15 Python
Python实现字符串的逆序 C++字符串逆序算法
May 28 Python
Selenium 模拟浏览器动态加载页面的实现方法
May 16 Python
解决pandas read_csv 读取中文列标题文件报错的问题
Jun 15 Python
详解python中的装饰器
Jul 10 Python
详解配置Django的Celery异步之路踩坑
Nov 25 Python
python将一个英文语句以单词为单位逆序排放的方法
Dec 20 Python
使用python制作一个为hex文件增加版本号的脚本实例
Jun 12 Python
使用python脚本自动创建pip.ini配置文件代码实例
Sep 20 Python
Python Tricks 使用 pywinrm 远程控制 Windows 主机的方法
Jul 21 Python
如何利用Matlab制作一款真正的拼图小游戏
May 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
PHP中for与foreach的区别分析
2011/03/09 PHP
关于WordPress的SEO优化相关的一些PHP页面脚本技巧
2015/12/10 PHP
PHP自定义图片缩放函数实现等比例不失真缩放的方法
2016/08/19 PHP
KindEditor在php环境下上传图片功能集成的方法示例
2020/07/20 PHP
浅析onsubmit校验表单时利用ajax的return false无效问题
2013/07/10 Javascript
JavaScript:Div层拖动效果实例代码
2013/08/06 Javascript
js实现的全国省市二级联动下拉选择菜单完整实例
2015/08/17 Javascript
jQuery实现标题有打字效果的焦点图代码
2015/11/16 Javascript
AngularJS学习笔记之依赖注入详解
2016/05/16 Javascript
javascript检测移动设备横竖屏
2016/05/21 Javascript
Jquery on方法绑定事件后执行多次的解决方法
2016/06/02 Javascript
Bootstrap中表单控件状态(验证状态)
2016/08/04 Javascript
微信小程序中实现一对多发消息详解及实例代码
2017/02/14 Javascript
angular-cli修改端口号【angular2】
2017/04/19 Javascript
jQuery Plupload上传插件的使用
2017/04/19 jQuery
js模块加载方式浅析
2017/08/12 Javascript
浅谈Redux中间件的实践
2018/07/27 Javascript
JS原型和原型链原理与用法实例详解
2020/02/05 Javascript
[02:13] 完美世界DOTA2联赛PWL DAY5集锦
2020/11/03 DOTA
利用Python在一个文件的头部插入数据的实例
2018/05/02 Python
Python利用公共键如何对字典列表进行排序详解
2018/05/19 Python
Python3列表List入门知识附实例
2020/02/09 Python
Jupyter打开图形界面并画出正弦函数图像实例
2020/04/24 Python
Python操作word文档插入图片和表格的实例演示
2020/10/25 Python
python中Pexpect的工作流程实例讲解
2021/03/02 Python
CSS3 Columns分列式布局方法简介
2014/05/03 HTML / CSS
html5给汉字加拼音加进度条的实现代码
2020/04/07 HTML / CSS
追悼会上的答谢词
2014/01/10 职场文书
服务之星获奖感言
2014/01/21 职场文书
2014年预备党员学习两会心得体会
2014/03/17 职场文书
合作协议书范本
2014/04/17 职场文书
高中同学会活动方案
2014/08/14 职场文书
县政府办公室领导班子对照检查材料思想汇报
2014/09/28 职场文书
教师群众路线心得体会
2014/11/04 职场文书
导游词之天津盘山
2019/11/01 职场文书
修改并编译golang源码的操作步骤
2021/07/25 Golang