Python 之禅：PEP8编码规范

铁棍阿童木

偶然看见，果断转载。牢记PEP8规范写出优雅代码。省得用sublime Text 3时用插件，然后满屏白框。

一  代码编排

    1. 缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tab，更不能混合使用Tab和空格。
    2. 每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。
    3. 类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

二  文档编排

    1. 模块内容的顺序：模块说明和docstring — import — globals&constants — 其他定义。其中import部分又按标准、三方和自己编写顺序依次排放，之间空一行。
    2. 不要在一句import中导入多个库，比如 import os，sys（不推荐）。
    3. 如果采用 from XX import XX 引入库，可以省略“module”，都是可能出现命名冲突，这时就采用 import XX。

三  空格的使用

    1. 各种右括号前不要加空格。
    2. 逗号、冒号、分号前不要加空格。
    3. 函数的左括号前不要加空格。如 Func(1)。
    4. 序列的左括号前不要加空格。如 list[2]。
    5. 操作符左右各加一个空格，不要为了对齐增加空格。
    6. 函数默认参数使用的赋值符左右省略空格。
    7. 不要将多句语句写在同一行，尽管使用 ";"允许。
    8. if / for / while 语句中，即使执行语句只有一句，也必须另起一行。

四  注释

总体原则，错误的注释不如没有注释。所以当一段代码发生变化时，第一件事情就是要修改注释！
注释必须使用英文，最好是完整的句子，首字母大写，句后要有结束符，结束符后跟两个空格，开始下一句。如果是短语，可以省略结束符。
    1. 块注释，在一段代码前增加的注释。在“#”后加一空格。段落之间以只有“#”的行间隔。比如：
        # Description ： Module config .
        #
        # Input : None

    2. 行注释，在一句代码后加注释。比如： x = x + 1 # Increment x（这种方式尽量少用）
    3. 避免无谓的注释。

五  文档描述

    1. 为所有的共有模块、函数、类、方法写 docstrings；非共有的没有必要，但是可以写注释（在 def 的下一行）。
    2. 如果 docstrings 要换行，参考如下例子，详见PEP 257
        """Return a foobang

        Optional plotz says to frobnicate the bizbaz first .

        """

六  命名规范

总体原则，新编代码必须按下面命名风格进行，现有库的编码尽量保持风格。
    1. 尽量单独使用小写字母 "I"，大写字母"O"等容易混淆的字母。
    2. 模块名尽量短小，使用全部小写的方式，可以使用下划线。
    3. 包命名尽量短小，使用全部小写的方式，不可以使用下划线。
    4. 类的命名使用 CapWords 的方式，模块内部使用的类采用 _CapWords 的方式。
    5. 异常命名使用 CapWords + Error 后缀的方式。
    6. 全局变量只在模块内有效，类似 C 语言中的 static。实现方式有两种，一种是 __all__机制；二是前缀一个下划线。
    7. 函数命名使用全部小写的方式，可以使用下划线。
    8. 常量命名使用全部大写的方式，可以使用下划线。
    9. 类的属性（方法和变量）命名使用全部小写的方式，可以使用下划线。
  10. 类的属性有3种作用域：public \ non-public和subclass API，可以理解成 C++ 中的public\private\protected，non-public属性前，前缀一条下划线。
  11. 类的属性若与关键字名字冲突，后缀一下划线，尽量不要使用缩略等其他方式。
  12. 为避免与子类属性命名冲突，在类的一些属性前，前缀两条下划线。比如：类 Foo 中声明 __a，访问时，只能通过 Foo._Foo__a。
  13. 类的方法第一个参数必须是 self ，而静态方法第一个参数必须是 cls

七  编码建议

    1. 编码中考虑到其他 python 实现的效率问题，比如运算符 "+" 在CPython中效率很高，但在 Jpython 中却非常低，所以应该采用 .join()的方式。
    2. 尽可能使用 "is" 和 "is not" 取代 "=="，比如 if x is not None 要优于 if x
    3. 使用基于类的异常，每个模块或包都有自己的异常类，此异常类继承自 Exception
    4. 异常中不要使用裸露的 except ，except 后要跟具体的 exceptions
    5. 异常中 try 代码尽可能少。比如：
        try:
            value = collection[key]
        except KeyError:
            return Key_not_found(key)
        else:
            return handle_value(value)

    6. 使用 startswith() 和 endswith()代替切片进行序列前缀或后缀的检查。比如
        if foo.startswith("bar"):   要优于
        if foo[:3] == "bar":

    7. 使用isinstance()比较对象的类型。比如
        if isinstance(objecet,int):    要优于
        if type(object) is type(1)

    8. 判断序列空或不空，有如下规则
        if not seq:
        if seq:
        要优于
        if len(seq):
        if not len(seq)

    9. 字符串不要以空格收尾
  10. 二进制数据判断使用 if boolvalue 的方式。

短发

Unicorn#

为啥不用tab而用空格

knightalive

对TAB和空格的关系还是有点混乱，不过刚刚开始接触PYTHON，且行且阅读，过段时间再返回来看看吧

诸己h

收藏啦

loiskk

Unicorn# 发表于 2019-10-24 21:47
为啥不用tab而用空格

我也疑惑这个，刚搜到的一个解释：

混用Tab和空格是指相邻的两句的缩进需要统一使用tab或统一使用空格，不能混用

python中不提倡使用tab缩进
不同编辑器对于TAB的解释是不同的，有的编辑器tab是4个字符宽，有的8个字符宽。
如果有的地方用TAB，有的地方用空格，在不同的地方，原本对齐的代码就可能会不对齐。

空格永远都是一样的。
对于一些细致排版缩进来说（比如说想把每一行的注释都对齐），用空格也更加精确。

兜倪纨

学到老

wosay

明白了TAB 和空格的区别，谢谢

kingayu

收藏了

R0SIE

谢谢转载与分享，学习就应当脚踏实地。

鱼cpython学习者

为什么注释必须使用英文？