?

軟件目錄結(jié)構規(guī)范

為什么要設計好目錄結(jié)構?

"設計項目目錄結(jié)構"，就和"代碼編碼風格"一樣，屬于個人風格問題。對于這種風格上的規(guī)范，一直都存在兩種態(tài)度:

一類同學認為，這種個人風格問題"無關緊要"。理由是能讓程序work就好，風格問題根本不是問題。

另一類同學認為，規(guī)范化能更好的控制程序結(jié)構，讓程序具有更高的可讀性。

我是比較偏向于后者的，因為我是前一類同學思想行為下的直接受害者。我曾經(jīng)維護過一個非常不好讀的項目，其實現(xiàn)的邏輯并不復雜，但是卻耗費了我非常長的時間去理解它想表達的意思。從此我個人對于提高項目可讀性、可維護性的要求就很高了。"項目目錄結(jié)構"其實也是屬于"可讀性和可維護性"的范疇，我們設計一個層次清晰的目錄結(jié)構，就是為了達到以下兩點:

可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結(jié)構，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非?？焖俚牧私膺@個項目。

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

所以，我認為，保持一個層次清晰的目錄結(jié)構是有必要的。更何況組織一個良好的工程目錄，其實是一件很簡單的事兒。

目錄組織方式

關于如何組織一個較好的Python工程目錄結(jié)構，已經(jīng)有一些得到了共識的目錄結(jié)構。在Stackoverflow的這個問題上，能看到大家對Python目錄結(jié)構的討論。

這里面說的已經(jīng)很好了，我也不打算重新造輪子列舉各種不同的方式，這里面我說一下我的理解和體會。

假設你的項目名為foo, 我比較建議的最方便快捷目錄結(jié)構這樣就足夠了:

Foo/

|-- bin/

|? |-- foo

|

|-- foo/

|? |-- tests/

|? |? |-- __init__.py

|? |? |-- test_main.py

|? |

|? |-- __init__.py

|? |-- main.py

|

|-- docs/

|? |-- conf.py

|? |-- abc.rst

|

|-- setup.py

|-- requirements.txt

|-- README

簡要解釋一下:

bin/: 存放項目的一些可執(zhí)行文件，當然你可以起名script/之類的也行。

foo/: 存放項目的所有源代碼。(1) 源代碼中的所有模塊、包都應該放在此目錄。不要置于頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程序的入口最好命名為main.py。

docs/: 存放一些文檔。

setup.py: 安裝、部署、打包的腳本。

requirements.txt: 存放軟件依賴的外部Python包列表。

README: 項目說明文件。

除此之外，有一些方案給出了更加多的內(nèi)容。比如LICENSE.txt,ChangeLog.txt文件等，我沒有列在這里，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟件，目錄該如何組織，可以參考這篇文章。

下面，再簡單講一下我對這些目錄的理解和個人要求吧。

關于README的內(nèi)容

這個我覺得是每個項目都應該有的一個文件，目的是能簡要描述該項目的信息，讓讀者快速了解這個項目。

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

軟件定位，軟件的基本功能。

運行代碼的方法: 安裝環(huán)境、啟動命令等。

簡要的使用說明。

代碼目錄結(jié)構說明，更詳細點可以說明軟件的基本原理。

常見問題說明。

我覺得有以上幾點是比較好的一個README。在軟件開發(fā)初期，由于開發(fā)過程中以上內(nèi)容可能不明確或者發(fā)生變化，并不是一定要在一開始就將所有信息都補全。但是在項目完結(jié)的時候，是需要撰寫這樣的一個文檔的。

可以參考Redis源碼中Readme的寫法，這里面簡潔但是清晰的描述了Redis功能和源碼結(jié)構。

關于requirements.txt和setup.py

setup.py

一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業(yè)界標準的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用于開源項目中。不過這里的核心思想不是用標準化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環(huán)境裝好、代碼部署好和將程序運行起來。

這個我是踩過坑的。

我剛開始接觸Python寫項目的時候，安裝環(huán)境、部署代碼、運行程序這個過程全是手動完成，遇到過以下問題:

安裝環(huán)境時經(jīng)常忘了最近又添加了一個新的Python包，結(jié)果一到線上運行，程序就出錯了。

Python包的版本依賴問題，有時候我們程序中使用的是一個版本的Python包，但是官方的已經(jīng)是最新的包了，通過手動安裝就可能裝錯了。

如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。

新同學開始寫項目的時候，將程序跑起來非常麻煩，因為可能經(jīng)常忘了要怎么安裝各種依賴。

