Reporting a bug

Choose your own 🐜 adventure!

This page outlines how to file a bug on the Python extension. If you are facing an issue with the Python Debugger, you can follow the same steps outlined below, but use "Python Debugger" as the extension name in the Report Issue command (Python Debugger: Report Issue...).

• VS Code on the desktop?
  • Does the Python extension at least load?
    • Yes
    • No
• VS Code on the web? (i.e. vscode.dev or github.dev)
  • Yes (short answer: click here)
• raise RuntimeError("you should never reach here ...")

Desktop

The extension loads

1. Run the Python: Report Issue... command from the command palette (note: If the command is missing, please follow the instructions below)

3. Fill in the details of the bug where there are XXX markers (you will have a chance to add screenshots and GIFs momentarily).
4. Click the green Create on GitHub button.
5. Attach any screenshots or GIFs to help explain the bug you are experiencing.
6. Submit the issue on GitHub.

Gathering Detailed Logs

1. Run Developer: Set Log Level... from the Command Palette.
2. Select Trace.
3. Run Developer: Reload Window.
4. Reproduce the problem.
5. Open the Output panel (View → Output) and select Python in the dropdown.
6. Copy the output and attach it to the issue.

Tip: Logs can contain file paths or environment details. Please review/redact secrets before sharing.

After collecting logs, you can set the log level back to Info (or your preferred level).

Performance issue

Please attach a CPU profile of your running extensions to the issue after you create it.

The extension won't even start

1. Run the Help: Report Issue... command from the command palette.
2. Notice the new window that looks something like the following (notice the empty "Steps to Reproduce" which separates this command from Python: Report Issue...):

3. Set File on to An extension.
4. Set Extension to Python.
5. Fill in Title and Steps to Reproduce.
6. Click the green Create on GitHub button.
7. Add any screenshots or GIFs to the issue.
8. Submit the issue on GitHub.

Web

Create a new issue by following this link.

---

Short link to this page