使用pylint 规范python代码

安装

pip install pylint

使用 Pylint 对一个模块 module.py 进行代码检查：

• 1. 进入这个模块所在的文件夹，运行 pylint [options] module.py

• 这种调用方式是一直可以工作的，因为当前的工作目录会被自动加入 Python 的路径中。

• 2. 不进入模块所在的文件夹，运行 pylint [options] directory/module.py

• 这种调用方式当如下条件满足的时候是可以工作的：directory 是个 Python 包 ( 比如包含一个 __init__.py 文件 )，或者 directory 被加入了 Python 的路径中。

使用 Pylint 对一个包 pakage 进行代码检查：

• 1. 进入这个包所在文件夹，运行 pylint [options] pakage。

• 这种调用方式是一直可以工作的，因为当前的工作目录会被自动加入 Python 的路径中。

• 2. 不进入包所在的文件夹，运行 pylint [options] directory/ pakage。

• 这种情况下当如下条件满足的时候是可以工作的：directory 被加入了 Python 的路径中。比如在 Linux 上，export PYTHONPATH=$PYTHONPATH: directory。

Pylint 的输出
MESSAGE_TYPE: LINE_NUM:[OBJECT:] MESSAGE
清单 2. Pylint 中的 utils 模块的输出结果
************* Module utils
C: 88:Message: Missing docstring
R: 88:Message: Too few public methods (0/2)
C:183:MessagesHandlerMixIn._cat_ids: Missing docstring
R:183:MessagesHandlerMixIn._cat_ids: Method could be a function
R:282:MessagesHandlerMixIn.list_messages: Too many branches (14/12)

Pylint的默认输出格式是原始文本（raw text）格式 ，可以通过 -f <format>，--output-format=<format> 来指定别的输出格式如html等等。在Pylint的输出中有如下两个部分：源代码分析部分和报告部分。

源代码分析部分：

对于每一个 Python 模块，Pylint 的结果中首先显示一些"*"字符 , 后面紧跟模块的名字，然后是一系列的 message, message 的格式如下：

MESSAGE_TYPE 有如下几种：

(C) 惯例。违反了编码风格标准

(R) 重构。写得非常糟糕的代码。

(W) 警告。某些 Python 特定的问题。

(E) 错误。很可能是代码中的错误。

(F) 致命错误。阻止 Pylint 进一步运行的错误。