教你用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代码的打包与发布详解
Jul 30 Python
python制作最美应用的爬虫
Oct 28 Python
python之super的使用小结
Aug 13 Python
python3调用百度翻译API实现实时翻译
Aug 16 Python
Python进阶之全面解读高级特性之切片
Feb 19 Python
kali中python版本的切换方法
Jul 11 Python
opencv 获取rtsp流媒体视频的实现方法
Aug 23 Python
Python循环实现n的全排列功能
Sep 16 Python
基于python中__add__函数的用法
Nov 25 Python
通俗易懂了解Python装饰器原理
Sep 17 Python
python自动统计zabbix系统监控覆盖率的示例代码
Apr 03 Python
用Python提取PDF表格的方法
Apr 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 mvc开发模式的感想
2011/06/28 PHP
apache php模块整合操作指南
2012/11/16 PHP
PHP使用Face++接口开发微信公众平台人脸识别系统的方法
2015/04/17 PHP
PHP实现加强版加密解密类实例
2015/07/29 PHP
完美解决在ThinkPHP控制器中命名空间的问题
2017/05/05 PHP
thinkphp5框架API token身份验证功能示例
2019/05/21 PHP
PHP实现提取多维数组指定一列的方法总结
2019/12/04 PHP
Javascript中innerHTML用法实例分析
2015/01/12 Javascript
纯JavaScript代码实现移动设备绘图解锁
2015/10/16 Javascript
DIV+CSS+jQ实现省市联动可扩展
2016/06/22 Javascript
Vue + better-scroll 实现移动端字母索引导航功能
2018/05/07 Javascript
react-native使用leanclound消息推送的方法
2018/08/06 Javascript
VUE2.0+ElementUI2.0表格el-table实现表头扩展el-tooltip
2018/11/30 Javascript
JS中FileReader类实现文件上传及时预览功能
2020/03/27 Javascript
vue实现图片按比例缩放问题操作
2020/08/11 Javascript
[04:02]DOTA2上海特锦赛小组赛第二日recap精彩回顾
2016/02/28 DOTA
[35:27]完美世界DOTA2联赛循环赛 GXR vs FTD BO2第二场 10.29
2020/10/29 DOTA
pygame学习笔记(4):声音控制
2015/04/15 Python
Python编程产生非均匀随机数的几种方法代码分享
2017/12/13 Python
selenium+python设置爬虫代理IP的方法
2018/11/29 Python
python实现自动解数独小程序
2019/01/21 Python
详解django中url路由配置及渲染方式
2019/02/25 Python
python面向对象实现名片管理系统文件版
2019/04/26 Python
PyTorch 对应点相乘、矩阵相乘实例
2019/12/27 Python
python 安装教程之Pycharm安装及配置字体主题,换行,自动更新
2020/03/13 Python
Keras 使用 Lambda层详解
2020/06/10 Python
聚网科技C++面试笔试题
2015/09/01 面试题
财务出纳岗位职责
2014/02/03 职场文书
大学生村官考核材料
2014/05/23 职场文书
乡镇平安建设汇报材料
2014/08/25 职场文书
自主招生学校推荐信
2014/09/26 职场文书
《葡萄沟》教学反思
2016/02/23 职场文书
golang如何去除多余空白字符(含制表符)
2021/04/25 Golang
通过shell脚本对mysql的增删改查及my.cnf的配置
2021/07/07 MySQL
Spring实现内置监听器
2021/07/09 Java/Android
Python中生成随机数据安全性、多功能性、用途和速度方面进行比较
2022/04/14 Python