带下划线_的变量或函数命名，带下划线的方法

Posted 2021-06-08 NEU_ShuaiCheng

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

单前置下划线的名字: 《流畅的python》作者称之为“受保护的”名字，有两种主要的用法：

1、作为类名或函数名时， 会阻止其他python脚本通过【from module import *】语句导入该名字，即该名字不会被星号匹配；

1 """foo.py模块"""
2 def add(a, b):
3     """待导入的函数，是个公有的名字"""
4     return a+b
5 ​
6 def _add2(a, b):
7     """待导入的函数，是个受保护的名字"""
8     return a+b

比如，对于上面的模块foo，如果我在另一个python脚本中使用【from foo import *】语句，实际上是访问不到_add2()函数的，但是如果我使用【from foo import add, _add2】语句，则两个函数都能被访问到。

2、作为类的属性名或方法名时 意为不希望下游的程序员直接访问该名字，而导致意外覆盖该属性，但是这只是一种【命名约定】，python解释器不会对这种属性名做特殊处理。只是表示类的定义者希望这些属性或者方法是"私有的"，但实际上并不会起任何作用。

 

前后均带有双下划线__的命名 一般用于特殊方法的命名，用来实现对象的一些行为或者功能，比如

__new__()方法用来创建实例， __init__()方法用来初始化对象， x + y操作被映射为方法x.__add__(y)，序列或者字典的索引操作x[k]映射为x.__getitem__(k)， __len__()、__str__()分别被内置函数len()、str()调用等等。

仅开头带双下划线__的命名 用于对象的数据封装，以此命名的属性或者方法为类的私有属性或者私有方法。

 1 class Foo(object):
 2     def __init__(self):
 3         self.__name = \'private name\'
 4 ​
 5     def getname(self):
 6         return self.__name
 7 ​
 8     def __spam(self):
 9         print \'private method\'
10 ​
11     def bar(self):
12         self.__spam()
13 ​

如果在外部直接访问私有属性或者方法：是不可行的，这就起到了隐藏数据的作用，

 1 >>> f = Foo()
 2 >>> f.__name
 3 ​
 4 Traceback (most recent call last):
 5   File "<pyshell#1>", line 1, in <module>
 6     f.__name
 7 AttributeError: \'Foo\' object has no attribute \'__name\'
 8 >>> f.__spam()
 9 ​
10  
11 Traceback (most recent call last):
12   File "<pyshell#2>", line 1, in <module>
13     f.__spam()
14 AttributeError: \'Foo\' object has no attribute \'__spam\'

但是这种实现机制并不是很严格，机制是通过自动"变形"实现的，类中所有以双下划线开头的名称name都会自动变为"_类名name"的新名称：

1 >>> f._Foo__name
2 \'private name\'
3 ​
4 >>> f._Foo__spam()
5 private method

这样就可以访问了。

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

1 class Goo(Foo):
2     def __spam(self):
3         print \'private method of Goo\'

重写了__spam方法，运行：

1 >>> g = Goo()
2 >>> g.bar()
3 private method

调用bar()方法的时候依然执行的是Foo类的__spam()方法，因为在bar()方法的实现中，self.__spam()已自动变形为self._Foo__spam(),Goo继承的bar()方法也是如此，注意此时运行的是父类中的私有化方法，而不是子类重写的方法。