VS Code 與 Django 相關配置

說明

分享在 Visual Studio Code 開發 Django 時有哪些好用的擴充和設定，以及注意事項。

Python

Django 以 Python 語言開發，在開發 Django 之前，需先把 Python 相關設定配置好，詳細內容可參考 VS Code 的 Python 擴充和設定 。

以下是 Python 擴充相關注意事項

Pylance Django 問題

在我寫這篇文章時，我在寫 Django 資料庫查詢語法的 Article.objects.filter().all() 類似這樣的程式碼被提示會回傳 ValuesQuerySet 型態，但上網查卻指出這是舊版 Django 回傳的型態，最後我直接下載 django-stubs 專案，將Pylance 擴充的 ~/.vscode/extensions/ms-python.vscode-pylance-2023.4.31/dist/bundled/stubs/django-stubs 替換成最新下載的 django-stubs，也許官方之後會修正這個問題，如果你有遇到相同的狀況可以試試看這個方法。

Pylint Django 設定

開發 Django 時需安裝 pylint_django

pip install pylint-django

然後在 settings.json 配置

settings.json

{
  "python.linting.pylintArgs": [
    "--django-settings-module=your_app.settings",
    "--load-plugins=pylint_django"
  ],
}

your_app.settings 為你的 Django 專案的 settings.py 位置

Django 擴充功能推薦

1. Django
2. djLint

Django 擴充功能

這我主要用來檢查 Django Html 樣板的語法，以及將 Django Html 檔案識別為 django-html。

djLint 擴充功能

用來格式化 django-html 檔案，使用之前需先安裝套件。

pip install djlint

接著在 settings.json 設定

settings.json

{
  // 忽略問題
  "djlint.ignore": ["H017"],
  // 我的電腦 python3 會自動連結到最新的 python 3.x 版
  "djlint.pythonPath": "python3",
  "[django-html]": {
    // 預設格式化工具
    "editor.defaultFormatter": "monosans.djlint"
  }
}

關於 H017 問題，可參考 djLint Linter Usage