模块命名尽量短小，使用全部小写的方式，可以使用下划线。

包命名尽量短小，使用全部小写的方式，不可以使用下划线。

类的命名使用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。

缩进。4个空格的缩进（编辑器都可以完成此功能），不使用Tap，更不能混合使用Tap和空格。

每行最大长度79，换行可以使用反斜杠，最好使用圆括号。换行点要在操作符的后边敲回车。

类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行

空格使用

总体原则，避免不必要的空格。

各种右括号前不要加空格。

逗号、冒号、分号前不要加空格。

函数的左括号前不要加空格。如Func(1)。

序列的左括号前不要加空格。如list[2]。

操作符左右各加一个空格，不要为了对齐增加空格。

函数默认参数使用的赋值符左右省略空格。

不要将多句语句写在同一行，尽管使用‘;’允许。

if/for/while语句中，即使执行语句只有一句，也必须另起一行。

Reference

[1] PEP8 Python 编码规范整理

发布时间: 2018年01月09日 - 14:39:19

最后更新: 2020年05月16日 - 01:48:54

原始链接: http://zhangzhk.com/2018/01/09/python-pep8-program-standard/

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。