Python PEP8 编码规范

时间:2022-05-28 06:57:57

代码编排

  • 缩进。缩进4个空格,不能混合使用Tab和空格。
  • 每行最大长度79,文档字符串和注释行最大长度为72,换行可以使用反斜杠,最好使用圆括号。
  • 类和顶层函数定义之间空两行;类中的方法定义以单行分隔;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

模块导入

  • 导入尽量在文件的顶部,模块注释和文档字符串之后,模块全局变量和常量之前。导入顺序为:标准库à相关第三方库à本地库,各组的导入之间要有空行。推荐绝对路径导入。
  • 不建议在一行import多个库,比如import os,sys不推荐。
  • 如果采用from XX import XX引用库,可以省略‘module.’,应尽量避免通配符(from <moduel> import *)导入。
  • 各种右括号前不要加空格。
  • 逗号、冒号、分号前不要加空格。
  • 函数的左括号前不要加空格。如Func(1)。

空格的使用

  • 序列的左括号前不要加空格。如list[2]。
  • 操作符左右各加一个空格,不要为了对齐增加空格。
  • 函数默认参数使用的赋值符左右省略空格。
  • 不要将多句语句写在同一行,可以使用‘;’。
  • if/for/while语句中,即使执行语句只有一句,也必须另起一行。

注释

  • 当一段代码发生变化时,第一件事就是要修改注释!
  • 注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。
  • 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。
  • 行注释,在一句代码后加注释。比如:(但是这种方式尽量少使用)
  • 避免无谓的注释。

文档描述

  • 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
  • 如果docstring要换行。

命名规范

总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。

  • 尽量避免单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
  • 模块命名尽量短小,使用全部小写的方式,可以使用下划线。
  • 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
  • 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
  • 异常命名使用CapWords+Error后缀的方式。
  • 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是all机制;二是前缀一个下划线。
  • 函数命名使用全部小写的方式,可以使用下划线。
  • 常量命名使用全部大写的方式,可以使用下划线。
  • 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
  • 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
  • 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
  • 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
  • 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。