初學Python——軟體目錄結構規範

為什麼要設計好目錄結構?

1. 可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結構，知道程式啟動腳本是哪個，測試目錄在哪兒，配置檔案在哪兒等等。進而非常快速的了解這個項目。
2. 可維護性高: 定義好組織規則後，維護者就能很明确地知道，新增的哪個檔案和代碼應該放在什麼目錄之下。這個好處是，随着時間的推移，代碼/配置的規模增加，項目結構不會混亂，仍然能夠組織良好

目錄組織方式

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

這個問題

上，能看到大家對Python目錄結構的讨論。

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

假設你的項目名為foo, 我比較建議的最友善快捷目錄結構這樣就足夠了:

Foo/
|-- bin/
|   |-- foo
|
|-- foo/
|   |-- tests/
|   |   |-- __init__.py
|   |   |-- test_main.py
|   |
|   |-- __init__.py
|   |-- main.py
|
|-- docs/
|   |-- conf.py
|   |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README
           

簡要解釋一下:

1. bin/

   : 存放項目的一些可執行檔案，當然你可以起名

   script/

   之類的也行。

2. foo/

   : 存放項目的所有源代碼。(1) 源代碼中的所有子產品、包都應該放在此目錄。不要置于頂層目錄。(2) 其子目錄

   tests/

   存放單元測試代碼； (3) 程式的入口最好命名為

   main.py

   。

3. docs/

   : 存放一些文檔。

4. setup.py

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

5. requirements.txt

   : 存放軟體依賴的外部Python包清單。

6. README

   : 項目說明檔案。

除此之外，有一些方案給出了更加多的内容。比如

LICENSE.txt

,

ChangeLog.txt

檔案等，我沒有列在這裡，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟體，目錄該如何組織，可以參考

這篇文章

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

關于README的内容

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

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

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

我覺得有以上幾點是比較好的一個

README

。在軟體開發初期，由于開發過程中以上内容可能不明确或者發生變化，并不是一定要在一開始就将所有資訊都補全。但是在項目完結的時候，是需要撰寫這樣的一個文檔的。

可以參考Redis源碼中

Readme

的寫法，這裡面簡潔但是清晰的描述了Redis功能和源碼結構。

關于requirements.txt和setup.py

setup.py

一般來說，用

setup.py

來管理代碼的打包、安裝、部署問題。業界标準的寫法是用Python流行的打包工具

setuptools

來管理這些事情。這種方式普遍應用于開源項目中。不過這裡的核心思想不是用标準化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一台新機器上将環境裝好、代碼部署好和将程式運作起來。

這個我是踩過坑的。

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

1. 安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上運作，程式就出錯了。
2. Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
3. 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。
4. 新同學開始寫項目的時候，将程式跑起來非常麻煩，因為可能經常忘了要怎麼安裝各種依賴。

setup.py

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

setuptools的

文檔

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

當然，簡單點自己寫個安裝腳本（

deploy.sh

）替代

setup.py

也未嘗不可。

requirements.txt

這個檔案存在的目的是:

1. 友善開發者維護軟體的包依賴。将開發過程中新增的包添加進這個清單中，避免在

   setup.py

   安裝依賴時漏掉軟體包。
2. 友善讀者明确項目使用了哪些Python包。

這個檔案的格式是每一行包含一個包依賴的說明，通常是

flask>=0.10

這種格式，要求是這個格式能被

pip

識别，這樣就可以簡單的通過 

pip install -r requirements.txt

來把所有Python包依賴都裝好了。具體格式說明： 

點這裡

關于配置檔案的使用方法

注意，在上面的目錄結構中，沒有将

conf.py

放在源碼目錄下，而是放在

docs/

目錄下。

很多項目對配置檔案的使用做法是:

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

之類的。