這篇文章討論Python中下劃線_
的使用。跟Python中很多用法類似,下劃線_
的不同用法絕大部分(不全是)都是一種慣例約定。
單個下劃線(_
)
主要有三種情況:
1. 直譯器中
_
符號是指互動直譯器中最後一次執行語句的返回結果。這種用法最初出現在CPython直譯器中,其他直譯器後來也都跟進了。
1 2 3 4 5 6 7 8 9 10 11 12 |
>>> _ Traceback (most recent call last): File "", line 1, in NameError: name '_' is not defined >>> 42 >>> _ 42 >>> 'alright!' if _ else ':(' 'alright!' >>> _ 'alright!' |
2. 作為名稱使用
這個跟上面有點類似。_
用作被丟棄的名稱。按照慣例,這樣做可以讓閱讀你程式碼的人知道,這是個不會被使用的特定名稱。舉個例子,你可能無所謂一個迴圈計數的值:
1 2 3 |
n = 42 for _ in range(n): do_something() |
3. i18n
_
還可以被用作函式名。這種情況,單下劃線經常被用作國際化和本地化字串翻譯查詢的函式名。這種慣例好像起源於C語言。舉個例子,在 Django documentation for translation 中你可能會看到:
1 2 3 4 5 6 |
from django.utils.translation import ugettext as _ from django.http import HttpResponse def my_view(request): output = _("Welcome to my site.") return HttpResponse(output) |
第二種和第三種用法會引起衝突,所以在任意程式碼塊中,如果使用了_
作i18n翻譯查詢函式,就應該避免再用作被丟棄的變數名。
單下劃線字首的名稱(例如_shahriar
)
以單下劃線做字首的名稱指定了這個名稱是“私有的”。在 有些 匯入import * 的場景中,下一個使用你程式碼的人(或者你本人)會明白這個名稱僅內部使用。Python documentation裡面寫道:
a name prefixed with an underscore (e.g. _spam) should be treated as a non-public part of the API (whether it is a function, a method or a data member). It should be considered an implementation detail and subject to change without notice.
之所以說在在 有些 import * 的場景,是因為匯入時直譯器確實對單下劃線開頭的名稱做了處理。如果你這麼寫from import *
,任何以單下劃線開頭的名稱都不會被匯入,除非模組/包的__all__
列表明確包含了這些名稱。更多相關資訊見““Importing * in Python”。
雙下劃線字首的名稱(例如__shahriar
)
以雙下劃線做字首的名稱(特別是方法名)並不是一種慣例;它對直譯器有特定含義。Python會改寫這些名稱,以免與子類中定義的名稱產生衝突。Python documentation中提到,任何__spam
這種形式(至少以兩個下劃線做開頭,絕大部分都還有一個下劃線做結尾)的識別符號,都會文字上被替換為_classname__spam
,其中classname
是當前類名,並帶上一個下劃線做字首。
看下面這個例子:
1 2 3 4 5 6 7 8 |
>>> class A(object): ... def _internal_use(self): ... pass ... def __method_name(self): ... pass ... >>> dir(A()) ['_A__method_name', ..., '_internal_use'] |
正如所料,_internal_use
沒有變化,但__method_name
被改寫成了_ClassName__method_name
。現在建立一個A
的子類B
(這可不是個好名字),就不會輕易的覆蓋掉A
中的__method_name
了:
1 2 3 4 5 6 |
>>> class B(A): ... def __method_name(self): ... pass ... >>> dir(B()) ['_A__method_name', '_B__method_name', ..., '_internal_use'] |
這種特定的行為差不多等價於Java中的final
方法和C++中的正常方法(非虛方法)。
前後都帶有雙下劃線的名稱(例如__init__
)
這些是Python的特殊方法名,這僅僅是一種慣例,一種確保Python系統中的名稱不會跟使用者自定義的名稱發生衝突的方式。通常你可以覆寫這些方法,在Python呼叫它們時,產生你想得到的行為。例如,當寫一個類的時候經常會覆寫__init__
方法。
你也可以寫出自己的“特殊方法”名(但是別這麼做):
1 2 3 4 5 6 |
>>> class C(object): ... def __mine__(self): ... pass ... >>> dir(C) ... [..., '__mine__', ...] |
還是不要這樣寫方法名,只讓Python定義的特殊方法名使用這種慣例吧。
hackernews和reddit上的相關討論