詳解 Python 中的下划線命名規則


在 python 中,下划線命名規則往往令初學者相當 疑惑:單下划線、雙下划線、雙下划線還分前后……那它們的作用與使用場景 到底有何區別呢?今天 就來聊聊這個話題。

1、單下划線(_)

通常情況下,單下划線(_)會在以下3種場景中使用:

1.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!'

1.2 作為一個名稱:

這與上面一點稍微有些聯系,此時“_”作為臨時性的名稱使用。這樣,當其他人閱讀你的代碼時將會知道,你分配了一個特定的名稱,但是並不會在后面再次用到該名稱。例如,下面的例子中,你可能對循環計數中的實際值並不感興趣,此時就可以使用“_”。

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

1. 3 國際化:

也許你也曾看到”_“會被作為一個函數來使用。這種情況下,它通常用於實現國際化和本地化字符串之間翻譯查找的函數名稱,這似乎源自並遵循相應的C約定。例如,在 Django文檔“轉換”章節 中,你將能看到如下代碼:

from django.utils.translation import ugettext as _ from django.http import HttpResponse def my_view(request): output = _("Welcome to my site.") return HttpResponse(output)

可以發現,場景二和場景三中的使用方法可能會相互沖突,所以我們需要避免在使用“_”作為國際化查找轉換功能的代碼塊中同時使用“_”作為臨時名稱。

2、名稱前的單下划線(如:_shahriar)

程序員使用名稱前的單下划線,用於指定該名稱屬性為“私有”。這有點類似於慣例,為了使其他人(或你自己)使用這些代碼時將會知道以“_”開頭的名稱只供內部使用。正如Python文檔中所述:

以下划線“_”為前綴的名稱(如_spam)應該被視為API中非公開的部分(不管是函數、方法還是數據成員)。此時,應該將它們看作是一種實現細節,在修改它們時無需對外部通知。

正如上面所說,這確實類似一種慣例,因為它對解釋器來說確實有一定的意義,如果你寫了代碼“from <模塊/包名> import *”,那么以“_”開頭的名稱都不會被導入, 除非模塊或包中的“__all__”列表顯式地包含了它們 。了解更多請查看“ Importing * in Python ”。

不過值得注意的是,如果使用 import a_module 這樣導入模塊,仍然可以用 a_module._some_var 這樣的形式訪問到這樣的對象。

另外單下划線開頭還有一種一般不會用到的情況在於使用一個 C 編寫的擴展庫有時會用下划線開頭命名,然后使用一個去掉下划線的 Python 模塊進行包裝。如 struct 這個模塊實際上是 C 模塊 _struct 的一個 Python 包裝。

3、名稱前的雙下划線(如:__shahriar)

名稱(具體為一個方法名)前雙下划線(__)的用法並不是一種慣例,對解釋器來說它有特定的意義。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”:__開頭 的 私有變量會在代碼生成之前被轉換為長格式(變為公有)。轉換機制是這樣的:在變量前端插入類名,再在前端加入一個下划線字符。這就是所謂的私有變量 名字改編 (Private name mangling) 。

此時,如果你創建A的一個子類B,那么你將不能輕易地覆寫A中的方法“__method_name”,

>>> class B(A): ... def __method_name(self): ... pass ... >>> dir(B()) ['_A__method_name', '_B__method_name', ..., '_internal_use']

 

然而如果你知道了這個規律,最終你還是可以訪問這個“私有”變量的。

私有變量名字改編意在給出一個在類中定義"私有"實例變量和方法的簡單途徑,避免派生類的實例變量定義產生問題,或者與外界代碼中的變量搞混。

要注意的是混淆規則(私有變量名字改編)主要目的在於避免意外錯誤,被認作為私有的變量仍然有可能被訪問或修改(使用_classname__membername),在特定的場合它也是有用的,比如調試的時候。

上述的功能幾乎和Java中的final方法和C++類中標准方法(非虛方法)一樣。

再講兩點題外話:

一是因為軋壓(改編)會使標識符變長,當超過255的時候,Python會切斷,要注意因此引起的命名沖突。

二是當類名全部以下划線命名的時候,Python就不再執行軋壓(改編)。

無論是單下划線還是雙下划線開頭的成員,都是希望外部程序開發者不要直接使用這些成員變量和這些成員函數,只是雙下划線從語法上能夠更直接的避 免錯誤的使用,但是如果按照 _類名__成員名 則依然可以訪問到。單下划線的在動態調試時可能會方便一些,只要項目組的人都遵守下划線開頭的成員不直接使用,那使用單下划線或許會更好。

