Python 中下划线的 5 种寄义

发布日期:2019-07-23 19:48:12 阅读数: 311次 来源: 作者:

  • 单前导下划线:_var
  • 单末尾下划线:var_
  • 双前导下划线:__var
  • 双前导和末尾下划线:__var__
  • 单下划线:_

在文章结尾处,你能够找到一个简短的"速查表",总结了五种分歧的下划线定名商定和其寄义,以和一个简短的视频教程,可让你切身体验它们的行为。

让我们顿时起头!

1. 单前导下划线 _var

当涉和到变量和方式名称时,单个下划线前缀有一个商定俗成的寄义。 它是对法式员的一个提醒 - 意味着Python社区分歧认为它该当是什么意义,但法式的行为不受影响。

下划线前缀的寄义是奉告其他法式员:以单个下划线开首的变量或方式仅供内部利用。 该商定在PEP 8中有定义。

这不是Python强制划定的。 Python不像Java那样在"私有"和"公共"变量之间有很强的区别。 这就像有人提出了一个小小的下划线警告标记,说:

"嘿,这不是真的要成为类的公共接口的一部门。不去管它就好。"

看看下面的例子:

class Test:
   def __init__(self):
       self.foo = 11
       self._bar = 23

若是你实例化此类,并测验考试拜候在__init__机关函数中定义的foo和_bar属性,会发生什么环境? 让我们来看看:

>>> t = Test()
>>> t.foo
11
>>> t._bar
23

你会看到_bar中的单个下划线并没有阻遏我们"进入"类并拜候该变量的值。

这是由于Python中的单个下划线前缀仅仅是一个商定 - 至多相对于变量和方式名而言。

可是,前导下划线简直会影响从模块中导入名称的体例。

假设你在一个名为my_module的模块中有以下代码:

# This is my_module.py:

def external_func():
   return 23

def _internal_func():
   return 42

此刻,若是利用通配符从模块中导入所出名称,则Python不会导入带有前导下划线的名称(除非模块定义了笼盖此行为的__all__列表):

>>> from my_module import *
>>> external_func()
23
>>> _internal_func()
NameError: "name '_internal_func' is not defined"

趁便说一下,该当避免通配符导入,由于它们使名称空间中具有哪些名称不清晰。 为了清晰起见,对峙常规导入更好。

与通配符导入分歧,常规导入不受前导单个下划线定名商定的影响:

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

我晓得这一点可能有点令人迷惑。 若是你遵照PEP 8保举,避免通配符导入,那么你真正需要记住的只要这个:

单个下划线是一个Python定名商定,暗示这个名称是供内部利用的。 它凡是不由Python注释器强制施行,仅仅作为一种对法式员的提醒。 2. 单末尾下划线 var_

有时候,一个变量的最合适的名称曾经被一个环节字所占用。 因而,像class或def如许的名称不克不及用作Python中的变量名称。 在这种环境下,你能够附加一个下划线来处理定名冲突:

>>> def make_object(name, class):
SyntaxError: "invalid syntax"

>>> def make_object(name, class_):
...    pass

总之,单个末尾下划线(后缀)是一个商定,用来避免与Python环节字发生定名冲突。 PEP 8注释了这个商定。

3. 双前导下划线 __var

到目前为止,我们所涉和的所有定名模式的寄义,来自于已告竣共识的商定。 而对于以双下划线开首的Python类的属性(包罗变量和方式),环境就有点分歧了。

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

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

我晓得这听起来很笼统。 因而,我组合了一个小小的代码示例来予以申明:

class Test:
   def __init__(self):
       self.foo = 11
       self._bar = 23
       self.__baz = 23

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

>>> 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']

以上是这个对象属性的列表。 让我们来看看这个列表,并寻找我们的原始变量名称foo,_bar和__baz - 我包管你会留意到一些风趣的变化。

self.foo变量在属性列表中显示为未点窜为foo。

self._bar的行为体例不异 - 它以_bar的形式显示在类上。 就像我之前说过的,在这种环境下,前导下划线仅仅是一个商定。 给法式员一个提醒罢了。 然而,对于self.__baz而言,环境看起来有点分歧。 当你在该列表中搜刮__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
'overridden'
>>> t2._bar
'overridden'
>>> t2.__baz
AttributeError: "'ExtendedTest' object has no attribute '__baz'"

等一下,当我们测验考试查看t2 .__ baz的值时,为什么我们会获得AttributeError? 名称润色被再次触发了! 现实证明,这个对象以至没有__baz属性:

>>> dir(t2)
['_ExtendedTest__baz', '_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', 'get_vars']

正如你能够看到__baz变成_ExtendedTest__baz以防止不测点窜:

>>> t2._ExtendedTest__baz
'overridden'

但本来的_Test__baz还在:

>>> t2._Test__baz
42

双下划线名称润色对法式员是完全通明的。 下面的例子证明了这一点:

class ManglingTest:
   def __init__(self):
       self.__mangled = 'hello'

   def get_mangled(self):
       return self.__mangled

>>> ManglingTest().get_mangled()
'hello'
>>> ManglingTest().__mangled
AttributeError: "'ManglingTest' object has no attribute '__mangled'"

名称润色能否也合用于方式名称? 是的,也合用。名称润色会影响在一个类的上下文中,以两个下划线字符("dunders")开首的所出名称:

class MangledMethod:
   def __method(self):
       return 42

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

>>> MangledMethod().__method()
AttributeError: "'MangledMethod' object has no attribute '__method'"
>>> MangledMethod().call_it()
42

这是另一个也许令人惊讶的使用名称润色的例子:

_MangledGlobal__mangled = 23

class MangledGlobal:
   def test(self):
       return __mangled

>>> MangledGlobal().test()
23

在这个例子中,我声了然一个名为_MangledGlobal__mangled的全局变量。然后我在名为MangledGlobal的类的上下文中拜候变量。因为名称润色,我可以或许在类的test()方式内,以__mangled来援用_MangledGlobal__mangled全局变量。

Python注释器主动将名称__mangled扩展为_MangledGlobal__mangled,由于它以两亚博个下划线字符开首。这表白名称润色不是特地与类属性联系关系的。它合用于在类上下文中利用的两个下划线字符开首的任何名称。

有良多要接收的内容吧。

诚恳说,这些例子息争释不是从我脑子里蹦出来的。我作了一些研究和加工才弄出来。我不断利用Python,有良多年了,可是像如许的法则和特殊环境并不老是浮此刻脑海里。

有时候法式员最主要的技术是"模式识别",并且晓得在哪里查阅消息。若是您在这一点上感应有点不知所措,请不要担忧。慢慢来,尝尝这篇文章中的一些例子。

让这些概念完全沉浸下来,以便你可以或许理解名称润色的总体思绪,以和我向您展现的一些其他的行为。若是有一天你和它们萍水相逢,你会晓得在文档中按什么来查。

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

也许令人惊讶的是,若是一个名字同时以双下划线起头和竣事,则不会使用名称润色。 由双下划线前缀和后缀包抄的变量不会被Python注释器点窜:

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]

Python下划线定名模式 - 小结

以下是一个简短的小结,即"速查表",枚举了我在本文中谈到的五种Python下划线模式的寄义:

本文由亚博编辑整理亚博手机app