python如何实现代码检查


Posted in Python onJune 28, 2019

前言

通常我们的python代码都是遵循PEP8的规范化格式,目的是为了保持代码的一致性、可读性。,这里给大家推荐几个常用的静态代码检查工具,大家可以酌情选择使用

1. pylint

Pylint是一个Python静态代码分析工具,它可以查找编程错误,帮助强制执行编码标准,嗅探代码异味并提供简单的重构建议。

它具有高度可配置性,具有特殊的编译指示来控制代码中的错误和警告,以及广泛的配置文件。也可以编写自己的插件来添加自己的检查或以某种方式扩展pylint。

缺省情况下,PyLint 启用许多规则。它具有高度可配置性,从代码内部处理程序控制它。另外,编写插件添加到自己的检查中是可能的。

安装

pip install pylint
#如果您使用的是Python 3.6+,请升级以获得对您的版本的完全支持:
pip install pylint --upgrade
#如果要从源分发版安装,请解压缩tarball并运行以下命令
python setup.py install

文档

Pylint附带以下附加命令:

  • pyreverse:一个UML图生成器
  • symilar:一个独立的相似性检查器
  • epylint:Emacs和Flymake兼容的Pylint

使用

 pylint的各种引用以及使用方式都可以去文档查找,这里仅介绍一下比较基础简单的示例

pylint [options] modules_or_packages

命令行选项

参数 含义
--version 显示程序的版本号并退出
-h, --help 显示有关命令行选项的帮助
--ignore= 将文件或目录添加到黑名单。它们应该是基本名称,而不是路径。
--output-format= 选择输出格式(文本,json,自定义)。
--list-msgs 生成pylint的消息。

错误代码含义

  • C:惯例,违反了编码风格标准
  • R:重构,代码非常糟糕
  • W:警告,某些 Python 特定的问题
  • E:错误,很可能是代码中的错误
  • F:致命错误,阻止 Pylint 进一步运行的错误

更多pylint相关可参考文档

2. yapf:

Python的大多数当前格式化程序 - 例如,autopep8和pep8ify ---用于从代码中删除lint错误。这有一些明显的局限性。例如,符合PEP 8指南的代码可能无法重新格式化。但这并不意味着代码看起来很好。

YAPF采用不同的方法。它基于由Daniel Jasper开发的'clang-format'。从本质上讲,算法会获取代码并将其重新格式化为符合样式指南的最佳格式,即使原始代码没有违反样式指南。这个想法也类似于Go编程语言的'gofmt'工具:结束所有关于格式化的神圣战争

如果项目的整个代码库只是通过YAPF进行修改,只要进行修改,样式在整个项目中保持一致,并且没有必要在每次代码审查中争论风格。

最终目标是YAPF生成的代码与程序员在遵循样式指南时编写的代码一样好。它消除了维护代码的一些苦差事。
安装

pip install yapf

使用

yapf [-h] [-v] [-d | -i] [-r | -l START-END] [-e PATTERN]
[--style STYLE] [--style-help] [--no-local-style] [-p]
[-vv]
[files [files ...]]

同上,一样也可以直接跟文件进行操作

参数 参数说明
-h, --help 显示此帮助消息并退出
-v, --version 显示版本号并退出
-d, --diff 比较差异
-i, --in-place 对文件进行更改
-r, --recursive 以递归方式运行目录

示例

#直接跟文件名(并不修改文件)
yapf <python file>
#格式化前后对比
yapf -d <python file>
#直接修改源文件
yapf -i <python file>
#导出配置文件
yapf --style-help > style.cfg
#并发格式化多个文件,需要futures模块支持
yapf -pi *.py

更多yapf相关可参考yapf

其他的此类工具还有Pyflakes,flake8等等,小编直接出到这两个常用的,更多内容大家在项目实战中应该会有更多接触

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

