Python编码规范和Python风格规范

一、原因

　　1、长期的工作中，发现大多数程序员的代码可读性差

　　2、不同的程序员之间的协作很重要，代码可读性必须很好

　　3、版本升级时，要基于源码升级

　　4、不友好的代码会影响python的执行效率

二、基于的规范

　　1、PEP 8: Style Guide for Python Code---------Python的编码风格建议

　　2、Google Python Style Guide--------------Goole Python编码风格建议

三、Python语言规范

　　1. imports 仅仅用做包和模块的导入，包的导入每个尽量独占一行

　　2. packages 导入模块尽量使用模块的全路径

　　3. Exceptions 必须小心使用

　　4. Global variables 避免使用全局变量

　　5. Generator 

　　6. lambda 函数仅仅适用于一行代码能实现的简单函数

　　7. True or False 尽量使用[],'',{},0,None来隐式表示False

四、Python风格规范　

　　1、代码编排

　　　　1 缩进：4个空格实现缩进，尽量不使用Tab，禁止混用Tab和空格

　　　　2 行：每行最大长度不超过79，换行可以使用反斜杠(\)。最好使用圆括号将换行内容括起来，不建议使用“;”

　　　　3 空行：类和top-level函数定义之间空两行；类中的方法定义之间空一行；函数内逻辑无关段落之间空一行；其他地方尽量不要再空行。

　　　　4 空格：括号内的第一个位置，不要空格。紧靠右括号的位置也不要空格。冒号(:)、逗号(,)、分号(;)之前不要加空格。切片木有参数，不要加空格等

　　　　5 括号：对于单元素tuple一定要加,和括号

　　2、命名规范

　　　　module_name

　　　　package_name  

　　　　ClassName  

　　　　method_name  

　　　　ExceptionName

　　　　function_name

　　　　GLOBAL_CONSTANT_NAME

　　　　global_var_name

　　　　instance_var_name

　　　　function_parameter_name

　　　　local_var_name

　　3、注释规范

　　　　1.块注释，在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如：

　　　　# Description : Module config. 　　　　# 　　　　# Input : None 　　　　# 　　　　# Output : None

　　　　2. 行注释，在一句代码后加注释。比如：x = x + 1 # Increment x 但是这种方式尽量少使用。

　　　　3. 避免无谓的注释。

　　4、编程建议

　　　　1. 字符串拼接，尽量使用join。使用str的方法而不是内置方法。使用startswith或endswith拉检查前缀和后缀

　　　　2. 单例对象，尽量使用is 、is not，不要使用==

　　　　3. 使用is not而不是not is

　　　　4. 使用def来定义函数，而不是将匿名函数赋给某个变量

　　　　5. 尽量使代码整齐，简洁

　　　　6. 使用isinstance()来判断instance的类型