Skip to content

Commit b66f64c

Browse files
NikolaRHristovNikolaRHristov
committed
1 parent fb25700 commit b66f64c

File tree

6 files changed

+140
-63
lines changed

6 files changed

+140
-63
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Microsoft Open Source Code of Conduct
22

3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
3+
This project has adopted the
4+
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
45

56
Resources:
67

7-
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
8-
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
9-
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
8+
- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
9+
- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
10+
- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with
11+
questions or concerns

‎README.md‎

Lines changed: 73 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,98 @@
11
# Python Debugger extension for Visual Studio Code
22

3-
A [Visual Studio Code](https://code.visualstudio.com/) [extension](https://marketplace.visualstudio.com/VSCode) 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.
4-
5-
Note:
6-
- The Python extension offers the python debugger extension as an optional installation, including it during the setup process.
7-
- This extension is supported for all [actively supported versions](https://devguide.python.org/#status-of-python-branches) of the Python language (i.e., Python >= 3.7).
8-
3+
A [Visual Studio Code](https://code.visualstudio.com/)
4+
[extension](https://marketplace.visualstudio.com/VSCode) that supports Python
5+
debugging with debugpy. Python Debugger provides a seamless debugging experience
6+
by allowing you to set breakpoints, step through code, inspect variables, and
7+
perform other essential debugging tasks. The debugpy extension offers debugging
8+
support for various types of Python applications including scripts, web
9+
applications, remote processes, and multi-threaded processes.
10+
11+
Note:
12+
13+
- The Python extension offers the python debugger extension as an optional
14+
installation, including it during the setup process.
15+
- This extension is supported for all
16+
[actively supported versions](https://devguide.python.org/#status-of-python-branches)
17+
of the Python language (i.e., Python >= 3.7).
918

1019
## Purpose
1120

1221
The main intent of this extension is to offer:
1322

14-
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.
15-
16-
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.
17-
18-
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.
19-
23+
1. **Independence and Compatibility:** The Python Debugger extension aims to
24+
separate the debugging functionality from the main Python extension to
25+
prevent compatibility issues. This ensures that even as the Python extension
26+
drops support for older Python versions (e.g., Python 3.7), you can continue
27+
debugging projects with those versions without downgrading your Python
28+
extension. This allows you to access new features and bug fixes while keeping
29+
your debugging capabilities intact.
30+
31+
2. **Platform-Specific Builds:** Unlike the main Python extension, which bundles
32+
all debugpy builds for various platforms into a single extension package, the
33+
Python Debugger extension provides a more streamlined approach: it delivers
34+
platform-specific builds, ensuring you only receive the components relevant
35+
to your specific operating system. This reduces download times and
36+
unnecessary overhead.
37+
38+
3. **Feature Parity and Ongoing Updates:** This extension replicates all the
39+
functionality available in the main Python extension, and more. Going
40+
forward, any new debugger features will be added to this extension. In the
41+
future, the Python extension will no longer offer debugging support on its
42+
own, and we will transition all debugging support to this extension for all
43+
debugging functionality.
2044

2145
## Usage
2246

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

2550
## Disabling the Python Debugger extension
26-
If you want to disable the Python Debugger extension, you can [disable this extension](https://code.visualstudio.com/docs/editor/extension-marketplace#_disable-an-extension) per workspace in Visual Studio Code.
51+
52+
If you want to disable the Python Debugger extension, you can
53+
[disable this extension](https://code.visualstudio.com/docs/editor/extension-marketplace#_disable-an-extension)
54+
per workspace in Visual Studio Code.
2755

2856
## Commands
2957

30-
| Command | Description |
31-
| ---------------------- | --------------------------------- |
32-
| Python Debugger: viewOutput | Show the Python Debugger Extension output. |
58+
| Command | Description |
59+
| ------------------------------------ | ----------------------------------------------------------- |
60+
| Python Debugger: viewOutput | Show the Python Debugger Extension output. |
3361
| Python Debugger: clearCacheAndReload | Allows you to clear the global values set in the extension. |
34-
| Python Debugger: debugInTerminal | Allows you to debug a simple Python file in the terminal. |
62+
| Python Debugger: debugInTerminal | Allows you to debug a simple Python file in the terminal. |
3563

3664
## Limited support for deprecated Python versions
3765

38-
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.
39-
40-
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.
66+
Older versions of the Python Debugger extension are available for debugging
67+
Python projects that use outdated Python versions like Python 2.7 and Python
68+
3.6. However, it’s important to note that our team is no longer maintaining
69+
these extension versions. We strongly advise you to update your project to a
70+
supported Python version if possible.
4171

42-
> **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`.
72+
You can reference the table below to find the most recent Python Debugger
73+
extension version that offers debugging support for projects using deprecated
74+
Python versions, as well as the debugpy version that is shipped in each
75+
extension version.
4376

44-
| Python version | Latest supported Python Debugger extension version | debugpy version |
45-
| -------------- | -------------------------------------------------- | ---------------- |
46-
| 2.7, >= 3.5 | 2023.1.XXX | 1.5.1 |
47-
| >= 3.7 | 2024.0.XXX | 1.7.0 |
48-
| >= 3.8 | 2024.2.XXX | 1.8.1 |
77+
> **Note**: If you do not see older extension versions to install
78+
> (<=`2024.0.0`), try opting-in to pre-releases. You can do so on the extension
79+
> page by clicking `Switch to Pre-Release Version`.
4980
81+
| Python version | Latest supported Python Debugger extension version | debugpy version |
82+
| -------------- | -------------------------------------------------- | --------------- |
83+
| 2.7, >= 3.5 | 2023.1.XXX | 1.5.1 |
84+
| >= 3.7 | 2024.0.XXX | 1.7.0 |
85+
| >= 3.8 | 2024.2.XXX | 1.8.1 |
5086

51-
> **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.
52-
87+
> **Note**: Once you install an older version of the Python Debugger extension
88+
> in VS Code, you may want to disable auto update by changing the value of the
89+
> `"extensions.autoUpdate"` setting in your `settings.json` file.
5390
5491
## Data and telemetry
55-
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](https://privacy.microsoft.com/privacystatement) 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.
92+
93+
The Debugpy Extension for Visual Studio Code collects usage data and sends it to
94+
Microsoft to help improve our products and services. Read our
95+
[privacy statement](https://privacy.microsoft.com/privacystatement) to learn
96+
more. This extension respects the `telemetry.enableTelemetry` setting which you
97+
can learn more about at
98+
https://code.visualstudio.com/docs/supporting/faq#_how-to-disable-telemetry-reporting.

‎SECURITY.md‎

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,62 @@
22

33
## Security
44

5-
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
6-
7-
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition), please report it to us as described below.
5+
Microsoft takes the security of our software products and services seriously,
6+
which includes all source code repositories managed through our GitHub
7+
organizations, which include [Microsoft](https://github.com/microsoft),
8+
[Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet),
9+
[AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and
10+
[our GitHub organizations](https://opensource.microsoft.com/).
11+
12+
If you believe you have found a security vulnerability in any Microsoft-owned
13+
repository that meets
14+
[Microsoft's definition of a security vulnerability](https://aka.ms/opensource/security/definition),
15+
please report it to us as described below.
816

917
## Reporting Security Issues
1018

1119
**Please do not report security vulnerabilities through public GitHub issues.**
1220

13-
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
21+
Instead, please report them to the Microsoft Security Response Center (MSRC) at
22+
[https://msrc.microsoft.com/create-report](https://aka.ms/opensource/security/create-report).
1423

15-
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
24+
If you prefer to submit without logging in, send email to
25+
[secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your
26+
message with our PGP key; please download it from the
27+
[Microsoft Security Response Center PGP Key page](https://aka.ms/opensource/security/pgpkey).
1628

17-
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://aka.ms/opensource/security/msrc).
29+
You should receive a response within 24 hours. If for some reason you do not,
30+
please follow up via email to ensure we received your original message.
31+
Additional information can be found at
32+
[microsoft.com/msrc](https://aka.ms/opensource/security/msrc).
1833

19-
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
34+
Please include the requested information listed below (as much as you can
35+
provide) to help us better understand the nature and scope of the possible
36+
issue:
2037

21-
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22-
* Full paths of source file(s) related to the manifestation of the issue
23-
* The location of the affected source code (tag/branch/commit or direct URL)
24-
* Any special configuration required to reproduce the issue
25-
* Step-by-step instructions to reproduce the issue
26-
* Proof-of-concept or exploit code (if possible)
27-
* Impact of the issue, including how an attacker might exploit the issue
38+
- Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting,
39+
etc.)
40+
- Full paths of source file(s) related to the manifestation of the issue
41+
- The location of the affected source code (tag/branch/commit or direct URL)
42+
- Any special configuration required to reproduce the issue
43+
- Step-by-step instructions to reproduce the issue
44+
- Proof-of-concept or exploit code (if possible)
45+
- Impact of the issue, including how an attacker might exploit the issue
2846

2947
This information will help us triage your report more quickly.
3048

31-
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page for more details about our active programs.
49+
If you are reporting for a bug bounty, more complete reports can contribute to a
50+
higher bounty award. Please visit our
51+
[Microsoft Bug Bounty Program](https://aka.ms/opensource/security/bounty) page
52+
for more details about our active programs.
3253

3354
## Preferred Languages
3455

3556
We prefer all communications to be in English.
3657

3758
## Policy
3859

39-
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
60+
Microsoft follows the principle of
61+
[Coordinated Vulnerability Disclosure](https://aka.ms/opensource/security/cvd).
4062

4163
<!-- END MICROSOFT SECURITY.MD BLOCK -->

‎SUPPORT.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
1-
# Support
2-
3-
## How to file issues and get help
4-
5-
This project uses GitHub Issues to track bugs and feature requests. Please search the [existing issues](https://github.com/microsoft/vscode-python-debugger/issues) before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue.
6-
7-
For help and questions about using this project, please see the [python+visual-studio-code labels on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+python) or the `#vscode` channel on the [microsoft-python server on Discord](https://aka.ms/python-discord-invite).
8-
9-
## Microsoft Support Policy
10-
11-
Support for this project is limited to the resources listed above.
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
This project uses GitHub Issues to track bugs and feature requests. Please
6+
search the
7+
[existing issues](https://github.com/microsoft/vscode-python-debugger/issues)
8+
before filing new issues to avoid duplicates. For new issues, file your bug or
9+
feature request as a new Issue.
10+
11+
For help and questions about using this project, please see the
12+
[python+visual-studio-code labels on Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code+python)
13+
or the `#vscode` channel on the
14+
[microsoft-python server on Discord](https://aka.ms/python-discord-invite).
15+
16+
## Microsoft Support Policy
17+
18+
Support for this project is limited to the resources listed above.

‎resources/report_issue_template.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<!-- Please fill in all XXX markers -->
2+
23
# Behaviour
34

45
XXX
@@ -12,7 +13,9 @@ XXX
1213
-->
1314

1415
<!-- **NOTE**: Please do provide logs from the Python and Python Debugger Output panel. -->
16+
1517
# Diagnostic data
18+
1619
<details>
1720

1821
<summary><code>launch.json</code> configuration
@@ -53,4 +56,4 @@ XXX
5356
```
5457

5558
</p>
56-
</details>
59+
</details>

‎resources/report_issue_user_data_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
- Python version (& distribution if applicable, e.g. Anaconda): {0}
2-
- Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): {1}
2+
- Type of virtual environment used (e.g. conda, venv, virtualenv, etc.): {1}

0 commit comments

Comments
 (0)