远程调试Python脚本之ptvsd

深度学习

---

---

前言

有时候需要远程调试Python脚本，怎么办呢…

以下这段代码用于远程调试 Python 脚本，特别是通过 Visual Studio Code（VS Code）的远程调试功能。它会在指定的服务器 IP 和端口上等待调试器的连接。

# 检查是否提供了服务器 IP 和端口
if args.server_ip and args.server_port:
    # 远程调试 - 参见 https://code.visualstudio.com/docs/python/debugging#_attach-to-a-local-script
    import ptvsd

    # 打印等待调试器连接的消息
    print("Waiting for debugger attach")
    # 启用 ptvsd 进行调试，指定服务器 IP 和端口，并重定向输出
    ptvsd.enable_attach(address=(args.server_ip, args.server_port), redirect_output=True)
    # 等待调试器连接
    ptvsd.wait_for_attach()

详细解释
if args.server_ip and args.server_port:：检查 args 对象中是否包含 server_ip 和 server_port 属性。这些属性通常是在启动脚本时通过命令行参数传递的。如果这两个参数都存在，说明需要进行远程调试。

import ptvsd：导入 ptvsd 模块，这是一个用于 Python 的远程调试工具。

print(“Waiting for debugger attach”)：打印消息，提示用户脚本正在等待调试器连接。

ptvsd.enable_attach(address=(args.server_ip, args.server_port), redirect_output=True)：启用远程调试功能。指定的 address 参数是一个元组，包含服务器的 IP 地址和端口。redirect_output=True 表示将标准输出和标准错误重定向到调试器。

ptvsd.wait_for_attach()：阻塞当前线程，直到调试器连接。这意味着脚本会暂停执行，直到调试器连接上来。

示例
假设我们有一个 Args 类，用于存储服务器 IP 和端口。我们可以这样使用这段代码：

class Args:
    def __init__(self):
        self.server_ip = '127.0.0.1'  # 本地 IP 地址
        self.server_port = 5678  # 调试端口

args = Args()

if args.server_ip and args.server_port:
    import ptvsd

    print("Waiting for debugger attach")
    ptvsd.enable_attach(address=(args.server_ip, args.server_port), redirect_output=True)
    ptvsd.wait_for_attach()

print("Debugger attached. Continuing execution...")
# 这里可以放后续的代码，例如模型训练、数据处理等

远程调试步骤
配置 VS Code：

打开 VS Code。
安装 Python 扩展。
打开调试面板（左侧的虫子图标），点击创建 launch.json 文件，并添加以下配置：

{
    "name": "Python: Remote Attach",
    "type": "python",
    "request": "attach",
    "connect": {
        "host": "127.0.0.1",
        "port": 5678
    },
    "justMyCode": false
}

运行脚本：

在终端中运行你的 Python 脚本，例如：

python your_script.py --server_ip 127.0.0.1 --server_port 5678

连接调试器：

在 VS Code 中选择配置好的调试任务 Python: Remote Attach，然后点击绿色的播放按钮开始调试。
脚本会暂停在 ptvsd.wait_for_attach() 处，等待调试器连接。
一旦调试器连接上来，脚本将继续执行，你可以在 VS Code 中进行断点调试等操作。
通过这种方式，你可以在远程服务器上运行代码，并在本地使用 VS Code 进行调试。这对于复杂的深度学习或数据处理任务非常有用。