PEP8的规范
- 缩进:每级缩进使用4个空格
- 行宽:每行不超过80个字符
- 空行:用空行将程序的不同部分分开
- 运算符:使用运算符时(比如=)两边各加一个空格
- 模块导入(有空行分割,各模块按首字母自上而下排序):
标准库
相关的第三方库
本地库 - 字符串:保证单双引号成对出现
- 注释(#):注释在前,代码在后,并和代码有同样的缩进
- 命名规则:
1.类:遵循驼峰命名,首字母大写(HelloWord)
2.全局变量:可在变量前加一个前置下划线,防止全局变量被其他模块导入(_name = ‘zhang’)
3.函数名:用小写,为增强可读性可以用下划线连接my_name
4.常量:可以全部使用大写或者用下划线连接的大写 - 其他:不要用“”进行布尔值True或False的比较
None的比较用is或is not 而不是用“”
函数的编码风格
- 编写函数时,给函数指定性的描述名称
- 为每个函数标注其功能和注释(注释在函数后,文档字符串的格式)
- 函数形参指定默认值时,等号两边不要有空格,关键字形参最好也遵循
- 若参数很多,可以回车换行,写参数
类和模块的编码风格
- import 语句放开头,除非使用注释来描述整个程序
- 类名采用驼峰命名(每个首字母大写,不适用下划线),实例和模块用小写,中间可以用下划线
- 在类中,一个空行分隔方法,在模块中,可使用两个空行分隔类