1. 程式人生 > 程式設計 >在 Windows 下搭建高效的 django 開發環境的詳細教程

在 Windows 下搭建高效的 django 開發環境的詳細教程

從初學 django 到現在(記得那時最新版本是 1.8,本文釋出時已經發展到 3.1 了),開發環境一直都是使用從官方文件或者別的教程中學來的方式搭建的。但是在實際專案的開發中,越來越感覺之前的開發環境難以適應專案的發展。官方文件或一些教程中的環境搭建方式主要存在這些問題:

python manage.py runserver 啟動的開發伺服器熱過載非常慢,尤其是當專案中匯入了大量模組時,有時候改一次程式碼要等幾秒鐘才能完成過載。 主力開發環境為 Windows + PyCharm,然而有時候依賴的一些服務只能在 Linux 下執行(例如 Celery 以及其他一些非同步任務的庫如 django-q )。

針對以上的一些痛點,我在實際開發當中逐步摸索出一套新的開發環境搭建方法,用來搭建一套舒適的 django 開發環境,總的來說,新的環境包括以下幾個方面的改進:

  • 使用 Uvicorn 代替 django 自帶的開發伺服器啟動應用,極大提高程式碼熱過載速度。
  • 使用 Pipenv 或者 Poetry 來管理虛擬環境和專案依賴。
  • 使用 Docker 容器來執行需要在 Linux 平臺下才能執行的服務。
  • 使用 AutoHotkey 為常用命令設定 alias。

PyCharm 建立 django 專案

Django 專案開發首選 PyCharm,當然你也可以使用 VS Code,不過極有可能隨著一通折騰和配置之後,你會發現終於成功地把 VS Code 配置成了一個 PyCharm。所以為了節約有限的開發時間以及生命,推薦直接使用 PyCharm。

PyCharm 建立一個 django 專案非常簡單,如果是第一次開啟 PyCharm,點選 + Create New Project 就會彈出建立新專案的對話方塊。如果已經開啟過別的專案,則依次點選頂部導航條的 File > New Project 也會彈出建立新專案的對話方塊。

然後在對話方塊左側點選 django ,就會進入 django 專案的配置頁面,完成一些初始化設定,PyCharm 就會自動為我們建立一個新的 django 專案。

Django 專案的配置頁面如圖:

在 Windows 下搭建高效的 django 開發環境的詳細教程

Location配置項會讓你選擇專案位置,例如我要在 C:\Users\user\SpaceLocal\Workspace\G_Courses\

目錄下建立一個名為 django_dev_env_demo 的專案,就填寫 C:\Users\user\SpaceLocal\Workspace\G_Courses\django-dev-env-demo

然後 Project Interpret 選項的展開項中有 2 個選項

  • New environment using

勾選這個選項將使用你選擇的虛擬環境建立工具為新建的專案建立一個 Python 虛擬環境。PyCharm 支援多種虛擬環境建立工具,預設為自帶的 Virtualenv。我之前習慣使用 Pipenv,只需要在系統全域性使用 pip install pipenv 後,PyCharm 就會自動發現 Pipenv 的存在。不過現在我更加傾向於使用 Poetry,PyCharm 目前還沒有整合 Poetry,但是可以在建立完專案後手動設定 Poetry,配置也是超級簡單,將在後面介紹。

建立新的虛擬環境需要指定一個 Base interpreter 基礎 Python 環境,通常 PyCharm 會自動發現系統當前正在使用的 Python 直譯器,如果 PyCharm 沒有自動發現或者想要更換為系統中其它的 Python 直譯器版本,也可以在 Base interpreter 選項裡手動選擇 Python 直譯器。

使用 Pipenv 建立虛擬環境時,PyCharm 同樣會自動發現系統中安裝的 Pipenv 工具,如果沒有發現,也可以在選項中手動選擇。

  • Existing interpreter

勾選這個選項將使用系統已有的 Python 環境。

More Settings選項的展開項中包含更多的 django 初始化設定:

  • Template language

使用的模板引擎,如果沒有特別理由,當然是選擇 django 自帶的模板引擎,當然不嫌麻煩也可以選擇 jinja2。

  • Template folder

