python编程的PEP8规范小结

PEP8原文连接:https://legacy.python.org/dev/peps/pep-0008/
续更

介绍

代码规范原则是提高代码的可读性，便于自己和他人去完善和修改代码。
所以要考虑实际情况来选择性使用代码规范。

代码排版

缩进

1. 每行缩进四个空格（不能混用TAB）
2. 一行最大为79个字符，文档或注释最多72个字符
3. 空行
   类和顶层函数之间有两个空行
   类中的方法之间有一个空行
   函数中可以使用空行来隔开不同的逻辑锻落
4. 源文件编码在python2中使用ASCII格式，python3中使用UTF-8
5. 导入要放在文件的顶部

字符串引号

虽然python中单引号和双引号都可用于字符串，但是最好使用一种方式，不要变来变去。

关于空格

尽量避免没必要的空格

1. 紧跟各种括号之后的空格
2. 紧跟着逗号，分号，冒号之前的空格
3. 切片中，前后空格数量保持一致

ham[1:9], ham[1:9:3], ham[:9:3], ham[1::3], ham[1:9:]
ham[: upper_fn(x) : step_fn(x)], ham[:: step_fn(x)]
ham[lower + offset : upper + offset]

4. 紧跟函数参数的左括号之前
5. 紧跟索引或切片左括号之前
6. 赋值运算中的多个附加括号

x = 1
long_variable = 3
x             = 1
long_variable = 3

注释

1. 注释最好用英语，便于其他人阅读。
2. 注释在# 之后空一格开始书写。
3. 注释最好是完整的句子，以句号结尾。
4. 少用行内注释，除非必要。

命名

1. 整体代码中保持一致的命名风格。
2. 不要使用 “l”（小写L）， “I”（大写I），“O”（大写O）等做打个变量名，和0，1完全区分不了。
3. 类名首字母大写；函数名小写，可用下划线隔开。
4. 厂里用大写字母加下划线。

其他

1. 对于布尔型的比较判断，使用“is”效率高于“==”。（python中None是固定内存id）
2. 字符串拼接时，.join()优于 +
3. 字符串比较使用“equals()”，值比较使用“==”。