PEP8代码要求规范:
-
缩进:使用4个空格缩进,而不是制表符,以保证缩进的一致性。
-
行长限制:每行不超过79个字符。
-
空行:需要用两个空行分隔函数和类定义,而函数内可以利用一个空行分隔不同的逻辑代码块。
-
函数及注释:在定义函数和类的文档字符串之前留一个空行,注释句子之间使用一个空格分隔。
-
命名规范:遵循下划线命名法,即单词全小写,以下划线分隔。
-
代码块:if、while、for、try等关键字之后必须跟着一个空格,并保持一致。
-
导入顺序及格式:按照从官方库到第三方库再到本地库的顺序编写,组内的库名称按字母顺序排列。
-
字符串表达式:采用单引号而非双引号,除非字符串中本身包含单引号,应考虑使用双引号。
-
异常的捕获:在定义时应该先加一个空格,而不是连着中括号写。
-
类的命名:采用骆驼命名法(CamelCase)风格,其中每个单词的首字母都大写,实例方法第一个参数为(self),类方法第一个参数为(cls)。
-
上下文管理器:当一个类可以作为上下文管理器时,应该明确定义__enter__()和__exit__()方法。
-
每个文件应该清晰明确地声明版权和许可证。
-
变量命名:使用小写字母组成,单词之间以下划线分隔。
-
常量命名:使用大写字母组成,单词之间以下划线分隔。
-
函数定义:函数名应紧接左括号之后,而参数列表中则应该使用逗号分隔每个参数。
-
模块导入:应该在文件头部进行,放在模块注释和文档字符串之后,而任何先于这两者的行则应该是标准的Python注释。
-
换行符:Python默认使用\r\n,UNIX/Linux用/n,Mac OS X则用\r。
-
注释排版:在分隔符号后,特别是在函数签名中,逗号之前,应该使用空格。
-
函数上下文:文档字符串,函数输入的解释,逻辑处理流程,最后才是函数本身的逻辑。