Add configuration option to issue a SIGTERM (or other signal) when the debugger is being stopped

[DeflateAwning]

Related to implementing this issue: microsoft/vscode-python-debugger#316

Example Use Cases

• When working with hardware, hardware connections/locks can be released.
• Debugging/testing signal handling capabilities (e.g., testing an AWS Batch container termination)

Related Issues

• Ctrl-C doesn't send SIGINT to python program launched with debugger #500
• Add configuration option to issue a SIGTERM when the Stop button is clicked in debugger vscode-python-debugger#316

[1st]

Totally support this. My use case:

• run a debugger for Python async code
• then stop debugger by pressing a red square

Expected:

• code will be stopped in the same way as when I click Ctrl+C
• in my code I can use except asyncio.CancelledError as e: to catch this exception on the needed level and exit my program gratefully. I do not do it for Ctrl + C and it works well for me
• when I stop my code gratefully, I can close WebSocket, DB and other opened connections. It will avoid problems with unclosed network connections and file descriptors

Actual:

• when I stop debugger using red square, it kills the process
• any signals like these aren't raised by debugger: signal.signal(signal.SIGINT, signal_handler) or signal.signal(signal.SIGTERM, signal_handler)

Workaround:

• as for now, we can go to the terminal with debugger and press there Ctrl + C. It will stop debugger in a needed way

I would like to see an option in the launch.json file that allows to control how debugger is existed - by killing the process or by sending a signal. Sending a signal is a preferred way as it allows to handle program exit in a predefined way.

[rubensa]

I think this might be of interest.

[rubensa]

This might also be of interest as I checked myself that adding onTerminate property (despite VSCode says it's not allowed) to the launch configuration allows for a graceful termination.

@debonte it looks like @fabioz added this functionality.

[jrx-sjg]

This might also be of interest as I checked myself that adding onTerminate property (despite VSCode says it's not allowed) to the launch configuration allows for a graceful termination.

@debonte it looks like @fabioz added this functionality.

Did this really worked? Where do you put the option? I'm trying to use it, but my application stills receive a SIGKILL.

[rubensa]

@jrx-sjg Yes, this works.

You have to add it to your launch.json configuration. This is an example:

{
  // 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 (local): my-project (uvicorn)",
      "type": "debugpy",
      "request": "launch",
      "program": "${workspaceFolder}/.venv/bin/uvicorn",
      "console": "integratedTerminal",
      "envFile": "${workspaceFolder}/.devcontainer/.env.local",
      "justMyCode": false,
      // see: https://stackoverflow.com/a/79469455
      "onTerminate": "KeyboardInterrupt",
      "args": [
        "main:app",
        "--host",
        "0.0.0.0",
        "--reload"
      ]
    }
  ]
}