How do I setup launch.json and tasks under Visual Studio Code to fully automate, connect to and debug a remote Python Flask code in Docker container?

Question

至少有 20 个问题与我的问题有些相关，并且有助于我了解如何解决这个问题，但似乎没有一个问题能涵盖我的具体问题的全部答案。 此外，微软文档似乎告诉你 function 部分是如何实现的，但我还没有找到一个全面的例子来说明如何做到这一切。 如果可能的话，我希望这个问题能够涵盖所有内容。 我有一个手动调试过程，我将在下面分享，但我想通过 launch.json 文件中的任务和条目进一步自动化它，这样我就不必手动启动任何东西。 有人愿意与我分享他们在自动化中的确切步骤的全自动版本吗？

这是我为使 Windows Visual Studio Code 与 debugpy 远程 python 调试器一起工作而遵循的配置步骤。 我还添加了如何使用 docker exec -it 和 pdb 来使用交互式调试 session。

我详细介绍了此处更改的文件以及更改内容，以便您了解当前手动工作的方式。

下面我有两种不同的方式来运行 python 调试器：

1. 从终端 window 以交互方式从 pdb 命令行运行它：
2. 从终端 window 中的命令行手动运行它，但让 Visual Studio Code 连接到调试程序和 Docker 容器，以便从 Visual Studio Code 以交互方式执行此操作。

以下步骤是我在阅读 Visual Studio Code 文档并谷歌搜索如何启用远程 Docker 容器 Python 调试后发现的以下两篇文章中采用的：

第1条：

https://stackoverflow.com/questions/40233928/how-to-remote-debug-python-code-in-a-docker-container-with-vs-code#:~:text=In%20your%20Docker%20image %2C%20you%27ll%20need%20to%20make,something%20like%3A%20docker%20run%20-d%20-p%203000%3A3000%20my-image

第2条： https://code.visualstudio.com/docs/python/debugging#:~:text=Switch%20to%20the%20Run%20and%20Debug%20view%20%28Ctrl%2BShift%2BD%29%2C， which%20point%20you%20can%20use%20the%20debugger%20normally .

2. 为了允许 my.py 代码使用 Visual Studio 使用的 debugpy 调试器，我在 Docker 文件中添加了以下条目：

   运行 /usr/bin/pip --no-cache-dir install -U debugpy

3. 从 Ubuntu 20.04 命令行手动和交互运行 pdb 调试器的过程如下。 仅使用此步骤或下面的步骤 6，但不能同时使用两者。 此行运行 Visual Studio 使用的 pdb 调试器（不是 debugpy ）。

在 Ubuntu 20.04 命令行执行以下命令：

export  USER=JOHN DIR=/data OUTPUTFILE=/data/output/output.txt

以下是我如何使用 pdb 运行 python 程序，并通过 3 个环境变量调用 run_user 模块：

docker exec -it my_docker_container /usr/bin/python my.py run_user --my_user=$(USER) --my_dir=$(DIR) --my_file=$(OUTPUTFILE)

4. 现在，为了支持使用 Visual Studio Code 进行调试，我将以下 8888:3001 端口添加到 docker-compose.yml 以便在更改后如下所示：

   webapp: build: ./ image: my.webapp container_name: my_docker_container ports: - 80:80 - 443:443 #----docker-compose.yml 更改开始 - 8888:3001 #----docker-compose.yml 更改结束依赖： - 数据库

5. 打开 Ubuntu 20.04 命令提示符

6. 在内部端口 3001 和主机上的 8888 上运行 debugpy 远程模块的过程，以便可以使用 Visual Studio 调试器。 注意：您不能同时运行第 3 步的交互式 pdb 调试器和此步骤，因为它可能无法正常工作，并且会挂起您的计算机以重新启动。

这是我在 Visual Studio 中使用 debugpy 手动运行 python 程序的方法

export  USER="JOHN" DIR=/data OUTPUTFILE=/data/output/output.txt
docker exec -it my_docker_container /usr/bin/python -m debugpy --listen 0.0.0.0:3001 --wait-for-client my.py run_user --user=$(USER) --my_dir=$(DIR) --my_file=$(OUTPUTFILE)

7. 我至少将以下内容添加到 ~/.vscode/launch.json 中的 Visual Studio 配置中，如下所示（.vscode/launch.json），以便连接到 debugpy 后端：

   { // 使用 IntelliSense 了解可能的属性。 // Hover 查看现有属性的描述。 // 更多信息请访问： https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "name": "Python: Remote Debug Docker JMK", "type": "python", "request": "attach", "port": 8888, // 这是将在本地计算机上打开以与调试器通信的 localhost 端口。: "host" : "localhost", "pathMappings": [ { "localRoot": "${workspaceFolder}", "remoteRoot": "/opt/webapp" } ], "logToFile": true } ]

   }

8. 将上述更改保存到 .vscode/launch.json 文件后，您应该可以按 Control+Shift+D，然后您将在屏幕顶部看到带有绿色右箭头的调试器条目。 或者，您可以按 F5 调出调试器 window。

9. 如果您不使用 Visual Studio 代码并使用交互式 pdb 调试器，则在运行第 3 步后，调试器将附加并在第一行代码处暂停。

然后，您可以使用 pdb 命令并使用 next 单步执行，直到到达下一行代码，否则您必须使用 import pdb pdb.set_trace() 设置初始断点。

10. 不要在 Visual Studio Code 调试 session 中使用 import pdb 或 pdb.set_trace()，而是使用 Visual Studio Code 附加，如其他步骤中所述，因为两者在 Python 历史上的不同时间开发，因此两者有些不兼容。

我对社区的确切问题是什么？它与其他问题有何不同？

我对在第 3 步执行手动步骤以运行 pdb 调试器或 debugpy（在第 6 步）不感兴趣，并且想要一个如何设置任务和启动的完整工作示例。json 条目以自动运行Visual Studio Code 中步骤 3 和步骤 6 的手动步骤。