Python带_的变量或函数命名

Posted 2020-10-16 再见紫罗兰

python中的标识符可以包含数字、字母和_，但必须以字母或者_开头，其中以_开头的命名一般具有特殊的意义。

前后均带有双下划线__的命名

一般用于特殊方法的命名，用来实现对象的一些行为或者功能，比如__new__()方法用来创建实例，__init__()方法用来初始化对象，

x + y操作被映射为方法x.__add__(y)，序列或者字典的索引操作x[k]映射为x.__getitem__(k)，__len__()、__str__()分别被内置函数len()、str()调用等等。

仅开头带双下划线__的命名

用于对象的数据封装，以此命名的属性或者方法为类的私有属性或者私有方法。

class Foo(object):
    def __init__(self):
        self.__name = ‘private name‘

    def getname(self):
        return self.__name

    def __spam(self):
        print ‘private method‘

    def bar(self):
        self.__spam()

如果在外部直接访问私有属性或者方法：

>>> f = Foo()
>>> f.__name

Traceback (most recent call last):
  File "<pyshell#1>", line 1, in <module>
    f.__name
AttributeError: ‘Foo‘ object has no attribute ‘__name‘
>>> f.__spam()

Traceback (most recent call last):
  File "<pyshell#2>", line 1, in <module>
    f.__spam()
AttributeError: ‘Foo‘ object has no attribute ‘__spam‘

是不可行的，这就起到了隐藏数据的作用，但是这种实现机制并不是很严格，机制是通过自动"变形"实现的，类中所有以双下划线开头的名称__name都会自动变为"_类名__name"的新名称：

>>> f._Foo__name
‘private name‘
>>> f._Foo__spam()
private method

这样就可以访问了。

这种机制可以阻止继承类重新定义或者更改方法的实现，比如，定义一个Foo的派生类：

class Goo(Foo):
    def __spam(self):
        print ‘private method of Goo‘

重写了__spam方法，运行：

>>> g = Goo()
>>> g.bar()
private method

调用bar()方法的时候依然执行的是Foo类的__spam()方法，因为在bar()方法的实现中，self.__spam()已自动变形为self._Foo__spam(),Goo继承的bar()方法也是如此。

以单下划线_开头的命名

一般用于模块中的"私有"定义的命名。

from module import * 语句用于加载模块中的所有名称，要控制导入的名称，一种方法是定义列表__all__，只有在__all__中的名称才能通过*导入，

另一种方法就是以单下划线开头命名定义了，这种定义不会被*导入。

当然，在类中也可以用单下划线开头来命名属性或者方法，这只是表示类的定义者希望这些属性或者方法是"私有的"，但实际上并不会起任何作用。