Python中下劃線的5種含義

本文介紹了Python中單下劃線和雙下劃線("dunder")的各種含義和命名約定歧胁,名稱修飾(name mangling)的工作原理摊鸡,以及它如何影響你自己的Python類孤里。

單下劃線和雙下劃線在Python變量和方法名稱中都各有其含義累舷。有一些含義僅僅是依照約定知纷,被視作是對(duì)程序員的提示 - 而有一些含義是由Python解釋器嚴(yán)格執(zhí)行的壤圃。
在本文中,我將討論以下五種下劃線模式和命名約定琅轧,以及它們?nèi)绾斡绊慞ython程序的行為:

單前導(dǎo)下劃線:_var
單末尾下劃線:var_
雙前導(dǎo)下劃線:__var
雙前導(dǎo)和末尾下劃線:__var__
單下劃線:_

1. 單前導(dǎo)下劃線 _var

當(dāng)涉及到變量和方法名稱時(shí)伍绳,單個(gè)下劃線前綴有一個(gè)約定俗成的含義。 它是對(duì)程序員的一個(gè)提示 - 意味著Python社區(qū)一致認(rèn)為它應(yīng)該是什么意思乍桂,但程序的行為不受影響冲杀。
下劃線前綴的含義是告知其他程序員:以單個(gè)下劃線開頭的變量或方法僅供內(nèi)部使用。 該約定在PEP 8中有定義睹酌。
這不是Python強(qiáng)制規(guī)定的权谁。 Python不像Java那樣在“私有”和“公共”變量之間有很強(qiáng)的區(qū)別。 這就像有人提出了一個(gè)小小的下劃線警告標(biāo)志憋沿,說:“嘿旺芽,這不是真的要成為類的公共接口的一部分。不去管它就好卤妒∩蹋”
看看下面的例子:

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

如果你實(shí)例化此類字币,并嘗試訪問在__init__構(gòu)造函數(shù)中定義的foo和_bar屬性则披,會(huì)發(fā)生什么情況? 讓我們來看看:

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

你會(huì)看到_bar中的單個(gè)下劃線并沒有阻止我們“進(jìn)入”類并訪問該變量的值洗出。

這是因?yàn)镻ython中的單個(gè)下劃線前綴僅僅是一個(gè)約定 - 至少相對(duì)于變量和方法名而言士复。

但是,前導(dǎo)下劃線的確會(huì)影響從模塊中導(dǎo)入名稱的方式翩活。
假設(shè)你在一個(gè)名為my_module的模塊中有以下代碼:

# This is my_module.py:

def external_func():
   return 23

def _internal_func():
   return 42

現(xiàn)在阱洪,如果使用通配符從模塊中導(dǎo)入所有名稱,則Python不會(huì)導(dǎo)入帶有前導(dǎo)下劃線的名稱(除非模塊定義了覆蓋此行為的all列表):

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

順便說一下菠镇,應(yīng)該避免通配符導(dǎo)入冗荸,因?yàn)樗鼈兪姑Q空間中存在哪些名稱不清楚。 為了清楚起見利耍,堅(jiān)持常規(guī)導(dǎo)入更好蚌本。

與通配符導(dǎo)入不同盔粹,常規(guī)導(dǎo)入不受前導(dǎo)單個(gè)下劃線命名約定的影響:

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

我知道這一點(diǎn)可能有點(diǎn)令人困惑。 如果你遵循PEP 8推薦程癌,避免通配符導(dǎo)入舷嗡,那么你真正需要記住的只有這個(gè):

單個(gè)下劃線是一個(gè)Python命名約定,表示這個(gè)名稱是供內(nèi)部使用的嵌莉。 它通常不由Python解釋器強(qiáng)制執(zhí)行进萄,僅僅作為一種對(duì)程序員的提示。

2. 單末尾下劃線 var_

有時(shí)候锐峭,一個(gè)變量的最合適的名稱已經(jīng)被一個(gè)關(guān)鍵字所占用中鼠。 因此,像class或def這樣的名稱不能用作Python中的變量名稱沿癞。 在這種情況下兜蠕,你可以附加一個(gè)下劃線來解決命名沖突:

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

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

總之,單個(gè)末尾下劃線(后綴)是一個(gè)約定抛寝,用來避免與Python關(guān)鍵字產(chǎn)生命名沖突熊杨。 PEP 8解釋了這個(gè)約定。

3. 雙前導(dǎo)下劃線 __var(私有)

到目前為止盗舰,我們所涉及的所有命名模式的含義晶府,來自于已達(dá)成共識(shí)的約定。 而對(duì)于以雙下劃線開頭的Python類的屬性(包括變量和方法)钻趋,情況就有點(diǎn)不同了川陆。

雙下劃線前綴會(huì)導(dǎo)致Python解釋器重寫屬性名稱,以避免子類中的命名沖突蛮位。

