Python中的下劃線（譯文）

原文地址
這篇文章討論Python中下劃線_的使用。跟Python中不少用法相似，下劃線_的不一樣用法絕大部分（不全是）都是一種慣例約定。

單個下劃線（_）

主要有三種狀況：

1. 解釋器中

_符號是指交互解釋器中最後一次執行語句的返回結果。這種用法最初出如今CPython解釋器中，其餘解釋器後來也都跟進了。

>>> _
Traceback (most recent call last):
  File "", line 1, in 
NameError: name '_' is not defined
>>> 42
>>> _
42
>>> 'alright!' if _ else ':('
'alright!'
>>> _
'alright!'

2. 做爲名稱使用

這個跟上面有點相似。_用做被丟棄的名稱。按照慣例，這樣作可讓閱讀你代碼的人知道，這是個不會被使用的特定名稱。舉個例子，你可能無所謂一個循環計數的值：

n = 42
for _ in range(n):
    do_something()

3. i18n

_還能夠被用做函數名。這種狀況，單下劃線常常被用做國際化和本地化字符串翻譯查詢的函數名。這種慣例好像起源於C語言。舉個例子，在 Django documentation for translation 中你可能會看到：

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 <module/package> import *，任何以單下劃線開頭的名稱都不會被導入，除非模塊/包的__all__列代表確包含了這些名稱。更多相關信息見「「Importing * in Python」。

雙下劃線前綴的名稱（例如__shahriar）

以雙下劃線作前綴的名稱（特別是方法名）並非一種慣例；它對解釋器有特定含義。Python會改寫這些名稱，以避免與子類中定義的名稱產生衝突。Python documentation中提到，任何__spam這種形式（至少以兩個下劃線作開頭，絕大部分都還有一個下劃線作結尾）的標識符，都會文本上被替換爲_classname__spam，其中classname是當前類名，並帶上一個下劃線作前綴。
看下面這個例子：

>>> 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了：

>>> 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__方法。
你也能夠寫出本身的「特殊方法」名（可是別這麼作）：

>>> class C(object):
...     def __mine__(self):
...         pass
...
>>> dir(C)
... [..., '__mine__', ...]

仍是不要這樣寫方法名，只讓Python定義的特殊方法名使用這種慣例吧。

---

hackernews和reddit上的相關討論