本文介绍了Python中单下划线和双下划线的各种含义和命名约定,名称修饰(name mangling)的工作原理,以及它如何影响Python类。
五类下划线
1、 前导单下划线:_var
2、末尾单下划线:var_
3、前导双下划线:__var
4、前导和末尾双下划线:__var__
5、单下划线:_

1. 单前导下划线_var
-
当涉及到变量和方法名称时,单个下划线前缀有一个约定俗成的含义,它是程序员的一个提示:python社区一致认为它应该是什么意思,但不会对程序行为产生影响。
-
告知其他程序员:以单个下划线开头的变量或方法仅供内部使用(该约定在'PEP 8'中有定义)
-
不是python的强制规定。python不像JAVA那样在"私有"和“公有”变量之间存在很强的区别。这就像有人用下划线为标识提出一个小小的警告:
“嘿,这不是真的要成为类的一个公共接口的一部分。不去管它就好”
class Test:
def __init__(self):
self.foo = 11
self._bar = 23
>>> t = Test()
>>> t.foo
11
>>> t._bar
23
_bar
中的前导单下划线并未阻止我们引用它。至少相对于变量和方法名而言,前导单下划线_
仅是一个定义内部(私有)变量或方法的约定而已。
但是,前导下划线的确会影响从模块中导入名称的方式。
# This is my_module.py:
def external_func():
return 23
def _internal_func():
return 42
>>> from my_module import *
>>> external_func()
23
>>> _internal_func()
NameError: "name '_internal_func' is not defined"
此时,如果使用通配符从模块中导入所有名称,则Python不会导入带有前导下划线的名称(除非模块定义了覆盖此行为的all列表)。
- PEP 8推荐避免通配符导入,如果你遵循此约定,那么就不必担忧上述问题,只需要记住:
单个下划线是一个Python命名约定,表示这个名称是供内部使用的。 它通常不由Python解释器强制执行,仅仅作为一种对程序员的提示。
2、末尾单下划线var_
- 作为一个命名用的字符,用于解决命名冲突。有时候,一个变量的最合适的名称已经被一个关键字所占用。 因此,像class或def这样的名称不能用作Python中的变量名称。 在这种情况下,你可以附加一个下划线来解决命名冲突:
3、前导双下划线__var
- 双下划线前缀会导致Python解释器重写属性名称,以避免子类中的命名冲突。
这也叫做名称修饰(name mangling) —— 解释器更改变量的名称,以便在类被扩展的时候不容易产生冲突。
class Test:
def __init__(self):
self.foo = 11
self._bar = 23
self.__baz = 23
>>> t = Test()
>>> dir(t)
['_Test__baz', '__class__', '__delattr__', '__dict__', '__dir__',
'__doc__', '__eq__', '__format__', '__ge__', '__getattribute__',
'__gt__', '__hash__', '__init__', '__le__', '__lt__', '__module__',
'__ne__', '__new__', '__reduce__', '__reduce_ex__', '__repr__',
'__setattr__', '__sizeof__', '__str__', '__subclasshook__',
'__weakref__', '_bar', 'foo']
可以看见:
self.foo
变量在属性列表中显示为未修改为foo。
self._bar
经解释器解释后并无变化。
self.__baz
情况看起来有点不同,它被解释器做了名称修饰,变为了_Test__baz
class ExtendedTest(Test):
def __init__(self):
super().__init__()
self.foo = 'overridden'
self._bar = 'overridden'
self.__baz = 'overridden'
>>> t2 = ExtendedTest()
>>> t2.foo
'overridden'
>>> t2._bar
'overridden'
>>> t2.__baz
AttributeError: "'ExtendedTest' object has no attribute '__baz'"
直接使用__baz
引用该属性(或方法)就出错了。而得如下方式才能引用:
>>> t2._Test__baz
42
4、前导和末尾双下划线__var__
- 与前导双下划线
__var
不同,在解释器解释过程中,前导和末尾双下划线__var__
不会应用名称修饰。
class PrefixPostfixTest:
def __init__(self):
self.__bam__ = 42
>>> PrefixPostfixTest().__bam__
42
-
但是,Python保留了有双前导和双末尾下划线的名称,用于特殊用途。 这样的例子有,
__init__
对象构造函数,或__call__
它使得一个对象可以被调用。 -
这些dunder方法通常被称为神奇方法 , 但Python社区中的许多人(包括我自己)都不喜欢这种方法。
-
最好避免在自己的程序中使用以双下划线(dunders)开头和结尾的名称,以避免与将来Python语言的变化产生冲突。
5、单下划线 _
- 按照习惯,有时候单个独立下划线
_
用作一个名字,来表示某个变量是临时的或无关紧要的。
>>> for _ in range(32):
... print('Hello, World.')
在上述代码段中,单下划线_
仅作为一个临时变量用于循环迭代。
- 在拆分(unpacking)表达式中将单个下划线用作“不关心的”变量,以忽略特定的值。
- 这个含义只是“依照约定”,并不会在Python解释器中触发特殊的行为。 单个下划线仅仅是一个有效的变量名称,会有这个用途而已。
>>> car = ('red', 'auto', 12, 3812.4)
>>> color, _, _, mileage = car
>>> color
'red'
>>> mileage
3812.4
>>> _
12
上述代码段中,_
作为占位符变量使用。
- 除了用作临时变量之外,
_
是大多数Python REPL中的一个特殊变量,它表示由解释器评估的最近一个表达式的结果。
这样就很方便了,比如你可以在一个解释器会话中访问先前计算的结果,或者,你是在动态构建多个对象并与它们交互,无需事先给这些对象分配名字:
>>> 20 + 3
23
>>> _
23
>>> print(_)
23
>>> list()
[]
>>> _.append(1)
>>> _.append(2)
>>> _.append(3)
>>> _
[1, 2, 3]
改写自:https://blog.csdn.net/tcx1992
原文作者:地球的外星人君
链接:https://zhuanlan.zhihu.com/p/36173202
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
网友评论