Debug Protocol Overview about debugger HOT 4 CLOSED

cc @KsavinN

Let me know if something isn't clear, and we can update the diagram.

from debugger.

Awesome! That will be super useful for kernel authors who want to support debugging! I think it would be nice to add it to the kernel protocol documentation once the "extended" debug protocol has been adopted.

from debugger.

Definitely 👍

from debugger.

Adding some documentation on how to inspect the debug messages sent in VS Code. This can be useful to understand when debug requests are made (for example triggered by a UI action).

Create launch.json

First step is to create a test file and a debug configuration:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "env": {"PTVSD_LOG_DIR": "/path/to/logs/folder"}
        }
    ]
}

EDIT: recent versions of VS Code are now using debugpy. The launch configuration must then be changed to using the DEBUGPY_LOG_DIR environment variable:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "env": {"DEBUGPY_LOG_DIR": "/path/to/logs/folder"}
        }
    ]
}

Start the debugger

Open the logs

The content of the log file look like this:

...

D00000.032: IDE --> {
                "command": "initialize",
                "arguments": {
                    "clientID": "vscode",
                    "clientName": "Visual Studio Code",
                    "adapterID": "python",
                    "pathFormat": "path",
                    "linesStartAt1": true,
                    "columnsStartAt1": true,
                    "supportsVariableType": true,
                    "supportsVariablePaging": true,
                    "supportsRunInTerminalRequest": true,
                    "locale": "en-us"
                },
                "type": "request",
                "seq": 1
            }

...

With:

• IDE = VS Code
• PYD = pydev debugger
• Messages follow the DAP: https://microsoft.github.io/debug-adapter-protocol/specification

Overview

from debugger.