Debugging a QGIS plugin with VS Code

debug_with_vscode.md

QGIS

1. ScriptRunnerでdebugpy_OSGeo4W.pyを実行。

VS Code

1. 次で.vscode/launch.jsonを作成。remoteRootを${workspaceFolder}に変更。

Menu / Run / Add Configuration…

• Python Debugger
• Debug Configuration: Remote Attach
• Enter the host name: localhost
• Enter the port number: 5678

2. デバッグ開始。

Menu / Run / Start Debugging

debugpy_OSGeo4W.py

import debugpy
debugpy.configure(python="C:/OSGeo4W/bin/python3.exe")  # https://github.com/microsoft/debugpy/issues/262
port = 5678
debugpy.listen(port)

launch.json

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Remote Attach",
            "type": "debugpy",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "pathMappings": [
                {
                    "localRoot": "${workspaceFolder}",
                    "remoteRoot": "${workspaceFolder}"
                }
            ]
        }
    ]
}