dockerコンテナ内のdjangoアプリケーションをVsCodeでデバッグする方法

2020年7月20日2020年12月21日

dockerコンテナ内のdjangoアプリケーションをVsCodeでデバッグする方法

今までdjangoでのデバッグは「djangoでdjango-debug-toolbarを使ってデバッグする」の記事で紹介しているdebug-toolbarなるものを使用してきました。しかしPHPでx-debugを使っていたようにdjangoでもデバッガーの導入したいと思い、ようやく導入してみました。

参考：
　　デバッグツールのインストール方法
　　　　・Visual Studio CodeでPython(Django)のデバッグをしてみた
　　　　・Djangoアプリの動作確認・デバッグ実行にVisual Studio Codeを利用する：Windows10・python3

　　デバッグツールのインストール方法とポート指定方法
　　　　・Dockerで作ったDjangoプロジェクトをVisual Studio Codeで開く

　　デバッグツールをdockerで仕様する方法
　　　　・ぼく「Djangoのリモートデバッグも出来ないエディターなんて…」VSCode「それ、できるで。」~docker-compose編~

インストール

Microsoft公式のPythonの拡張機能をインストールします。

デバッグ用のポートを設定

djangoでデバッグをする時は、django備え付けの簡易WEBサーバーを使用します。この簡易ウェブサーバーにアクセスできるようにポートフォワードの設定をしてあげます。今回はdocker-composeを使用します。必要な部分だけ抜粋します。exposeとportの設定のみです。


expose:
 - "80"
 - "81"
ports:
 - "127.0.0.1:10080:80"
 - "127.0.0.1:10081:81" #debugger用

launch.jsonファイルを生成する

1.デバッガーのマークをクリック
2.「create a launch.json file」をクリック
3.python→djangoを選択する

launch.jsonのファイルが生成されるのでファイルを開いて「"0.0.0.0:81",」の部分を追記してあげます。


{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Django",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/manage.py",
            "args": [
                "runserver",
                "--noreload",
                "0.0.0.0:81", //追加
            ],
            "django": true
        }
    ]
}