目的
"項(xiàng)目目錄結(jié)構(gòu)"屬于"可讀性和可維護(hù)性"的范疇，設(shè)計(jì)一個(gè)層次清晰的目錄結(jié)構(gòu)，是為了達(dá)到以下兩點(diǎn)目的:
- 可讀性高: 不熟悉這個(gè)項(xiàng)目的代碼的人，一眼就能看懂目錄結(jié)構(gòu)，知道程序啟動(dòng)腳本是哪個(gè)，測(cè)試目錄在哪兒，配置文件在哪兒等等。從而非?？焖俚牧私膺@個(gè)項(xiàng)目。
- 可維護(hù)性高: 定義好組織規(guī)則后，維護(hù)者就能很明確地知道，新增的哪個(gè)文件和代碼應(yīng)該放在什么目錄之下。這個(gè)好處是，隨著時(shí)間的推移，代碼/配置的規(guī)模增加，項(xiàng)目結(jié)構(gòu)不會(huì)混亂，仍然能夠組織良好。
所以保持一個(gè)層次清晰的目錄結(jié)構(gòu)是有必要的。更何況組織一個(gè)良好的工程目錄，其實(shí)是一件很簡(jiǎn)單的事兒。
目錄組織方式
關(guān)于如何組織一個(gè)較好的Python工程目錄結(jié)構(gòu)，已經(jīng)有一些得到了共識(shí)的目錄結(jié)構(gòu)。
假設(shè)你的項(xiàng)目名為foo, 我比較建議的最方便快捷目錄結(jié)構(gòu)這樣就足夠了:
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/: 存放項(xiàng)目的一些可執(zhí)行文件，當(dāng)然你可以起名script/之類的也行。
- foo/: 存放項(xiàng)目的所有源代碼。(1) 源代碼中的所有模塊、包都應(yīng)該放在此目錄。不要置于頂層目錄。(2) 其子目錄tests/存放單元測(cè)試代碼； (3) 程序的入口最好命名為main.py。
- docs/: 存放一些文檔。
- setup.py: 安裝、部署、打包的腳本。
- requirements.txt: 存放軟件依賴的外部Python包列表。
- README: 項(xiàng)目說(shuō)明文件。
關(guān)于README的內(nèi)容
每個(gè)項(xiàng)目都應(yīng)該有的一個(gè)文件，目的是能簡(jiǎn)要描述該項(xiàng)目的信息，讓讀者快速了解這個(gè)項(xiàng)目。
它需要說(shuō)明以下幾個(gè)事項(xiàng):
- 軟件定位，軟件的基本功能。
- 運(yùn)行代碼的方法: 安裝環(huán)境、啟動(dòng)命令等。
- 簡(jiǎn)要的使用說(shuō)明。
- 代碼目錄結(jié)構(gòu)說(shuō)明，更詳細(xì)點(diǎn)可以說(shuō)明軟件的基本原理。
- 常見(jiàn)問(wèn)題說(shuō)明。
有以上幾點(diǎn)是比較好的一個(gè)README。在軟件開(kāi)發(fā)初期，由于開(kāi)發(fā)過(guò)程中以上內(nèi)容可能不明確或者發(fā)生變化，并不是一定要在一開(kāi)始就將所有信息都補(bǔ)全。但是在項(xiàng)目完結(jié)的時(shí)候，是需要撰寫(xiě)這樣的一個(gè)文檔的。
可以參考Redis源碼中Readme的寫(xiě)法，這里面簡(jiǎn)潔但是清晰的描述了Redis功能和源碼結(jié)構(gòu)。
關(guān)于requirements.txt和setup.py
setup.py
一般來(lái)說(shuō)，用setup.py來(lái)管理代碼的打包、安裝、部署問(wèn)題。業(yè)界標(biāo)準(zhǔn)的寫(xiě)法是用Python流行的打包工具setuptools來(lái)管理這些事情。這種方式普遍應(yīng)用于開(kāi)源項(xiàng)目中。不過(guò)這里的核心思想不是用標(biāo)準(zhǔn)化的工具來(lái)解決這些問(wèn)題，而是說(shuō)，一個(gè)項(xiàng)目一定要有一個(gè)安裝部署工具，能快速便捷的在一臺(tái)新機(jī)器上將環(huán)境裝好、代碼部署好和將程序運(yùn)行起來(lái)。
使用Python寫(xiě)項(xiàng)目的時(shí)候，安裝環(huán)境、部署代碼、運(yùn)行程序這個(gè)過(guò)程全是手動(dòng)完成，遇到過(guò)以下問(wèn)題:
- 安裝環(huán)境時(shí)經(jīng)常忘了最近又添加了一個(gè)新的Python包，結(jié)果一到線上運(yùn)行，程序就出錯(cuò)了。
- Python包的版本依賴問(wèn)題，有時(shí)候我們程序中使用的是一個(gè)版本的Python包，但是官方的已經(jīng)是最新的包了，通過(guò)手動(dòng)安裝就可能裝錯(cuò)了。
- 如果依賴的包很多的話，一個(gè)一個(gè)安裝這些依賴是很費(fèi)時(shí)的事情。
- 新成員開(kāi)始寫(xiě)項(xiàng)目的時(shí)候，將程序跑起來(lái)非常麻煩，因?yàn)榭赡芙?jīng)常忘了要怎么安裝各種依賴。
setup.py可以將這些事情自動(dòng)化起來(lái)，提高效率、減少出錯(cuò)的概率。"復(fù)雜的東西自動(dòng)化，能自動(dòng)化的東西一定要自動(dòng)化。"是一個(gè)非常好的習(xí)慣。
setuptools的文檔比較龐大，剛接觸的話，可能不太好找到切入點(diǎn)。學(xué)習(xí)技術(shù)的方式就是看他人是怎么用的，可以參考一下Python的一個(gè)Web框架，flask是如何寫(xiě)的: article3
當(dāng)然，簡(jiǎn)單點(diǎn)自己寫(xiě)個(gè)安裝腳本（deploy.sh）替代setup.py也未嘗不可。
requirements.txt
這個(gè)文件存在的目的是:
- 方便開(kāi)發(fā)者維護(hù)軟件的包依賴。將開(kāi)發(fā)過(guò)程中新增的包添加進(jìn)這個(gè)列表中，避免在setup.py安裝依賴時(shí)漏掉軟件包。
- 方便讀者明確項(xiàng)目使用了哪些Python包。
這個(gè)文件的格式是每一行包含一個(gè)包依賴的說(shuō)明，通常是flask>=0.10這種格式，要求是這個(gè)格式能被pip識(shí)別，這樣就可以簡(jiǎn)單的通過(guò) pip install -r requirements.txt來(lái)把所有Python包依賴都裝好了。
關(guān)于配置文件的使用方法
注意，在上面的目錄結(jié)構(gòu)中，沒(méi)有將conf.py放在源碼目錄下，而是放在docs/目錄下。
很多項(xiàng)目對(duì)配置文件的使用做法是:
配置文件寫(xiě)在一個(gè)或多個(gè)python文件中，比如此處的conf.py。
項(xiàng)目中哪個(gè)模塊用到這個(gè)配置文件就直接通過(guò)import conf這種形式來(lái)在代碼中使用配置。
這讓單元測(cè)試變得困難（因?yàn)槟K內(nèi)部依賴了外部配置）
另一方面配置文件作為用戶控制程序的接口，應(yīng)當(dāng)可以由用戶自由指定該文件的路徑。
程序組件可復(fù)用性太差，因?yàn)檫@種貫穿所有模塊的代碼硬編碼方式，使得大部分模塊都依賴conf.py這個(gè)文件。
所以，我認(rèn)為配置的使用，更好的方式是，
- 模塊的配置都是可以靈活配置的，不受外部配置文件的影響。
- 程序的配置也是可以靈活控制的。
所以，不應(yīng)當(dāng)在代碼中直接import conf來(lái)使用配置文件。上面目錄結(jié)構(gòu)中的conf.py，是給出的一個(gè)配置樣例，不是在寫(xiě)死在程序中直接引用的配置文件。可以通過(guò)給main.py啟動(dòng)參數(shù)指定配置路徑的方式來(lái)讓程序讀取配置內(nèi)容。當(dāng)然，這里的conf.py你可以換個(gè)類似的名字，比如settings.py。或者你也可以使用其他格式的內(nèi)容來(lái)編寫(xiě)配置文件，比如settings.yaml之類的。
如果想寫(xiě)一個(gè)開(kāi)源軟件，目錄該如何組織,參考article2。
