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中的from..import绝对导入语句
Jun 21 Python
Python决策树分类算法学习
Dec 22 Python
对python cv2批量灰度图片并保存的实例讲解
Nov 09 Python
pyside+pyqt实现鼠标右键菜单功能
Dec 08 Python
详解python和matlab的优势与区别
Jun 28 Python
python制作英语翻译小工具代码实例
Sep 09 Python
基于Python实现船舶的MMSI的获取(推荐)
Oct 21 Python
Python利用PyExecJS库执行JS函数的案例分析
Dec 18 Python
使用PyOpenGL绘制三维坐标系实例
Dec 24 Python
Pycharm连接gitlab实现过程图解
Sep 01 Python
python/golang 删除链表中的元素
Sep 14 Python
python爬虫请求库httpx和parsel解析库的使用测评
May 10 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
基于asp+ajax和数据库驱动的二级联动菜单
2010/05/06 PHP
PHP随机生成信用卡卡号的方法
2015/03/23 PHP
Laravel 手动开关 Eloquent 修改器的操作方法
2019/12/30 PHP
php 的多进程操作实践案例分析
2020/02/28 PHP
JavaScript中的View-Model使用介绍
2011/08/11 Javascript
JavaScript将Table导出到Excel实现思路及代码
2013/03/13 Javascript
jQuery简单几行代码实现tab切换
2015/03/10 Javascript
JavaScript三元运算符的多种使用技巧
2015/04/16 Javascript
Three.js基础部分学习
2017/01/08 Javascript
vue渲染时闪烁{{}}的问题及解决方法
2018/03/28 Javascript
微信打开网址添加在浏览器中打开提示的办法
2019/05/20 Javascript
element-ui table组件如何使用render属性的实现
2019/11/04 Javascript
JavaScript setInterval()与setTimeout()计时器
2019/12/27 Javascript
Python中使用partial改变方法默认参数实例
2015/04/28 Python
Python对list列表结构中的值进行去重的方法总结
2016/05/07 Python
详解Python3.6安装psutil模块和功能简介
2018/05/30 Python
python高阶爬虫实战分析
2018/07/29 Python
Django中自定义查询对象的具体使用
2019/10/13 Python
Python日志处理模块logging用法解析
2020/05/19 Python
html5手机键盘弹出收起的处理
2020/01/20 HTML / CSS
HTML5页面无缝闪开的问题及解决方案
2020/06/11 HTML / CSS
奥地利网上书店:Weltbild
2017/07/14 全球购物
西班牙购买行李箱和背包网站:Maletas Greenwich
2019/10/08 全球购物
在c#中using和new这两个关键字有什么意义
2013/05/19 面试题
实习护理工作自我评价
2013/09/25 职场文书
司机的工作范围及职责
2013/11/13 职场文书
岳父生日宴会答谢词
2014/01/13 职场文书
学生实习介绍信
2014/01/15 职场文书
事业单位绩效考核实施方案
2014/03/27 职场文书
空乘英文求职信
2014/04/13 职场文书
标准版离职证明书
2014/09/12 职场文书
门面房租房协议书
2014/12/01 职场文书
KTV员工管理制度
2015/08/06 职场文书
心理健康教育主题班会
2015/08/13 职场文书
浅谈golang package中init方法的多处定义及运行顺序问题
2021/05/06 Golang
实现一个简单得数据响应系统
2021/11/11 Javascript