教你用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 相关文章推荐
python BeautifulSoup使用方法详解
Nov 21 Python
jupyter安装小结
Mar 13 Python
Python更新数据库脚本两种方法及对比介绍
Jul 27 Python
python获取多线程及子线程的返回值
Nov 15 Python
Python查找两个有序列表中位数的方法【基于归并算法】
Apr 20 Python
python实现Dijkstra算法的最短路径问题
Jun 21 Python
python列表生成器迭代器实例解析
Dec 19 Python
python实现npy格式文件转换为txt文件操作
Jul 01 Python
Vs Code中8个好用的python 扩展插件
Oct 12 Python
Django后端按照日期查询的方法教程
Feb 28 Python
OpenCV 图像梯度的实现方法
Jul 25 Python
python3操作redis实现List列表实例
Aug 04 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判断是否有Get参数的方法
2014/05/05 PHP
php实现的css文件背景图片下载器代码
2014/11/11 PHP
PHP数组函数array_multisort()用法实例分析
2016/04/02 PHP
php中类和对象:静态属性、静态方法
2017/04/09 PHP
asp函数split()对应php函数explode()
2019/02/27 PHP
用Div仿showModalDialog模式菜单的效果的代码
2007/03/05 Javascript
用js 让图片在 div或dl里 居中,底部对齐
2008/01/21 Javascript
Javascript this指针
2009/07/30 Javascript
editable.js 基于jquery的表格的编辑插件
2011/10/24 Javascript
jquery实现点击弹出层效果的简单实例
2014/03/03 Javascript
jquery实现勾选复选框触发事件给input赋值
2015/02/01 Javascript
javascript实现点击单选按钮链接转向对应网址的方法
2015/08/12 Javascript
jquery validate和jquery form 插件组合实现验证表单后AJAX提交
2015/08/26 Javascript
12个超实用的JQuery代码片段
2015/11/02 Javascript
AngularJS 使用 UI Router 实现表单向导
2016/01/29 Javascript
详谈JS中数组的迭代方法和归并方法
2017/08/11 Javascript
详解使用Nuxt.js快速搭建服务端渲染(SSR)应用
2019/03/13 Javascript
layui table去掉右侧滑动条的实现方法
2019/09/05 Javascript
微信小程序scroll-view锚点链接滚动跳转功能
2019/12/12 Javascript
如何利用nodejs实现命令行游戏
2020/11/24 NodeJs
全面了解python中的类,对象,方法,属性
2016/09/11 Python
python中kmeans聚类实现代码
2018/02/23 Python
python 读取dicom文件,生成info.txt和raw文件的方法
2019/01/24 Python
Python selenium根据class定位页面元素的方法
2019/02/26 Python
python做接口测试的必要性
2019/11/20 Python
开启Django博客的RSS功能的实现方法
2020/02/17 Python
Python Tricks 使用 pywinrm 远程控制 Windows 主机的方法
2020/07/21 Python
使用Html5 Stream开发实时监控系统
2020/06/02 HTML / CSS
Gap工厂店:Gap Factory
2017/11/02 全球购物
中国专业的音频分享平台:喜马拉雅
2019/05/24 全球购物
法学专业本科生自荐信范文
2013/12/17 职场文书
追悼会上的答谢词
2014/01/10 职场文书
债务纠纷委托书
2014/08/30 职场文书
工作推荐信模板
2015/03/25 职场文书
Nginx配置Https安全认证的实现
2021/05/26 Servers
详解nginx安装过程并代理下载服务器文件
2022/02/12 Servers