教你用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 07 Python
wxPython框架类和面板类的使用实例
Sep 28 Python
Python中利用原始套接字进行网络编程的示例
May 04 Python
深入理解python函数递归和生成器
Jun 06 Python
通过Python爬虫代理IP快速增加博客阅读量
Dec 14 Python
Python基于pycrypto实现的AES加密和解密算法示例
Apr 10 Python
对python中的pop函数和append函数详解
May 04 Python
numpy中的delete删除数组整行和整列的实例
May 09 Python
浅析python参数的知识点
Dec 10 Python
pytorch .detach() .detach_() 和 .data用于切断反向传播的实现
Dec 27 Python
opencv 图像礼帽和图像黑帽的实现
Jul 07 Python
Python 创建TCP服务器的方法
Jul 28 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
dedecms后台验证码总提示错误的解决方法
2007/03/21 PHP
PHP中date与gmdate的区别及默认时区设置
2014/05/12 PHP
Yii2设置默认控制器的两种方法
2017/05/19 PHP
PHP创建对象的六种方式实例总结
2019/06/27 PHP
js动态在form上插入enctype=multipart/form-data的问题
2012/05/24 Javascript
js抽奖实现随机抽奖代码效果
2013/12/02 Javascript
js中opener与parent的区别详细解析
2014/01/14 Javascript
JS使用cookie实现DIV提示框只显示一次的方法
2015/11/05 Javascript
js实现图片加载淡入淡出效果
2017/04/07 Javascript
深入理解vue中的$set
2017/06/01 Javascript
nodeJS实现路由功能实例代码
2017/06/08 NodeJs
详解require.js配置路径的用法和css的引入
2017/09/06 Javascript
Vue之Vue.set动态新增对象属性方法
2018/02/23 Javascript
详解Angular Forms中自定义ngModel绑定值的方式
2018/12/10 Javascript
JS实现纸牌发牌动画
2021/01/19 Javascript
Django日志模块logging的配置详解
2017/02/14 Python
Python Socket使用实例
2017/12/18 Python
python 处理dataframe中的时间字段方法
2018/04/10 Python
Python实现的线性回归算法示例【附csv文件下载】
2018/12/29 Python
对python:循环定义多个变量的实例详解
2019/01/20 Python
python使用Pandas库提升项目的运行速度过程详解
2019/07/12 Python
简单了解Pandas缺失值处理方法
2019/11/16 Python
python、Matlab求定积分的实现
2019/11/20 Python
使用OpenCV-python3实现滑动条更新图像的Canny边缘检测功能
2019/12/12 Python
python爬虫模拟浏览器访问-User-Agent过程解析
2019/12/28 Python
基于Python的接口自动化unittest测试框架和ddt数据驱动详解
2021/01/27 Python
纯DOM+CSS3实现简单的小风车动画
2016/09/27 HTML / CSS
End Clothing美国站:英国男士潮牌商城
2018/04/20 全球购物
在使用非全零作为空指针内部表达的机器上, NULL是如何定义
2014/11/09 面试题
我的长生果教学反思
2014/04/28 职场文书
保险公司开门红口号
2014/06/21 职场文书
关于感恩的演讲稿800字
2014/08/26 职场文书
党委书记个人检查对照材料思想汇报
2014/10/11 职场文书
完美处理python与anaconda环境变量的冲突问题
2021/04/07 Python
一看就懂的MySQL的聚簇索引及聚簇索引是如何长高的
2021/05/25 MySQL
mysql如何能有效防止删库跑路
2021/10/05 MySQL