​【Python】单下划线与双下划线的区别

  • 2019 年 10 月 11 日
  • 笔记

Python用下划线作为前缀和后缀指定特殊变量和定义方法，主要有如下四种形式：

  • 单下划线（_）
  • 名称前的单下划线（如：_name）
  • 名称前的双下划线（如：__name）
  • 名称前后的双下划线（如:__init__）

单下划线（_）

只有单划线的情况，主要有两种使用场景：

1、在交互式解释器中，单下划线“_”代表的是上一条执行语句的结果。如果单下划线前面没有语句执行，交互式解释器将会报单下划线没有定义的错误。也可以对单下划线进行赋值操作，这时单下划线代表赋值的结果。但是一般不建议对单下划线进行赋值操作，因为单下划线内建标识符。

>>> _  Traceback (most recent call last):    File "<pyshell#0>", line 1, in <module>      _  NameError: name '_' is not defined  >>> "python"  'python'  >>> _  'python'  >>> _="Java"  >>> _  'Java'  >>>

2、单下划线“_”还可以作为特殊的临时变量。如果一个变量在后面不会再用到，并且不想给这个变量定义名称，这时就可以用单下划线作为临时性的变量。比如对for循环语句遍历的结果元素并不感兴趣，此时就可以用单下划线表示。

# _ 这个变量在后面不会用到  for _ in range(5):      print("Python")

名称前的单下划线（如：_name）

当在属性和方法前面加上单下划线“_”，用于指定属性和方法是“私有”的。但是Python不像Java一样具有私有属性、方法、类，在属性和方法之前加单下划线，只是代表该属性、方法、类只能在内部使用，是API中非公开的部分。如果用fromimport * 和 fromimport * 时，这些属性、方法、类将不被导入。

# Test.py 文件    #普通属性  value="Java"    #单下划线属性  _otherValue="Python"      #普通方法  def  method():      print("我是普通方法")    #单下划线方法  def _otherMethod():      print("我是单下划线方法")    #普通类  class PClass(object):        def __init__(self):          print("普通类的初始化")    #单下划线类  class _WClass(object):        def __init__(self):          print("单下划线类的初始化")

将上述的Test.py文件导入，进行测试。

>>> from Test import *  >>> value  'Java'  >>> _otherValue  Traceback (most recent call last):    File "<pyshell#4>", line 1, in <module>      _otherValue  NameError: name '_otherValue' is not defined  >>> method()  我是普通方法  >>> _otherMethod()  Traceback (most recent call last):    File "<pyshell#6>", line 1, in <module>      _otherMethod()  NameError: name '_otherMethod' is not defined  >>> p=PClass()  普通类的初始化  >>> w=_WClass()  Traceback (most recent call last):    File "<pyshell#8>", line 1, in <module>      w=_WClass()  NameError: name '_WClass' is not defined

从上面的结果可以看出，不管是属性、方法和类，只要名称前面加了单下划线，都不能导出。

如果对程序进行修改，将在开头加入__all__,结果会是如何？

# Test.py 文件    #将普通属性、单下划线的属性、方法、和类加入__all__列表  __all__=["value"，"_otherValue","_otherMethod","_WClass"]    #普通属性  value="Java"    #单下划线属性  _otherValue="Python"    #普通方法  def  method():      print("我是普通方法")    #单下划线方法  def _otherMethod():      print("我是单下划线方法")    #普通类  class PClass(object):        def __init__(self):          print("普通类的初始化")    #单下划线类  class _WClass(object):        def __init__(self):          print("单下划线类的初始化")

将上述修改过的Test.py文件导入，进行测试。

>>> from Test import *  >>> value  'Java'  >>> _otherValue  'Python'  >>> method()  Traceback (most recent call last):    File "<pyshell#4>", line 1, in <module>      method()  NameError: name 'method' is not defined  >>> _otherMethod()  我是单下划线方法  >>> p=PClass()  Traceback (most recent call last):    File "<pyshell#6>", line 1, in <module>      p=PClass()  NameError: name 'PClass' is not defined  >>> w= _WClass()  单下划线类的初始化

__all__是一个字符串列表，不管是普通的还是单下划线的属性、方法和类，都将导出来，使用其他不在这个字符列表上的属性、方法和类，都会报未定义的错误。

不管是属性、方法和类，只要名称前面加了单下划线，都不能导入。除非是模块或包中的“__all__”列表显式地包含了它们。

名称前的双下划线（如：__name）

我们先看看下面的程序：

class Method(object):      # 构造器方法      def __init__(self, name):          # 双下划线属性          self.__name = name      # 普通方法      def sayhello(self):          print("Method say hello!")      # 双下划线方法      def __sayhi(self):          print("Method say hi!")    # 初始化Method  m = Method("Python")  # 调用sayhello方法  m.sayhello()  # 调用sayhi方法  m.__sayhi()  # 输出属性__name  print(m.__name)

