Python 编码风格参考

时间 2019-12-09

原文原文链接

代码除了用来运行外，更多的是用来读。为了是代码的可读性更强，不少编程语言都有本身的编码规范。规范的制定是为了保持代码的一致性，以使代码更美观和易读。代码应该怎么样排版和编写并非绝对的，因此一些地方会有争议。有时风格指南并不适用，最重要的知道什么时候不一致。当你没法判断该怎么作时，应该所参考下其余的例子。html

本文仅是一个 Python 编码风格的参考，并非一个规定，规定必需要这么去作。本文的目的应该是起一个指导做用，指导开发者去写更易读的代码。python

1、代码编排

主要是缩进与空行的排版：程序员

一、使用 4 个空格进行缩进（编辑器均可以完成此功能），不推荐使用制表符，更不能混合使用制表符和空格。
二、每行不超过 80 个字符，换行可使用反斜杠，最好使用括号（Python 会将圆括号, 中括号和花括号中的行隐式的链接起来）。
三、类和顶层函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其余地方尽可能不要再空行。

2、文档编排

主要是整个源码文件的布局：算法

一、模块内容的顺序：模块说明，模块文档字符串，导入语句，全局变量或者常量，其余定义。
二、模块导入部分顺序：标准库，第三方模块，自定义模块；各部分之间空一行。
三、不要在一个 import 语句中一次导入多个模块，好比 import os, sys 不推荐。
四、导入模块时应该使用合适的方式来避免命名冲突，例如在适当的时候才使用 from xx import xx，尽可能避免使用 from xx imoprt *。
五、在自已编写的模块中，若是须要使用 from xx import * 时，应该在导入语句后或者模块尾使用 __all__ 机制来限制导入规则。

3、语句编排

一、一般每一个语句应该独占一行。
二、不要在行尾加分号, 也不要用分号将多条语句放在同一行。
三、if/for/while 语句中，即便执行语句只有一句，也应尽可能另起一行。
四、不要在返回语句（return）或条件语句（if/for/while）中使用括号，除非是用于实现行链接。
五、对于 if 语句, 在没有 else 且语句比较短时，能够在一行完成（但不推荐），好比：if foo: bar(foo).
六、对于简单的类定义，也能够在一行完成（但不推荐），好比定义一个异常：class UnfoundError(Exception): pass.
七、函数和方法的括号中使用垂直隐式缩进或使用悬挂缩进。

# 一行写不下时，有括号来链接多行，后续行应该使用悬挂缩进
if (this_is_one_thing
        and that_is_another_thing):
    do_something()

# 函数调用参数较多时，对准左括号
f = foo(a, b,
        c, d)

# 不对准左括号，但加多一层缩进，以和后面内容区别
def long_function_name(
        a, b, c,
        d, e):
    print(a, b, c, d, e)

# 列表、元组、字典以及函数调用时可让右括号回退，这样更加美观
l = [
    1, 2, 3,
    4, 5, 6,
]