存放模板的資料夾名稱。預設即可,後續可以在專案中更改。

  • Application name

django app 名稱,填不填都行,後續可以使用 python manage.py startapp 命令來建立 django app。

勾選 Enable Django admin 將啟用 django 自帶的 admin 管理後臺。

配置完成後,點選 Create 就可以建立一個全新的 django 專案了。

Uvicorn 執行 django

之前說過,django 內建的開發伺服器在修改程式碼後的熱過載非常緩慢,我發現 uvicorn 的過載速度要快得多,所以新專案第一件事,就是使用在開發環境下使用 uvicorn 執行 django。

首先當然要安裝 uvicorn。

安裝 uvicorn 非常簡單,首先開啟 PyCharm 的 Terminal,PyCharm 會自動幫我們啟用專案關聯的虛擬環境,所有命令將在虛擬環境執行,非常方便。執行 pipenv install uvicorn 安裝 uvicorn 就可以了。

在 Windows 下搭建高效的 django 開發環境的詳細教程

Uvicorn 安裝好後,可以在命令列使用 uvicorn 命令來執行 django。但是,每次輸命令啟動 django 會非常麻煩!最好的做法是建立一個指令碼,啟動 django 只需要執行指令碼就可以了。

專案根目錄 建立一個 run_uvicorn.py 的指令碼(指令碼名可以自己隨便取),程式碼如下:

run_uvicorn.py

import uvicorn
import os

def main():
 os.environ.setdefault("DJANGO_SETTINGS_MODULE","django_dev_env_demo.settings")
 uvicorn.run(
  "django_dev_env_demo.asgi:application",host="0.0.0.0",port=8000,log_level="debug",reload=True,)

if __name__ == "__main__":
 main()

指令碼中可以隨意定製程式碼的邏輯,非常靈活。比如這裡我首先設定了一個環境變數 DJANGO_SETTINGS_MODULE 用來指定 django 啟動時載入的配置檔案。舉一反三,可以在 uvicorn.run 之前進行更多的設定。例如對於更加複雜的專案,我通常會把一些重要的路徑加入到 sys.path 中,以及設定專案所需的環境變數。

然後就是 uvicorn.run 啟動 django。更確切點地說就是啟動一個 ASGI 或者 WSGI 應用。django 3 以後逐漸支援 ASGI 應用,而在此之前則是 WSGI。第一個引數傳入 ASGI 或者 WSGI 應用所在的模組。例如這裡的 django_dev_env_demo.asgi:application 表示 django_dev_env_demo 下 asgi.py 模組裡的 application(django 提供的 ASGI 應用的例項),在 django_dev_env_demo/asgi.py 下可以看到。如果是 django 3.0 以前版本,相應改為 WSGI application 所在模組即可。

其它啟動引數顧名思義,最為重要的就是這個 reload ,它啟動熱過載功能,比 django 自帶的開發伺服器過載快 很多。

在 Windows 下搭建高效的 django 開發環境的詳細教程

PyCharm 執行一個 Python 指令碼非常方便,點選 if __name__=="__main__" 旁邊的綠色小三角就可以執行這個指令碼,或者滑鼠放到 run_uvicorn.py 上,然後點選滑鼠右鍵,再點選 Run ‘run_uvicorn'。點選 Debug ‘run_uvicorn',則以 debug 模式啟動 django,開發過程中可以非常方便地打斷點進行除錯。

在 Windows 下搭建高效的 django 開發環境的詳細教程

指令碼執行後的輸出:

在 Windows 下搭建高效的 django 開發環境的詳細教程

說明應用已在 8000 埠啟動,現在訪問 localhost:8000,可以看到熟悉的 django 專案初始頁面。

在 Windows 下搭建高效的 django 開發環境的詳細教程

對於執行過的指令碼,PyCharm 都會記錄在右上角,以後只要在右上角的下拉框中選擇需要執行的指令碼,然後點選綠色三角或者 debug 按鈕執行就可以了,非常方便!

在 Windows 下搭建高效的 django 開發環境的詳細教程

