在容器中调试 Python

将 Docker 文件添加到 Python 项目时，会添加任务和启动配置以在容器中调试应用程序。为适应 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 日志。
应用程序必须记录“服务器已就绪”消息。
应用程序必须提供可浏览的页面。

以下是一个使用 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://localhost:%s/about.html"
      }
    }
  ]
}

注意：pattern 属性中的正则表达式只是尝试捕获类似于“Starting development server at http://localhost: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 任务内，创建一个新的 dockerRun 属性，并带有一个 volumes 属性。此设置将当前工作区文件夹（应用程序代码）映射到容器中的 /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"
  }
}

选择“容器: 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"
  }
}

选择“容器: 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://localhost:%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"
      }
    }
  ]
}

后续步骤

了解更多关于

在容器中配置非 root 用户

12/21/2021