1.命名规范
模块名
小写字母,单词之间用_分割。
common_method.py
包名
小写字母,单词之间用_分割。
类名
单词首字母大写。
StudentManager
类变量
大写字母,单词之间用_分割。
CALC_PARAMS
常量
大写字母,单词之间用_分割。
SCORE_BASE
普通变量
小写字母,单词之间用_分割。
student_name
实例变量
以_开头,其他和普通变量一样。
_student_age
私有实例变量(外部访问会报错)
以__开头(2个下划线),其他和普通变量一样。
__student_score
普通函数
和普通变量一样,小写字母,单词之间用_分割。
get_student_name()
私有函数(外部访问会报错)
以__开头(2个下划线),其他和普通函数一样。
__get_student_name()
专有变量
__开头,__结尾,一般为python的自有变量,不要以这种方式命名。
__doc__
异常
异常命名规范和类的一样,若异常本身是一个错误,名称带上“Error”后缀。
2.其他规范
①使用4个空格的缩进,不使用Tap,更不要混合使用空格和Tap。
②类和top-level函数定义之间空两行,类中方法空一行。
③函数内逻辑无关片段空一行。
④导入模块时,按照标准库模块、第三方模块、应用程序自定义模块的顺序导入,且相互之间空一行。
⑤不要在一句import中多个库。
⑥不要将多句语句写在同一行,尽管使用‘;’允许。
⑦块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:
# Description : Module config.
#
# Input : None
#
# Output : None
⑧为所有的共有模块、函数、类、方法写文档字符串。文档字符串要换行使用下面的格式。
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
⑨尽可能使用‘is’‘is not’取代‘==’。
⑩异常中不要使用裸露的except,except后跟具体的exceptions。
⑪使用isinstance()比较对象的类型。