result = some_function(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

4、空格使用

整体原则，避免没必要要的空格。编程

一、各类右括号前不要加空格。
二、逗号、冒号、分号前不要加空格，但应该在它们后面加(除了在行尾)。
三、函数的左括号前不要加空格。如 Func(1)。
四、序列的左括号前不要加空格。如 list[2]。
五、操做符左右各加一个空格，不要为了对齐增长空格。
六、函数默认参数使用的赋值符左右省略空格。

良好的风格：session

spam(ham[1], {eggs: 2})

if x == 4:
    print x, y; x, y = y, x

f = foo(1, 2, 3)

ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
ham[lower:upper], ham[lower:upper:], ham[lower::step]
ham[lower+offset : upper+offset]
ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
ham[lower + offset : upper + offset]

x = 1
y = 2
long_variable = 3

def foo(a, b, c=0):
    return moo(m=a, n=b, o=c)

很差的风格：数据结构

spam( ham[ 1 ], { eggs: 2 } )

if x == 4 :
    print x , y ; x , y = y , x

f = foo (1, 2, 3)

ham[lower + offset:upper + offset]
ham[1: 9], ham[1 :9], ham[1:9 :3]
ham[lower : : upper]
ham[ : upper]

x             = 1
y             = 2
long_variable = 3

def foo(a, b, c = 0):
    return moo(m = a, n = b, o = c)

5、注释

整体原则，错误的注释不如没有注释。因此当一段代码发生变化时，第一件事就是要修改注释。注释尽可能使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。若是是短语，能够省略结束符。注释应该在 # 后加一个空格才开始写注释内容。编程语言

一、块注释，在一段代码前增长的注释。段落之间用只有 ‘#’ 的行间隔。好比：

# Description : Module config.
#
# Input : None
#
# Output : None

二、行注释，在一句代码后加注释。应该尽可能在语句后空两格后再开始注释。当有连续的行注释时，为了美观可让 ‘#’ 对齐。在语句比较长时，应该尽可能少使用行注释。好比：

person = {
    "name": "huoty",  # 姓名
    "age": 26,        # 年龄
    "stature": 169,   # 身高
    "weight": 60,     # 体重
}

print person  # 输出信息

三、对类或者函数的说明，尽可能不要在其定义的前一行或者后一行用块注释的形式来讲明，而应该使用文档字符串（docstring）
四、使用 TODO 注释来标记待完成的工做，团队协做中，必要的时候应该写上你的名字或者联系方式，好比：

# TODO(sudohuoty@gmail.com): Use a "*" here for string repetition.
# TODO(Huoty) Change this to use relations.

五、避免无谓的注释。你见过哪些奇趣的代码注释？

# 你可能会认为你读得懂如下的代码。可是你不会懂的，相信我吧。  

# 要是你尝试玩弄这段代码的话，你将会在无尽的通宵中不断地咒骂本身为何会认为本身聪明到能够优化这段代码。  
# so，如今请关闭这个文件去玩点别的吧。  

# 程序员1（于2010年6月7日）：在这个坑临时加入一些调料  
# 程序员2（于2011年5月22日）：临你个屁啊  
# 程序员3（于2012年7月23日）：楼上都是狗屎，鉴定完毕  
# 程序员4（于2013年8月2日）：fuck 楼上，三年了，这坑还在！！！  
# 程序员5（于2014年8月21日）：哈哈哈，这坑竟然坑了这么多人，幸亏我也不用填了，系统终止运行了，you're died

6、文档描述

一、尽可能为全部的共有模块、函数、类、方法写 docstring。
二、前三引号后不该该换行，应该紧接着在后面归纳性的说明模块、函数、类、方法的做用，而后再空一行进行详细的说明。后三引号应该单独占一行。好比：

"""Convert an API path to a filesystem path

If given, root will be prepended to the path.
root must be a filesystem path already.
"""

二、函数和方法的 docstring 层次顺序大体为概述、详细描述、参数、返回值、异常，通常不要求描述实现细节，除非其中涉及很是复杂的算法。大体的层次结构以下所示：

"""函数或方法的概述

详细的描述信息……
详细的描述信息……

参数说明
--------
    参数1：...
    参数2：...

返回值：
    ...

异常：
    异常1：...
    异常2：...
"""

一个参考示例：编辑器

"""Start a kernel for a session and return its kernel_id.                                                                                             

Parameters
----------
kernel_id : uuid
    The uuid to associate the new kernel with. If this
    is not None, this kernel will be persistent whenever it is
    requested.
path : API path
    The API path (unicode, '/' delimited) for the cwd.
    Will be transformed to an OS path relative to root_dir.
kernel_name : str
    The name identifying which kernel spec to launch. This is ignored if
    an existing kernel is returned, but it may be checked in the future.

Return a kernel id
"""

三、类的 docstring 的层次顺序大体为概述、详细描述、属性说明。若是类有公开属性值时，应该尽可能在 docstring 中进行说明。以下所示：

"""这里是类的概述。

详细的描述信息……
详细的描述信息……

属性(Attributes):
-----------------
    属性1: ...
    属性2: ...
"""

7、命名规范

一、模块命名尽可能短小，使用所有小写的方式，可使用下划线。
二、包命名尽可能短小，使用所有小写的方式，不可使用下划线。
三、类的命名使用驼峰命令的方式，即单词首字符大写，类名应该所有使用名词。
四、异常命令应该使用加 Error 后缀的方式，好比：HTTPError。
五、全局变量尽可能只在模块内有效，而且应该尽可能避免使用全局变量。
六、函数命名使用所有小写的方式，使用下划线分割单词，并采用动宾结构。
七、常量命名使用所有大写的方式，使用下划线分割单词。
八、类的属性（方法和变量）命名使用所有小写的方式，使用下划线分割单词。
九、变量、类属性等命令尽可能不要使用缩写形式，除了计数器和迭代器，尽可能不要使用单字符名称。
十、类的方法第一个参数必须是 self，而静态方法第一个参数必须是 cls。
十一、在模块中要表示私有变量或者函数时，能够在变量或者函数前加一个下划线 _foo, _show_msg 来进行访问控制。
十二、在 Python 中没有诸如 public、private、protected 等修饰符，而在类的定义中每每会有相似这样的需求，那么能够在属性或者方法前加一个下划线表示 protected，加两个下划线来表示 private。加两个下划线的变量或者方法无法直接访问。好比：类 Foo 中声明 __a, 则不能用 Foo.__a 的方式访问，但能够用 Foo._Foo__a 的方式访问。`

8、程序入口

Python 属于脚本语言，代码的运行是经过解释器对代码文件进行逐行解释执行来完成的。它不像其余编程语言那样有统一的入口程序，好比 Java 有 Main 方法，C/C++ 有 main 方法。Python 的代码文件除了能够被直接执行外，还能够做为模块被其余文件导入。全部的顶级代码在模块导入时都会被执行，当但愿模块被导入时，应该避免主程序被执行。这样就须要把主程序放到 if __name__ == '__main__' 代码块中，好比：ide

def main():
      ...

if __name__ == '__main__':
    main()

一个包除了可以被导入外，也能够经过 python -m package 的方式被直接执行，前提是包中须要有 __main__.py，这个文件能够说是包的程序入口，包中有了这个文件就能够用 Python 的 -m 参数来直接运行。

9、编码建议

一、尽量使用 'is' 和 'is not' 取代 '=='，好比 if x is not None 要优于 if x != None，另外用 if x 效率更高。

Note: 等于比较运算符（==）会调用左操做数的 __eq__ 函数，这个函数能够被其任意定义，而 is 操做只是作 id 比较，并不会被自定义。同时也能够发现 is 函数是要快于等于运算符的，由于不用查找和运行函数。

二、用 "is not" 代替 "not ... is"，前者的可读性更好。
三、使用基于类的异常，每一个模块或包都有本身的异常类，此异常类继承自 Exception。
四、异常中尽可能不要使用裸露的 except，except 后应该跟具体的 exceptions。
五、使用 startswith() 和 endswith() 代替切片进行序列前缀或后缀的检查。
六、使用 isinstance() 比较对象的类型，而不是 type()，好比：

# Yes:  
if isinstance(obj, int)

# No:  
if type(obj) is type(1)

七、判断序列是否为空时，不用使用 len() 函数，序列为空时其 bool 值为 False，好比：

# Yes:  
if not seq
if seq

# No:  
if len(seq)
if not len(seq)

八、字符串后面不要有大量拖尾空格。
九、使用 join 合并的字符串，字符串方法 join 能够合并 list、tuple、iterator 中的元素，效率比链接符 + 高。
十、使用 while 1 比 while True 更快。
十一、使用 ** 比 pow 快 10 倍以上。
十二、使用迭代器和生成器代替列表等数据结构效率更高，使用列表（字典）解析式和生成器表达式比用循环效率更高。
1三、避免在循环中用 + 或 += 来连续拼接字符串。由于字符串是不变型，这会毫无必要地创建不少临时对象，从而成为二次方级别的运算量而不是线性运算时间。
1四、多去了解标准库，标准库中用不少好用的功能，可以更优雅的解决问题，如 pkgutil.get_data()、operator.methodcaller() 等等。