目的
"項(xiàng)目目錄結(jié)構(gòu)"屬于"可讀性和可維護(hù)性"的范疇，設(shè)計(jì)一個(gè)層次清晰的目錄結(jié)構(gòu)框仔，是為了達(dá)到以下兩點(diǎn)目的:
- 可讀性高: 不熟悉這個(gè)項(xiàng)目的代碼的人舀武，一眼就能看懂目錄結(jié)構(gòu)，知道程序啟動腳本是哪個(gè)离斩，測試目錄在哪兒银舱，配置文件在哪兒等等。從而非初斯＃快速的了解這個(gè)項(xiàng)目寻馏。
- 可維護(hù)性高: 定義好組織規(guī)則后，維護(hù)者就能很明確地知道核偿，新增的哪個(gè)文件和代碼應(yīng)該放在什么目錄之下诚欠。這個(gè)好處是，隨著時(shí)間的推移漾岳，代碼/配置的規(guī)模增加轰绵，項(xiàng)目結(jié)構(gòu)不會混亂，仍然能夠組織良好尼荆。
所以保持一個(gè)層次清晰的目錄結(jié)構(gòu)是有必要的藏澳。更何況組織一個(gè)良好的工程目錄，其實(shí)是一件很簡單的事兒耀找。
目錄組織方式
關(guān)于如何組織一個(gè)較好的Python工程目錄結(jié)構(gòu)，已經(jīng)有一些得到了共識的目錄結(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/存放單元測試代碼摇锋； (3) 程序的入口最好命名為main.py丹拯。
- docs/: 存放一些文檔。
- setup.py: 安裝荸恕、部署乖酬、打包的腳本。
- requirements.txt: 存放軟件依賴的外部Python包列表融求。
- README: 項(xiàng)目說明文件咬像。
關(guān)于README的內(nèi)容
每個(gè)項(xiàng)目都應(yīng)該有的一個(gè)文件，目的是能簡要描述該項(xiàng)目的信息生宛，讓讀者快速了解這個(gè)項(xiàng)目县昂。
它需要說明以下幾個(gè)事項(xiàng):
- 軟件定位，軟件的基本功能陷舅。
- 運(yùn)行代碼的方法: 安裝環(huán)境倒彰、啟動命令等。
- 簡要的使用說明莱睁。
- 代碼目錄結(jié)構(gòu)說明待讳，更詳細(xì)點(diǎn)可以說明軟件的基本原理。
- 常見問題說明缩赛。
有以上幾點(diǎn)是比較好的一個(gè)README耙箍。在軟件開發(fā)初期，由于開發(fā)過程中以上內(nèi)容可能不明確或者發(fā)生變化酥馍，并不是一定要在一開始就將所有信息都補(bǔ)全辩昆。但是在項(xiàng)目完結(jié)的時(shí)候，是需要撰寫這樣的一個(gè)文檔的旨袒。
可以參考Redis源碼中Readme的寫法汁针，這里面簡潔但是清晰的描述了Redis功能和源碼結(jié)構(gòu)。
關(guān)于requirements.txt和setup.py
setup.py
一般來說砚尽，用setup.py來管理代碼的打包施无、安裝、部署問題必孤。業(yè)界標(biāo)準(zhǔn)的寫法是用Python流行的打包工具setuptools來管理這些事情猾骡。這種方式普遍應(yīng)用于開源項(xiàng)目中。不過這里的核心思想不是用標(biāo)準(zhǔn)化的工具來解決這些問題敷搪，而是說兴想，一個(gè)項(xiàng)目一定要有一個(gè)安裝部署工具，能快速便捷的在一臺新機(jī)器上將環(huán)境裝好赡勘、代碼部署好和將程序運(yùn)行起來嫂便。
使用Python寫項(xiàng)目的時(shí)候，安裝環(huán)境闸与、部署代碼毙替、運(yùn)行程序這個(gè)過程全是手動完成岸售，遇到過以下問題:
- 安裝環(huán)境時(shí)經(jīng)常忘了最近又添加了一個(gè)新的Python包，結(jié)果一到線上運(yùn)行厂画，程序就出錯(cuò)了凸丸。
- Python包的版本依賴問題，有時(shí)候我們程序中使用的是一個(gè)版本的Python包木羹，但是官方的已經(jīng)是最新的包了甲雅，通過手動安裝就可能裝錯(cuò)了。
- 如果依賴的包很多的話坑填，一個(gè)一個(gè)安裝這些依賴是很費(fèi)時(shí)的事情抛人。
- 新成員開始寫項(xiàng)目的時(shí)候，將程序跑起來非常麻煩脐瑰，因?yàn)榭赡芙?jīng)常忘了要怎么安裝各種依賴妖枚。
setup.py可以將這些事情自動化起來，提高效率苍在、減少出錯(cuò)的概率绝页。"復(fù)雜的東西自動化，能自動化的東西一定要自動化寂恬。"是一個(gè)非常好的習(xí)慣续誉。
setuptools的文檔比較龐大，剛接觸的話初肉，可能不太好找到切入點(diǎn)酷鸦。學(xué)習(xí)技術(shù)的方式就是看他人是怎么用的，可以參考一下Python的一個(gè)Web框架牙咏，flask是如何寫的: article3
當(dāng)然臼隔，簡單點(diǎn)自己寫個(gè)安裝腳本（deploy.sh）替代setup.py也未嘗不可。
requirements.txt
這個(gè)文件存在的目的是:
- 方便開發(fā)者維護(hù)軟件的包依賴妄壶。將開發(fā)過程中新增的包添加進(jìn)這個(gè)列表中摔握，避免在setup.py安裝依賴時(shí)漏掉軟件包。
- 方便讀者明確項(xiàng)目使用了哪些Python包丁寄。
這個(gè)文件的格式是每一行包含一個(gè)包依賴的說明氨淌，通常是flask>=0.10這種格式，要求是這個(gè)格式能被pip識別伊磺，這樣就可以簡單的通過 pip install -r requirements.txt來把所有Python包依賴都裝好了宁舰。
關(guān)于配置文件的使用方法
注意，在上面的目錄結(jié)構(gòu)中奢浑，沒有將conf.py放在源碼目錄下，而是放在docs/目錄下腋腮。
很多項(xiàng)目對配置文件的使用做法是:
配置文件寫在一個(gè)或多個(gè)python文件中雀彼，比如此處的conf.py壤蚜。
項(xiàng)目中哪個(gè)模塊用到這個(gè)配置文件就直接通過import conf這種形式來在代碼中使用配置。
這讓單元測試變得困難（因?yàn)槟K內(nèi)部依賴了外部配置）
另一方面配置文件作為用戶控制程序的接口徊哑，應(yīng)當(dāng)可以由用戶自由指定該文件的路徑袜刷。
程序組件可復(fù)用性太差，因?yàn)檫@種貫穿所有模塊的代碼硬編碼方式莺丑，使得大部分模塊都依賴conf.py這個(gè)文件著蟹。
所以，我認(rèn)為配置的使用梢莽，更好的方式是萧豆，
- 模塊的配置都是可以靈活配置的，不受外部配置文件的影響昏名。
- 程序的配置也是可以靈活控制的涮雷。
所以，不應(yīng)當(dāng)在代碼中直接import conf來使用配置文件轻局。上面目錄結(jié)構(gòu)中的conf.py洪鸭，是給出的一個(gè)配置樣例，不是在寫死在程序中直接引用的配置文件仑扑±谰簦可以通過給main.py啟動參數(shù)指定配置路徑的方式來讓程序讀取配置內(nèi)容。當(dāng)然镇饮，這里的conf.py你可以換個(gè)類似的名字蜓竹，比如settings.py『腥茫或者你也可以使用其他格式的內(nèi)容來編寫配置文件梅肤，比如settings.yaml之類的。
如果想寫一個(gè)開源軟件邑茄，目錄該如何組織,參考article2姨蝴。
