python--軟體目錄結構

標籤：src   __file__   比較   dir   列表   自動   mit   end   hat   

軟體目錄結構規範

設計目錄結構優點：

1.可讀性高，可以快速的瞭解項目

2.可維護性高，定義好組織規則後，維護者就能很明確地知道，新增的哪個檔案和代碼應該放在什麼目錄之下。

目錄組織方式

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/: 存放項目的一些可執行檔，當然你可以起名script/之類的也行。
2. foo/: 存放項目的所有原始碼。(1) 原始碼中的所有模組、包都應該放在此目錄。不要置於頂層目錄。(2) 其子目錄tests/存放單元測試代碼； (3) 程式的入口最好命名為main.py。
3. docs/: 存放一些文檔。
4. setup.py: 安裝、部署、打包的指令碼。
5. requirements.txt: 存放軟體依賴的外部Python包列表。
6. README: 項目說明檔案。

除此之外，有一些方案給出了更加多的內容。比如LICENSE.txt,ChangeLog.txt檔案等，我沒有列在這裡，因為這些東西主要是項目開源的時候需要用到。如果你想寫一個開源軟體，目錄該如何組織，可以參考這篇文章。

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

關於README的內容

目的是能簡要描述該項目的資訊，讓讀者快速瞭解這個項目。

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

1. 軟體定位，軟體的準系統。
2. 運行代碼的方法: 安裝環境、啟動命令等。
3. 簡要的使用說明。
4. 代碼目錄結構說明，更詳細點可以說明軟體的基本原理。
5. 常見問題說明。

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

關於requirements.txt和setup.pysetup.py

一般來說，用setup.py來管理代碼的打包、安裝、部署問題。業界標準的寫法是用Python流行的打包工具setuptools來管理這些事情。這種方式普遍應用於開源項目中。不過這裡的核心思想不是用標準化的工具來解決這些問題，而是說，一個項目一定要有一個安裝部署工具，能快速便捷的在一台新機器上將環境裝好、代碼部署好和將程式運行起來。

問題:

1. 安裝環境時經常忘了最近又添加了一個新的Python包，結果一到線上運行，程式就出錯了。
2. Python包的版本依賴問題，有時候我們程式中使用的是一個版本的Python包，但是官方的已經是最新的包了，通過手動安裝就可能裝錯了。
3. 如果依賴的包很多的話，一個一個安裝這些依賴是很費時的事情。
4. 新同學開始寫項目的時候，將程式跑起來非常麻煩，因為可能經常忘了要怎麼安裝各種依賴。

setup.py可以將這些事情自動化起來，提高效率、減少出錯的機率。

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

當然，簡單點自己寫個安裝指令碼（deploy.sh）替代setup.py也未嘗不可。

requirements.txt

這個檔案存在的目的是:

1. 方便開發人員維護軟體的包依賴。將開發過程中新增的包添加進這個列表中，避免在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. 這讓單元測試變得困難（因為模組內部依賴了外部配置）
2. 另一方面設定檔作為使用者控製程序的介面，應當可以由使用者自由指定該檔案的路徑。
3. 程式組件可複用性太差，因為這種貫穿所有模組的代碼寫入程式碼方式，使得大部分模組都依賴conf.py這個檔案。

配置的使用，更好的方式是，

1. 模組的配置都是可以靈活配置的，不受外部設定檔的影響。
2. 程式的配置也是可以靈活控制的。

能夠佐證這個思想的是，用過nginx和mysql的同學都知道，nginx、mysql這些程式都可以自由的指定使用者配置。

所以，不應當在代碼中直接import conf來使用設定檔。上面目錄結構中的conf.py，是給出的一個配置範例，不是在寫死在程式中直接引用的設定檔。可以通過給main.py啟動參數指定配置路徑的方式來讓程式讀取配置內容。當然，這裡的conf.py你可以換個類似的名字，比如settings.py。或者你也可以使用其他格式的內容來編寫設定檔，比如settings.yaml之類的。

以Atm項目為例目錄結構：

在項目中需要通過atm.py檔案調用主要的代碼main.py，通過如下方式實現:

#在main檔案中寫入代碼def login():    print("Welcome..")#配置環境變數步驟#所在程式的路徑 返回當前程式的相對路徑print(__file__)import os#返回絕對路徑print(os.path.abspath(__file__))#返回上一級print(os.path.dirname(os.path.abspath(__file__)))#再返回上一級print(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))#賦值import sysBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))#添加環境變數sys.path.append(BASE_DIR)#import conf,corefrom conf import settingsfrom core import mainmain.login()#最終在atm中調用代碼import sys,osBASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))#添加環境變數sys.path.append(BASE_DIR)from conf import settingsfrom core import mainmain.login()

 

python--軟體目錄結構