這也叫做名稱修飾(name mangling) - 解釋器更改變量的名稱较沪,以便在類被擴(kuò)展的時(shí)候不容易產(chǎn)生沖突。

我知道這聽起來很抽象失仁。 因此尸曼,我組合了一個(gè)小小的代碼示例來予以說明:

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

讓我們用內(nèi)置的dir()函數(shù)來看看這個(gè)對(duì)象的屬性:

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

以上是這個(gè)對(duì)象屬性的列表。 讓我們來看看這個(gè)列表萄焦,并尋找我們的原始變量名稱foo控轿,_bar和__baz - 我保證你會(huì)注意到一些有趣的變化。

self.foo變量在屬性列表中顯示為未修改為foo拂封。
self._bar的行為方式相同 - 它以_bar的形式顯示在類上茬射。 就像我之前說過的,在這種情況下冒签,前導(dǎo)下劃線僅僅是一個(gè)約定在抛。 給程序員一個(gè)提示而已。
然而萧恕,對(duì)于self.__baz而言刚梭,情況看起來有點(diǎn)不同档悠。 當(dāng)你在該列表中搜索__baz時(shí),你會(huì)看不到有這個(gè)名字的變量望浩。
__baz出什么情況了辖所?

如果你仔細(xì)觀察,你會(huì)看到此對(duì)象上有一個(gè)名為_Test__baz的屬性磨德。 這就是Python解釋器所做的名稱修飾缘回。 它這樣做是為了防止變量在子類中被重寫。

讓我們創(chuàng)建另一個(gè)擴(kuò)展Test類的類典挑,并嘗試重寫構(gòu)造函數(shù)中添加的現(xiàn)有屬性:

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

現(xiàn)在酥宴,你認(rèn)為foo,_bar和__baz的值會(huì)出現(xiàn)在這個(gè)ExtendedTest類的實(shí)例上嗎您觉? 我們來看一看:

>>> t2 = ExtendedTest()
>>> t2.foo
'overridden'
>>> t2._bar
'overridden'
>>> t2.__baz
AttributeError: "'ExtendedTest' object has no attribute '__baz'"

等一下拙寡,當(dāng)我們嘗試查看t2 .__ baz的值時(shí),為什么我們會(huì)得到AttributeError琳水? 名稱修飾被再次觸發(fā)了肆糕! 事實(shí)證明,這個(gè)對(duì)象甚至沒有__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

雙下劃線名稱修飾對(duì)程序員是完全透明的在孝。 下面的例子證實(shí)了這一點(diǎn):

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

名稱修飾是否也適用于方法名稱诚啃? 是的,也適用私沮。名稱修飾會(huì)影響在一個(gè)類的上下文中始赎,以兩個(gè)下劃線字符("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

這是另一個(gè)也許令人驚訝的運(yùn)用名稱修飾的例子:

_MangledGlobal__mangled = 23

class MangledGlobal:
   def test(self):
       return __mangled

>>> MangledGlobal().test()
23

在這個(gè)例子中,我聲明了一個(gè)名為_MangledGlobal__mangled的全局變量仔燕。然后我在名為MangledGlobal的類的上下文中訪問變量造垛。由于名稱修飾,我能夠在類的test()方法內(nèi)晰搀,以__mangled來引用_MangledGlobal__mangled全局變量五辽。

Python解釋器自動(dòng)將名稱__mangled擴(kuò)展為_MangledGlobal__mangled,因?yàn)樗詢蓚€(gè)下劃線字符開頭厕隧。這表明名稱修飾不是專門與類屬性關(guān)聯(lián)的奔脐。它適用于在類上下文中使用的兩個(gè)下劃線字符開頭的任何名稱。

4. 雙前導(dǎo)和雙末尾下劃線 __var__

也許令人驚訝的是吁讨,如果一個(gè)名字同時(shí)以雙下劃線開始和結(jié)束,則不會(huì)應(yīng)用名稱修飾峦朗。 由雙下劃線前綴和后綴包圍的變量不會(huì)被Python解釋器修改:

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

>>> PrefixPostfixTest().__bam__
42

但是建丧,Python保留了有雙前導(dǎo)和雙末尾下劃線的名稱,用于特殊用途肤视。 這樣的例子有橄教,__init__對(duì)象構(gòu)造函數(shù),或__call__ --- 它使得一個(gè)對(duì)象可以被調(diào)用盒至。

這些dunder方法通常被稱為神奇方法 - 但Python社區(qū)中的許多人(包括我自己)都不喜歡這種方法拴曲。

最好避免在自己的程序中使用以雙下劃線(“dunders”)開頭和結(jié)尾的名稱争舞,以避免與將來Python語(yǔ)言的變化產(chǎn)生沖突。

5.單下劃線 _

