Python代码规范与pylint

 

Pylint简介

Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8）和有潜在问题的代码。

参考《如何使用 Pylint 来规范 Python 代码风格 》

Windows 下的安装

1.     确保 Python 的安装目录和相应的 Scripts 目录已经在环境变量 path 中

2.     先到 http://pypi.python.org/pypi/pylint下载安装包，然后解压到某目录，这里假定在 D:/pylint-0.23.0

3.     进入 D:/pylint-0.23.0 目录，然后在命令行执行以下指令：python setup.py install

4.     在上一步会出错，但会报告成已经成功安装，这时候需要打开 D:/pylint-0.23.0/bin 目录，然后把那里的所有文件拷贝到 Python 的 Scripts 目录下（如：D:/Python26/Scripts）

5.     在命令行尝试执行 pylint，如果输出帮助，则表示已经安装成功

与 PyDev 集成

PyDev 的安装略过...以下是集成配置的过程：

1.     Window -> preferences -> Pydev -> Pylint,选中 "Use pylint?"

2.     在 Location of pylint 处输入你安装的 lint.py 的地址，如：C:/Python25/Lib/site-packages/pylint-0.23.0-py2.5.egg/pylint/lint.py

3.     在下方的 Arguments to pass to pylint添加参数，以限制pylint的输出。

             --persistent=n --comment=n

           --disable-msg=C0103,C0301,W0312,W0511,W0232,E1101

4.      Project -> Properties -> PyDev?-PYTHONPATH 增添项目的源文件目录到"Project Source Folders"。

（注：python源文件必须放在src文件夹）

 

 

 

 

 

 

 

 

 

 

Python Coverntions

介绍

这篇文档所给出的编码约定，适用于在主要的 Python 发布版本中组成标准库的 Python 代码。在 Python 的 C 实现中 C 代码风格指南的描述，请查阅姊妹篇 PEP 7。

这篇文档改编自 Guido (注：python之父) 最初的《Python Style Guide》一文。并从《Barry's style guide》中添加了部分内容。在有冲突的地方，Guide 的风格规则应该是符合本 PEP 的意图。这篇 PEP 可能仍是不完善的 (实际上，它可能永远不会完美)。

A Foolish Consistency is the Hobgoblin of Little Minds

Guido 的关键观点之一是：代码更多是用来读而不是写。故本指南致力于改善 Python 代码的可读性、使不同的 (wide spectrum) Python 代码 保持一致性。正如 PEP 20 所说的可读性计算 (Readability counts)。

 

风格指南是关于一致性的。风格一致对本指南是重要的，对一个项目更重要。在一个 模块、或者函数内保持 (代码风格) 一致最重要。但最重要的是：知道何时会不一致 -- 有时只是没有实施风格指导。当有疑惑时，运用你的最佳判断。看看别的例子，然后决定怎样看起来更好。并且要不耻下问！

打破一条既定规则的两个好理由：

(1) 当应用这条规则时将导致代码可读性下降，即便对某人来说，他已经习惯于按这条规则来阅读代码了。

(2) 为了和周围的代码保持一致而打破规则 (也许是历史原因) -- 虽然这也是个清除其他混乱的好机会 (在真正的 XP 风格中)。

代码布局 (Code lay-out)

缩进 (Indentation)

每级缩进用 4 个空格。

为避免与旧代码混淆，可继续采用 8 个空格宽的 tab 缩进。

Tab 还是空格 (Tabs or Spaces)？

绝不要混合使用 tab 和空格。

 

最流行的 Python 缩进方式是仅使用空格，其次是仅使用制表符。混合着制表符和空格缩进的代码将被转换成仅使用空格。调用 Python 命令行解释器时使用 -t 选项， 可对代码中不合法的混用制表符和空格发出警告 (warnings)。使用 -tt 时警告将变 成错误。这些选项是被高度推荐的。

 

对新项目，强烈推荐只用空格，而不是用 tabs。大多数编辑器拥有使之易于实现的功 能。

最大行宽 (Maximum Line Length)

限制所有行的最大行宽为 79 字符。

 

周围仍然有许多设备被限制在每行 80 字符；而且，窗口限制在 80 个字符，使将多 个窗口并排放置成为可能。在这些设备上使用默认的折叠 (wrapping) 方式看起来有 点丑陋。 因此，请将所有行限制在最大 79 字符。对顺序排放的大块文本 (文档字符 串或注释 (docstrings or comments))，推荐将长度限制在 72 字符。

 

折叠长行的首选方法是使用 Python 支持的圆括号、方括号 (brackets) 和花括号 (braces) 内的行延续。如果需要，你可以在表达式周围增加一对额外的圆括号，但是 有时使用反斜杠看起来更好。确认恰当地缩进了延续的行。一些例子：

class Rectangle(Blob):

    def init(self, width, height,

             color='black', emphasis=None, highlight=0):

        if (width == 0 and height == 0 and /

            color == 'red' and emphasis == 'strong' or /

            highlight > 100):

            raise ValueError("sorry, you lose")

        if width == 0 and height &#