介绍一款python类型检查工具pyright(推荐)


Posted in Python onJuly 03, 2019

近日,微软在 Github 上开源了一个 Python 静态类型检查工具:pyright ,引起了社区内的多方关注。

微软在开源项目上的参与力度是越来越大了,不说收购 Github 这种大的战略野心,只说它家开源的 VS Code 编辑器,在猿界已割粉无数,连我 Python 圈的红人 Kenneth Reitz(多个开源项目的作者,包括 requests、requests-html、responder等)都对它赞不绝口。

如今开源的 Pyright ,口碑还不错,那我们就来看看它有啥本事,顺便再介绍其它几款类型检查工具。

众所周知,Python 是一门动态类型语言,在运行期才知道变量的实际类型。这本就是动态语言的特色,然而在团队合作或大型项目上,维护的代价也不可避免,俗话说的是:“动态一时爽,重构火葬场 ”。

早在 2006 年的 PEP-3107,Python 就推出了函数注解的功能,最终落在 3.0 版本实现。而到了 3.5 版本,Python 继续引入了静态类型检查的语法(即 PEP-484,type hints)。2014 年的 PEP-483 更是以《The Theory of Type Hints》为题,做出了理论上的归纳。后来,又陆续提出了 PEP-526、PEP-544,类型检查的规范逐渐丰富。

类型检查的好处是及早检查,提前发现类型的错误,增强代码的一致性与可维护性。(还有防止脱发,喵)

# 不加检查
def greeting(name):
  return 'Hello ' + name
 
# 添加检查
def greeting(name: str) -> str:
  return 'Hello ' + name

如上例所示,增加检查后,可以在编译期就判断入参和返回值是否是字符串类型。例如下图:

介绍一款python类型检查工具pyright(推荐)

在微软推出 pyright 之前,主流的静态检查工具有三款:官方的mypy 、Google 出的pytype 、Facebook 出的pyre-check 。三足鼎立的局面要被打破了。

pyright 的文档宣称它有如下特点:

  1. 速度快。相较于 mypy 及其它用 Python 写的检查工具,它的速度是 5 倍甚至更多。
  2. 不依赖 Python 环境。它用 TypeScript 写成,运行于 node 上,不依赖 Python 环境或第三方包。
  3. 可配置性强。支持自由地配置,支持指定不同的运行环境(PYTHONPATH 设置、Python 版本、平台目标)。
  4. 检查项齐全。支持类型检查及其它语法项的检查(如 PEP-484、PEP-526、PEP-544),以及函数返回值、类变量、全局变量的检查,甚至可以检查条件循环语句
  5. 命令行工具。它包含两个 VS Code 插件:一个命令行工具和一个语言服务器协议(Language Server Protocol)
  6. 内置 Stubs 。使用的是 Typeshed 的副本。(注:使用静态的 pyi 文件,检查内置模块、标准库和三方件 )
  7. 语言服务特性。悬停提示信息、符号定义的跳转、实时的编辑反馈

就此而言,不可谓不强大。事实上,pyright 是“站在了巨人的肩膀上”,它的各项功能似乎都继承自其它几位前辈。

接着看官方的 mypy ,它由“Python 之父” Guido van Rossum 亲自参与开发,是最主流的选择,推出得早,用户基数大,文档与社区经验也最丰富。

在集成 IDE 方面,所有主流的编辑器都支持:PyCharm、Vim、Emacs、Sublime Text、VS Code、Atom……在业界经验上,Instagram 和 Dropbox 的项目从 py2 迁移到 py3 ,就是用的它来做保障。

接着看谷歌的 pytype ,据文档描述,它可以:

  1. 标记常见错误,如拼写错误、函数调用错误
  2. 加强自定义的类型注解
  3. 支持对 pyi 文件生成类型注解

查看文档,我发现它有个功能还挺人性化的,即“错误降噪 ”,对于那些不必修改的错误,可以添加注释,来消除类型检查。

此外,还有一个考虑也不错,为了写类型检查,模块中可能会额外引入其它的模块,对于后者,pytype 有办法隐藏它,只在做类型检查时才加载。

最后,要介绍的是脸书的 pyre-check,它是去年开源的,也曾收获一片好评(说不定正是因为它,微软才上马了 pyright 项目也说不定)。

基本的功能点大同小异,不过它也是有亮点的。pyre-check 可集成Watchman 模块,该“观察者”会监听代码文件,跟踪所做的修改。微软的 pyright 有个 watch 模式,应该是吸收了这点,而且更加好用(因为不需要额外安装 Watchman 和其它依赖)。

pyre-check 还有个亮点,它有个query 参数,可以对源码做局部区域性的检查,例如查询某行中一个表达式的类型、查询一个类的全部方法并返回成列表,等等,这样可以避免做全面的检查。

