Python模組結構和布局,python模組布局
用模組來合理組織你的Python代碼是簡單又自然的方法。你應該建立一種統一且容易閱讀的結構,並將它應用到每一個檔案中去。下面就是一種非常合理的布局:
(1) 起始行(Unix)
(2) 模組文檔
(3) 模組匯入
(4) 變數定義
(5) 類定義
(6) 函數定義
(7) 主程式
是一個典型模組的內部結構圖解。
(1) 起始行
通常只有在類Unix 環境下才使用起始行,有起始行就能夠僅輸入指令碼名字來執行指令碼,無需直接調用解譯器。
(2)模組文檔
簡要介紹模組的功能及重要全域變數的含義,模組外可通過 module.__doc__ 訪問這些內容。
(3)模組匯入
匯入當前模組的代碼需要的所有模組;每個模組僅匯入一次(當前模組被載入時);函數內部的模組匯入代碼不會被執行,除非該函數正在執行。
(4)變數定義
這裡定義的變數為全域變數,本模組中的所有函數都可直接使用。從好的編程風格角度說,除非必須,否則就要盡量使用局部變數代替全域變數,如果堅持這樣做,你的代碼就不但容易維護,而且還可以提高效能並節省記憶體。
(5)類定義語句
所有的類都需要在這裡定義。當模組被匯入時class 語句會被執行, 類也就會被定義。類的文檔變數是class.__doc__。
(6)函數定義語句
此處定義的函數可以通過module.function()在外部被訪問到,當模組被匯入時 def 語句會被執行,函數也就都會定義好,函數的文檔變數是function.__doc__。
(7) 主程式
無論這個模組是被別的模組匯入還是作為指令碼直接執行,都會執行這部分代碼。通常這裡不會有太多功能性代碼,而是根據執行的模式調用不同的函數。
推薦代碼風格:主程式調用main()函數
主程式碼通常都和你前面看到的代碼相似,檢查 __name__ 變數的值然後再執行相應的調用。
主程式中的代碼通常包括變數賦值, 類定義和函數定義,隨後檢查__name__來決定是否調用另一個函數(通常調用main()函數)來完成該模組的功能。
大部分的Python 模組都是用於匯入調用的,直接運行模組應該調用該模組的迴歸測試代碼。