python编程规范-最佳实践

python编程规范

变量命名

全部小写,由下划线连接各个单词,比如home_addr

注意

1)不论是成员变量还是全局变量,均不使用m或g为前缀

2)变量名不应该带有类型信息,因为python是动态语言类,比如name_list,stu_info_dict等都不可以

常量命名

所有字母大写,由下划线连接各个单词,比如PI = 3.14

异常命名

以"Error"作为后缀

缩写说明

尽量使用全屏写的单词,常用的缩写,如XML, ID

function > fn

text > txt

object > obj

count > cnt

number > num

前后缀下划线

前缀下划线表示非公有

后缀下划线为了避免关键字冲突

两个前缀下划线,当命名一个类属性,避免引起冲突使用

两个前缀下划线两个后缀下划线,python内置的属性或方法,比如__init__,__new__等,不用这种方式命名,只是使用它们

避免使用下划线作为变量名的首字符

函数命名

全部为小写,由下划线连接各个单词,以增加可读性,比如read_json_file

类内的方法的参数

总使用self作为实例方法的第一个参数,总使用cls作为类方法的第一个参数

如果一个函数的参数名与保留字的关键字相同,通常在其名称后加一个后缀下划线

模块名

全部小写,由下划线连接各个单词

包名

全部小写,由下划线连接各个单词

类名

首字母大写,比如Player

全局变量

全部大写,由下划线连接各个单词

实例变量

以下划线开头,全部小写,由下划线连接各个单词

参考资料:python 中变量的命名规范

原文地址:https://www.cnblogs.com/marton/p/10778775.html