Docker 執行外部服務

以前為了開發 django,我需要在系統中安裝和配置各種服務,例如 MySQL、PostgreSQL、Redis、Elasticsearch,有些服務 Windows 還配不了,比如 Celery。

現在有了 Docker 容器,一切變得簡單。

例如我需要一個 PostgreSQL,我只需要一條命令就可以啟動一個 PostgreSQL 容器。當然更好的做法是編寫一個 docker-compose 檔案,並且設定該容器隨 Docker 啟動而啟動,我係統中 PostgreSQL 服務的 Dockerfile 和docker-compose.yml 檔案如下:

Dockerfile

FROM postgres:11.3

docker-compose.yml

version: '3'

volumes:
 postgres_data: {}
 postgres_data_backups: {}

services:
 postgres:
 restart: always
 build:
  context: .
 image: postgres
 container_name: postgres
 volumes:
  - postgres_data:/var/lib/postgresql/data
  - postgres_data_backups:/backups
 env_file:
  - postgres.env
 ports:
  - "14789:5432"

各項配置的含義請參考 Docker 的官方文件,實現的效果就是系統開機自啟動 Docker,Docker 啟動後自動啟動一個執行著 PostgreSQL 資料庫服務的容器,服務對映到主機的 14789 埠,這樣,我的 django 或者其他應用程式都可以通過 host.docker.internal:14789 訪問到 PostgreSQL 資料庫服務。

最棒的是,PyCharm 還集成了資料庫管理工具,無論是 SQLite 還是 MySQL 或者 PostgreSQL,都可以輕鬆連線,這樣開發過程中就不需要使用額外的資料庫視覺化工具來檢視開發資料了。

以 SQLite 為例,示例專案中執行 python manage.py migrate 命令建立資料庫。

在 Windows 下搭建高效的 django 開發環境的詳細教程

對於 SQLite 資料庫,只需要雙擊資料庫檔案就可以直接連線,然後就能檢視資料庫表結構以及表中的資料了:

在 Windows 下搭建高效的 django 開發環境的詳細教程

其它如 MySQL、PostgreSQL,只需要手動新增 Data Source 就可以連線。

類似的,Redis 現在幾乎是開發必備,我會設定系統啟動後也會自動啟動一個 執行著 Redis 服務的容器。docker-compose.yml 檔案內容如下:

version: '3'

services:
 redis:
 restart: always
 image: 'bitnami/redis:5.0'
 container_name: redis
 ports:
  - '48988:6379'
 volumes:
  - 'redis_data:/bitnami/redis/data'
 env_file:
  - redis.env

volumes:
 redis_data:
 driver: local

服務對映到主機的 48988 埠,這樣,我的 django 或者其他應用程式都可以通過 host.docker.internal:48988 訪問到 redis 服務。

其它任何服務都可以類似地配置,例如 Elasticsearch、Celery 等等。

AutoHotkey

開發過程中難免需要輸入大量命令,比如 django 中的這幾條使用頻率極高:

python manage.py makemigrations
python manage.py migrate
python manage.py createsuperuser

重複輸入這些命令單調又枯燥,還浪費生命。

AutoHotkey 的其中一個功能是為指定的文字設定縮寫詞,並使用熱鍵將縮寫詞展開為全文字。例如我會為以上命令設定縮寫詞:

python manage.py makemigrations 設定為 pmmm,按 tab 鍵展開
python manage.py migrate 設定為 pmm,按 tab 鍵展開
python manage.py createsuperuser 設定為 pmcs,按 tab 鍵展開

我只需要在命令列輸入 pmmm 再按 tab,AutoHotkey 就會將其展開為 python manage.py makemigrations 的完整命令。

當然,AutoHotkey 的功能遠不止如此,還可以用來設定快捷開啟常用網站,常用資料夾等等,現在已是我在 Windows 下節約不少生命值的效率工具。

使用 Poetry?

Poetry 與 Pipenv 的爭議

當年關於 Pipenv 還是 Poetry 曾引發過不少爭議。《Flask Web 開發實戰》的作者發文呼籲大家 不要用 Pipenv ,並列舉了不少 Pipenv 存在的問題。

