PEP8规范

Posted 2022-05-21 z-x-y

 

缩进

4个空格缩进

 

行长

建议每行不超过80个字符，每行只能容纳79个字符

注释的行长不超过72个字符

 

空行

如5行创建列表的代码和三行处理列表的代码，用一个空行把两部分隔开，不应该用三四行空行隔开

空行不会影响代码的运行，但会影响代码的可读性

 

条件测试的格式设置方面，在如==、<=、>=等比较运算符两边各添加一个空格，例如if age < 4比if age<4好

 

函数

编写函数时，要给函数指定描述性名称，只能用小写字母和下划线，给模块命名也要遵守上述约定

每个函数要包含简要的阐述其功能的注释，注释紧跟函数定义后面，采用文档字符串的格式，文档良好的函数让其他程序员只要阅读文档字符串中的描述就能够使用它

只要知道函数的名称，需要的实参以及返回值的类型，就能在自己的程序中使用它

给形参指定默认值时，等号两边不要有空格，关键字实参也一样

如果形参很多超过了79字符，可以在函数定义中输入左括号加上回车键，在下一行按两下tab,将形参列表和只缩进一层的函数体区分开来，

大多数编辑器都会自动对齐后序参数列表行，缩进程度与你给第一个参数列表行指定的缩进程度相同

如果程序包含多个函数，可以使用两个空行把相邻的函数分开，这样更容易知道前一个函数在什么地方结束，后一个函数在什么地方开始

 

所有的import语句都应该放在文件的开头，除非文件开头有注释

 

类

 类名应该使用驼峰命名法，即类名中的每个首字母都要大写，而不使用下划线，实例名和模块名都使用小写格式，并在单词之间加上下划线

每个类都应该在类定义后包含一个文档字符串，简要的描述类的功能，并遵循编写函数的文档字符串时采用的格式约定

每个模块也都应包含一个文档字符串，对其中的类可用于做什么进行描述

在类中，用一个空行来分隔方法

在模块中，用两个空行来分隔类

需要同时导入标准库中的模块和你编写的模块时，先编写导入标准库模块中的import语句，再添加一个空行，然后编写导入你自己编写的模块的import语句，这样在包含多条import语句的程序中，这种做法让人更容易明白程序使用的各个模块都来自何方