Python基礎之軟體目錄結構規範

標籤：編碼   方便   軟體開發   版本   控制   UI   基礎   打包工具   基本   

設計一個層次清晰的目錄結構，就是為了達到這兩點：

1. 可讀性高：不熟悉項目的人，一眼就能看懂目錄結構。
2. 可維護性高：隨著時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好。

目錄組織方式：

ATM
├── bin
│   └── start.py
├── conf
│   └── settings.py
├── core
│   └── test_main.py
├── db
│   └── db.json
├── docs
├── lib
│   └── common.py
├── log
│   └── access.log
└── README

簡單解釋一下：

1. bin ：存放項目的一些可執行檔，當然你可以起名script/之類的也行。
2. conf ：設定檔目錄
3. core：核心代碼目錄
4. db：資料目錄
5. docs ：存放一些說明文檔。
6. lib：庫檔案，存放一些自訂模組和包
7. log：日誌目錄
8. README 安裝說明

關於README的內容：

README的作用是描述該項目的資訊，讓讀者快速瞭解這個項目。
它需要說明以下幾個事項：

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

關於requirements.txt和setup.py

一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業界標準的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源項目中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一台新機器上將環境裝好、代碼部署好和將程式運行起來。這個我是踩過坑的。我剛開始接觸Python寫項目的時候，安裝環境、部署代碼、運行程式這個過程全是手動完成，遇到過以下問題:1、安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上運行，程式就出錯了。2、Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。3、如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。4、新同學開始寫項目的時候，將程式跑起來非常麻煩，因為可能經常忘了要怎麼安裝各種依賴。setup.py可以將這些事情自動化起來，提高效率、減少出錯的機率。"複雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎麼用的，可以參考一下Python的一個Web架構，flask是如何寫的: setup.py當然，簡單點自己寫個安裝指令碼（deploy.sh）替代setup.py也未嘗不可。

setup.py說明

這個檔案存在的目的是:1、方便開發人員維護軟體的包依賴。將開發過程中新增的包添加進這個列表中，避免在setup.py安裝依賴時漏掉軟體包。2、方便讀者明確項目使用了哪些Python包。這個檔案的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了。

requirements.txt說明

關於設定檔的使用方法：

1、設定檔寫在一個或多個python檔案中，比如此處的conf.py。2、項目中哪個模組用到這個設定檔就直接通過import conf這種形式來在代碼中使用配置。這種做法我不太贊同:1、這讓單元測試變得困難（因為模組內部依賴了外部配置）2、另一方面設定檔作為使用者控製程序的介面，應當可以由使用者自由指定該檔案的路徑。3、程式組件可複用性太差，因為這種貫穿所有模組的代碼寫入程式碼方式，使得大部分模組都依賴conf.py這個檔案。所以，我認為配置的使用，更好的方式是，1、模組的配置都是可以靈活配置的，不受外部設定檔的影響。2、程式的配置也是可以靈活控制的。能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程式都可以自由的指定使用者配置。所以，不應當在代碼中直接import conf來使用設定檔。上面目錄結構中的conf.py，是給出的一個配置範例，不是在寫死在程式中直接引用的設定檔。可以通過給main.py啟動參數指定配置路徑的方式來讓程式讀取配置內容。當然，這裡的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫設定檔，比如settings.yaml之類的。

設定檔說明

 

關於作業：

作業必備知識：

1. 模組匯入
2. 目錄組織圖
3. 函數
4. 第三方模組（序列化、logging）
5. 裝飾器
6. 使用面向過程開發（ATM程式是不經常更改得程式）

軟體開發流程：

1. 畫流程圖
2. 寫README
3. 嚴格按照軟體開發規範去開發程式

作業需求：

類比實現一個ATM + 購物商城程式

1. 額度 15000或自訂
2. 實現購物商城，買東西加入 購物車，調用信用卡介面結賬
3. 可以提現，手續約5%
4. 每月22號出賬單，每月10號為還款日，到期未還，按欠款總額 萬分之5 每日計息
5. 支援多賬戶登入
6. 支援賬戶間轉賬
7. 記錄每月日常消費流水
8. 提供還款介面
9. ATM記錄動作記錄 
10. 提供管理介面，包括添加賬戶、使用者額度，凍結賬戶等。。。
11. 使用者認證用裝飾器

範例程式碼 https://github.com/triaquae/py3_training/tree/master/atm　

簡易流程圖：https://www.processon.com/view/link/589eb841e4b0999184934329 

 

參考連結：http://www.cnblogs.com/alex3714/articles/5765046.html

Python基礎之軟體目錄結構規範