Pipenv 的確存在不少如文中所說的問題,很多問題 issue 維護者給出的建議是請安裝 master 分支的程式碼。

在體驗了 Poetry 以後,我發現遷移 Poetry 並非一件困難的事,而且對於日常使用來說,Poetry 一樣簡單易用,所以目前對於新的專案,我都會優先使用 Poetry。

當然話說回來,Pipenv 的一些問題都是一些特殊環境下的問題,這些問題 Poetry 同樣也會存在。對於一般的使用場景,我並未發現 Pipenv 和 Poetry 的使用區別。

所以總結一句話,我的使用原則是:

優先用 Poetry,但對於一些小專案或者示例專案,為了更好地和 PyCharm 配合,我也會使用 Pipenv。

PyCharm 中設定 Poetry

PyCharm 中設定 Poetry 非常簡單。當然首先第一步是安裝 Poetry,安裝也是超級簡單,各種作業系統平臺都是一條命令搞定,安裝命令可參考 Poetry 的 官方文件 。

Poetry 安裝後,在專案根目錄執行 poetry init 命令初始化專案,依據提示輸入初始化設定後,poetry 會在專案根目錄生成 pyproject.toml 專案描述檔案。內容大概是這樣:

[tool.poetry]
name = "django_dev_env_demo"
version = "0.1.0"
description = ""
authors = ["zmrenwu <[email protected]>"]

[tool.poetry.dependencies]
python = "^3.7"

[tool.poetry.dev-dependencies]

[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"

安裝依賴可以使用 add 命令,例如要新增 django 依賴:

$ poetry add django

poetry 會自動將依賴寫入 pyproject.toml 專案描述檔案, [tool.poetry.dependencies] 的內容變成了這樣:

[tool.poetry.dependencies]
python = "^3.7"
django = "^3.0.3"

如果是開發環境下的依賴,和 Pipenv 類似,可以加 --dev 引數標記為開發環境依賴包:

$ poetry add pytest pytest-django --dev

Poetry 會自動將依賴寫入 pyproject.toml 專案描述檔案, [tool.poetry.dev-dependencies] 的內容變成了這樣:

[tool.poetry.dev-dependencies]
pytest = "^5.3.5"
pytest-django = "^3.8.0"

為了 PyCharm 自動使用 poetry 建立的虛擬環境,需要在專案中配置 Python 直譯器為 poetry 建立的虛擬環境中的直譯器。

首先執行下面的命令輸出建立的虛擬環境所在位置:

$ poetry env info --path
C:\Users\user\.virtualenvs\django_dev_env_demo-frkNfPtg

PyCharm 中:File -> Settings -> Porject: django_dev_env_demo -> Project Interpreter。

在 Windows 下搭建高效的 django 開發環境的詳細教程

點選右上角的齒輪,再點選 Add 新增虛擬環境,選擇 Existing environment,再點選 Interpreter 後面的省略號,選擇 poetry env info --path 輸出的虛擬環境路徑下的 Scripts/python.exe 作為直譯器。

在 Windows 下搭建高效的 django 開發環境的詳細教程

然後點選 ok 確認就 ok 了。

這樣,在使用 PyCharm 的 Terminal 時,就會自動啟用 poetry 建立的虛擬環境,和用 Pipenv 建立的虛擬環境一樣。

總結

這裡給大家展示瞭如何使用 PyCharm + Uvicorn + Docker + AutoHotkey + Pipenv or Poetry 搭建舒適的 django 開發環境,基本上能滿足大部分不是很複雜的專案。

要記住,無論以什麼樣的方式搭建開發環境,核心目的只有一個: 讓開發者只需關注核心業務邏輯的開發,而不是被各種環境問題分心。

當然,對於一些更加複雜的專案,在此基礎上我們還可以進一步優化環境的配置來滿足各種複雜的環境要求,我會在以後的文章裡進行進一步地介紹。

到此這篇關於在 Windows 下搭建高效的 django 開發環境的詳細教程的文章就介紹到這了,更多相關Windows 搭建django 開發環境內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!