vscode ssh远程调试python

原创

mob64ca12d94299 2024-11-03 10:11:48 ©著作权

文章标签 Python 远程服务器 json 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12d94299的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用 VSCode 进行 SSH 远程调试 Python

随着远程开发的普及，使用 Visual Studio Code（VSCode）进行 SSH 远程调试 Python 应用程序逐渐成为开发者们的热门选择。它不仅提升了工作效率，同时也方便了对远程服务器上代码的实时编辑和调试。本文将为你介绍如何在 VSCode 中设置 SSH 远程调试 Python 的步骤，同时提供相应的代码示例。

设置环境

在开始之前，确保你已经具备以下条件：

一台可以 SSH 连接的远程服务器。
安装了 VSCode 并添加了 Remote Development 插件。
远程服务器上安装了 Python。

步骤一：安装必备扩展

在 VSCode 中，打开扩展市场并搜索以下扩展进行安装：

Remote - SSH：用于通过 SSH 连接远程主机。
Python：用于 Python 代码的支持，包括调试功能。

步骤二：通过 SSH 连接远程主机

连接到远程主机可以通过 VSCode 的命令面板实现。按下 Ctrl + Shift + P，输入 “Remote-SSH: Connect to Host”，然后选择你的远程主机。

# 使用 SSH 连接命令
ssh username@remote_host

步骤三：设置 Python 项目

在远程服务器上创建一个新的 Python 项目。假设我们创建一个名为 my_project 的文件夹，并在其中创建一个 app.py 文件。

mkdir my_project
cd my_project
touch app.py

在 app.py 文件中添加以下代码：

# app.py
def main():
    print("Hello, World!")
    
if __name__ == "__main__":
    main()

步骤四：配置调试环境

接下来，你需要在你的项目根目录下创建一个 .vscode 文件夹，然后在其中添加一个 launch.json 文件，以配置调试参数。

mkdir .vscode
touch .vscode/launch.json

在 launch.json 文件中添加以下内容：

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

步骤五：开始调试

返回 VSCode，在 app.py 代码行中设置断点（点击行号），然后按下 F5 启动调试。VSCode 将会自动运行你的 Python 脚本，并在断点处停止，允许你检查变量、调用堆栈等信息。

流程图

下面是整个流程的简要概述：

flowchart TD
    A[安装 VSCode 和扩展] --> B[通过 SSH 连接远程主机]
    B --> C[创建 Python 项目]
    C --> D[配置调试环境]
    D --> E[设置断点并开始调试]

关系图

为了更好地理解 VSCode 调试过程中的组件关系，下面是一个关系图：

erDiagram
    USER ||--o{ PROJECT : manages
    PROJECT ||--o{ FILE : contains
    FILE ||--o{ BREAKPOINT : has
    BREAKPOINT ||--o{ DEBUG_SESSION : activates
    USER ||--o{ DEBUG_SESSION : initiates