【转】Python Enhancement Proposal #8【PEP8】
pep8 通常会听别人提到,但是具体的指什么内容呢,简单介绍下。
《Python Enhancement Proposal #8》 (8号python增强提案)又叫PEP8,他针对的python代码格式而编订的风格指南。
空白
- 使用space来表示缩进,而不要用tab
- 和语法相关的每一层缩进用4个空格来表示
- 每行的字符数不应超过79
- 文件中函数与类之间应该用两个空行隔开
- 在同一个类中,各方法之间应用一个空行隔开
- 在使用下表来获取列表元素、调用函数或给关键字参数赋值的时候,不要在两旁添加空格
- 为变量赋值的时候,赋值符号的左侧和右侧应该各自写上一个空格,而且只要一个就好
命名
- 函数、变量及属性应该用小写字母来拼写,各单词之间以下划线相连
- 类与异常,应该以每个单词首字母均大写的格式来命名
- 类中的实例方法,应该把首个参数命名为self,以表示该对象的自身
- 类方法的首个参数,应该命名为cls,以表示该类自身
表达式和语句
- 采用内联式的否定词,而不要把否定词放在整个表达式的前面,例如,应该写if a is not b 而不是if not a is b
- 不要通过检测长度的办法(如 if len(somelist) == 0)来判断somelist是否为空值,而是应该采用 if not somelist 这种写法来判断,他会假定:空值将自动评估为False
- 不要编写单行的if语句,for循环,while循环及except复合语句,而是应该把这些语句分成多行来书写,以示清晰
- import语句应在总放在文件开头
- 文件中的哪些import语句应该按照顺序划分为三个部分,分别表示标准库模块,第三方模块以及自用模块
要点
- 当编写Python代码时,总应该遵循PEP8风格指南
- 与广大Python开发者采用同一套代码风格,可以使项目更利于多人协作
- 采用一直的风格来编写代码,可以领后续的修改工作变得更为容易