Python編碼規範

文章目錄

• Python編碼規範

Python編碼規範縮排

使用4個空格作為第一級縮排。

TAB或空格

不要混合TAB和空格。

最大行長度

最大行長度限制在80個字元內。

空白行

分割頂層函數和類定義使用二個空行。在類裡面的方法定義用一個空行分割。多餘的空行用來分割相關的函數組。使用空行分割邏輯塊。

語句或運算式裡面的空格

x = 1y = 2  

注釋

注釋最好寫英文。與代碼相違背的注釋還不如沒有注釋。如果注釋是一個句子，首字母要大寫。在注釋一個句子結束出加上二個空格。

• 塊注釋

  通過一個#開始,#結束

• 內部注釋

文檔

所有的函數和模組都應該有文檔，範例如下：

def kos_root():    """Return the pathname of the KOS root directory."""    global _kos_root    if _kos_root: return _kos_root    ...def complex(real=0.0, imag=0.0):    """Form a complex number.    Keyword arguments:    real -- the real part (default 0.0)    imag -- the imaginary part (default 0.0)    """    if imag == 0.0 and real == 0.0: return complex_zero    ...  

版本資訊

需要加入原始碼的版本資訊，可以寫下面的代碼：

__version__ = "$Revision: 6104 ___FCKpd___2quot;# $Source$

這段代碼加在模組文檔之後。

模組

模組命名使用小寫，因為模組對應檔案名稱，這樣和檔案的命名規範相一致。

類

類名使用CapWords慣例。在內部使用的類在前面加上底線。

異常名函數

函數名稱使用lower_case_with_underscores命名。

變數

不需要被匯出的變數需要加底線。