4、名稱前后的雙下划線(如:__init__)

這種用法表示Python中特殊的方法名。其實,這只是一種慣例,對Python系統來說,這將確保不會與用戶自定義的名稱沖突。通常,你將會 覆寫這些方法,並在里面實現你所需要的功能,以便Python調用它們。例如,當定義一個類時,你經常會覆寫“__init__”方法。

雙下划線開頭雙下划線結尾的是一些 Python 的“魔術”對象,如類成員的 __init__、__del__、__add__、__getitem__ 等,以及全局的 __file__、__name__ 等。 Python 官方推薦永遠不要將這樣的命名方式應用於自己的變量或函數,而是按照文檔說明來使用。 雖然你也可以編寫自己的特殊方法名,但不要這樣做。

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

其實,很容易擺脫這種類型的命名,而只讓Python內部定義的特殊名稱遵循這種約定 :)

5、題外話 if __name__ == "__main__":

所有的 Python 模塊都是對象並且有幾個有用的屬性,你可以使用這些屬性方便地測試你所書寫的模塊。

模塊是對象, 並且所有的模塊都有一個內置屬性 __name__。一個模塊的 __name__ 的值要看您如何應用模塊。如果 import 模塊, 那么 __name__的值通常為模塊的文件名, 不帶路徑或者文件擴展名。但是您也可以像一個標准的程序一樣直接運行模塊, 在這種情況下 __name__的值將是一個特別的缺省值:__main__。

>>> import odbchelper >>> odbchelper.__name__ 'odbchelper'

一旦了解到這一點, 您可以在模塊內部為您的模塊設計一個測試套件, 在其中加入這個 if 語句。當您直接運行模塊, __name__ 的值是 __main__, 所以測試套件執行。當您導入模塊, __name__的值就是別的東西了, 所以測試套件被忽略。這樣使得在將新的模塊集成到一個大程序之前開發和調試容易多了。

在 MacPython 上, 需要一個額外的步聚來使得 if __name__ 技巧有效。 點擊窗口右上角的黑色三角, 彈出模塊的屬性菜單, 確認 Run as __main__ 被選中。

6、總結:

Python 用下划線作為變量前綴和后綴指定特殊變量。

_xxx       不能用'from module import *'導入

__xxx__  系統定義名字

__xxx     類中的私有變量名

核心風格:避免用下划線作為變量名的開頭。

因為下划線對解釋器有特殊的意義,而且是內建標識符所使用的符號,我們建議程序員避免用下划線作為變量名的開頭。一般來講,變量名_xxx被看作是“私有的”,在模塊或類外不可以使用。當變量是私有的時候,用_xxx 來表示變量是很好的習慣。 因為變量名__xxx__對Python 來說有特殊含義,對於普通的變量應當避免這種命名風格。

"單下划線" 開始的成員變量叫做保護變量,意思是只有類對象和子類對象自己能訪問到這些變量;

"雙下划線" 開始的是私有成員,意思是只有類對象自己能訪問,連子類對象也不能訪問到這個數據。

以單下划線開頭(如_foo)的代表不能直接訪問的類屬性,需通過類提供的接口進行訪問,不能用“from xxx import *”而導入;以雙下划線開頭的(如__foo)代表類的私有成員;以雙下划線開頭和結尾的(__foo__)代表python里特殊方法專用的標識,如 __init__() 代表類的構造函數。

附 PEP 規范:

PEP-0008: In addition, the following special forms using leading or trailing underscores are recognized (these can generally be combined with any case convention):  - _single_leading_underscore: weak "internal use" indicator. E.g. "from M import *" does not import objects whose name starts with an underscore.  - single_trailing_underscore_: used by convention to avoid conflicts with Python keyword, e.g.  Tkinter.Toplevel(master, class_='ClassName')  - __double_leading_underscore: when naming a class attribute, invokes name mangling (inside class FooBar, __boo becomes _FooBar__boo; see below).  - __double_leading_and_trailing_underscore__: "magic" objects or attributes that live in user-controlled namespaces. E.g. __init__,  __import__ or __file__. Never invent such names; only use them as documented. 

7、Refer:

[1]  Importing `*` in Python

http://shahriar.svbtle.com/importing-star-in-python

[2]  理解Python的雙下划線命名

http://blog.csdn.net/zhu_liangwei/article/details/7667745

[3]  Python 的類的下划線命名有什么不同?

http://www.zhihu.com/question/19754941


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM