模組化編輯流程

1. 設計API, 進行功能的描述
2. 編碼實現API中的流程
3. 在模組中編寫測試程式碼, 並消除全域性程式碼
4. 使用私有函式實現不被外部客戶端呼叫的模組函式

模組API功能描述的特點

API是用於描述模組中提供的函式和類功能描述和使用方法的描述

模組化描述中, 首先設計的就是模組化API, 然後開始編碼實現API中描述的功能. 最後在其他模組中匯入本模組進行呼叫

我們可以通過help(模組名)檢視模組的API, 一般使用時先匯入模組, 然後通過help函式檢視

也可以在python的api文件中查詢:

1. 首先進入python安裝目錄下的docs子目錄
2. 雙擊開啟chm文件, 即可通過索引輸入math檢視API

Practice: 設計計算薪水的模組API

1 '''本模組用於計算公司員工的薪資'''
2 company = 'Asis'
3 def yearSalary(monthSalary):
4     '''根據傳入月薪計算出年薪'''
5     return monthSalary*12
6 
7 def daySalary(monthSalary):
8     '''根據傳入月薪計算每天薪資'''
9     return monthSalary/22.5

測試:

1 import Python07_7
2 
3 print(Python07_7.__doc__)
4 print
 
(Python07_7.yearSalary.__doc__)

模組的建立和測試程式碼

每個模組都有一個特殊的名稱,通過特殊變數__name__可以獲取模組名稱. 在正常情況下, 模組名稱對應檔名, 當一個模組作為程式入口時, 他的__name__值為__main__, 可以根據這個特點, 將模式原始碼檔案中的測試程式碼進行獨立處理

模組文件字串的API設計

我們可以在模組文件的第一行增加一個字串, 用於描述模組的相關功能, 然後通過__doc__可以獲取文件字串的內容