Python PEP8规范笔记

PEP8是我在阅读python相关的博客最常见的一个词语,因为它是python的一个普遍接受的编码规范,今天在仔细阅读PEP8文档的基础上,写下这篇笔记。

PEP是什么意思?

PEP是Python Enhancement Proposal的缩写,也就是Python增强提议的意思,这里汇聚了很多关于增强Python的文档和规范,这里的PEP8就是编号为8的规范。

函数多参数格式

  1. 左括号后回车,参数另起一行(可选)
  2. 多行参数要与函数内部语句在缩进上区别开来,通常比函数内语句多一级缩进。
  3. 右括号可以单独放在一行
  4. 以上规则,可类比于list,tuple字面定义

推荐4个空格缩进,优先使用空格,一行不超过79个字符,这类简单的就不说了。

隔开

全局的类和函数,用2个空行隔开;内部函数用一个空行隔开。

import

不推荐一次import多个模块,但可以from xxx import a, b。

逗号和双目运算符分隔

[逗号,冒号]后面空格,双目运算符两边空格(如果涉及到运算符优先级,可以取消空格以保持可读性)。

命名规则

有人说,写程序最烦恼的就是给变量命名,有的时候自己会词库穷竭,有的时候为了琢磨命名规范而小心谨慎。可想而知,命名是一件对于软件工程师来说,多么重要的事情。

有些在屏幕上容易混淆的字符,比如l,O等,尽量避免使用。

包名和模块名一律小写。

类名使用驼峰命名法。

__all__的使用避免全局命名空间污染。

Table of Contents