microsoft / microsoft/vscode-python-debugger

Add configuration option to issue a SIGTERM when the Stop button is clicked in debugger

Open
#316 10 comments 60 reactions 1 assignee View on GitHub

@karthiknadig is already working on this.

Since Aug 8, 2024.

feature-request needs community feedback
Dominant language
TypeScript
Stars
181
Forks
126
Avg merge
2d 3h
Merged PRs (30d)
3

Description

I want the ability to use the "Stop" button in the Python debugger in VS Code to send a SIGTERM (and/or maybe a SIGINT) to the running process, instead of just sending it SIGKILL (as it currently does).

This is the "Stop" button I'm talking about:
image

Proposed Solution

I'm thinking that a new option like this in the launch.json config file could be a good way to introduce this change without being a breaking change for the way everyone is used to the "stop" button working.

{
  "configurations": [
    {
      "name": "Python Debugger: Current File (Integrated Terminal)",
      "type": "debugpy",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "stop_action": "SIGKILL", // this would be a new enum-like config option, with values of "SIGKILL", "SIGINT", "SIGTERM", maybe others
    },
  ]
}
Possible additional ideas, more context
  • The minimum viable solution is described above.

  • SIGKILL (the current behavior) and SIGTERM are the two behaviors I'm personally chasing. SIGINT is another one that would be good to have as an option though.

  • As an extended implementation, the stop_action field could support a process like: send SIGTERM, wait 15 seconds, send SIGKILL.

  • This feature request stems from wanting to be able to test and debug the AWS Batch end-of-job behavior:

Under the hood, the Amazon ECS StopTask API call is used, which sends a SIGTERM value to the running container task. If after 30 seconds the container is still running, a SIGKILL signal is sent to forcibly stop the container. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

Related Previous Issues and Discussions

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.