python軟體目錄結構規範

標籤：檔案   功能   安裝   執行   目錄結構   時間   原始碼   維護   strong   

軟體目錄結構規範軟體開發規範一、為什麼要設計好目錄結構?

1.可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結構，知道程式啟動指令碼是哪個，測試目錄在哪兒，設定檔在哪兒等等。從而非常快速的瞭解這個項目。

2.可維護性高: 定義好組織規則後，維護者就能很明確地知道，新增的哪個檔案和代碼應該放在什麼目錄之下。這個好處是，隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好。

二、目錄組織方式

關於如何組織一個較好的Python工程目錄結構，已經有一些得到了共識的目錄結構。

假設你的項目名為ATM

ATM/|-- bin/    存放項目的一些可執行檔，當然你可以起名script/之類的也行，但bin/更直觀。易懂|   |-- __init__
|　 |-- start.py   寫啟動程式||-- core/   存放項目的所有原始碼(核心代碼）。(1) 原始碼中的所有模組、包都應該放在此目錄。不要置於頂層目錄。 (2) 其子目錄tests/存放單元測試代碼； (3) 程式的入口最好命名為main.py。
|   |-- tests/   
|   |   |-- __init__.py
|   |   |-- test.main.py  
|   ||   |-- __init__.py|   |-- test_main.py|  存放核心邏輯  ||-- conf/    設定檔|   |-- __init__.py|   |-- setting.py   寫上相關配置
|
|---db/    資料庫檔案|   |--db.json    寫資料庫檔案
|   |-- docs/   存放一些文檔
|   |-- lib/   庫檔案，放自訂模組和包
|   |-- __init__.py
|   |-- common.py    放常用的功能
|
|-- log/   記錄檔
|   |-- access.log    寫上日誌
|
|-- __init__.py|-- README    項目說明檔案

註：運行程式時，在bin目錄下執行start.py代碼，不可以直接執行core下的模組。

關於README的內容

這個我覺得是每個項目都應該有的一個檔案，目的是能簡要描述該項目的資訊，讓讀者快速瞭解這個項目。

它需要說明以下幾個事項:

1. 軟體定位，軟體的準系統。
2. 運行代碼的方法: 安裝環境、啟動命令等。
3. 簡要的使用說明。
4. 代碼目錄結構說明，更詳細點可以說明軟體的基本原理。
5. 常見問題說明。

 

python軟體目錄結構規範