五种下划线含义


# 多行输出结果
from IPython.core.interactiveshell import InteractiveShell
InteractiveShell.ast_node_interactivity = "all"

五种下划线含义

  • 1.单前导下划线:_var
  • 2.单末尾下划线:var_
  • 3.双前导下划线:__var
  • 4.双前导和末尾下划线:__var__
  • 5.单下划线:_

1.单前导下划线 _var

当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义。 它是对程序员的一个提示 - 意味着Python社区一致认为它应该是什么意思,但程序的行为不受影响。

下划线前缀的含义是告知其他程序员:以单个下划线开头的变量或方法仅供内部使用。 该约定在PEP8中有定义。

class Test(object):

    def __init__(self):
        self.foo = 11
        self._bar = 22

t = Test()
t.foo
t._bar
11
22

_bar中的单个下划线并没有阻止我们“进入”类并访问该变量的值。
这是因为Python中的单个下划线前缀仅仅是一个约定 - 至少相对于变量和方法名而言。

但是,前导下划线的确会影响从模块中导入名称的方式。

%%writefile my_module.py

def external_func():
   return 23

def _internal_func():
   return 42
Overwriting my_module.py

现在,如果使用通配符从模块中导入所有名称,则Python不会导入带有前导下划线的名称(除非模块定义了覆盖此行为的__all__列表)

from my_module import *

external_func()
_internal_func()
----------------------------------------------------------

NameError Traceback (most recent call last)
<ipython-input-3-a9405b7f9b0e> in <module>()
      1 from my_module import *
      2 external_func()
----> 3 _internal_func()

NameError: name '_internal_func' is not defined

顺便说一下,应该避免通配符导入,因为它们使名称空间中存在哪些名称不清楚。 为了清楚起见,坚持常规导入更好。

与通配符导入不同,常规导入不受前导单个下划线命名约定的影响:

import my_module

my_module.external_func()
my_module._internal_func()
23
42

总结: 单个下划线是一个Python命名约定,表示这个名称是供内部使用的。 它通常不由Python解释器强制执行,仅仅作为一种对程序员的提示

2. 单末尾下划线 var_

有时候,一个变量的最合适的名称已经被一个关键字所占用。 因此,像class或def这样的名称不能用作Python中的变量名称。 在这种情况下,你可以附加一个下划线来解决命名冲突:

def make_object(name, class):
    pass
  File "<ipython-input-7-88a174f47223>", line 1
    def make_object(name, class):
                              ^
SyntaxError: invalid syntax
def make_object(name, class_):
    pass

总结: 单个末尾下划线(后缀)是一个约定,用来避免与Python关键字产生命名冲突。 PEP 8解释了这个约定

3. 双前导下划线 __var

双下划线前缀会导致Python解释器重写属性名称,以避免子类中的命名冲突。

这也叫做名称修饰(name mangling) - 解释器更改变量的名称,以便在类被扩展的时候不容易产生冲突。

class Test(object):

    def __init__(self):
        self.foo = 11
        self._bar = 22
        self.__baz = 33

用内置的dir()函数来看看这个对象的属性:

t = Test()
[att for att in dir(t) if 'foo' in att or 'ba' in att]
['_Test__baz', '_bar', 'foo']

查看对象属性列表会发现下面变化:
- self.foo变量在属性列表中显示为未修改为foo
- self._bar的行为方式相同 - 它以_bar的形式显示在类上。 就像我之前说过的,在这种情况下,前导下划线仅仅是一个约定。 给程序员一个提示而已。
- 然而,对于self.__baz而言,情况看起来有点不同。 当你在该列表中搜索__baz时,你会看不到有这个名字的变量。仔细观察会看到此对象上有一个名为_Test__baz的属性。 这就是Python解释器所做的名称修饰。 它这样做是为了防止变量在子类中被重写。

让我们创建另一个扩展Test类的类,并尝试重写构造函数中添加的现有属性:

class ExtendedTest(Test):

    def __init__(self):
        super().__init__()
        self.foo = 'overridden'
        self._bar = 'overridden'
        self.__baz = 'overridden'

现在看一看foo,_bar和__baz的值会出现在这个ExtendedTest类的实例上吗:

t2 = ExtendedTest()
t2.foo
t2._bar
t2.__baz
'overridden'
'overridden'
--------------------------------------------------------------

AttributeError Traceback (most recent call last)
<ipython-input-25-f87b3fbe8470> in <module>()
      2 t2.foo
      3 t2._bar
