使用debugpy進行Python調試

一、介紹

在編寫Python代碼時，我們難免會遇到一些bug，這時我們需要調試器來幫助我們找到問題。Python自帶了pdb模塊，但它的使用並不太方便，而debugpy則是一款輕量級的Python調試器，它具有快速、易用等特點。

在本篇文章中，我們將介紹如何使用debugpy進行Python調試，包括在本地和遠程進行調試，以及如何使用VSCode的調試功能。

二、本地調試

1. 安裝debugpy

首先，我們需要安裝debugpy模塊，可以使用pip進行安裝。

pip install debugpy

2. 在代碼中插入斷點

在需要進行調試的代碼中插入斷點，可以使用debugpy的breakpoint()函數來實現。

import debugpy

debugpy.breakpoint()  # 在此處插入斷點

3. 啟動debugpy調試器

通過在命令行中運行debugpy調試器來啟動調試。

python -m debugpy --listen localhost:5678 your_script.py

其中your_script.py為需要調試的Python文件。該命令會啟動debugpy調試器，並等待連接。可以使用–wait-for-client選項來等待調試客戶端的連接。

4. 連接調試器

在VSCode中打開一個Python文件，然後打開調試視圖，在左側的調試菜單中選擇“添加配置”，選擇Python（調試器），然後將配置文件修改為：

{
    "name": "Python: Remote Attach",
    "type": "python",
    "request": "attach",
    "connect": {
        "host": "localhost",
        "port": 5678
    },
    "pathMappings": [
        {
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "."
        }
    ]
}

其中，host和port分別為啟動debugpy時指定的地址和端口號。

5. 啟動調試器

點擊調試界面的啟動按鈕，即可連接到debugpy調試器並開始調試。

三、遠程調試

1. 進入遠程環境

在遠程環境中需要安裝debugpy模塊，然後在代碼中插入斷點。

2. 啟動debugpy調試器

在遠程環境中啟動debugpy調試器，並將–listen選項設置為0.0.0.0:5678，以便外部連接。

python -m debugpy --listen 0.0.0.0:5678 your_script.py

3. 配置SSH

在本地電腦上，我們需要使用SSH連接到遠程環境。可以使用OpenSSH或PuTTY。

在OpenSSH中，可以使用以下命令：

ssh -R 5678:localhost:5678 user@remote-host

其中，5678為需要轉發的端口號，user為遠程環境的用戶名，remote-host為遠程環境的主機名或IP地址。

4. 連接調試器

在VSCode中打開一個Python文件，然後打開調試視圖，在左側的調試菜單中選擇“添加配置”，選擇Python（調試器），然後將配置文件修改為：

{
    "name": "Python: Remote Attach",
    "type": "python",
    "request": "attach",
    "port": 5678,
    "host": "localhost",
    "pathMappings": [
        {
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "."
        }
    ]
}

其中，host和port分別為連接到遠程環境的SSH地址和端口號。

5. 啟動調試器

點擊調試界面的啟動按鈕，即可連接到遠程環境的debugpy調試器並開始調試。

四、在VSCode中使用調試功能

在VSCode中，可以使用內置的調試功能調試Python代碼，同樣可以使用debugpy進行調試。

1. 配置啟動項

首先，需要在VSCode的啟動項中添加調試配置。點擊VSCode的調試視圖中的“添加配置”，然後選擇Python。

下面是一個使用debugpy的調試配置：

{
    "name": "Python: Debug with Debugpy",
    "type": "python",
    "request": "attach",
    "port": 5678,
    "host": "localhost",
    "pathMappings": [
        {
            "localRoot": "${workspaceFolder}",
            "remoteRoot": "."
        }
    ]
}

2. 插入斷點

在Python代碼中插入調試斷點。

3. 啟動調試器

點擊調試視圖中的啟動按鈕，即可連接到debugpy調試器並開始調試。

五、總結

debugpy是一款輕量級的Python調試器，支持本地和遠程調試，易於使用。我們可以在通過命令行啟動debugpy調試器後，在VSCode中連接調試器，進行Python代碼的調試。通過這篇文章的介紹，希望大家對debugpy的使用有更深入的了解。