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 相关文章推荐
Django查找网站项目根目录和对正则表达式的支持
Jul 15 Python
使用Python导出Excel图表以及导出为图片的方法
Nov 07 Python
python常用函数详解
Sep 13 Python
selenium python浏览器多窗口处理代码示例
Jan 15 Python
Python RabbitMQ消息队列实现rpc
May 30 Python
Python实现的读写json文件功能示例
Jun 05 Python
python 反编译exe文件为py文件的实例代码
Jun 27 Python
Python画图实现同一结点多个柱状图的示例
Jul 07 Python
对django 模型 unique together的示例讲解
Aug 06 Python
浅谈python print(xx, flush = True) 全网最清晰的解释
Feb 21 Python
python 基于PYMYSQL使用MYSQL数据库
Dec 24 Python
基于Python实现对比Exce的工具
Apr 07 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
163的邮件用phpmailer发送(实例详解)
2013/06/24 PHP
php ios推送(代码)
2013/07/01 PHP
PHP实现微信申请退款功能
2018/10/01 PHP
PHP中16个高危函数整理
2019/09/19 PHP
基于Web标准的UI组件 — 树状菜单(2)
2006/09/18 Javascript
JS 文件本身编码转换 图文教程
2009/10/12 Javascript
基于jquery的划词搜索实现(备忘)
2010/09/14 Javascript
基于jquery中children()与find()的区别介绍
2013/04/26 Javascript
jQuery+ajax中getJSON() 用法实例
2014/12/22 Javascript
JS实现的数组全排列输出算法
2015/03/19 Javascript
自己动手写的jquery分页控件(非常简单实用)
2015/10/28 Javascript
jQuery实现隔行变色的方法分析(对比原生JS)
2016/11/18 Javascript
常用原生js自定义函数总结
2016/11/20 Javascript
JS常见疑难点分析之match,charAt,charCodeAt,map,search用法分析
2016/12/25 Javascript
jQuery实现百度登录框的动态切换效果
2017/04/21 jQuery
JS计算距当前时间的时间差实例
2017/12/29 Javascript
详解如何在vscode里面调试js和node.js的方法步骤
2018/12/24 Javascript
Vue指令v-for遍历输出JavaScript数组及json对象的常见方式小结
2019/02/11 Javascript
vue登录注册实例详解
2019/09/14 Javascript
Python实现telnet服务器的方法
2015/07/10 Python
python异常处理try except过程解析
2020/02/03 Python
基于python检查SSL证书到期情况代码实例
2020/04/04 Python
详解利用python识别图片中的条码(pyzbar)及条码图片矫正和增强
2020/11/17 Python
用python爬虫批量下载pdf的实现
2020/12/01 Python
详解css3 mask遮罩实现一些特效
2018/10/24 HTML / CSS
英国名牌服装购物网站:OD’s Designer
2019/09/02 全球购物
如何查找网页漏洞
2016/06/22 面试题
财务分析个人的自荐书范文
2013/11/24 职场文书
医药专业应届毕业生求职信范文
2014/01/01 职场文书
上班离岗检讨书
2014/01/27 职场文书
运动会入场词50字
2014/02/20 职场文书
新书发布会策划方案
2014/06/09 职场文书
2014机关干部学习“焦裕禄精神”思想汇报
2014/09/19 职场文书
宣传部部长竞选稿
2015/11/21 职场文书
学校团代会开幕词
2016/03/04 职场文书
MYSQL优化之数据表碎片整理详解
2022/04/03 MySQL