4 种类型检查工具介绍完毕,下面是一份概要对比:

介绍一款python类型检查工具pyright(推荐)

至于它们的性能如何,是否真如 pyright 所说,它的速度是其它几个的 5 倍呢?感兴趣的同学们可以去试试。有什么使用体会,欢迎留言与我交流。

 项目地址:

https://github.com/python/mypy

https://github.com/Microsoft/pyright

https://github.com/google/pytype

https://github.com/facebook/pyre-check

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python之eval()函数危险性浅析
Jul 03 Python
python获取本机mac地址和ip地址的方法
Apr 29 Python
Python的Tornado框架的异步任务与AsyncHTTPClient
Jun 27 Python
Python中的字符串操作和编码Unicode详解
Jan 18 Python
代码讲解Python对Windows服务进行监控
Feb 11 Python
Python判断两个文件是否相同与两个文本进行相同项筛选的方法
Mar 01 Python
Python 中的参数传递、返回值、浅拷贝、深拷贝
Jun 25 Python
Python新手如何进行闭包时绑定变量操作
May 29 Python
Python如何执行系统命令
Sep 23 Python
对pytorch中x = x.view(x.size(0), -1) 的理解说明
Mar 03 Python
python实现简易名片管理系统
Apr 11 Python
彻底弄懂Python中的回调函数(callback)
Jun 25 Python
Python flask框架post接口调用示例
Jul 03 #Python
Python3安装psycopy2以及遇到问题解决方法
Jul 03 #Python
python调试神器PySnooper的使用
Jul 03 #Python
详解DeBug Python神级工具PySnooper
Jul 03 #Python
使用python来调用CAN通讯的DLL实现方法
Jul 03 #Python
opencv python 图像轮廓/检测轮廓/绘制轮廓的方法
Jul 03 #Python
在cmd中查看python的安装路径方法
Jul 03 #Python
You might like
php curl模拟post请求小实例
2013/11/13 PHP
laravel安装zend opcache加速器教程
2015/03/02 PHP
javascript 获取网页参数系统
2008/07/19 Javascript
Cookie 注入是怎样产生的
2009/04/08 Javascript
JavaScript 保存数组到Cookie的代码
2010/04/14 Javascript
JavaScript自定义方法实现trim()、Ltrim()、Rtrim()的功能
2013/11/03 Javascript
js将字符串转成正则表达式的实现方法
2013/11/13 Javascript
深入理解JavaScript系列(27):设计模式之建造者模式详解
2015/03/03 Javascript
jQuery实现的鼠标滑过弹出放大图片特效
2016/01/08 Javascript
JS组件系列之Bootstrap Icon图标选择组件
2016/01/28 Javascript
jQuery实现输入框邮箱内容自动补全与上下翻动显示效果【附demo源码下载】
2016/09/20 Javascript
JavaScript获取select中text值的方法
2017/02/13 Javascript
使用JavaScriptCore实现OC和JS交互详解
2017/03/28 Javascript
React利用插件和不用插件实现双向绑定的方法详解
2017/07/03 Javascript
webpack4.x打包过程详解
2018/07/18 Javascript
layui radio点击事件实现input显示和隐藏的例子
2019/09/02 Javascript
解决layui的input独占一行的问题
2019/09/10 Javascript
如何修改Vue打包后文件的接口地址配置的方法
2020/04/22 Javascript
js实现滑动滑块验证登录
2020/07/24 Javascript
vue项目打包为APP,静态资源正常显示,但API请求不到数据的操作
2020/09/12 Javascript
js实现圆形菜单选择器
2020/12/03 Javascript
Python 3.x 新特性及10大变化
2015/06/12 Python
Python写入数据到MP3文件中的方法
2015/07/10 Python
Python与人工神经网络:使用神经网络识别手写图像介绍
2017/12/19 Python
python3.6 实现AES加密的示例(pyCryptodome)
2018/01/10 Python
用python打印菱形的实操方法和代码
2019/06/25 Python
python pyinstaller打包exe报错的解决方法
2019/11/02 Python
python爬虫中采集中遇到的问题整理
2020/11/27 Python
pandas统计重复值次数的方法实现
2021/02/20 Python
HTML5 Web 存储详解
2016/09/16 HTML / CSS
关于保护环境的标语
2014/06/09 职场文书
勤俭节约倡议书范文
2015/04/29 职场文书
小学教学工作总结2015
2015/05/13 职场文书
导游词之贵州织金洞
2019/10/12 职场文书
mysql的Buffer Pool存储及原理
2022/04/02 MySQL
Elasticsearch 聚合查询和排序
2022/04/19 Python