PEP 8 风格指南
空格的使用
- 使用空格来表示缩进而不要用制表符(Tab) 但是pycharm中会自动将Tab转换成四个空格
- 和语法想法的每一层缩进都用4个空格来表示
- 每行的字符都不超过79个字符。
- 函数和类的定义,代码前后都要用两个空行进行分隔。
- 在同一个类中,各个方法之间应用一个空行进行分隔。
- 二元运算符的左右两侧应该保留一个空格,而且只要一个空格就好。
标识符命名
- 变量,函数和属性应该使用小写字母来拼写,如果有多个单词就使用下划线来进行连接。
- 类中受保护的实例属性,应该以一个下划线开头。
- 类中私有的实例属性,应该以两个下划线开头。
- 类和异常的命名,应该每个单词首字母大写。
- 模块级别的常量,应该采用全大写字母,如果有多个单词就用下划线进行连接。
- 类的实例方法,应该把第一个参数命名为self以表示对象自身。
- 类的类方法,应该把第一个参数命名为cls以表示该类自身。