Python中帶下劃線_的變數和函式命名的用法

pythontab發表於2017-12-06

Python 的程式碼風格由 PEP 8 描述。這個文件描述了 Python 程式設計風格的方方面面。在遵守這個文件的條件下,不同程式設計師編寫的 Python 程式碼可以保持最大程度的相似風格。這樣就易於閱讀,易於在程式設計師之間交流。

python中的識別符號可以包含數字、字母和_,但必須以字母或者_開頭,其中以_開頭的命名一般具有特殊的意義。

前後均帶有雙下劃線__的命名

一般用於特殊方法的命名,用來實現物件的一些行為或者功能,比如__new__()方法用來建立例項,__init__()方法用來初始化物件,x + y操作被對映為方法x.__add__(y),序列或者字典的索引操作x[k]對映為x.__getitem__(k),__len__()、__str__()分別被內建函式len()、str()呼叫等等。

僅開頭帶雙下劃線__的命名

用於物件的資料封裝,以此命名的屬性或者方法為類的私有屬性或者私有方法。

class Foo(object):
  def __init__(self):
    self.__name = 'private name'
 
  def getname(self):
    return self.__name
 
  def __spam(self):
    print 'private method'
 
  def bar(self):
    self.__spam()

如果在外部直接訪問私有屬性或者方法:

>>> f = Foo()
>>> f.__name
 
Traceback (most recent call last):
 File "<pyshell#1>", line 1, in <module>
  f.__name
AttributeError: 'Foo' object has no attribute '__name'
>>> f.__spam()
 
Traceback (most recent call last):
 File "<pyshell#2>", line 1, in <module>
  f.__spam()
AttributeError: 'Foo' object has no attribute '__spam'

是不可行的,這就起到了隱藏資料的作用,但是這種實現機制並不是很嚴格,機制是透過自動"變形"實現的,類中所有以雙下劃線開頭的名稱__name都會自動變為"_類名__name"的新名稱:

>>> f._Foo__name
'private name'
>>> f._Foo__spam()
private method

這樣就可以訪問了。

這種機制可以阻止繼承類重新定義或者更改方法的實現,比如,定義一個Foo的派生類:

class Goo(Foo):
  def __spam(self):
    print 'private method of Goo'

重寫了__spam方法,執行:

>>> g = Goo()
>>> g.bar()
private method

呼叫bar()方法的時候依然執行的是Foo類的__spam()方法,因為在bar()方法的實現中,self.__spam()已自動變形為self._Foo__spam(),Goo繼承的bar()方法也是如此。

以單下劃線_開頭的命名

一般用於模組中的"私有"定義的命名。

from module import * 語句用於載入模組中的所有名稱,要控制匯入的名稱,一種方法是定義列表__all__,只有在__all__中的名稱才能透過*匯入,

另一種方法就是以單下劃線開頭命名定義了,這種定義不會被*匯入。

當然,在類中也可以用單下劃線開頭來命名屬性或者方法,這只是表示類的定義者希望這些屬性或者方法是"私有的",但實際上並不會起任何作用。


相關文章