本文通过详细的理论介绍和简单易懂的实例全面介绍了 python 代码分析工具 pylint。相信读者看完后一定可以轻松地将 pylint 运用到自己的开发工程中
pylint 是什么
pylint 是一个 python 代码分析工具，它分析 python 代码中的错误，查找不符合代码风格标准（pylint 默认使用的代码风格是 pep 8，具体信息，请参阅参考资料）和有潜在问题的代码。目前 pylint 的最新版本是 pylint-0.18.1。
pylint 是一个 python 工具，除了平常代码分析工具的作用之外，它提供了更多的功能：如检查一行代码的长度，变量名是否符合命名标准，一个声明过的接口是否被真正实现等等。
pylint 的一个很大的好处是它的高可配置性，高可定制性，并且可以很容易写小插件来添加功能。
如果运行两次 pylint，它会同时显示出当前和上次的运行结果，从而可以看出代码质量是否得到了改进。
目前在 eclipse 的 pydev 插件中也集成了 pylint。
pylint 具体介绍
pylint 的安装
pylint 可以用于所有高于或者等于 2.2 的 python 版本兼容。需要 logilab-astng（version >= 0.14）和 logilab-common（version >= 0.13）的包（具体信息，请参阅 参考资料），如果是 python 版本低于 2.3，那么它还需要 optik 包（本文接下来的示例暂不考虑这种情况）。
pylint 所用到的所有的包的下载地址
logilab-astng 的最新包下载：http://www.logilab.org/856/
logilab-common 的最新包下载：http://www.logilab.org/848/
optik 的包下载：http://optik.sourceforge.net/
pylint 的最新包下载：http://www.logilab.org/project/pylint
pylint 在 linux 上的安装
1. 在 linux 上，首先安装 python 的包（高于版本 2.2），并在环境变量 $path 中添加 python 可执行文件的路径。
2. 下载 pylint、logilab-astng (version >= 0.14) 和 logilab-common (version >= 0.13) 的包 , 使用 tar zxvf *.tar.gz解压缩这些包。
3. 依次进入 logilab-astng、logilab-common 和 pylint 解开的文件夹中，运行命令 python setup.py install来安装。
4. 安装完成后，就可以通过 pylint [options] module_or_package来调用 pylint 了。
pylint 在 windows 上的安装
1. 安装 python 的包（高于版本 2.2），右键单击桌面上的我的电脑图标，选择属性，高级，环境变量，在 $path 中添加 python 的安装路径，如 c:\python26\。
2. 使用解压缩工具解压缩所有的包。
3. 打开命令行窗口，使用 cd依次进入 logilab-astng、logilab-common 和 pylint 解开的文件夹中，运行命令 python setup.py install来安装。
4. 安装完成后，在 python 的安装路径下出现一个 scripts 文件夹，里面包含一些 bat 脚本，如 pylint.bat 等。
5. 为了使调用 pylint.bat 的时候不需要输入完整路径，在 python 的安装目录下创建 pylint.bat 的重定向文件，这是一个纯文本文件 pylint.bat，里面包含 pylint.bat 的实际路径，如：c:\python26\scripts\pylint.bat。
6. 安装完成后，可以通过 pylint [options] module_or_package来调用 pylint 了。
pylint 的调用
清单 1. pylint 的调用命令
pylint [options] module_or_package
使用 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。
此外，对于安装了 tkinter 包的机器，可以使用命令 pylint-gui打开一个简单的 gui 界面，在这里输入模块或者包的名字 ( 规则同命令行 ), 点击 run，pylint 的输出会在 gui 中显示。
pylint 的常用命令行参数
-h,--help
显示所有帮助信息。
--generate-rcfile
可以使用 pylint --generate-rcfile 来生成一个配置文件示例。可以使用重定向把这个配置文件保存下来用做以后使用。也可以在前面加上其它选项，使这些选项的值被包含在这个产生的配置文件里。如：pylint --persistent=n --generate-rcfile > pylint.conf，查看 pylint.conf，可以看到 persistent=no，而不再是其默认值 yes。
--rcfile=28897b20adb25fbae118a3f80f538dec
指定一个配置文件。把使用的配置放在配置文件中，这样不仅规范了自己代码，也可以方便地和别人共享这些规范。
-i 160d9f8cfe2207c164f6d66f6bba2720, --include-ids=160d9f8cfe2207c164f6d66f6bba2720
在输出中包含 message 的 id, 然后通过 pylint --help-msg=a3edf2af01942fdcffdf035464303e4c来查看这个错误的详细信息，这样可以具体地定位错误。
-r 160d9f8cfe2207c164f6d66f6bba2720, --reports=160d9f8cfe2207c164f6d66f6bba2720
默认是 y, 表示 pylint 的输出中除了包含源代码分析部分，也包含报告部分。
--files-output=160d9f8cfe2207c164f6d66f6bba2720
将每个 module /package 的 message 输出到一个以 pylint_module/package. [txt|html] 命名的文件中，如果有 report 的话，输出到名为 pylint_global.[txt|html] 的文件中。默认是输出到屏幕上不输出到文件里。
-f 0313a12b65aa20a048ec62b8cf470fd2, --output-format=0313a12b65aa20a048ec62b8cf470fd2
设置输出格式。可以选择的格式有 text, parseable, colorized, msvs (visual studio) 和 html, 默认的输出格式是 text。
--disable-msg=890637d5323cc846fd09422940793fac
禁止指定 id 的 message. 比如说输出中包含了 w0402 这个 warning 的 message, 如果不希望它在输出中出现，可以使用 --disable-msg= w0402
pylint 的输出
pylint的默认输出格式是原始文本（raw text）格式 ，可以通过 -f 0313a12b65aa20a048ec62b8cf470fd2，--output-format=0313a12b65aa20a048ec62b8cf470fd2 来指定别的输出格式如html等等。在pylint的输出中有如下两个部分：源代码分析部分和报告部分。
源代码分析部分：
对于每一个 python 模块，pylint 的结果中首先显示一些*字符 , 后面紧跟模块的名字，然后是一系列的 message, message 的格式如下：
message_type: line_num:[object:] message
message_type 有如下几种：
(c) 惯例。违反了编码风格标准
(r) 重构。写得非常糟糕的代码。
(w) 警告。某些 python 特定的问题。
(e) 错误。很可能是代码中的错误。
(f) 致命错误。阻止 pylint 进一步运行的错误。
清单 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)
报告部分：
在源代码分析结束后面，会有一系列的报告，每个报告关注于项目的某些方面，如每种类别的 message 的数目，模块的依赖关系等等。具体来说，报告中会包含如下的方面：
检查的 module 的个数。
对于每个 module, 错误和警告在其中所占的百分比。比如有两个 module a 和 b, 如果一共检查出来 4 个错误，1 个错误是在 a 中，3 个错误是在 b 中，那么 a 的错误的百分比是 25%, b 的错误的百分比是 75%。
错误，警告的总数量。
使用 pylint 分析 python 代码的具体示例
下面是一个从 xml 文件中读取一些值并显示出来的一段 python 代码 dw.py，代码如下：
清单 3. 源码
import string #!/usr/bin/env python import xml.dom.minidom xmldom=xml.dom.minidom.parse("identity.xml") organizations = xmldom.getelementsbytagname('dw') for org in organizations: products = org.getelementsbytagname('linux') for product in products: print 'id: ' + product.getattribute('id') print 'name: ' + product.getattribute('name') print 'word count: ' + product.getattribute('count')
清单 4. identity.xml 的内容
<ibm> <dw> <linux id="100" name="python" count="3000" /> </dw> </ibm>
这时候使用 pylint 的结果（这是从 html 格式的输出中拷贝的）为：
清单 5. pylint 的分析结果
************* module dw
c:1:missing docstring
c:5:operator not preceded by a space xmldom=xml.dom.minidom.parse("identity.xml") ^
c:5:invalid name "xmldom" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
c:6:invalid name "organizations" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
report 部分省略
输出中第一部分是源代码分析，第二部分是报告。输出结果中有这么多信息，从哪里开始分析呢？首先使用如下的步骤来分析代码：
1. 因为输出结果太长，所以可以先不让它输出报告部分，先根据源代码分析部分来找出代码中的问题。使用选项 "--reports=n"。
2. 使用选项 "--include-ids=y"。可以获取到源代码分析部分每条信息的 id。
清单 6. 使用 pylint --reports=n --include-ids=y dw.py 的结果
************* module dw
c0111: 1: missing docstring
c0322: 5: operator not preceded by a space xmldom=xml.dom.minidom.parse("identity.xml") ^
c0103: 5: invalid name "xmldom" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
c0103: 6: invalid name "organizations" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
每个信息前面都会加上一个 id, 如果不理解这个信息的意思，可以通过 pylint --help-msg=id来查看。
清单 7. 使用 pylint --help-msg= c0111 的结果
c0111: *missing docstring*
used when a module, function, class or method has no docstring. some special
methods like __init__ doesn't necessary require a docstring.
this message belongs to the basic checker.
3. 开始分析每个源代码中的问题。从上面知道，第一个问题的原因是缺少 docstring，在代码中增加 docstring, 修改后的代码如下：
清单 8. 增加 docstring 修改后的源码
#!/usr/bin/env python """this script parse the content of a xml file""" import xml.dom.minidom xmldom=xml.dom.minidom.parse("identity.xml") organizations = xmldom.getelementsbytagname('dw') for org in organizations: products = org.getelementsbytagname('linux') for product in products: print 'id: ' + product.getattribute('id') print 'name: ' + product.getattribute('name') print 'word count: ' + product.getattribute('count')
重新运行 pylint --reports=n --include-ids=y dw.py，结果为：
清单 9. 运行结果
************* module dw
c0322: 7: operator not preceded by a space
xmldom=xml.dom.minidom.parse("identity.xml")
^
c0103: 7: invalid name "xmldom" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
c0103: 8: invalid name "organizations" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
可以看到源代码中的第一个问题已被解决。
4. 关于第二个 c0322 的问题，这里的分析结果说明得比较清楚，是代码第七行中的等号运算符两边没有空格。我们在这里加上空格，重新运行 pylint --reports=n --include-ids=y dw.py，结果为：
清单 10. 运行结果
************* module dw
c0103: 7: invalid name "xmldom" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
c0103: 8: invalid name "organizations" (should match (([a-z_][a-z0-9_]*)|(__.*__))$)
5. 可以看到现在问题只剩下 c0103 了。这里的意思是变量命名规则应该符合后面正则表达式的规定。pylint 定义了一系列针对变量，函数，类等的名字的命名规则。实际中我们不一定要使用这样的命名规则，我们可以定义使用正则表达式定义自己的命名规则，比如使用选项 --const-rgx='[a-z_][a-z0-9_]{2,30}$'，我们将变量 xmldom改为 xmldom, 代码如下：
清单 11. 将变量 xmldom 改为 xmldom 后的源码
#!/usr/bin/env python """this script parse the content of a xml file""" import xml.dom.minidom xmldom = xml.dom.minidom.parse("identity.xml") organizations = xmldom.getelementsbytagname('dw') for org in organizations: products = org.getelementsbytagname('linux') for product in products: print 'id: ' + product.getattribute('id') print 'name: ' + product.getattribute('name') print 'word count: ' + product.getattribute('count')
运行 pylint --reports=n --include-ids=y --const-rgx='[a-z_][a-z0-9_]{2,30}$' dw.py，结果中就没有任何问题了。
6. 如果希望一个组里的人都使用这些统一的规则，来规范一个部门的代码风格。比如说大家都使用 --const-rgx='[a-z_][a-z0-9_]{2,30}$'作为命名规则，那么一个比较便捷的方法是使用配置文件。
使用 pylint --generate-rcfile > pylint.conf来生成一个示例配置文件，然后编辑其中的 --const-rgx选项。或者也可以直接 pylint --const-rgx='[a-z_][a-z0-9_]{2,30}$' --generate-rcfile > pylint.conf，这样生成的配置文件中 --const-rgx选项直接就是 '[a-z_][a-z0-9_]{2,30}$'了。
以后运行 pylint 的时候指定配置文件：pylint --rcfile=pylint.conf dw.py
这样 pylint 就会按照配置文件 pylint.conf中的选项来指定参数。在一个部门中，大家可以共同使用同一个配置文件，这样就可以保持一致的代码风格。
7. 如果把 report 部分加上，即不使用 --reports=n，可以看到报告部分的内容。
结束语
本文通过详细的理论介绍和简单易懂的实例全面介绍了 python 代码分析工具 pylint。相信读者看完后一定可以轻松地将 pylint 运用到自己的开发工程中。
相关主题
pylint 官方网站。
logilab-astng 的最新包下载。
logilab-common 的最新包下载。
optik 的包下载。
pylint 的最新包下载。
查看 python 代码风格标准 pep 8 -- style guide for python code下载。
更多关于 python 内容，请参考 developerworks 上 python 专题。
相关推荐：
python代码检查工具pylint 让你的python更规范
以上就是如何使用 pylint 来规范 python 代码风格(来自ibm)_python的详细内容。