天天看点

Python代码审阅工具Pylint

Pylint 是什么

Pylint是一个Python静态代码分析工具,它查找编程错误、帮助执行编码标准,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8)和有潜在问题的代码。除了平常代码分析工具的作用之外,它提供了更多的功能:如检查一行代码的长度,变量名是否符合命名标准,一个声明过的接口是否被真正实现;Pylint 的一个很大的好处是它的高可配置性,高可定制性,并且可以很容易写小插件来添加功能;目前在 PyCharm 中也集成了 Pylint。

pip安装

pip install pylint

Python代码审阅工具Pylint

四、规范的代码有助于代码审阅(说白了别人看着舒服,也能看懂)

三、规范的代码可以降低维护成本

二、规范的代码可以减少人力资源投入

一、规范的代码可以促进团队开发

代码规范的重要性

离线包安装python setup.py install

升级 pip install pylint --upgrade帮助

-h,--help : 显示所有帮助信息

PyCharm 配置pylint过程

File > Settings> Tools > External Tools,点击 + 号添加,如下图配置

Python代码审阅工具Pylint
Python代码审阅工具Pylint

AFTERNOON

一个夏日的午后

Python代码审阅工具Pylint

Program设置为:指向 pylint 的实际目录,此处以 windows10目录为例

Parameters 设置为 (用户可根据自己的情况,选择 pylint 输出信息显示格式和要 disable 的项目):

--output-format=parseable --disable=R --disable=C0102,C0103,C0111,C0301,C0302,C0303,C0304,C0305,W0120,W0123,W0401,W0603,W0612,W0614,W0621,W0622,W0703,E1003,E1101 $FilePath$      

注:为了防止 Pylint 打印找不到 配置文件的 warning,可以在当前工程目录下新建一个空的文件,取名为 .pylintrc,再在上述参数中加入选项 --rcfile=path/to/.pylintrc 即可。

Working Direcroty 设置为:$FileDir$

Python代码审阅工具Pylint
Python代码审阅工具Pylint