上面的程序定义了一个类，这个类有三个方法，一个构造器方法，一个普通方法，一个双下划线方法，以及包括一个双下划线的属性。上面的结果输出的是什么？很多读者可能认为输出的结果如下：

Method say hello!  Method say hi!  Python

那么恭喜你，上面的输出结果是错误的，实际输出的结果为：

Method say hello!  Traceback (most recent call last):    File "<encoding error>", line 18, in <module>  AttributeError: 'Method' object has no attribute '__sayhi'

实际上，当对象调用__sayhi()方法时，将会报Method类没有这个方法属性的错误。那如何去调用以双下划线开头的方法和属性？Python这样设计的目的是什么？

首先回答第一个问题，读者看完下面的程序就知道怎么调用了。

class Method(object):        def __init__(self, name):          self.__name = name        def sayhello(self):          print("Method say hello!")        def __sayhi(self):          print("Method say hi!")      # 初始化Method  m = Method("Python")  # 调用sayhello方法  m.sayhello()  # 调用sayhi方法  #m.__sayhi()  m._Method__sayhi()  # 输出属性__name  #print(m.__name)  print(m._Method__name)

输出结果如下：

Method say hello!  Method say hi!  Python

我们从上面的程序中可以很清楚的看到，如果要调用以双下划线开头的方法和属性，只要以“类名_方法（属性）”的形式就可以实现方法或者属性的访问了。类前面是单下划线，类名后面是双下划线，然后再加上方法或者属性。但是并不建议调用，因为这是Python内部进行调用的形式。

回答完第一个问题，我们看看第二个问题，Python这样设计的目的是什么？

有很多人认为，Python以双下划线开头的方法和属性表示私有的方法和属性，实际上这样的理解不太准确，也不能说完全错误的。但是这并不是Python设计的目的和初衷，我们先看看下面一段程序和程序运行结果:

class AMethod(object):        def __method(self):          print("__method in class Amethod!")        def method(self):          self.__method()          print("anthod method in class AMethod!")    class BMethod(AMethod):        def __method(self):          print("__method in class Bmethod!")      if __name__=="__main__":        print("调用AMethod的method方法")      a = AMethod()      a.method()        print("调用BMethod的method方法")      b = BMethod()      b.method()

上面的程序定义了两个类，一个是AMethod类，另外一个是继承了AMethod类的BMethod类。在AMethod类中，定义了两个方法，一个是以双下划线开头的__method方法，另外一个是普通方法。在BMethod类中，重写了AMethod类中的__method方法。

程序运行结果：

调用AMethod的method方法  __method in class Amethod!  anthod method in class AMethod!  调用BMethod的method方法  __method in class Amethod!  anthod method in class AMethod!

运行结果并不是我们想要的结果，b.method()并没有调用BMethod类的__method方法，而这个设计的实际目的是为了避免父类的方法被子类轻易的覆盖。

名称前后的双下划线（如:__ init __）

在Python类中，我们可以常常看到类似于“__ init ___”的方法，这表示在Python内部调用的方法，一般不建议在程序中调用。比如，当调用len()方法时，实际上调用了 Python中内部的 ___len ___方法，虽然不建议调用这种以双下划线开头以及结尾的方法，但是可以对这些方法进行重写。比如下面的例子：

class Number(object):        def __init__(self, number):          self.number = number        def __add__(self, number):          # 重写方法，返回两个数的差值          return self.number - number        def __sub__(self, number):          # 重写方法，返回两个数的和          return self.number + number        def __str__(self):          # 重写方法，返回字符串          return str(self.number)      num = Number(100)  print(num) # 100 调用了__str__方法  print(num+50) # 50 + 调用了__add__方法  print(num-20) # 120 -调用了__sub__方法

相信看了上面所有对Python中下划线作用的讲解，完全能够理解上述四种下划线所表示的意义。最后将对上面的，进行总结。

总结

  • 单下划线（_）: 在交互解释器中，表示上一条语句执行输出的结果。另外，单下划线还可以作为特殊的临时变量，表示在后面将不会在用到这个变量。
  • 名称前的单下划线：只能在内部使用，是API中非公开的部分，不能被import * 和 fromimport *导入程序中，除非在all列表中包含了以单下划线开头的属性、方法以及类。
  • 名称前的双下划线：以双下划线开头的属性、方法表示避免父类的属性和方法被子类轻易的覆盖，一般不建议这样定义属性和方法，除非你自己将要做什么。
  • 名称前后的双下划线：这类方法是Python内部定义的方法，你可以重写这些方法，这样Python就可以调用这个重写的方法以及利用操作符。

VirMach 便宜 VPS

QNews

QNews