一、速查表
二、單前導下划線:_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解釋器強制執行,僅僅作為一種對程序員的提示
三、單末尾下划線 var_
有時候,一個變量的最合適的名稱已經被一個關鍵字所占用。 因此,像class或def這樣的名稱不能用作Python中的變量名稱。 在這種情況下,你可以附加一個下划線來解決命名沖突:
>>> def make_object(name, class): SyntaxError: "invalid syntax"
>>> def make_object(name, class_): ... pass
總之,單個末尾下划線(后綴)是一個約定,用來避免與Python關鍵字產生命名沖突。 PEP 8解釋了這個約定。
四、雙前導下划線 __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 23
雙下划線名稱修飾對程序員是完全透明的。 下面的例子證實了這一點:
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
這是另一個也許令人驚訝的運用名稱修飾的例子:
_Test__mangled = 23 classTest: def test(self): return __mangled
>>> MangledGlobal().test() 23
在這個例子中,我聲明了一個名為_Test__mangled的全局變量。然后我在名Test的類的上下文中訪問變量。由於名稱修飾,我能夠在類的test()方法內,以__mangled來引用_Test__mangled全局變量。
Python解釋器自動將名稱__mangled擴展為_Test__mangled,因為它以兩個下划線字符開頭。這表明名稱修飾不是專門與類屬性關聯的。它適用於在類上下文中使用的兩個下划線字符開頭的任何名稱。
五、雙前導和雙末尾下划線 _var_
也許令人驚訝的是,如果一個名字同時以雙下划線開始和結束,則不會應用名稱修飾。 由雙下划線前綴和后綴包圍的變量不會被Python解釋器修改:
class PrefixPostfixTest: def __init__(self): self.__bam__ = 42
>>> PrefixPostfixTest().__bam__
42
但是,Python保留了有雙前導和雙末尾下划線的名稱,用於特殊用途。 這樣的例子有,__init__對象構造函數,或__call__ --- 它使得一個對象可以被調用。
這些dunder方法通常被稱為神奇方法 - 但Python社區中的許多人(包括我自己)都不喜歡這種方法。
最好避免在自己的程序中使用以雙下划線(“dunders”)開頭和結尾的名稱,以避免與將來Python語言的變化產生沖突。
六、單下划線 _
按照習慣,有時候單個獨立下划線是用作一個名字,來表示某個變量是臨時的或無關緊要的。
例如,在下面的循環中,我們不需要訪問正在運行的索引,我們可以使用“_”來表示它只是一個臨時值:
>>> 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]