按照習(xí)慣澈灼,有時(shí)候單個(gè)獨(dú)立下劃線是用作一個(gè)名字竞川,來表示某個(gè)變量是臨時(shí)的或無關(guān)緊要的。
例如叁熔,在下面的循環(huán)中委乌,我們不需要訪問正在運(yùn)行的索引,我們可以使用“_”來表示它只是一個(gè)臨時(shí)值:

>>> for _ in range(32):
...    print('Hello, World.')

你也可以在拆分(unpacking)表達(dá)式中將單個(gè)下劃線用作“不關(guān)心的”變量荣回,以忽略特定的值遭贸。 同樣,這個(gè)含義只是“依照約定”心软,并不會(huì)在Python解釋器中觸發(fā)特殊的行為壕吹。 單個(gè)下劃線僅僅是一個(gè)有效的變量名稱,會(huì)有這個(gè)用途而已删铃。

在下面的代碼示例中算利,我將汽車元組拆分為單獨(dú)的變量,但我只對(duì)顏色和里程值感興趣泳姐。 但是效拭,為了使拆分表達(dá)式成功運(yùn)行,我需要將包含在元組中的所有值分配給變量胖秒。 在這種情況下缎患,“_”作為占位符變量可以派上用場(chǎng):

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

>>> color
'red'
>>> mileage
3812.4
>>> _
12

除了用作臨時(shí)變量之外,“_”是大多數(shù)Python REPL中的一個(gè)特殊變量阎肝,它表示由解釋器評(píng)估的最近一個(gè)表達(dá)式的結(jié)果挤渔。

這樣就很方便了,比如你可以在一個(gè)解釋器會(huì)話中訪問先前計(jì)算的結(jié)果风题,或者判导,你是在動(dòng)態(tài)構(gòu)建多個(gè)對(duì)象并與它們交互,無需事先給這些對(duì)象分配名字:

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

>>> list()
[]
>>> _.append(1)
>>> _.append(2)
>>> _.append(3)
>>> _
[1, 2, 3]
下劃線總結(jié)
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末沛硅,一起剝皮案震驚了整個(gè)濱河市眼刃,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌摇肌,老刑警劉巖擂红,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異围小,居然都是意外死亡昵骤,警方通過查閱死者的電腦和手機(jī)树碱,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來变秦,“玉大人成榜,你說我怎么就攤上這事”拿担” “怎么了赎婚?”我有些...
    開封第一講書人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)钳垮。 經(jīng)常有香客問我惑淳,道長(zhǎng),這世上最難降的妖魔是什么饺窿? 我笑而不...
    開封第一講書人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任歧焦,我火速辦了婚禮,結(jié)果婚禮上肚医,老公的妹妹穿的比我還像新娘绢馍。我一直安慰自己,他們只是感情好肠套,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開白布舰涌。 她就那樣靜靜地躺著,像睡著了一般你稚。 火紅的嫁衣襯著肌膚如雪瓷耙。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,146評(píng)論 1 297
  • 那天刁赖,我揣著相機(jī)與錄音搁痛,去河邊找鬼。 笑死宇弛,一個(gè)胖子當(dāng)著我的面吹牛鸡典,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播枪芒,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開眼彻况,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了舅踪?” 一聲冷哼從身側(cè)響起纽甘,我...
    開封第一講書人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎硫朦,沒想到半個(gè)月后贷腕,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡咬展,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年泽裳,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片破婆。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡涮总,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出祷舀,到底是詐尸還是另有隱情瀑梗,我是刑警寧澤,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布裳扯,位于F島的核電站抛丽,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏饰豺。R本人自食惡果不足惜亿鲜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望冤吨。 院中可真熱鬧蒿柳,春花似錦、人聲如沸漩蟆。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)怠李。三九已至圾叼,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間捺癞,已是汗流浹背夷蚊。 一陣腳步聲響...
    開封第一講書人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留翘簇,地道東北人撬码。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像版保,于是被迫代替她去往敵國(guó)和親呜笑。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • 昨天晚上和同學(xué)打乒乓球彻犁。他打了一個(gè)高球給我叫胁,我狠狠地扣了過去。他說這球簡(jiǎn)直沒法接汞幢。我說既然如此驼鹅,那你要做的就是盡量...
    隨無涯之旅閱讀 1,158評(píng)論 0 0
  • 自去年8月赴美,已經(jīng)是第四次到紐約了,算上來時(shí)轉(zhuǎn)機(jī)输钩,也可以說是五次豺型,自己都覺得好像有些太頻繁,以至于靜靜都笑道买乃,沒...
    顏南希閱讀 129評(píng)論 2 1
  • 開卷有益姻氨,今天讀的是《故事思維》,發(fā)現(xiàn)了一只眼里有故事的斑馬剪验,可惜肴焊,手殘如我,畫出來斑馬的眼睛就像瞎了一樣~ 《故...
    自由邢閱讀 284評(píng)論 1 2