Python中的底線詳解

這篇文章討論Python中底線_的使用。跟Python中很多用法類似，底線_的不同用法絕大部分（不全是）都是一種慣例約定。

一、 單個底線直接做變數名（_）

主要有三種情況：

1. 解譯器中

_符號是指互動解譯器中最後一次執行語句的返回結果。這種用法最初出現在CPython解譯器中，其他解譯器後來也都跟進了。

代碼如下:

>>> _
Traceback (most recent call last):
File "", line 1, in
NameError: name '_' is not defined
>>> 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 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 C(object):
... def __mine__(self):
... pass
...
>>> dir(C)
... [..., '__mine__', ...]

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