Python 相关文章推荐
Python编写一个闹钟功能
Jul 11 Python
Python实现读取字符串按列分配后按行输出示例
Apr 17 Python
Python中.join()和os.path.join()两个函数的用法详解
Jun 11 Python
Python二叉树的镜像转换实现方法示例
Mar 06 Python
详解Python 切片语法
Jun 10 Python
python如何删除文件中重复的字段
Jul 16 Python
python中栈的原理及实现方法示例
Nov 27 Python
tensorflow实现在函数中用tf.Print输出中间值
Jan 21 Python
Python列表操作方法详解
Feb 09 Python
python属于解释型语言么
Jun 15 Python
PyQt5 QDockWidget控件应用详解
Aug 12 Python
python运算符之与用户交互
Apr 13 Python
python射线法判断一个点在图形区域内外
Jun 28 #Python
Python OpenCV之图片缩放的实现(cv2.resize)
Jun 28 #Python
如何使用Python 打印各种三角形
Jun 28 #Python
python射线法判断检测点是否位于区域外接矩形内
Jun 28 #Python
python 列表转为字典的两个小方法(小结)
Jun 28 #Python
numpy和pandas中数组的合并、拉直和重塑实例
Jun 28 #Python
使用Python画股票的K线图的方法步骤
Jun 28 #Python
You might like
php dirname(__FILE__) 获取当前文件的绝对路径
2011/06/28 PHP
php中使用gd库实现远程图片下载实例
2015/05/12 PHP
php使用GD2绘制几何图形示例
2017/02/15 PHP
thinkphp 验证码 的使用小结
2017/05/07 PHP
基于jQuery的日期选择控件
2009/10/27 Javascript
JavaScript 对Cookie 操作的封装小结
2009/12/31 Javascript
JQuery验证jsp页面属性是否为空(实例代码)
2013/11/08 Javascript
jQuery的3种请求方式$.post,$.get,$.getJSON
2014/03/28 Javascript
ExtJS4 表格的嵌套 rowExpander应用
2014/05/02 Javascript
javascript实现滑动解锁功能
2014/12/31 Javascript
深入学习AngularJS中数据的双向绑定机制
2016/03/04 Javascript
浅谈Javascript数组(推荐)
2016/05/17 Javascript
AngularJS中的DOM操作用法分析
2016/11/04 Javascript
Node.js 中exports 和 module.exports 的区别
2017/03/14 Javascript
JQuery和html+css实现带小圆点和左右按钮的轮播图实例
2017/07/22 jQuery
关于react中组件通信的几种方式详解
2017/12/10 Javascript
React全家桶环境搭建过程详解
2018/05/18 Javascript
Jquery实现无缝向上循环滚动列表的特效
2019/02/13 jQuery
vue自定义键盘信息、监听数据变化的方法示例【基于vm.$watch】
2019/03/16 Javascript
vue-cli随机生成port源码的方法
2019/09/02 Javascript
JS实现骰子3D旋转效果
2019/10/24 Javascript
JS实现选项卡插件的两种写法(jQuery和class)
2020/12/30 jQuery
python 获取文件列表(或是目录例表)
2009/03/25 Python
简洁的十分钟Python入门教程
2015/04/03 Python
Django中实现点击图片链接强制直接下载的方法
2015/05/14 Python
Python在线运行代码助手
2016/07/15 Python
Python3.7.0 Shell添加清屏快捷键的实现示例
2020/03/23 Python
python列表删除和多重循环退出原理详解
2020/03/26 Python
Python如何向SQLServer存储二进制图片
2020/06/08 Python
Python logging模块handlers用法详解
2020/08/14 Python
基于python实现操作redis及消息队列
2020/08/27 Python
CSS3 3D立方体效果示例-transform也不过如此
2016/12/05 HTML / CSS
Farfetch香港官网:汇集全球时尚奢侈品购物平台
2017/11/26 全球购物
大学教师年终总结的自我评价
2013/10/29 职场文书
终止或解除劳动合同及劳动关系的证明书
2014/10/06 职场文书
春节慰问简报
2015/07/21 职场文书