為什么要設(shè)計好目錄結(jié)構(gòu)?

"設(shè)計項目目錄結(jié)構(gòu)"，就和"代碼編碼風(fēng)格"一樣，屬于個人風(fēng)格問題。對于這種風(fēng)格上的規(guī)范，一直都存在兩種態(tài)度:

一類同學(xué)認(rèn)為，這種個人風(fēng)格問題"無關(guān)緊要"。理由是能讓程序work就好，風(fēng)格問題根本不是問題。

另一類同學(xué)認(rèn)為，規(guī)范化能更好的控制程序結(jié)構(gòu)，讓程序具有更高的可讀性。

我是比較偏向于后者的，因為我是前一類同學(xué)思想行為下的直接受害者。我曾經(jīng)維護(hù)過一個非常不好讀的項目，其實現(xiàn)的邏輯并不復(fù)雜，但是卻耗費(fèi)了我非常長的時間去理解它想表達(dá)的意思。從此我個人對于提高項目可讀性、可維護(hù)性的要求就很高了。"項目目錄結(jié)構(gòu)"其實也是屬于"可讀性和可維護(hù)性"的范疇，我們設(shè)計一個層次清晰的目錄結(jié)構(gòu)，就是為了達(dá)到以下兩點:

可讀性高:不熟悉這個項目的代碼的人，一眼就能看懂目錄結(jié)構(gòu)，知道程序啟動腳本是哪個，測試目錄在哪兒，配置文件在哪兒等等。從而非常快速的了解這個項目。

可維護(hù)性高:定義好組織規(guī)則后，維護(hù)者就能很明確地知道，新增的哪個文件和代碼應(yīng)該放在什么目錄之下。這個好處是，隨著時間的推移，代碼/配置的規(guī)模增加，項目結(jié)構(gòu)不會混亂，仍然能夠組織良好。

所以，我認(rèn)為，保持一個層次清晰的目錄結(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)這樣就足夠了

簡要解釋一下:

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文件等，我沒有列在這里，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟件，目錄該如何組織

以上內(nèi)容為大家介紹了Python軟件開發(fā)目錄規(guī)范的重要性，希望對大家有所幫助，如果想要了解更多Python相關(guān)知識，請關(guān)注IT培訓(xùn)機(jī)構(gòu):千鋒教育。

上一篇

Python 面向?qū)ο蟮能浖_發(fā)

下一篇

Python 代碼排版問題