VS Code + ptvsd ：本地调试远程服务器代码的神器

最新推荐文章于 2024-10-10 08:12:52 发布

置顶 lanyu_01

最新推荐文章于 2024-10-10 08:12:52 发布

阅读量7.9k

点赞数 3

分类专栏：随笔文章标签： ptvsd VScode 远程调试 remote debugger

本文链接：https://blog.csdn.net/lanyu_01/article/details/103374163

版权

随笔专栏收录该内容

2 篇文章 0 订阅

订阅专栏

示例环境：

Windows 10： 64bit
VS Code：1.36.1
Linux： centos 7 64bit
Python 3.6.7
ptvsd 4.3.2

ptvsd github: https://github.com/microsoft/ptvsd

概要

ptvsd 全称 Python Tools for Visual Studio debug server，是针对VScode开发的一款基于Debug Adaptive Protocol 协议的debugger工具。ptvsd结合VScode能够在本地调试远程服务器上的代码，查看程序中的临时变量等。与python自带的调试器pdb相比，可谓是非常的方便易用。以windows10作为本地机为例，我们只需要在本地安装VS Code，并在本地和远程服务器(Linux)上安装ptvsd就可以进行调试了。

PS:有网友指出 如果VS Code版本小于1.27，仅使用ptvsd3.0.0版本，否则直接安装最新的ptvsd（截止至今最新版本为4.1.1）。附上链接。

ptvsd的安装过程这里不作叙述，下面将详细介绍VScode + ptvsd的配置过程

VS Code + ptvsd 配置过程

第一步：打开本地的VS Code，点击debug的配置按钮
debug 配置按钮
选择Remote Attach
在这里插入图片描述
配置lauch.josn文件内容如下：

{
      "version": "0.2.0",
      "configurations": [
            {
                  "name": "Python: Remote Attach",
                  "type": "python",
                  "request": "attach",
                  "port": 5678,       //远程服务器开放的端口
                  "host": "127.0.0.1",  //远程服务器的ip地址
                  "pathMappings": [
                        {
                              "localRoot": "${workspaceFolder}",
                              "remoteRoot": "/home/test_ptvsd/"  //服务器代码存放位置
                        }
                  ]
            }
      ]
}

第二步：创建测试ptvsd的python文件 test_ptvsd.py, 在python代码中加入以下头部代码：

import ptvsd 
# Allow other computers to attach to ptvsd at this IP address and port.
ptvsd.enable_attach(address =('127.0.0.1',5678))
# Pause the program until a remote debugger is attached
ptvsd.wait_for_attach()

为了测试远程调试的效果，我们继续在test_ptvsd.py文件中加入以下代码：

import sys
while True:
	print(sys.platform)
    print("****************这只是个测试****************")

第三步：将test_ptvsd.py文件上传到远程Linux服务器上面（为了方便同步远程和本地的文件，建议采用ftp-sync插件，后续说明），确保本地和远程的测试文件内容完全相同，**然后将本地test_ptvsd.py的头部代码注释掉，切记不要删除！**本地代码如下所示：
在这里插入图片描述

第四步：在Linux远程服务器上输入以下命令行，利用ptvsd运行程序test_ptvsd.py

python3 -m ptvsd --host 127.0.0.1 --port 5678 --wait test_ptvsd.py


# 如果要以包的方式运行程序，只需在前面加上 -m , 例如
python3 -m ptvsd --host 127.0.0.1 --port 5678 --wait -m myproject

备注：

1、根据官方文档，按照我的理解这里的远程ip地址可以用localhost代替，但亲测不通。

2、通常你选择的端口可能会存在被其他程序占用的情况，此时会报Address already in use的错误，建议使用Linux命令 netstat -anp 查询可用的端口号，或者用命令netstat -tunpl|grep 端口号查看占用当前端口的进程，并kill（此方法慎用）。

3、有网友指出利用同样的命令可在本地通过ptvsd来启动远端的程序，亲测不通，如有误解，恳请指正。附上链接。

第五步：在远程执行ptvsd命令后，服务器程序进入等待debug状态，此时在本地代码中设置断点，选择remote attach 执行debug，出现以下debugging toolbar，则表示配置成功。
Debugging toolbar during remote debugging

PS：根据以上描述我们发现ptvsd全程没有使用远程服务器的密码，如果你需要一种更加安全的连接远程服务器的方案，建议使用 Debugging over SSH （ https://code.visualstudio.com/docs/python/debugging#_debugging-over-ssh ）

附加

前面我提到本地和远程服务器的文件同步的问题，其实只需要在VScode中安装扩展插件ftp-sync 就可以完美地解决这个问题，下面介绍其配置过程。

ftp-sync配置：

在安装好ftp-sync插件后，使用快捷键Ctrl+Shift+P打开菜单，输入ftp-sync，出现八种可用的ftp-sync命令，我们首先使用Ftp-sync: Init打开ftp-sync的配置文件ftp-sync.json，配置内容如下：
在这里插入图片描述

{
    "remotePath": "/home/test_ptvsd/",     //服务器代码的存放位置
    "host": "127.0.0.1",     //远程服务器的ip地址
    "username": "root",		 //服务器的username
    "password": "123456",    //服务器的password
    "port": 22,              // 端口号，sftp默认为22，ftp默认为21
    "secure": false,
    "protocol": "sftp",      //协议 sftp 或者 ftp 均可
    "uploadOnSave": false,
    "passive": false,
    "debug": false,
    "privateKeyPath": null,
    "passphrase": null,
    "agent": null,
    "allow": [],
    "ignore": [
        "\\.vscode",
        "\\.git",
        "\\.DS_Store"
    ],
    "generatedFiles": {
        "extensionsToInclude": [
            ""
        ],
        "path": ""
    }
}

常用命令解析：

Ftp-sync: Init       //初始化Ftp-sync配置文件

Ftp-sync: Upload File     //同步本地文件或文件夹到远程

Ftp-sync: Download File     //从远程下载文件

Ftp-sync: Local to Remote     //同步本地文件到远程

Ftp-sync: Remote to Local      //同步远程文件到本地

Ftp-sync: Commit    // 提交

Ftp-sync: Sync current file to Remote   同步当前文件到远程