如何使用 Pylint 来规范 Python 代码风格

核心提示： 这时候使用 Pylint 的结果（这是从 html 格式的输出中拷贝的）为：清单 5. Pylint 的分析结果*ModuledwC:1:MissingdocstringC:5:OperatornotprecededbyaspacexmlDom=xml.dom.minidom.parse(&qu

这时候使用 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.