Python 中特殊变量/方法命名规则说明(特别是私有变量)及使用实例

以下内容使用Markdown编写.包括python变量命名规则,特别是私有变量的使用.

问题引入

    在编写orm时候,看到一些参考资料上对变量的命名有些特殊,有的前面有一个下划线,有时会有两个,很是困惑;本以为变量的命名只要是前面是下划线或字母即可,为了弄清这个问题,产生这个文章 .

命名规范

• 常规变量命名

   这里可以[参考资料](4)
  

• 特殊变量命名

  1、 _xx 以单下划线开头的表示的是protected类型的变量。即保护类型只能允许其本身与子类进行访问。若内部变量标示，如： 当使用“from M import”时，不会将以一个下划线开头的对象引入 。

  2、 __xx 双下划线的表示的是私有类型的变量。只能允许这个类本身进行访问了，连子类也不可以用于命名一个类属性（类变量），调用时名字被改变（在类FooBar内部，__boo变成_FooBar__boo,如self._FooBar__boo）

  3、 xx__定义的是特列方法。用户控制的命名空间内的变量或是属性，如__init , import__或是__file 。只有当文档有说明时使用，不要自己定义这类变量。 （就是说这些是python内部定义的变量名）

在这里强调说一下私有变量,python默认的成员函数和成员变量都是公开的,没有像其他类似语言的public,private等关键字修饰.但是可以在变量前面加上两个下划线"",这样的话函数或变量就变成私有的.这是python的私有变量轧压(这个翻译好拗口),英文是(private name mangling.) **情况就是当变量被标记为私有后,在变量的前端插入类名,再类名前添加一个下划线"",即形成了_ClassName__变量名.**

---

实例演示

例子演示

class A(object):

    def __init__(self):
        self.__private()
        self.public()

    def __private(self):
        print 'A.__private()'

    def public(self):
        print 'A.public()'

class B(A):
    def __private(self):
        print 'B.__private()'

    def public(self):
        print 'B.public()'
        
a = A() # 实例化对象a
b = B() # 实例化对象b
print a.__private() # 这里会报错,说 AttributeError: 'a' object has no attribute '__private'
print b.__private() # 这里会报错,说 AttributeError: 'B' object has no attribute '__private'
print '======'
print b._A__private() # 因为私有变量轧压机制,__private方法变成_A__private()
print dir(b) # 通过自省方法dir(),查看b所具有的属性
print '======'

# --->
A.__private()
B.public()
======
A.__private()
======
['_A__private', '_B__private', '__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', '_test', 'get_pri', 'public']
        

类A和B都有一个私有方法,命名为_ _private() ,因为B是继承于A,在用B实例化对象b时,程序需要先执行A的_ _ init_ _ (),执行到_ _ private时, 是A的_ _private();到public()方法时候,B里面重写了,因此调用的是B的public()方法;

当 执行到print a.__private( )时候,会出现找不到属性错误,自己本身调用私有方法也会出错,因为私有变量轧压机制,_ _private方法变成_A _ _ private(),所以就找不到这个方法.

通过执行dir( )方法时候,可以查看到实例b所具有的属性,可以发现多出了`'_A_ _private'`,`'_B__private'`

私有变量/方法的用途

私有变量/方法在自身类中不能直接调用,这样的变量用途在哪呢?以下给出一个用途:制作端口,控制变量引用.

class A(object):

    def __init__(self):
        self.__private()
        self.public()

    def __private(self):
        print 'A.__private()'

    def public(self):
        print 'A.public()'

    def get_pri(self): # 获取私有方法
        return self.__private()

a= A( )
a.get_pri()


#---->
A.__private()

以上例子给出一个用途,在类中获取或设置私有变量,做成端口函数,进行调用,从而引用或修改私有变量.

知识点延伸

在理解私有变量 时候,其实还需要理解一下_ _init_ _( ),__new__(),__call__() ,这三者的执行顺序; new 用于创建对象，而 init 是在创建完成之后初始化对象状态,__call __相当于把这个类型的对象当作函数来使用，相当于重载了括号运算符(可参考这里).

总结

• 定义私有变量,只需在变量前加上两个下划线'_';
• 类中的私有变量通过转换,变成_ClassName__variableName;
• 通过在类中定义接口,实现私有变量的读取和修改;
• 类的生成__new__() --> __init__() ,之后可了解单例模式实现

---

参考资料

[1].init()注意事项
http://www.cnblogs.com/zyxstar2003/archive/2011/03/21/1989954.html
[2].理解python命名规则
http://blog.csdn.net/gzlaiyonghao/article/details/1734990
[3].python私有属性和方法
http://www.cnpythoner.com/post/295.html
[4].python 命名规范
http://www.codesky.net/article/201202/165214.html