Python命名规范

来源:互联网 发布:客户资料搜集软件 编辑:程序博客网 时间:2024/05/16 03:10

文件名、包名、模块名、局部变量名、函数&方法名 
  全小写+下划线式驼峰 
  example:this_is_var

 
  首字母大写式驼峰。如ClassName()。 
  内部类可以使用额外的前导下划线。 
   
函数和方法的参数 
  类实例方法第一个参数使用self, 类方法第一个参数使用cls 
  如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。

全局变量 
  对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。 
  全大写+下划线式驼峰 
  example:GLOBAL_VAR 
  注意:应避免使用全局变量

变量 
  变量名全部小写,由下划线连接各个单词。如color = WHITE,this_is_a_variable = 1 
注意: 
  1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。 
  2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。 
  3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。因为python在解释的时候才确定类型。

常量 
  常量名所有字母大写,由下划线连接各个单词如MAX_OVERFLOW,TOTAL。

异常 
  因为异常也是一个类,所以遵守类的命名规则。此外,如果异常实际上指代一个错误的话,应该使用“Error”做后缀。

缩写 
命名应当尽量使用全拼写的单词,缩写的情况有如下两种: 
  1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。 
  2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。 
例如: 
  function 缩写为 fn 
  text 缩写为 txt 
  object 缩写为 obj 
  count 缩写为 cnt 
  number 缩写为 num,等。

关于下划线 
  一个前导下划线:表示私有。 
  一个后缀下划线:避免关键字冲突。 
  以单下划线开头,是弱内部使用标识,from M import * 时,将不会导入该对象(python 一切皆对象)。 
   
  两个前导下划线:当命名一个类属性引起名称冲突时使用。 
  两个前导和后缀下划线:有特殊用途的对象或者属性,例如init或者file。绝对不要创造这样的名字,而只是使用它们。 
  以双下划线开头的变量名,主要用于类内部标识类私有,不能直接访问。 
  双下划线开头且双下划线截尾的命名方法尽量不要用,这是标识

特定命名方式 
  主要是指 xxx 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如

class Base(object):  def __init__(self, id, parent = None):    self.__id__ = id    self.__parent__ = parent      def __message__(self, msgid):