使用 VSCode Remote SSH 调试 Python 的指南

一、前言

在现代开发环境中，使用远程开发工具已经成为一种趋势。而 Visual Studio Code (VSCode) 的 Remote SSH 插件，能够让我们在本地机器上无缝地编辑和调试远程服务器上的代码。本文将详细讲解如何使用 VSCode Remote SSH 来调试 Python。

二、整体流程

在开始之前，我们先把整体流程展示给大家，方便理解整个过程：

步骤 任务 描述
1 安装 VSCode 首先需要在本地计算机上安装 VSCode。
2 安装 Remote - SSH 插件 在 VSCode 中安装 Remote - SSH 插件。
3 配置 SSH 连接 配置与远程服务器的 SSH 连接，路径可在 settings.json 中设置。
4 连接到远程服务器 使用 VSCode 连接到远程服务器。
5 安装 Python 和调试工具 在远程服务器上安装 Python 和 Pylance 等工具。
6 创建 Python 项目 在远程服务器上创建新的 Python 项目。
7 配置调试配置 在 VSCode 中配置调试设置。
8 启动调试 最后在 VSCode 中启动调试。

三、每一步详解

1. 安装 VSCode

首先，请确保你在本地计算机上安装了 VSCode。可以从 [VSCode 官网]( 下载并按照说明进行安装。

2. 安装 Remote - SSH 插件

打开 VSCode，按照以下步骤安装 Remote - SSH 插件：

  1. 点击左侧扩展图标。
  2. 在搜索框中输入 Remote - SSH 并按回车。
  3. 找到相应插件并点击“Install”按钮进行安装。

3. 配置 SSH 连接

  1. 打开终端并输入以下命令配置 SSH（请替换 your_username 和 your_server_ip）：

    ssh-keygen -t rsa -b 2048

    这条命令生成一个新的 SSH 密钥对。

    按照提示选择默认路径并设置密码（可选）。

  2. 将公钥复制到远程服务器（确保你有远程服务器的权限）：

    ssh-copy-id your_username@your_server_ip

    这条命令将你的公钥复制到远程服务器，以便无需密码访问。

4. 连接到远程服务器

在 VSCode 中，按下 F1 并输入 Remote-SSH: Connect to Host，选择你所配置的 SSH 连接。

这一步将打开一个新的窗口，连接到远程服务器。

5. 安装 Python 和调试工具

一旦连接成功，打开终端并安装 Python 和调试工具（例如 pylance），确保有 Python 环境可供使用：

sudo apt update
sudo apt install python3 python3-pip

安装最新版本的 Python 和 pip。

6. 创建 Python 项目

在远程服务器上创建一个新的 Python 项目文件夹：

mkdir my_python_project
cd my_python_project

创建一个新的项目文件夹并进入该文件夹。

然后，创建一个简单的 Python 文件 app.py：

echo "print('Hello, Remote SSH!')" > app.py

创建一个测试的 Python 文件。

7. 配置调试配置

  1. 在 VSCode 中，按 F1，输入并选择 Debug: Open launch.json。

  2. 在弹出的窗口中，选择 Python：

    {
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        }
    ]
}

    这是一个简单的调试配置，它将调试当前打开的 Python 文件。

8. 启动调试

确保你已经选中 app.py 文件，然后按下 F5 或点击调试面板中的“开始调试”按钮。

这一步将启动你的 Python 程序并进入调试模式。

四、旅行图

以下是你与 VSCode Remote SSH 调试 Python 的旅程图，帮助你快速了解整个过程。

journey
    title VSCode Remote SSH 调试 Python 旅程
    section 前期准备
      安装 VSCode: 5: 完成
      安装 Remote - SSH 插件: 5: 完成
      配置 SSH 连接: 4: 完成
    section 连接与开发
      连接到远程服务器: 4: 完成
      安装 Python 和调试工具: 4: 完成
      创建 Python 项目: 3: 完成
      配置调试配置: 3: 完成
    section 调试
      启动调试: 4: 完成

五、结尾

通过以上步骤，你应该已经成功地在 VSCode 中通过 Remote SSH 调试 Python 代码了。这个过程可以大大提高你的开发效率，尤其是在处理远程服务器的任务时。

在实践中，你可能会遇到其他问题，但记住这一流程会给你提供一个很好的起点。如果在执行过程中有任何疑问或者遇到困难，请随时查阅官方文档或社区寻求帮助。祝你编程愉快！