Python - 命名規範

一，套件名稱、模組名稱、局部變數名稱、函式名稱

全小寫+下劃線式駝峰

example：this_is_var

二，全域變數

ampleVACALCALC起區駝線式駝電

，類別名稱

首字母大寫式駝峰

example：ClassName()

四，關於下劃線

以單下劃線開頭，是弱內部使用標識，from M import * 時，將不會導入該物件（python一切皆對象）。

以雙下劃線開頭的變數名，主要用於類別內部識別類別私有，不能直接存取。模組中使用見上一條。

雙底線開頭且雙底線截尾的命名方法盡量不要用，這是標識

example for 1：

module_1 模組中定義變數var_1, _var_2, __var_3

__var_3

module_2 模組中程式碼如下：

#module_2_error
 '''
 以下划线开头的变量不会别导入
 '''
  from module_1 import *
    
  print var_1
  print _var_2  #将报错
  print __var_3  #将报错

   

執行到第6，7行將會報錯線。

既然是弱內部使用標識，就還是有使用辦法的，只需單獨導入即可：

#module_2_solution
   
 from module_1 import *  # 导入所有的不是下划线开头的对象
   
 from module_1 import _var_2, __var_3 # 显式导入下划线开头的对象
   
 print var_1
 print _var_2 # 不会报错
 print __var_3  # 不会报错

   

example for 2:

需要定義函數來取得雙底線開頭的變數

#module_error
 '''
 双下划线开头的变量不能被直接访问
 '''
   
 class MyClass():
     def __init__(self):
         self.var_1 = 1
         self._var_2 = 2
         self.__var_3 = 3
       
 if __name__=="__main__":
     obj = MyClass()
     print obj.var_1
     print obj._var_2
     print obj.__var_3  # 这里将会出错

   

四，其他要注意的

不要像cth等語言裡面一樣去用開頭字母來識別變數類型（如同在才確定類型。

因為異常也是一個類，所以遵守類別的命名規則。此外，如果異常實際上指涉一個錯誤的話，應該使用「Error」做後綴。

命名應當盡量使用全拼寫的單詞，縮寫的情況有以下兩種：常用的縮寫，如XML、ID等，在命名時也應隻大寫首字母，如XmlParser。命名中含有長單字，對某個單字進行縮寫。這時應使用約定成俗的縮寫方式。例如：function 縮寫為 fn, text 縮寫為 txt, object 縮寫為 obj, count 縮寫為 cnt, number 縮寫為 num 等。

類別實例方法第一個參數使用self, 類別方法第一個參數使用cls