python中的命名規範
阿新 • • 發佈：2019-01-03
模組名：
小寫字母，單詞之間用_分割
ad_stats.py
包名：
和模組名一樣
類名：
單詞首字母大寫
AdStats
ConfigUtil
全域性變數名（類變數，在java中相當於static變數）：
大寫字母，單詞之間用_分割
NUMBER
COLOR_WRITE
普通變數：
小寫字母，單詞之間用_分割
this_is_a_var
例項變數：
以_開頭，其他和普通變數一樣
_price
_instance_var
私有例項變數（外部訪問會報錯）：
以__開頭（2個下劃線），其他和普通變數一樣
__private_var
專有變數：
__開頭，__結尾，一般為python的自有變數，不要以這種方式命名
__doc__
__class__
普通函式：
和普通變數一樣：
get_name()
count_number()
ad_stat()
私有函式（外部訪問會報錯）：
以__開頭（2個下劃線），其他和普通函式一樣
__get_name()
————————————————————————————————————————————————————————————————————
檔名
全小寫,可使用下劃線
包
應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。
模組
與包的規範同。如mymodule。
類
總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下劃線。
函式&方法
函式名應該為小寫，可以用下劃線風格單詞以增加可讀性。如：myfunction，my_example_function。
*注意*：混合大小寫僅被允許用於這種風格已經佔據優勢的時候，以便保持向後相容。
函式和方法的引數
總使用“self”作為例項方法的第一個引數。總使用“cls”作為類方法的第一個引數。
如果一個函式的引數名稱和保留的關鍵字衝突，通常使用一個字尾下劃線好於使用縮寫或奇怪的拼寫。
全域性變數
對於from M import *匯入語句，如果想阻止匯入模組內的全域性變數可以使用舊有的規範，在全域性變數上加一個前導的下劃線。
*注意*:應避免使用全域性變數
變數
變數名全部小寫，由下劃線連線各個單詞。如color = WHITE，this_is_a_variable = 1
*注意*：
1.不論是類成員變數還是全域性變數，均不使用 m 或 g 字首。
2.私有類成員使用單一下劃線字首標識，多定義公開成員，少定義私有成員。
3.變數名不應帶有型別資訊，因為Python是動態型別語言。如 iValue、names_list、dict_obj 等都是不好的命名。
常量
常量名所有字母大寫，由下劃線連線各個單詞如MAX_OVERFLOW，TOTAL。
異常
以“Error”作為字尾。
縮寫
命名應當儘量使用全拼寫的單詞，縮寫的情況有如下兩種：
1.常用的縮寫，如XML、ID等，在命名時也應只大寫首字母，如XmlParser。
2.命名中含有長單詞，對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如：
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num，等。
前導字尾下劃線
一個前導下劃線：表示非公有。
一個字尾下劃線：避免關鍵字衝突。
兩個前導下劃線：當命名一個類屬性引起名稱衝突時使用。
兩個前導和字尾下劃線：“魔”（有特殊用途）物件或者屬性，例如__init__或者__file__。絕對不要創造這樣的名字，而只是使用它們。
*注意*：關於下劃線的使用存在一些爭議。
Python 用下劃線作為變數字首和字尾指定特殊變數。
_xxx 不能用'from module import *'匯入
__xxx__ 系統定義名字
__xxx 類中的私有變數名
核心風格：避免用下劃線作為變數名的開始。
因為下劃線對直譯器有特殊的意義，而且是內建識別符號所使用的符號，我們建議程式設計師避免用下劃線作為變數名的開始。一般來講，變數名_xxx被看作是“私有的”，在模組或類外不可以使用。當變數是私有的時候，用_xxx 來表示變數是很好的習慣。因為變數名__xxx__對Python 來說刑厥夂澹雜諂脹ǖ謀淞坑Φ北苊庹庵置綹瘛?br>
"單下劃線" 開始的成員變數叫做保護變數，意思是隻有類物件和子類物件自己能訪問到這些變數；
"雙下劃線" 開始的是私有成員，意思是隻有類物件自己能訪問，連子類物件也不能訪問到這個資料。
以單下劃線開頭（_foo）的代表不能直接訪問的類屬性，需通過類提供的介面進行訪問，不能用“from xxx import *”而匯入；以雙下劃線開頭的（__foo）代表類的私有成員；以雙下劃線開頭和結尾的（__foo__）代表python裡特殊方法專用的標識，如 __init__（）代表類的建構函式。
特定命名方式
主要是指 __xxx__ 形式的系統保留字命名法。專案中也可以使用這種命名，它的意義在於這種形式的變數是隻讀的，這種形式的類成員函式儘量不要過載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。
附:Google Python命名規範
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.
————————————————————————————————————————————————————————
from：http://hi.baidu.com/kxw102/blog/item/212e9f3859202fe33b87ce4b.html
理解Python命名機制
引子
我熱情地邀請大家猜測下面這段程式的輸出：
class A(object):
def __init__(self):
self.__private()
self.public()
def __private(self):
print 'A.__private()'
def public(self):
print 'A.public()'
class B(A):
def __private(self):
print 'B.__private()'
def public(self):
print 'B.public()'
b = B()
初探
正確的答案是：
A.__private()
B.public()
如果您已經猜對了，那麼可以不看我這篇博文了。如果你沒有猜對或者心裡有所疑問，那我的這篇博文正是為您所準備的。
一切由為什麼會輸出“A.__private()”開始。但要講清楚為什麼，我們就有必要了解一下Python的命名機制。
據 Python manual，變數名（識別符號）是Python的一種原子元素。當變數名被繫結到一個物件的時候，變數名就指代這個物件，就像人類社會一樣，不是嗎？當變 量名出現在程式碼塊中，那它就是本地變數；當變數名出現在模組中，它就是全域性變數。模組相信大家都有很好的理解，但程式碼塊可能讓人費解些。在這裡解釋一下：
程式碼塊就是可作為可執行單元的一段Python程式文字；模組、函式體和類定義都是程式碼塊。不僅如此，每一個互動指令碼命令也是一個程式碼塊；一個指令碼檔案也是一個程式碼塊；一個命令列指令碼也是一個程式碼塊。
接 下來談談變數的可見性，我們引入一個範圍的概念。範圍就是變數名在程式碼塊的可見性。如果一個程式碼塊裡定義本地變數，那範圍就包括這個程式碼塊。如果變數定義 在一個功能程式碼塊裡，那範圍就擴充套件到這個功能塊裡的任一程式碼塊，除非其中定義了同名的另一變數。但定義在類中的變數的範圍被限定在類程式碼塊，而不會擴充套件到 方法程式碼塊中。
迷蹤
據上節的理論，我們可以把程式碼分為三個程式碼塊：類A的定義、類B的定義和變數b的定義。根據類定義，我們知道程式碼給類A定義了三個成員變數（Python的函式也是物件，所以成員方法稱為成員變數也行得通。）；類B定義了兩個成員變數。這可以通過以下程式碼驗證：
>>> print '\n'.join(dir(A))
_A__private
__init__
public
>>> print '\n'.join(dir(B))
_A__private
_B__private
__init__
public
咦，為什麼類A有個名為_A__private的 Attribute 呢？而且__private消失了！這就要談談Python的私有變數軋壓了。
探究
懂 Python的朋友都知道Python把以兩個或以上下劃線字元開頭且沒有以兩個或以上下劃線結尾的變數當作私有變數。私有變數會在程式碼生成之前被轉換為 長格式（變為公有）。轉換機制是這樣的：在變數前端插入類名，再在前端加入一個下劃線字元。這就是所謂的私有變數軋壓（Private name mangling）。如類A裡的__private識別符號將被轉換為_A__private，這就是上一節出現_A__private和 __private消失的原因了。
再講兩點題外話：
一是因為軋壓會使識別符號變長，當超過255的時候，Python會切斷，要注意因此引起的命名衝突。
二是當類名全部以下劃線命名的時候，Python就不再執行軋壓。如：
>>> class ____(object):
def __init__(self):
self.__method()
def __method(self):
print '____.__method()'
>>> print '\n'.join(dir(____))
__class__
__delattr__
__dict__
__doc__
__getattribute__
__hash__
__init__
__method # 沒被軋壓
__module__
__new__
__reduce__
__reduce_ex__
__repr__
__setattr__
__str__
__weakref__
>>> obj = ____()
____.__method()
>>> obj.__method() # 可以外部呼叫
____.__method()
現在我們回過頭來看看為什麼會輸出“A.__private()”吧！
真相
相信現在聰明的讀者已經猜到答案了吧？如果你還沒有想到，我給你個提示：真相跟C語言裡的巨集預處理差不多。
因為類A定義了一個私有成員函式（變數），所以在程式碼生成之前先執行私有變數軋壓（注意到上一節標紅的那行字沒有？）。軋壓之後，類A的程式碼就變成這樣了：
class A(object):
def __init__(self):
self._A__private() # 這行變了
self.public()
def _A__private(self): # 這行也變了
print 'A.__private()'
def public(self):
print 'A.public()'
是不是有點像C語言裡的巨集展開啊？
因為在類B定義的時候沒有覆蓋__init__方法，所以呼叫的仍然是A.__init__，即執行了self._A__private()，自然輸出“A.__private()”了。
下面的兩段程式碼可以增加說服力，增進理解：
>>> class C(A):
def __init__(self): # 重寫__init__，不再呼叫self._A__private
self.__private() # 這裡繫結的是_C_private
self.public()
小寫字母，單詞之間用_分割
ad_stats.py
包名：
和模組名一樣
類名：
單詞首字母大寫
AdStats
ConfigUtil
全域性變數名（類變數，在java中相當於static變數）：
大寫字母，單詞之間用_分割
NUMBER
COLOR_WRITE
普通變數：
小寫字母，單詞之間用_分割
this_is_a_var
例項變數：
以_開頭，其他和普通變數一樣
_price
_instance_var
私有例項變數（外部訪問會報錯）：
以__開頭（2個下劃線），其他和普通變數一樣
__private_var
專有變數：
__開頭，__結尾，一般為python的自有變數，不要以這種方式命名
__doc__
__class__
普通函式：
和普通變數一樣：
get_name()
count_number()
ad_stat()
私有函式（外部訪問會報錯）：
以__開頭（2個下劃線），其他和普通函式一樣
__get_name()
————————————————————————————————————————————————————————————————————
檔名
全小寫,可使用下劃線
包
應該是簡短的、小寫的名字。如果下劃線可以改善可讀性可以加入。如mypackage。
模組
與包的規範同。如mymodule。
類
總是使用首字母大寫單詞串。如MyClass。內部類可以使用額外的前導下劃線。
函式&方法
函式名應該為小寫，可以用下劃線風格單詞以增加可讀性。如：myfunction，my_example_function。
*注意*：混合大小寫僅被允許用於這種風格已經佔據優勢的時候，以便保持向後相容。
函式和方法的引數
總使用“self”作為例項方法的第一個引數。總使用“cls”作為類方法的第一個引數。
如果一個函式的引數名稱和保留的關鍵字衝突，通常使用一個字尾下劃線好於使用縮寫或奇怪的拼寫。
全域性變數
對於from M import *匯入語句，如果想阻止匯入模組內的全域性變數可以使用舊有的規範，在全域性變數上加一個前導的下劃線。
*注意*:應避免使用全域性變數
變數
變數名全部小寫，由下劃線連線各個單詞。如color = WHITE，this_is_a_variable = 1
*注意*：
1.不論是類成員變數還是全域性變數，均不使用 m 或 g 字首。
2.私有類成員使用單一下劃線字首標識，多定義公開成員，少定義私有成員。
3.變數名不應帶有型別資訊，因為Python是動態型別語言。如 iValue、names_list、dict_obj 等都是不好的命名。
常量
常量名所有字母大寫，由下劃線連線各個單詞如MAX_OVERFLOW，TOTAL。
異常
以“Error”作為字尾。
縮寫
命名應當儘量使用全拼寫的單詞，縮寫的情況有如下兩種：
1.常用的縮寫，如XML、ID等，在命名時也應只大寫首字母，如XmlParser。
2.命名中含有長單詞，對某個單詞進行縮寫。這時應使用約定成俗的縮寫方式。
例如：
function 縮寫為 fn
text 縮寫為 txt
object 縮寫為 obj
count 縮寫為 cnt
number 縮寫為 num，等。
前導字尾下劃線
一個前導下劃線：表示非公有。
一個字尾下劃線：避免關鍵字衝突。
兩個前導下劃線：當命名一個類屬性引起名稱衝突時使用。
兩個前導和字尾下劃線：“魔”（有特殊用途）物件或者屬性，例如__init__或者__file__。絕對不要創造這樣的名字，而只是使用它們。
*注意*：關於下劃線的使用存在一些爭議。
Python 用下劃線作為變數字首和字尾指定特殊變數。
_xxx 不能用'from module import *'匯入
__xxx__ 系統定義名字
__xxx 類中的私有變數名
核心風格：避免用下劃線作為變數名的開始。
因為下劃線對直譯器有特殊的意義，而且是內建識別符號所使用的符號，我們建議程式設計師避免用下劃線作為變數名的開始。一般來講，變數名_xxx被看作是“私有的”，在模組或類外不可以使用。當變數是私有的時候，用_xxx 來表示變數是很好的習慣。因為變數名__xxx__對Python 來說刑厥夂澹雜諂脹ǖ謀淞坑Φ北苊庹庵置綹瘛?br>
"單下劃線" 開始的成員變數叫做保護變數，意思是隻有類物件和子類物件自己能訪問到這些變數；
"雙下劃線" 開始的是私有成員，意思是隻有類物件自己能訪問，連子類物件也不能訪問到這個資料。
以單下劃線開頭（_foo）的代表不能直接訪問的類屬性，需通過類提供的介面進行訪問，不能用“from xxx import *”而匯入；以雙下劃線開頭的（__foo）代表類的私有成員；以雙下劃線開頭和結尾的（__foo__）代表python裡特殊方法專用的標識，如 __init__（）代表類的建構函式。
特定命名方式
主要是指 __xxx__ 形式的系統保留字命名法。專案中也可以使用這種命名，它的意義在於這種形式的變數是隻讀的，這種形式的類成員函式儘量不要過載。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都採用了系統保留字命名法。
附:Google Python命名規範
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.
————————————————————————————————————————————————————————
from：http://hi.baidu.com/kxw102/blog/item/212e9f3859202fe33b87ce4b.html
理解Python命名機制
引子
我熱情地邀請大家猜測下面這段程式的輸出：
class A(object):
def __init__(self):
self.__private()
self.public()
def __private(self):
print 'A.__private()'
def public(self):
print 'A.public()'
class B(A):
def __private(self):
print 'B.__private()'
def public(self):
print 'B.public()'
b = B()
初探
正確的答案是：
A.__private()
B.public()
如果您已經猜對了，那麼可以不看我這篇博文了。如果你沒有猜對或者心裡有所疑問，那我的這篇博文正是為您所準備的。
一切由為什麼會輸出“A.__private()”開始。但要講清楚為什麼，我們就有必要了解一下Python的命名機制。
據 Python manual，變數名（識別符號）是Python的一種原子元素。當變數名被繫結到一個物件的時候，變數名就指代這個物件，就像人類社會一樣，不是嗎？當變 量名出現在程式碼塊中，那它就是本地變數；當變數名出現在模組中，它就是全域性變數。模組相信大家都有很好的理解，但程式碼塊可能讓人費解些。在這裡解釋一下：
程式碼塊就是可作為可執行單元的一段Python程式文字；模組、函式體和類定義都是程式碼塊。不僅如此，每一個互動指令碼命令也是一個程式碼塊；一個指令碼檔案也是一個程式碼塊；一個命令列指令碼也是一個程式碼塊。
接 下來談談變數的可見性，我們引入一個範圍的概念。範圍就是變數名在程式碼塊的可見性。如果一個程式碼塊裡定義本地變數，那範圍就包括這個程式碼塊。如果變數定義 在一個功能程式碼塊裡，那範圍就擴充套件到這個功能塊裡的任一程式碼塊，除非其中定義了同名的另一變數。但定義在類中的變數的範圍被限定在類程式碼塊，而不會擴充套件到 方法程式碼塊中。
迷蹤
據上節的理論，我們可以把程式碼分為三個程式碼塊：類A的定義、類B的定義和變數b的定義。根據類定義，我們知道程式碼給類A定義了三個成員變數（Python的函式也是物件，所以成員方法稱為成員變數也行得通。）；類B定義了兩個成員變數。這可以通過以下程式碼驗證：
>>> print '\n'.join(dir(A))
_A__private
__init__
public
>>> print '\n'.join(dir(B))
_A__private
_B__private
__init__
public
咦，為什麼類A有個名為_A__private的 Attribute 呢？而且__private消失了！這就要談談Python的私有變數軋壓了。
探究
懂 Python的朋友都知道Python把以兩個或以上下劃線字元開頭且沒有以兩個或以上下劃線結尾的變數當作私有變數。私有變數會在程式碼生成之前被轉換為 長格式（變為公有）。轉換機制是這樣的：在變數前端插入類名，再在前端加入一個下劃線字元。這就是所謂的私有變數軋壓（Private name mangling）。如類A裡的__private識別符號將被轉換為_A__private，這就是上一節出現_A__private和 __private消失的原因了。
再講兩點題外話：
一是因為軋壓會使識別符號變長，當超過255的時候，Python會切斷，要注意因此引起的命名衝突。
二是當類名全部以下劃線命名的時候，Python就不再執行軋壓。如：
>>> class ____(object):
def __init__(self):
self.__method()
def __method(self):
print '____.__method()'
>>> print '\n'.join(dir(____))
__class__
__delattr__
__dict__
__doc__
__getattribute__
__hash__
__init__
__method # 沒被軋壓
__module__
__new__
__reduce__
__reduce_ex__
__repr__
__setattr__
__str__
__weakref__
>>> obj = ____()
____.__method()
>>> obj.__method() # 可以外部呼叫
____.__method()
現在我們回過頭來看看為什麼會輸出“A.__private()”吧！
真相
相信現在聰明的讀者已經猜到答案了吧？如果你還沒有想到，我給你個提示：真相跟C語言裡的巨集預處理差不多。
因為類A定義了一個私有成員函式（變數），所以在程式碼生成之前先執行私有變數軋壓（注意到上一節標紅的那行字沒有？）。軋壓之後，類A的程式碼就變成這樣了：
class A(object):
def __init__(self):
self._A__private() # 這行變了
self.public()
def _A__private(self): # 這行也變了
print 'A.__private()'
def public(self):
print 'A.public()'
是不是有點像C語言裡的巨集展開啊？
因為在類B定義的時候沒有覆蓋__init__方法，所以呼叫的仍然是A.__init__，即執行了self._A__private()，自然輸出“A.__private()”了。
下面的兩段程式碼可以增加說服力，增進理解：
>>> class C(A):
def __init__(self): # 重寫__init__，不再呼叫self._A__private
self.__private() # 這裡繫結的是_C_private
self.public()