django最佳實務：項目布局

文章目錄

• project結構
• app目錄結構

在python開源項目目錄結構的基礎上，進一步定義django的目錄結構。根據django的特性，分成兩部分：project結構和app結構。

project結構

這裡定義的是python開源項目目錄結構中的$PROJ_NAME目錄內的內容，需要與python開源項目目錄結構結合起來。

PROJ_NAME/
     __init__.py      這幾個檔案是django建立project所必須的，不做過多說明
     manage.py
     settings.py
     urls.py  
     apps/               即使是“小”工程，也建議分成多個app，每個app足夠簡單，只解決某一個方面的問題 （注1）
         myapp1/
         myapp2/
     extra_apps/     引用的其他app。
     libs/                載入第三方模組，可以避免版本衝突，按照標準的site-packages管理（注2）
           python*.*/　　指定python版本號碼
               site-packages/   
               requirements.pip    #pip的依賴說明檔案
     tests/          project層級的測試，對於每個app，還要有自己的測試代碼
     static/          靜態內容
            css/
            js/
            images/
     uploads/       上傳檔案所在目錄
     templates/    模板目錄，覆蓋app的模板
            flatpages/
            comments/
            example/
            app1/
            app2/
     templatetags/    tag目錄

注1：指定app載入，在settings.py中設定：

sys.path.insert(0, os.path.join(PROJECT_ROOT, 'apps'))
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'extras'))
sys.path.insert(0, os.path.join(PROJECT_ROOT, 'libs'))  

注2：自訂libs的載入，在settings.py中設定：

sys.path.insert(0, '/{{MY_LIB)}/site-packages/*****.egg')
sys.path.insert(0, '/{{MY_LIB}} /site-packages/')  

app目錄結構

$APP_NAME/
     tests/                    app層級的測試代碼
     models/                 注1
          __init__.py
          Amodels.py
          Bmodels.py
     templates/              注2
     templatetags/        tag目錄

注1：如果很好的控制app的規模，Model類數量少，可以使用慣用的models.py檔案中, 否則將models做成一個package
接下來可以有兩種做法：

1. 在__init__.py中import所有的Model類
2. 指定Model的元類（Meta）的app_label, 參考這裡

注2：如果extend 工程下的base.html， 使用 !base.html