vscode-django-note

如何使用 VScode 執行 Django 📝

• Youtube Tutorial PART 1 - 如何使用 VScode 執行 Django - 基本篇

• Youtube Tutorial PART 2 - 如何使用 VScode 執行 Django Testing 以及 pylint_django

教學

安裝環境

建議大家先閱讀以下這篇文章 ( 假如你沒用 VScode 寫過 Python )，

Visual Studio Code Python 基本設定篇

安裝 requirements.txt

pip install -r requirements.txt

安裝 VScode Python 套件

設定 Django Debug

選取 Debug > Add Configuration，會跳出 launch.json，

這邊是預設的設定，其他更詳細的設定可參考 tutorial-django

justMyCode 這個主要為可以中斷點到外部 library (第三方) 裡面的東西.

執行 Django Debug

選取 Debug > Start Debugging 或是 F5 開始 Debug

成功執行

Vscode 設定中斷點

中斷點也很簡單，在需要中斷的地方點一下，會有一個紅色的點。

左邊可以看目前的變數，下方的 DEBUG CONSOLE 也很好用，

可以在這邊輸入你想執行的程式。

設定 Django Shell 中斷點

有時候需要使用 Django Shell 或是 Django management commands,

這時候可以這樣設定, .vscode/launch.json

{
    "name": "Python:Django Shell",
    "type": "debugpy",
    "request": "launch",
    "program": "${workspaceFolder}/manage.py",
    "args": [
        // "welcome",  // command
    ],
    "django": true,
    "justMyCode": false,
},

如果你有 management commands, 就在 args 裡面設定即可.

設定 Django Testing

在 Django 中執行 Testing 的指令為

python manage.py test

如果我只想單純對某個資料夾 ( 例如 musics ) 底下跑 testing

python manage.py test musics/

更多詳細可參考

Writing and running tests

這邊有一個簡單的 musics/test.py，

該如何設定讓他執行呢 ?

當然，可以直接在命令列下指令，可是我希望整合 VSCode，

回到剛剛前面介紹的 launch.json，

在這邊只需要再加一個即可 args 的部分改成 test，

就相當於是執行，

python manage.py test

儲存後，如果你點選下方，你會發現你多了一個選項 ( Django Test )

選擇 Django Test 就會開始跑 Testing 了

設定 pylint_django

之前再 Visual Studio Code Python 基本設定篇 這篇有教大家

pip install pylint，但這邊卻是要 pip install pylint_django，原因是因為如果

只安裝 pylint，自己定義的 ORM 很多會出現在 PROBLEMS 裡面，

所以要安裝 pylint_django 修正他，安裝完之後須再 settings.json 加上

"python.linting.pylintArgs": [
        "--load-plugins=pylint_django",
    ]

儲存之後，你就會發現被修正了 ( 剛剛的錯誤消失了 )，

然後底下會有一些 pylint 的建議。

更多 pylint_django 說明可參考 pylint_django。

執行環境

• Python 3.6.6

Donation

文章都是我自己研究內化後原創，如果有幫助到您，也想鼓勵我的話，歡迎請我喝一杯咖啡:laughing:

Thank-you-for-donate

License

MIT license