2019-08-05-python項目結構目錄

python項目結構

"項目目錄結構"其實也是屬于"可讀性和可維護性"的范疇瘫证，我們設計一個層次清晰的目錄結構碍岔，就是為了達到以下兩點:

1.?可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結構娘锁，知道程序啟動腳本是哪個，測試目錄在哪兒矮固，配置文件在哪兒等等窿克。從而非澄焙埽快速的了解這個項目搓萧。

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

假設你的項目名為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/: 存放項目的一些可執(zhí)行文件，當然你可以起名script/之類的也行罕邀。

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

3.?docs/: 存放一些文檔碍遍。

4.?setup.py: 安裝定铜、部署阳液、打包的腳本。

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

6.?README: 項目說明文件帘皿。

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

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

關于README的內(nèi)容

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

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

1.?軟件定位庸毫，軟件的基本功能仔拟。

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

3.?簡要的使用說明利花。

4.?代碼目錄結構說明，更詳細點可以說明軟件的基本原理载佳。

5.?常見問題說明晋被。

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

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

關于requirements.txt和setup.py

setup.py

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

這個我是踩過坑的。

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

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

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

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

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

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

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

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

requirements.txt

這個文件存在的目的是:

1.?方便開發(fā)者維護軟件的包依賴线脚。將開發(fā)過程中新增的包添加進這個列表中，避免在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.?這讓單元測試變得困難（因為模塊內(nèi)部依賴了外部配置）

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

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

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

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

2.?程序的配置也是可以靈活控制的矮嫉。

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

所以鳞陨，不應當在代碼中直接import conf來使用配置文件昨寞。上面目錄結構中的conf.py，是給出的一個配置樣例，不是在寫死在程序中直接引用的配置文件援岩∈焓罚可以通過給main.py啟動參數(shù)指定配置路徑的方式來讓程序讀取配置內(nèi)容。當然窄俏，這里的conf.py你可以換個類似的名字蹂匹，比如settings.py“简冢或者你也可以使用其他格式的內(nèi)容來編寫配置文件限寞，比如settings.yaml之類的。

對于文檔的態(tài)度

目錄結構中有設docs/這個目錄仰坦，用于存放代碼文檔履植。實際過程中，據(jù)我觀察悄晃，80%以上的程序員都沒有單獨寫文檔的習慣玫霎。一般文檔寫得比較好的，都是一些開源項目妈橄。

在普通的項目中庶近，確實沒必要寫非常詳細的文檔，我更贊同的是現(xiàn)在的一種流行的風格: "在代碼中寫文檔"眷蚓。即在寫代碼的時候鼻种，在代碼文件里把軟件/模塊的簡要用法寫明。簡單有用沙热。

小結