PEP8 Python

描绘在前头

对代码而言,相比叫写,它还多是朗诵之。

pep8

如出一辙、代码编排

  1. 缩进,4独空格的缩进,编辑器都可以好这个作用;
  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. 免无谓的注解
  2. 行注释,在同等句代码后加注。

    print 'hello'  # 行注释
    
  3. 片注释,在一如既往截代码前增加的诠释。在‘#’后加同空格。段落中为单独发‘#’的实行间隔。

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

五、文档描述

  1. 也具有的共有模块、函数、类、方法勾勒docstrings;非共有的远非必要,但是好形容注释(在def的下一行)
  2. 单行注释请参考如下方式

    def func():
        """Return a and b. tuple"""
        a = 1
        b = 2
        return a, b
    

六、命名规范

  1. 尽量避免动用小写字母‘l’,大写字母‘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,避免歧义。如果子类也让Foo,那即便无法了。
  13. 好像的法第一独参数必须是self,而静态方法第一个参数必须是cls。

编程建议

  1. 编码中考虑到其它python实现的频率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中倒不行小,所以理应使用.join()的道。
  2. 尽心尽力采取‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。
  3. 采取基于类的可怜,每个模块或包都生投机的很类,此万分类继承自Exception。
  4. 老大中毫无采取裸露的except,except后及现实的exceptions。

    try:
        ...
    except Exception as ex:
        raise ex
    
  5. 不行中try的代码尽可能少。

  6. 以startswith() and endswith()代替切片进行排前缀或后缀的自我批评。

    str = "test123abc"
    if str.startwith("test") and str.endwith("abc"):
        print 'yes'
    else:
        print 'no'
    
    # 不要使用下面的方式
    if str[:4] == "test" and str[-3:] == 'abc':
        print 'yes'
    else:
        print 'no'
    
  7. 动isinstance()比较对象的型。比如:

    test = 'abc123'
    
    print isinstance(test, int)  # False
    print isinstance(test, str)  # True