Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 4.85 KB

README.md

File metadata and controls

55 lines (32 loc) · 4.85 KB
Raw

Python Debugger extension for Visual Studio Code

A Visual Studio Code extension that supports Python debugging with debugpy. Python Debugger provides a seamless debugging experience by allowing you to set breakpoints, step through code, inspect variables, and perform other essential debugging tasks. The debugpy extension offers debugging support for various types of Python applications including scripts, web applications, remote processes, and multi-threaded processes.

Note:

  • The Python extension offers the python debugger extension as an optional installation, including it during the setup process.
  • This extension is supported for all actively supported versions of the Python language (i.e., Python >= 3.7).

Purpose

The main intent of this extension is to offer:

  1. Independence and Compatibility: The Python Debugger extension aims to separate the debugging functionality from the main Python extension to prevent compatibility issues. This ensures that even as the Python extension drops support for older Python versions (e.g., Python 3.7), you can continue debugging projects with those versions without downgrading your Python extension. This allows you to access new features and bug fixes while keeping your debugging capabilities intact.

  2. Platform-Specific Builds: Unlike the main Python extension, which bundles all debugpy builds for various platforms into a single extension package, the Python Debugger extension provides a more streamlined approach: it delivers platform-specific builds, ensuring you only receive the components relevant to your specific operating system. This reduces download times and unnecessary overhead.

  3. Feature Parity and Ongoing Updates: This extension replicates all the functionality available in the main Python extension, and more. Going forward, any new debugger features will be added to this extension. In the future, the Python extension will no longer offer debugging support on its own, and we will transition all debugging support to this extension for all debugging functionality.

Usage

Once installed in Visual Studio Code, python-debugger will be automatically activated when you open a Python file.

Disabling the Python Debugger extension

If you want to disable the Python Debugger extension, you can disable this extension per workspace in Visual Studio Code.

Commands

Command Description
Python Debugger: viewOutput Show the Python Debugger Extension output.
Python Debugger: clearCacheAndReload Allows you to clear the global values set in the extension.
Python Debugger: debugInTerminal Allows you to debug a simple Python file in the terminal.

Limited support for deprecated Python versions

Older versions of the Python Debugger extension are available for debugging Python projects that use outdated Python versions like Python 2.7 and Python 3.6. However, it’s important to note that our team is no longer maintaining these extension versions. We strongly advise you to update your project to a supported Python version if possible.

You can reference the table below to find the most recent Python Debugger extension version that offers debugging support for projects using deprecated Python versions, as well as the debugpy version that is shipped in each extension version.

Note: If you do not see older extension versions to install (<=2024.0.0), try opting-in to pre-releases. You can do so on the extension page by clicking Switch to Pre-Release Version.

Python version Latest supported Python Debugger extension version debugpy version
2.7, >= 3.5 2023.1.XXX 1.5.1
>= 3.7 2024.0.XXX 1.7.0
>= 3.8 2024.2.XXX 1.8.1

Note: Once you install an older version of the Python Debugger extension in VS Code, you may want to disable auto update by changing the value of the "extensions.autoUpdate" setting in your settings.json file.

Data and telemetry

The Debugpy Extension for Visual Studio Code collects usage data and sends it to Microsoft to help improve our products and services. Read our privacy statement to learn more. This extension respects the telemetry.enableTelemetry setting which you can learn more about at https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting.