python代码编写规范

  • 严格使用缩进来体现代码的逻辑从属关系
  • 每个import语句只能导入一个模块
  • 最好在每个类、函数定义、一段完整的功能代码之后增加一个空行
  • 尽量不要写过长的语句。如果语句过长可以使用续航符"\"

一、缩进:
每级缩进用4个空格。如果缩进不正确或缩进格式不统一,一般错误信息会明确告诉你,但有时也会出现invalid syntax报错。
所谓缩进不正确,python的缩进是四个空格或一个TAB,如果缩进三个空格,一定报错。
更不能混合使用Tap和空格。

二、最大行宽:

每行最大行宽不超过 79 个字符。一般续行可使用反斜杠,括号内续行不需要使用反斜杠

三、空行:

两行空行用于分割顶层函数和类的定义
单个空行用于分割类定义中的方法

四、模块导入:

导入的每个模块应该单独成行;
导入顺序如下: (各模块类型导入之间要有空行分割,各组里面的模块的顺序按模块首字母自上而下升序排列)
标准库
相关的第三方库
本地库

如:

# 按模块首字母排序导入, 依此递推

import active
import adidas
import create

五、字符串

单引号和双引号作用是一样的,但必须保证成对存在,不能夹杂使用. (建议句子使用双引号, 单词使用单引号.)

如:# 单引号和双引号效果一样
name = 'JmilkFan'
name = "Hey Guys!"

六、命名规则
包和模块名:
包和模块名应该简短,全部用小写字母, 多字母之间可以使用单下划线连接。
类名:
遵循驼峰命名。MyClass()

包和模块名:
包和模块名应该简短,全部用小写字母, 多字母之间可以使用单下划线连接。
函数名: 函数名应该为全部小写的凹驼峰规则。vcenter_connection
常量名:常量全部使用大写字母的凹驼峰规则来表示, 通常在模块顶格定义。MAX_OVERFLOW

七、空格的使用

总体原则,避免不必要的空格。 
1 各种右括号前不要加空格。 
2 逗号、冒号、分号前不要加空格。 
3 函数的左括号前不要加空格。如Func(1)。 
4 序列的左括号前不要加空格。如list[2]。 
5 操作符左右各加一个空格,不要为了对齐增加空格。 
6 函数默认参数使用的赋值符左右省略空格。 
7 不要将多句语句写在同一行,尽管使用‘;’允许。 
8 if/for/while语句中,即使执行语句只有一句,也必须另起一行

参考文献:

1.https://www.jb51.net/article/103944.htm

2.https://legacy.python.org/dev/peps/pep-0008/

posted @ 2020-09-07 21:33  shijin_lee  阅读(324)  评论(0编辑  收藏  举报