----> 4 t2.__baz

AttributeError: 'ExtendedTest' object has no attribute '__baz'

尝试查看t2 .__baz的值时,为什么我们会得到AttributeError? 名称修饰被再次触发了! 事实证明,这个对象甚至没有__baz属性:

[att for att in dir(t2) if 'foo' in att or 'ba' in att]
['_ExtendedTest__baz', '_Test__baz', '_bar', 'foo']

正如你可以看到__baz变成_ExtendedTest__baz以防止意外修改, 并且原来的_Test__baz还在

t2._ExtendedTest__baz
t2._Test__baz
'overridden'
33

双下划线名称修饰对程序员是完全透明的。 上面的例子证实了这一点:

称修饰是否也适用于方法名称? 是的,也适用。名称修饰会影响在一个类的上下文中,以两个下划线字符("dunders")开头的所有名称:

class MangledMethod(object):

    def __method(self):
        return 22

    def call_it(self):
        return self.__method()

MangledMethod().call_it()
MangledMethod().__method()
22
---------------------------------------------------------

AttributeError Traceback (most recent call last)
<ipython-input-31-20624391f414> in <module>()
      8 
      9 MangledMethod().call_it()
---> 10 MangledMethod().__method()

AttributeError: 'MangledMethod' object has no attribute '__method'

这是另一个也许令人惊讶的运用名称修饰的例子:

_MangledGlobal__mangled = 33

class MangledGlobal(object):

    def test(self):
        return __mangled

MangledGlobal().test()
33

在这个例子中,我声明了一个名为_MangledGlobal__mangled的全局变量。然后我在名为MangledGlobal的类的上下文中访问变量。由于名称修饰,我能够在类的test()方法内,以__mangled来引用_MangledGlobal__mangled全局变量。

Python解释器自动将名称__mangled扩展为_MangledGlobal__mangled,因为它以两个下划线字符开头。这表明名称修饰不是专门与类属性关联的。它适用于在类上下文中使用的两个下划线字符开头的任何名称。

总结: 双前导可用于属性也可用法方法。且这种经过解释器名称修饰后的变量可在全局使用

4. 双前导和双末尾下划线 __var__

也许令人惊讶的是,如果一个名字同时以双下划线开始和结束,则不会应用名称修饰。 由双下划线前缀和后缀包围的变量不会被Python解释器修改:

class PrefixPostfixTest(object):
    def __init__(self):
        self.__bam__ = 42

PrefixPostfixTest().__bam__
42

但是,Python保留了有双前导和双末尾下划线的名称,用于特殊用途。 这样的例子有,__init__对象构造函数,或__call__ --- 它使得一个对象可以被调用。
这些dunder方法通常被称为魔术方法

总结: 双前导和双末尾下划线不会应用名称修饰,但是有特殊用途 -- 魔术方法

5.单下划线 _

按照习惯,有时候单个独立下划线是用作一个名字,来表示某个变量是临时的或无关紧要的。

for _ in range(2):
    print('test')
test
test

可以在拆分(unpacking)表达式中将单个下划线用作“不关心的”变量,以忽略特定的值。 同样,这个含义只是“依照约定”,并不会在Python解释器中触发特殊的行为。 单个下划线仅仅是一个有效的变量名称,会有这个用途而已。

在下面的代码示例中,我将汽车元组拆分为单独的变量,但我只对颜色和里程值感兴趣。 但是,为了使拆分表达式成功运行,我需要将包含在元组中的所有值分配给变量。 在这种情况下,“_”作为占位符变量可以派上用场:

car = ('red', 'auto', 12, 3812.4)
color, _, _, mileage = car
color
mileage
_
'red'
3812.4
12

除了用作临时变量之外,“_”是大多数Python REPL中的一个特殊变量,它表示由解释器评估的最近一个表达式的结果。

这样就很方便了,比如你可以在一个解释器会话中访问先前计算的结果,或者,你是在动态构建多个对象并与它们交互,无需事先给这些对象分配名字:

>>> 20 + 3
23
>>> _
23
>>> print(_)
23

>>> list()
[]
>>> _.append(1)
>>> _.append(2)
>>> _.append(3)
>>> _
[1, 2, 3]

总结: 单下划线可用来表示某个量不关心或者无关要紧的,在解释器会话中它也会存储最后一个表达式的结果

评论
还没有评论
    发表评论 说点什么