為什么要設(shè)計好目錄結(jié)構(gòu)?
“設(shè)計項目目錄結(jié)構(gòu)”，就和”代碼編碼風(fēng)格”一樣捕儒，屬于個人風(fēng)格問題枚荣。對于這種風(fēng)格上的規(guī)范，一直都存在兩種態(tài)度:
一類同學(xué)認為边翁，這種個人風(fēng)格問題”無關(guān)緊要”翎承。理由是能讓程序work就好硕盹，風(fēng)格問題根本不是問題符匾。
另一類同學(xué)認為，規(guī)范化能更好的控制程序結(jié)構(gòu)瘩例，讓程序具有更高的可讀性啊胶。
我是比較偏向于后者的甸各，因為我是前一類同學(xué)思想行為下的直接受害者。我曾經(jīng)維護過一個非常不好讀的項目焰坪，其實現(xiàn)的邏輯并不復(fù)雜趣倾，但是卻耗費了我非常長的時間去理解它想表達的意思。從此我個人對于提高項目可讀性某饰、可維護性的要求就很高了儒恋。”項目目錄結(jié)構(gòu)”其實也是屬于”可讀性和可維護性”的范疇黔漂，我們設(shè)計一個層次清晰的目錄結(jié)構(gòu)诫尽，就是為了達到以下兩點:
可讀性高: 不熟悉這個項目的代碼的人，一眼就能看懂目錄結(jié)構(gòu)炬守，知道程序啟動腳本是哪個牧嫉，測試目錄在哪兒，配置文件在哪兒等等减途。從而非澈ㄔ澹快速的了解這個項目。
可維護性高: 定義好組織規(guī)則后鳍置，維護者就能很明確地知道辽剧，新增的哪個文件和代碼應(yīng)該放在什么目錄之下。這個好處是墓捻，隨著時間的推移抖仅，代碼/配置的規(guī)模增加，項目結(jié)構(gòu)不會混亂砖第，仍然能夠組織良好撤卢。
所以，我認為梧兼，保持一個層次清晰的目錄結(jié)構(gòu)是有必要的放吩。更何況組織一個良好的工程目錄，其實是一件很簡單的事兒羽杰。
目錄組織方式
關(guān)于如何組織一個較好的Python工程目錄結(jié)構(gòu)渡紫，已經(jīng)有一些得到了共識的目錄結(jié)構(gòu)。在Stackoverflow的這個問題上考赛，能看到大家對Python目錄結(jié)構(gòu)的討論惕澎。
這里面說的已經(jīng)很好了，我也不打算重新造輪子列舉各種不同的方式颜骤，這里面我說一下我的理解和體會唧喉。
假設(shè)你的項目名為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/: 存放項目的一些可執(zhí)行文件，當(dāng)然你可以起名script/之類的也行。
foo/: 存放項目的所有源代碼八孝。(1) 源代碼中的所有模塊董朝、包都應(yīng)該放在此目錄。不要置于頂層目錄干跛。(2) 其子目錄tests/存放單元測試代碼子姜； (3) 程序的入口最好命名為main.py。
docs/: 存放一些文檔楼入。
setup.py: 安裝哥捕、部署、打包的腳本嘉熊。
requirements.txt: 存放軟件依賴的外部Python包列表扭弧。
README: 項目說明文件。
除此之外记舆，有一些方案給出了更加多的內(nèi)容鸽捻。比如LICENSE.txt,ChangeLog.txt文件等，我沒有列在這里泽腮，因為這些東西主要是項目開源的時候需要用到御蒲。如果你想寫一個開源軟件，目錄該如何組織诊赊，可以參考這篇文章厚满。
下面，再簡單講一下我對這些目錄的理解和個人要求吧碧磅。
關(guān)于README的內(nèi)容
這個我覺得是每個項目都應(yīng)該有的一個文件碘箍，目的是能簡要描述該項目的信息，讓讀者快速了解這個項目鲸郊。
它需要說明以下幾個事項:
軟件定位丰榴，軟件的基本功能。
運行代碼的方法: 安裝環(huán)境秆撮、啟動命令等四濒。
簡要的使用說明。
代碼目錄結(jié)構(gòu)說明职辨，更詳細點可以說明軟件的基本原理盗蟆。
常見問題說明。
關(guān)于requirements.txt和setup.py
setup.py
一般來說舒裤，用setup.py來管理代碼的打包喳资、安裝、部署問題腾供。業(yè)界標準的寫法是用Python流行的打包工具setuptools來管理這些事情仆邓。這種方式普遍應(yīng)用于開源項目中亏栈。不過這里的核心思想不是用標準化的工具來解決這些問題，而是說宏赘，一個項目一定要有一個安裝部署工具，能快速便捷的在一臺新機器上將環(huán)境裝好黎侈、代碼部署好和將程序運行起來察署。
這個我是踩過坑的。
我剛開始接觸Python寫項目的時候峻汉，安裝環(huán)境贴汪、部署代碼、運行程序這個過程全是手動完成休吠，遇到過以下問題:
安裝環(huán)境時經(jīng)常忘了最近又添加了一個新的Python包扳埂，結(jié)果一到線上運行，程序就出錯了瘤礁。
Python包的版本依賴問題阳懂，有時候我們程序中使用的是一個版本的Python包，但是官方的已經(jīng)是最新的包了柜思，通過手動安裝就可能裝錯了岩调。
如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情赡盘。
新同學(xué)開始寫項目的時候号枕，將程序跑起來非常麻煩，因為可能經(jīng)常忘了要怎么安裝各種依賴陨享。
setup.py可以將這些事情自動化起來葱淳，提高效率、減少出錯的概率抛姑≡薏蓿”復(fù)雜的東西自動化，能自動化的東西一定要自動化定硝】痈担”是一個非常好的習(xí)慣。
setuptools的文檔比較龐大喷斋，剛接觸的話唁毒，可能不太好找到切入點。學(xué)習(xí)技術(shù)的方式就是看他人是怎么用的星爪，可以參考一下Python的一個Web框架浆西，flask是如何寫的:?setup.py
當(dāng)然，簡單點自己寫個安裝腳本（deploy.sh）替代setup.py也未嘗不可顽腾。
requirements.txt
這個文件存在的目的是:
方便開發(fā)者維護軟件的包依賴近零。將開發(fā)過程中新增的包添加進這個列表中诺核，避免在?setup.py?安裝依賴時漏掉軟件包。
方便讀者明確項目使用了哪些Python包久信。
這個文件的格式是每一行包含一個包依賴的說明窖杀，通常是flask>=0.10這種格式，要求是這個格式能被pip識別裙士，這樣就可以簡單的通過?pip install -r requirements.txt來把所有Python包依賴都裝好了入客。具體格式說明：?點這里。
關(guān)于配置文件的使用方法
注意腿椎，在上面的目錄結(jié)構(gòu)中桌硫，沒有將conf.py放在源碼目錄下，而是放在docs/目錄下啃炸。
很多項目對配置文件的使用做法是:
配置文件寫在一個或多個python文件中铆隘，比如此處的conf.py。
項目中哪個模塊用到這個配置文件就直接通過import conf這種形式來在代碼中使用配置南用。
這種做法我不太贊同:
這讓單元測試變得困難（因為模塊內(nèi)部依賴了外部配置）
另一方面配置文件作為用戶控制程序的接口膀钠，應(yīng)當(dāng)可以由用戶自由指定該文件的路徑。
程序組件可復(fù)用性太差裹虫，因為這種貫穿所有模塊的代碼硬編碼方式托修，使得大部分模塊都依賴conf.py這個文件。
所以恒界，我認為配置的使用睦刃，更好的方式是，
模塊的配置都是可以靈活配置的十酣，不受外部配置文件的影響涩拙。
程序的配置也是可以靈活控制的。
能夠佐證這個思想的是耸采，用過nginx和mysql的同學(xué)都知道兴泥，nginx、mysql這些程序都可以自由的指定用戶配置虾宇。
所以搓彻，不應(yīng)當(dāng)在代碼中直接import conf來使用配置文件。上面目錄結(jié)構(gòu)中的conf.py嘱朽，是給出的一個配置樣例旭贬，不是在寫死在程序中直接引用的配置文件√掠荆可以通過給main.py啟動參數(shù)指定配置路徑的方式來讓程序讀取配置內(nèi)容稀轨。當(dāng)然，這里的conf.py你可以換個類似的名字岸军，比如settings.py奋刽⊥呶辏或者你也可以使用其他格式的內(nèi)容來編寫配置文件，比如settings.yaml之類的佣谐。
