PEP8是针对python代码格式而编订的风格指南,采用一致的编码风格可以令代码更加易懂易读!方便更多的人协同工作。
空白
python中空白会影响代码的含义及其代码的清晰程度
- 使用space(空格)进行缩进,不采用tab
- 每一层缩进都用4个空格表示
- 每行字符数不超过79
- 占据多行的长表达式,每一层的缩进都应该在上一层基础上再加4个空格
- 文件中函数和类之间用两个空行隔开
- 同一个类中,各个方法之间应该用一个空行隔开
- 为变量赋值的时候,赋值符号两侧应该各自加上一个空格
命名
采用不同的命名风格来编写python代码,以便在阅读源码时可以根据名称看出它们在python语言语言中代表的角色
- 函数,变量,属性使用小写字母拼写,各单词之间采用下划线相连,如extrct_title ,extrct_content.
- 受保护的实例属性,以单个下划线开头,如_set_content
- 私有的实例属性,以两个下划线开头,如__double_set_title
- 类与异常,以每个单词首字母大写,如CapWord
- 模块级别的常量,全部大写,单词间采用下划线相连,如ALL_SYSTEM_ENCODE
-类方法中的首个参数,命名为cls,以表示该类自身
表达式与语句
- python文件中的import语句应该放在文件开头
- import语句应该分为三部分,标准库模块,第三方模块,自用模块,每一部分的import语句应该按模块的字母顺序排列
- 引入模块,应该采用绝对名称:from bar import foo ,而不是import foo
- 不编写单行的if ,for, while,except复合语句
指南原文:https://www.python.org/dev/peps/pep-0008/