剛開始學Python的你一定很疑惑,爲什麼Python裏會出現各種各樣的下劃線 “_”,而且位置都不相同,有時候在名稱後面,有時候在前面,有時候還會在數字中間......這些下劃線都分別代表了什麼意思?本文就給大家普及普及。
在本文中,我們將介紹 Python 中 _ 字符的不同用法。就像 Python 中的許多其他內容一樣,我們會看到 “_” 的不同用法主要是慣例問題。這裏我們將介紹的五種不同情況:
- 單下劃線(例如 _)
- 名稱前加一個下劃線(例如 _total)
- 名稱後加一個下劃線(例如 total_)
- 數字文字中的單個下劃線(例如 100_000)
- 名稱前加上雙下劃線(例如 __total)
- 名稱前後加雙下劃線(例如 __init__)
一.單下劃線(_)
單下劃線通常在3種情況下使用:
1.在解析程序中
_名稱指向交互式解釋器會話中,最後執行的語句結果。這首先是由標準CPython解釋器完成的,其他解析器也緊隨其後。
>>> _
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
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文檔中所見:
from django.http import HttpResponse
from django.utils.translation import gettext as _
def my_view(request):
output = _("Welcome to my site.")
return HttpResponse(output)
第二個和第三個用法可能會發生衝突,因此,在任何還將 _ 用作 i18n 查找和翻譯的代碼塊中,都應避免使用 _ 作爲一次性使用的名稱。
二.名稱前加單下劃線(例如_total)
名稱前的單個下劃線用於指定程序員將名稱視爲“私有”。這可以視爲一種約定,方便閱讀代碼的人知道以 _ 開頭的名稱供內部使用。 正如Python文檔所述:
帶有下劃線的名稱(例如 _spam)應被視爲 API 的非公開部分(無論是函數、方法還是數據成員)。它應被視爲實現細節,如有更改,恕不另行通知。
*之所以說是一種約定,是因爲它實際上對解析程序而言有着某種意義;如果我們從 <module / package> import *,除非以模塊/軟件包的 __all__ 列表明確包含它們,否則不會導入以 _ 開頭的名稱。
三. 名稱後的單下劃線(例如 total_)
名稱後面的單個下劃線用於避免名稱遮蓋另一個名稱,當然是慣例。例如,如果你想命名某種格式,爲了避免掩蓋 Python 的內置格式,你可以將其命名爲 format_。
四. 數字字面中的單下劃線(例如 100_000)
PEP 515 指數建議擴展 Python 的語法,以便下劃線可以用作整體、浮點和複雜數字文本中數字分組的可視分隔符,理由是:
這是其他現代語言的常見特徵,可以幫助提高較長的文字或文本的可讀性,其值應清楚地分隔成部分,如字節或十六進制表示法中的單詞。
因此,我們可以執行以下操作::
# 十進制數按千分組
amount = 10_000_000.0
# 按字對十六進制地址進行分組
addr = 0xCAFE_F00D
# 用二進制文字將位分組爲半字節
flags = 0b_0011_1111_0100_1110
#相同,用於字符串轉換
flags = int('0b_1111_0000', 2)
五. 姓名前的雙下劃線(例如__total)
在名稱(特別是方法名稱)前使用雙下劃線(__)不是約定,只是對解析程序有特殊的意義。Python 管理這些名稱,它用於避免名稱與子類定義的名稱衝突。正如Python文檔所指出的那樣,任何形式爲__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中的最終方法和C ++中的常規(非虛擬)方法。
六. 在名稱之前和之後加上雙下劃線(例如__init__)
這些是 Python 使用的特殊方法名稱。對於我們來說,這只是一個約定,即 Python 系統使用與用戶定義的名稱不衝突的名稱的一種方式。然後,我們通常會覆蓋這些方法併爲 Python 調用它們時定義所需的行爲。例如,在編寫類時__init__重寫方法。
沒有什麼可以阻止我們編寫自己的特殊方法名稱(但是最好別這麼做):
>>> class C(object):
... def __mine__(self):
... pass
...
>>> dir(C)
... [..., '__mine__', ...]
儘量不要使用這種命名方式,只需要讓Python定義的特殊名稱遵循該約定即可。
參考鏈接:
Django官方文檔:https://docs.djangoproject.com/en/dev/topics/i18n/translation/
Python官方文檔:https://docs.python.org/3/tutorial/classes.html#private-variables
PEP515:https://www.python.org/dev/peps/pep-0515/
--END--