Python编码规范

Python编码规范

缩进

使用4个空格作为第一级缩进。

TAB或空格

不要混合TAB和空格。

最大行长度

最大行长度限制在80个字符内。

空白行

分割顶层函数和类定义使用二个空行。在类里面的方法定义用一个空行分割。多余的空行用来分割相关的函数组。使用空行分割逻辑块。

语句或表达式里面的空格

x = 1
y = 2
  

注释

注释最好写英文。与代码相违背的注释还不如没有注释。如果注释是一个句子，首字母要大写。在注释一个句子结束出加上二个空格。

• 块注释

  通过一个#开始,#结束

• 内部注释

文档

所有的函数和模块都应该有文档，样例如下：

def kos_root():
    """Return the pathname of the KOS root directory."""
    global _kos_root
    if _kos_root: return _kos_root
    ...

def complex(real=0.0, imag=0.0):
    """Form a complex number.

    Keyword arguments:
    real -- the real part (default 0.0)
    imag -- the imaginary part (default 0.0)

    """
    if imag == 0.0 and real == 0.0: return complex_zero
    ...
  

版本信息

需要加入源代码的版本信息，可以写下面的代码：

__version__ = "$Revision: 6104 ___FCKpd___2quot;
# $Source$

这段代码加在模块文档之后。

模块

模块命名使用小写，因为模块对应文件名，这样和文件的命名规范相一致。

类

类名使用CapWords惯例。在内部使用的类在前面加上下划线。

异常名

函数

函数名称使用lower_case_with_underscores命名。

变量

不需要被导出的变量需要加下划线。