setup.py可以將這些事情自動化起來，提高效率、減少出錯的概率。"復雜的東西自動化，能自動化的東西一定要自動化。"是一個非常好的習慣。

setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點。學習技術的方式就是看他人是怎么用的，可以參考一下Python的一個Web框架，flask是如何寫的:setup.py

當然，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可。

requirements.txt

這個文件存在的目的是:

方便開發(fā)者維護軟件的包依賴。將開發(fā)過程中新增的包添加進這個列表中，避免在setup.py安裝依賴時漏掉軟件包。

方便讀者明確項目使用了哪些Python包。

這個文件的格式是每一行包含一個包依賴的說明，通常是flask>=0.10這種格式，要求是這個格式能被pip識別，這樣就可以簡單的通過pip install -r requirements.txt來把所有Python包依賴都裝好了。具體格式說明：點這里。

關于配置文件的使用方法

注意，在上面的目錄結(jié)構中，沒有將conf.py放在源碼目錄下，而是放在docs/目錄下。

很多項目對配置文件的使用做法是:

配置文件寫在一個或多個python文件中，比如此處的conf.py。

項目中哪個模塊用到這個配置文件就直接通過import conf這種形式來在代碼中使用配置。

這種做法我不太贊同:

這讓單元測試變得困難（因為模塊內(nèi)部依賴了外部配置）

另一方面配置文件作為用戶控制程序的接口，應當可以由用戶自由指定該文件的路徑。

程序組件可復用性太差，因為這種貫穿所有模塊的代碼硬編碼方式，使得大部分模塊都依賴conf.py這個文件。

所以，我認為配置的使用，更好的方式是，

模塊的配置都是可以靈活配置的，不受外部配置文件的影響。

程序的配置也是可以靈活控制的。

能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程序都可以自由的指定用戶配置。

所以，不應當在代碼中直接import conf來使用配置文件。上面目錄結(jié)構中的conf.py，是給出的一個配置樣例，不是在寫死在程序中直接引用的配置文件。可以通過給main.py啟動參數(shù)指定配置路徑的方式來讓程序讀取配置內(nèi)容。當然，這里的conf.py你可以換個類似的名字，比如settings.py?；蛘吣阋部梢允褂闷渌袷降膬?nèi)容來編寫配置文件，比如settings.yaml之類的。

附ATM目錄結(jié)構：

作者:Alex Li

版本:示例版本 v0.1

程序介紹:

? ? 實現(xiàn)ATM常用功能

? ? 功能全部用python的基礎知識實現(xiàn),用到了time\os\sys\json\open\logging\函數(shù)\模塊知識, 主要幫給大家一個簡單的模塊化編程的示例

? ? 注意:只實現(xiàn)了"還款"和"取現(xiàn)功能"

程序結(jié)構:

day5-atm/

├── README

├── atm #ATM主程目錄

│?? ├── __init__.py

│?? ├── bin #ATM 執(zhí)行文件 目錄

│?? │?? ├── __init__.py

│?? │?? ├── atm.py? #ATM 執(zhí)行程序

│?? │?? └── manage.py #ATM 管理端,未實現(xiàn)

│?? ├── conf #配置文件

│?? │?? ├── __init__.py

│?? │?? └── settings.py

│?? ├── core #主要程序邏輯都 在這個目錄里

│?? │?? ├── __init__.py

│?? │?? ├── accounts.py? #用于從文件里加載和存儲賬戶數(shù)據(jù)

│?? │?? ├── auth.py? ? ? #用戶認證模塊

│?? │?? ├── db_handler.py? #數(shù)據(jù)庫連接引擎

│?? │?? ├── logger.py? ? ? #日志記錄模塊

│?? │?? ├── main.py? ? ? ? #主邏輯交互程序

│?? │?? └── transaction.py? #記賬\還錢\取錢等所有的與賬戶金額相關的操作都 在這

│?? ├── db? #用戶數(shù)據(jù)存儲的地方

│?? │?? ├── __init__.py

│?? │?? ├── account_sample.py #生成一個初始的賬戶數(shù)據(jù) ,把這個數(shù)據(jù) 存成一個 以這個賬戶id為文件名的文件,放在accounts目錄 就行了,程序自己去會這里找

│?? │?? └── accounts #存各個用戶的賬戶數(shù)據(jù) ,一個用戶一個文件

│?? │??? ? └── 1234.json #一個用戶賬戶示例文件

│?? └── log #日志目錄

│??? ? ├── __init__.py

│??? ? ├── access.log #用戶訪問和操作的相關日志

│??? ? └── transactions.log? ? #所有的交易日志

└── shopping_mall #電子商城程序,需單獨實現(xiàn)

? ? └── __init__.py