【Django】基於Django架構網站代碼的目錄結構

 

 經典的Django項目源碼目錄結構

 Django在一個項目的目錄結構划分方面缺乏必要的規范。在Django的官方文檔中並沒有給出大型項目的代碼建議目錄結構，網上的文章也是根據項目的不同結構也有適當的變化。

樣式一 ：強調模塊化設計  參見參考文章二

··管理項目的依賴文件requirements文件夾，列出項目中需要的依賴的文件，比如項目使用的所有python包。

··分離應用文件和庫文件（apps ,libs）新建apps和libs用來保存application和library

··創建完善的setting模塊

優勢：模塊化設計適合規模較大的項目

 缺點：這種布局結構沒有說明static文件的放置路徑。

$ tree .
.
├── djangolicious
│ ├── apps
│   │   ├── blog
│   │   │   ├── __init__.py
│   │   │   ├── models.py
│   │   │   ├── tests.py
│   │   │   └── views.py
│   │   ├── __init__.py
│   │   ├── news
│   │   │   ├── __init__.py
│   │   │   ├── models.py
│   │   │   ├── tests.py
│   │   │   └── views.py
│   │   └── reader
│   │       ├── __init__.py
│   │       ├── models.py
│   │       ├── tests.py
│   │       └── views.py
│   ├── __init__.py
│ ├── libs
│   │   ├── display
│   │   │   ├── __init__.py
│   │   │   ├── models.py
│   │   │   ├── tests.py
│   │   │   └── views.py
│   │   ├── __init__.py
│   │   └── management
│   │       ├── __init__.py
│   │       ├── models.py
│   │       ├── tests.py
│   │       └── views.py
│ ├── settings
│   │   ├── common.py
│   │   ├── dev.py
│   │   ├── __init__.py
│   │   ├── prod.py
│   │   └── test.py
│   ├── urls.py
│   └── wsgi.py
├── manage.py
├── requirements
│   ├── common.txt
│   ├── dev.txt
│   ├── prod.txt
│   └── test.txt
└── requirements.txt

10 directories, 36 files

 

樣式二，大型開源Django框架項目的 參見參考文章5

 此模板是開源項目常用的結構，適合大型Django項目開發。

Project的目錄結構，PROJ_NAME指的是項目名

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

 

 我的總結

 ···樣式一中強調的“Think Modular”思想十分適合大型的項目，大部分大型的項目也是遵循模塊化目錄結構的原則的。

如下圖所示： 

-project
 ---app1
   --templates
     --statics
   views models tests
   urls
 ---app2
 ---appn
 statics
   --css
   --js
 settings 

 

 

···我在開源項目上看到的小型Project的目錄結構差異較大，沒有清晰的體系結構，規律不是很明顯。

 

參考文章

1 Large Django application layout

2 重要Django project structure  基於Django 1.4 project

3 Project design / FS layout for large django projects [closed]

4 Django官網提供的大型開源項目

5 重要 Django最佳實踐:項目布局   |   python開源項目目錄結構

6 AN UPDATED GENERAL DJANGO PROJECT (>= 1.5) STRUCTURE OR FOLDER LAYOUT

7 Google小組上關於目錄結構的討論