コンテナー内で Python をデバッグする
Python プロジェクトに Docker ファイルを追加すると、コンテナー内でアプリケーションをデバッグできるようにタスクと起動構成が追加されます。Python プロジェクトのさまざまなシナリオに対応するため、一部のアプリでは追加の設定が必要になる場合があります。
コンテナーのエントリポイントの設定
tasks.jsonでプロパティを設定することで、コンテナーのエントリポイントを設定できます。VS Code は、最初にContainers: Add Docker Files to Workspace...コマンドを使用すると、コンテナーのエントリポイントを自動的に設定します。
例: Python モジュールのエントリポイントを設定する
{
"tasks": [
{
"type": "docker-run",
"label": "docker-run: debug",
"dependsOn": ["docker-build"],
"python": {
"module": "myapp"
}
}
]
}
例: Python ファイルのエントリポイントを設定する
{
"tasks": [
{
"type": "docker-run",
"label": "docker-run: debug",
"dependsOn": ["docker-build"],
"python": {
"args": ["runserver", "0.0.0.0:8000", "--nothreading", "--noreload"],
"file": "manage.py"
}
}
]
}
アプリケーションのエントリページにブラウザーを自動的に起動する
Containers: Python - DjangoまたはContainers: Python - Flaskの起動構成を選択すると、ブラウザーが自動的にアプリのメインページに起動されます。この機能は既定で有効になっていますが、launch.jsonでdockerServerReadyActionオブジェクトを設定することで、この動作を明示的に設定できます。
この機能は、アプリケーションのいくつかの側面によって異なります
- アプリケーションは、デバッグコンソールまたはDockerログに出力する必要があります。
- アプリケーションは、「サーバー準備完了」メッセージをログに記録する必要があります。
- アプリケーションは、ブラウズ可能なページを提供する必要があります。
以下は、特定のサーバーメッセージパターンに基づいてブラウザーを起動してabout.htmlページを開くためにdockerServerReadyActionを使用する例です。
{
"configurations": [
{
"name": "Containers: Python - Django",
"type": "docker",
"request": "launch",
"preLaunchTask": "docker-run: debug",
"python": {
"pathMappings": [
{
"localRoot": "${workspaceFolder}",
"remoteRoot": "/app"
}
],
"projectType": "django"
},
"dockerServerReadyAction": {
"action": "openExternally",
"pattern": "Starting development server at (https?://\\S+|[0-9]+)",
"uriFormat": "%s://:%s/about.html"
}
}
]
}
注:
pattern属性にある正規表現は、単に「Starting development server athttps://:8000」のようなログメッセージをキャプチャしようとします。httpまたはhttpsのURL、任意のホスト名、任意のポートのバリエーションに対応しています。
重要な dockerServerReadyAction オブジェクトのプロパティ
-
action: パターンが見つかったときに実行するアクション。debugWithChromeまたはopenExternallyを指定できます。 -
pattern: アプリケーションが上記と異なるメッセージをログに記録する場合、dockerServerReadyAction オブジェクトのpatternプロパティを、そのメッセージに一致するJavaScript の正規表現に設定します。正規表現には、アプリケーションがリッスンしているポートに対応するキャプチャグループを含める必要があります。 -
uriFormat: 既定では、Container Tools 拡張機能はブラウザーのメインページを開きます (ただし、それはアプリケーションによって決定されます)。ブラウザーが上記の例のように特定のページを開くようにしたい場合は、dockerServerReadyAction オブジェクトのuriFormatプロパティを、プロトコルとポートの置換を示す2つの文字列トークンを含む形式の文字列に設定する必要があります。
Django または Flask アプリでホットリロードを有効にする方法
Django または Flask でContainers: Add Docker Files to Workspaceを選択すると、静的デプロイ用に構成された Dockerfile とtasks.jsonが提供されます。アプリのコードを変更するたびに、コンテナーを再ビルドして再実行する必要があります。ホットリロードを使用すると、コンテナーの実行中にアプリのコードの変更を視覚化できます。次の手順でホットリロードを有効にします。
Django アプリの場合
-
Dockerfile で、アプリのコードをコンテナーに追加する行をコメントアウトします。
#ADD . /app -
tasks.jsonファイルのdocker-runタスク内で、volumesプロパティを持つ新しいdockerRun属性を作成します。この設定により、現在のワークスペースフォルダー (アプリのコード) からコンテナー内の/appフォルダーへのマッピングが作成されます。{ "type": "docker-run", "label": "docker-run: debug", "dependsOn": [ "docker-build" ], "dockerRun": { "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ] }, ... } -
Python 属性を編集し、
--noreloadと--nothreadingを削除します。{ ... "dockerRun": { "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ] }, "python": { "args": [ "runserver", "0.0.0.0:8000", ], "file": "manage.py" } } -
Containers: Python – Django 起動構成を選択し、F5 を押してコンテナーをビルドして実行します。
-
任意のファイルを変更して保存します。
-
ブラウザを更新し、変更が適用されたことを確認します。
Flask アプリの場合
-
Dockerfile で、アプリのコードをコンテナーに追加する行をコメントアウトします。
#ADD . /app -
tasks.jsonファイルのdocker-runタスク内で、既存のdockerRun属性を編集し、envプロパティにFLASK_ENVとvolumesプロパティを追加します。この設定により、現在のワークスペースフォルダー（アプリのコード）からコンテナー内の/appフォルダーへのマッピングが作成されます。{ "type": "docker-run", "label": "docker-run: debug", "dependsOn": [ "docker-build" ], "dockerRun": { "env": { "FLASK_APP": "path_to/flask_entry_point.py", "FLASK_ENV": "development" }, "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ] }, ... } -
Python 属性を編集し、
--no-reloadと--no-debuggerを削除します。{ ... "dockerRun": { "env": { "FLASK_APP": "path_to/flask_entry_point.py", "FLASK_ENV": "development" }, "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ] }, "python": { "args": [ "run", "--host", "0.0.0.0", "--port", "5000" ], "module": "flask" } } -
Containers: Python – Flask 起動構成を選択し、F5 を押してコンテナーをビルドして実行します。
-
任意のファイルを変更して保存します。
-
ブラウザを更新し、変更が適用されたことを確認します。
コンテナーをまとめてビルドして実行する方法
- 前述の
tasks.jsonファイルには、docker-buildタスクへの依存関係があります。このタスクは、tasks.jsonのtasks配列の一部です。たとえば、
"tasks":
[
{
...
},
{
"label": "docker-build",
"type": "docker-build",
"dockerBuild": {
"context": "${workspaceFolder}",
"dockerfile": "${workspaceFolder}/Dockerfile",
"tag": "YOUR_IMAGE_NAME:YOUR_IMAGE_TAG"
}
}
]
ヒント: 依存関係はdocker-buildをその依存関係として明確に示しているため、名前はこのタスクと一致する必要があります。必要に応じて名前を変更できます。
-
JSON の
dockerBuildオブジェクトでは、次のパラメーターを使用できます。- context: Dockerfile が呼び出されるビルドコンテキスト
- dockerfile: 実行する Dockerfile へのパス
- tag: ビルドするイメージの名前とバージョンタグ
-
全体として、Flask アプリケーションをビルドしてデバッグするための VS Code の設定は次のようになります。
-
launch.json{ "version": "0.2.0", "configurations": [ { "name": "Debug Flask App", "type": "docker", "request": "launch", "preLaunchTask": "docker-run: debug", "python": { "pathMappings": [ { "localRoot": "${workspaceFolder}", "remoteRoot": "/app" } ], "projectType": "flask" }, "dockerServerReadyAction": { "action": "openExternally", "pattern": "Running on (http?://\\S+|[0-9]+)", "uriFormat": "%s://:%s/" } } ] } -
tasks.json{ "version": "2.0.0", "tasks": [ { "type": "docker-run", "label": "docker-run: debug", "dependsOn": ["docker-build"], "dockerRun": { "containerName": "YOUR_IMAGE_NAME", "image": "YOUR_IMAGE_NAME:YOUR_IMAGE_TAG", "env": { "FLASK_APP": "path_to/flask_entry_point.py", "FLASK_ENV": "development" }, "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ], "ports": [ { "containerPort": 5000, "hostPort": 5000 } ] }, "python": { "args": ["run", "--host", "0.0.0.0", "--port", "5000"], "module": "flask" } }, { "label": "docker-build", "type": "docker-build", "dockerBuild": { "context": "${workspaceFolder}", "dockerfile": "${workspaceFolder}/Dockerfile", "tag": "YOUR_IMAGE_NAME:YOUR_IMAGE_TAG" } } ] }
-
次のステップ
詳細はこちら