一、規范目錄結構的好處：
1、可讀性高: 不熟悉這個專案的代碼的人，一眼就能看懂目錄結構，知道程式啟動腳本是哪個，測驗目錄在哪兒，組態檔在哪兒等等，從而非常快速的了解這個專案，
2、可維護性高: 定義好組織規則后，維護者就能很明確地知道，新增的哪個檔案和代碼應該放在什么目錄之下，隨著時間的推移，代碼規模增加，專案結構不會混亂，仍然能夠組織良好，
二、目錄組織形式：
專案名
|-- bin
| |-- 啟動腳本.py
|
|-- 專案名
| |-- tests
| | |-- __init__.py
| | |-- test_main.py
| |
| |-- __init__.py
| |-- main.py
|
|— conf
|— logs
|-- docs
| |-- conf.py
| |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README
三、目錄結構解釋:
bin：存放專案的一些可執行檔案，當然你可以起名script/之類的也行，專案名：存放專案的所有源代碼，(1) 源代碼中的所有模塊、包都應該放在此目錄，(2) 其子目錄tests/存放單元測驗代碼； (3) 程式的主入口命名為main.py，從bin的啟動腳本呼叫main.pydocs：存放一些檔案，setup.py：安裝、部署、打包的腳本，requirements.txt：存放軟體依賴的外部Python包串列，README：專案說明檔案，- config：專案組態檔
- logs：日志檔案
四、關于README檔案的內容：參考redis專案的README寫法
- 軟體定位，軟體的基本功能，
- 運行代碼的方法: 安裝環境、啟動命令等，
- 簡要的使用說明，
- 代碼目錄結構說明，更詳細點可以說明軟體的基本原理，
- 常見問題說明，
五、setup.py檔案：一個專案一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環境裝好、代碼部署好和將程式運行起來，手動部署會遇到過以下問題:
- 安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上運行，程式就出錯了，
- Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了，
- 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情，
- 新同學開始寫專案的時候，將程式跑起來非常麻煩，因為可能經常忘了要怎么安裝各種依賴，
六、總結，簡單專案中：bin，專案名(放源代碼)，conf，logs，這幾個目錄是必須的，README，main.py，專案名.py(啟動腳本)，這三個檔案是必須的
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/160077.html
標籤：Python
上一篇：SpringMVC之檔案上傳