介绍一款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 相关文章推荐
Flask SQLAlchemy一对一,一对多的使用方法实践
Feb 10 Python
python实现倒计时的示例
Feb 14 Python
编写Python脚本批量下载DesktopNexus壁纸的教程
May 06 Python
解析Python中的__getitem__专有方法
Jun 27 Python
python爬虫实战之最简单的网页爬虫教程
Aug 13 Python
python实现比较文件内容异同
Jun 22 Python
Python面向对象类的继承实例详解
Jun 27 Python
Python unittest单元测试框架总结
Sep 08 Python
Python实现的批量修改文件后缀名操作示例
Dec 07 Python
python实现比较类的两个instance(对象)是否相等的方法分析
Jun 26 Python
python字符串查找函数的用法详解
Jul 08 Python
Python3进制之间的转换代码实例
Aug 24 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获取http请求的头信息实现步骤
2012/12/16 PHP
php树型类实例
2014/12/05 PHP
php字符串的替换,分割和连接方法
2016/05/23 PHP
TNC vs BOOM BO3 第三场2.13
2021/03/10 DOTA
如何用javascript判断录入的日期是否合法
2007/01/08 Javascript
JavaScript学习历程和心得小结
2010/08/16 Javascript
基于JQuery的Select选择框的华丽变身
2011/08/23 Javascript
JQuery入门——用bind方法绑定事件处理函数应用介绍
2013/02/05 Javascript
如何防止回车(enter)键提交表单
2014/05/11 Javascript
jQuery点缩略图弹出层显示大图片
2015/02/13 Javascript
JQuery遍历DOM节点的方法
2015/06/11 Javascript
JavaScript中各种引用类型的常用操作方法小结
2016/05/05 Javascript
javascript判断图片是否加载完成的方法推荐
2016/05/13 Javascript
JS 循环li添加点击事件 (闭包的应用)
2016/12/10 Javascript
Angular2 http jsonp的实例详解
2017/08/31 Javascript
浅谈es6中export和export default的作用及区别
2018/02/07 Javascript
微信小程序实现全局搜索代码高亮的示例
2018/03/30 Javascript
Angular7.2.7路由使用初体验
2019/03/01 Javascript
原生JS实现图片懒加载之页面性能优化
2019/04/26 Javascript
小程序实现日历左右滑动效果
2019/10/21 Javascript
解决await在forEach中不起作用的问题
2021/02/25 Javascript
Python代码解决RenderView窗口not found问题
2016/08/28 Python
使用Python和Prometheus跟踪天气的使用方法
2019/05/06 Python
简单了解python中对象的取反运算符
2019/07/01 Python
python计算无向图节点度的实例代码
2019/11/22 Python
Python动态强类型解释型语言原理解析
2020/03/25 Python
Django获取model中的字段名和字段的verbose_name方式
2020/05/19 Python
详解基于 Canvas 手撸一个六边形能力图
2019/09/02 HTML / CSS
UGG英国官方网站:UGG UK
2018/02/08 全球购物
Elemis美国官网:英国的第一豪华护肤品牌
2018/03/15 全球购物
SmartBuyGlasses荷兰:购买太阳镜和眼镜
2020/03/16 全球购物
安全生产年活动总结
2014/08/29 职场文书
法院个人总结
2015/03/03 职场文书
美丽人生观后感
2015/06/03 职场文书
班主任远程培训研修日志
2015/11/13 职场文书
解决tk mapper 通用mapper的bug问题
2021/06/16 Java/Android