在容器中调试 Python
当向 Python 项目添加 Docker 文件时,将添加任务和启动配置以实现在容器中调试应用程序。为了适应 Python 项目的各种场景,某些应用程序可能需要额外的配置。
配置容器入口点
你可以通过在 tasks.json
中设置属性来配置容器的入口点。当你首次使用**容器: 将 Docker 文件添加到工作区...** 命令时,VS Code 会自动配置容器入口点。
示例:为 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"
}
}
]
}
自动将浏览器启动到应用程序入口页
你可以选择**容器: Python - Django** 或**容器: Python - Flask** 启动配置,以自动将浏览器启动到应用程序的主页。此功能默认启用,但你可以通过在 launch.json
中设置 dockerServerReadyAction
对象来显式配置此行为。
此功能依赖于应用程序的以下几个方面
- 应用程序**必须输出到调试控制台或 Docker 日志**。
- 应用程序必须记录“server ready”消息。
- 应用程序必须提供可浏览的页面。
以下是使用 dockerServerReadyAction
根据特定服务器消息模式启动浏览器以打开 about.html
页面的示例
{
"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
:默认情况下,容器工具扩展会打开浏览器的主页(无论应用程序如何确定)。如果你希望浏览器打开特定页面(如上例),则应将 dockerServerReadyAction 对象的uriFormat
属性设置为一个包含两个字符串标记的格式字符串,以指示协议和端口替换。
如何在 Django 或 Flask 应用程序中启用热重载
当你为 Django 或 Flask 选择**容器: 将 Docker 文件添加到工作区**时,我们会为你提供一个 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}" } ] }, ... }
-
通过**删除**
--noreload
和--nothreading
来编辑 python 属性。{ ... "dockerRun": { "volumes": [ { "containerPath": "/app", "localPath": "${workspaceFolder}" } ] }, "python": { "args": [ "runserver", "0.0.0.0:8000", ], "file": "manage.py" } }
-
选择**容器: Python – Django** 启动配置,然后按 F5 来构建并运行你的容器。
-
修改并保存任意文件。
-
刷新浏览器并验证更改已生效。
对于 Flask 应用程序
-
在 Dockerfile 中,注释掉将应用程序代码添加到容器的行。
#ADD . /app
-
在
tasks.json
文件中的docker-run
任务中,通过在env
属性中添加FLASK_ENV
以及一个volumes
属性来编辑现有的 dockerRun 属性。此设置将当前工作区文件夹(应用程序代码)映射到容器中的/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}" } ] }, ... }
-
通过**删除**
--no-reload
和--no-debugger
来编辑 python 属性。{ ... "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" } }
-
选择**容器: 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" } } ] }
-
后续步骤
了解更多关于