python的程式基本風格

注釋：簡潔明了的說明對於程式的維護還是比較重要的

 

文檔：通過__doc__特別變數，動態獲得文檔字串，在模組、類聲明、函式宣告中第一個沒有賦值的字串可以用屬性obj.__doc__來訪問，obj為模組、類、函數的名字。

 

縮排：比較流行的縮排方式是，四個空格或者定位字元Tab，代碼若存在跨平台，由於不同的文字編輯器對Tab的設定不一樣，所以盡量不使用Tab。

 

選擇標識符名稱：定義簡短好理解的變數名、模組名是個好習慣。

 

模組結構和布局：

(1) 起始行：通常在unix/linux下使用

(2) 模組文檔：介紹模組功能及其他說明性字串，模組外通過module.__doc__訪問

(3) 模組匯入：import匯入當前模組所需的其他模組

(4) 變數定義：一般在這定義全域變數，若非必須，盡量使用局部變數代替全域變數

(5) 類定義：當模組匯入時class語句被執行，類也會被定義，類文檔變數是class.__doc__

(6) 函數定義：此處定義函數通過module.function()被外部存取，當模組匯入時def語句會被執行，函數會被定義，函數文檔變數是function.__doc__

(7) 主程式：本模組被匯入或直接執行都會調用代碼，一般主程式不會寫功能性代碼，都是調用本程式中的各個函數

 

#!/usr/bin/env python                        (1) 起始行

“this is a test module”                     (2) 模組文檔

import sys                                      
   (3) 模組匯入

import os

debug=True                                   
   (4) 變數定義

 

class Fooclass (object):                  
(5) 類定義

        “Foo class”

        pass

 

def test():                                            
  (6) 函數定義

        “test function”

        foo=Fooclass()

        if debug:

                  print ‘ran test()’

 

if __name__==’__main__’:               (7) 主程式

        test()

 

__name__指示模組如何被載入：

如果模板是被匯入，__name__的值為模組名字；

如果模組是被直接執行，__name__的值為’__name__’