python开发规范

python开发规范

• 代码编排
• 命名规范
• 编码建议
• 代码检查工具

代码编排

1. 程序块要采用缩进风格编写，缩进的空格数为4 个，禁止使用tab
   和空格混合使用。 (如果使用tab 缩进，必须设置一个tab 为4 个空格)

2. 单行字符数限制不超过80 个，较长的语句要分成多行书写。

3. 类和函数定义之间分隔行。

   1. 类和top-level 函数定义之间空俩行;
   2. 类中的方法定义之间空一行;
   3. 函数内逻辑无关段落之间空一行;

4. 方法参数在定义和传入时，多个参数逗号后边必须加空格。

5. 任何二元，三元运算符的左右俩边都需要加一个空格。

6. 紧挨着圆括号，方括号和花括号不要出现空格

命名规范

1. 代码中的命名严禁使用使用拼音和英文的混合使用。

2. 类名使用UpperCamelCase 风格，必须遵从驼峰形式。

3. 函数名应该为小写，必要时可用下划线分隔单词以增加可读性。

4. 如果函数的参数名与保留关键字冲突，通常在参数名后加一个下
   划线。

5. 方法名和实例变量同函数命名规则，非公开方法和实例变量增加
   一个前置下划线。

6. 常量通常在模块级定义，由大写字母用下划线分隔组成

编码建议

1. 遵循开放封闭原则，将程序解耦化，使职责进行有效的分离，各司其
   职。

2. 使用startswith 或endswith 检查前缀和后缀。

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

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

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

6. for循环不建议超过三层

7. 尽量使用with语句、便于资源的自动释放

8. 异常中try的代码尽可能少

代码检查工具

autopep8

pylint

pychecker