Python變量命名規范

模塊名： 
小寫字母，單詞之間用_分割 
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() 
       def __private(self): 
              print 'C.__private()' 
       def public(self): 
              print 'C.public()' 
>>> c = C() 
C.__private() 
C.public() 
############################ 
>>> class A(object): 
       def __init__(self): 
              self._A__private()   # 調用一個沒有定義的函數，Python會把它給我的 ^_^～ 
              self.public() 
       def __private(self): 
              print 'A.__private()' 
       def public(self): 
              print 'A.public()' 
>>>a = A() 
A.__private() 
A.public()