Python中单、双下划线的区别

最新推荐文章于 2024-04-14 22:01:34 发布

leolin037

最新推荐文章于 2024-04-14 22:01:34 发布

阅读量315

点赞数

分类专栏： python

本文链接：https://blog.csdn.net/qq_40363447/article/details/102817717

版权

python 专栏收录该内容

3 篇文章 0 订阅

订阅专栏

Python 的代码风格由 PEP 8 描述。

Python中单、双下划线的区别

单下划线开头
双下划线开头
开头结尾双下划线
结论

单下划线开头

Python中不存在真正意义上的私有方法或者属性，前面加单下划线_只是表示你不应该去访问这个方法或者属性，因为它不是API的一部分。
例子：

class BaseForm(StrAndUnicode):
 ...
 
 def _get_errors(self):
 	"Returns an ErrorDict for the data provided for the form"
 	if self._errors is None:
 		self.full_clean()
 		return self._errors
 
 errors = property(_get_errors)

该代码片段来自Django源码(django/forms/forms.py)。这段代码的设计就是errors属性是对外API的一部分，如果你想获取错误详情，应该访问errors属性，而不是（也不应该）访问_get_errors方法。

双下划线开头

很多人说Python中双下划线开头表示私有。这样理解可能也不能说错，但这不是Python设计双下划线开头的初衷和目的，Python设计此的真正目的仅仅是为了避免子类覆盖父类的方法。
例子

class A(object):
  
 def __method(self):
 print("I'm a method in class A")
 
 def method_x(self):
 print("I'm another method in class A\n")
 
 def method(self):
 self.__method()
 self.method_x()
 
class B(A):
  
 def __method(self):
 print("I'm a method in class B")
 
 def method_x(self):
 print("I'm another method in class B\n")
 
 
if __name__ == '__main__':
  
 print("situation 1:")
 a = A()
 a.method()
 
 b = B()
 b.method()
 
 print("situation 2:")
 # a.__method()
 a._A__method()

结果：
在这里插入图片描述
注意：
A类中我们定义了__method()、method_x和method()三个方法；然后我们重新定义一个类B，继承自A，并且在B类中覆写(override)了其父类的__method()和method_x方法，但是从输出结果看，B对象调用method()方法时调用了其父类A的__method()方法和自己的method_x()方法。也就是说，** __method()覆写没有生效，而method_x()覆写生效了。而这也正是Python设计双下划线开头的唯一目的。**

这一点也可在Python官方说明中得到答案：https://www.python.org/dev/peps/pep-0008/#method-names-and-instance-variables。

Python中不存在真正意义上的私有变量。对于双下划线开头的方法和属性虽然我们不能直接引用，那是因为Python默认在其前面加了前缀_类名，所以就像situation 2下面的代码，虽然我们不能用a直接访问__method()，但却可以加上前缀去访问，即_A__method()。

开头结尾双下划线

一般来说像__this__这种开头结尾都加双下划线的方法表示这是Python自己调用的，你不要调用。比如我们可以调用len()函数来求长度，其实它后台是调用了__len__()方法。一般我们应该使用len，而不是直接使用__len__():

a = [1, 2, 3]
print(len(a)) 
print(a.__len__()) # 和上面等效
 
num = 10
print(num + 10)
print(num.__add__(10)) # 和上面等效

我们一般称__len__()这种方法为magic methods，一些操作符后台调用的也是也是这些magic methods，比如+后台调用的是__add__，-调用的是__sub__，所以这种机制使得我们可以在自己的类中覆写操作符（见后面例子）。另外，有的时候这种开头结尾双下划线方法仅仅是某些特殊场景的回调函数，比如__init__()会在对象的初始化时调用，new()会在构建一个实例的时候调用等等。下面我们看两个例子：

class CrazyNumber(object):
 def __init__(self, n): 
 self.n = n 
 def __add__(self, other): 
 return self.n - other 
 def __sub__(self, other): 
 return self.n + other 
 def __str__(self): 
 return str(self.n) 
 
num = CrazyNumber(10) 
print(num) # output is: 10
print(num + 5) # output is: 5
print(num - 20) # output is: 30

在上面这个例子中，我们覆写了+和-操作符，将他们的功能交换了。再看个例子：

class Room(object):
 def __init__(self): 
 self.people = [] 
 def add(self, person): 
 self.people.append(person) 
 def __len__(self): 
 return len(self.people)
  
room = Room() 
room.add("Igor") 
print len(room) # output is: 1