Skip to content

Commit 4a8fec3

Browse files
luabudbenibenj
authored andcommitted
Update docs to reference Python Debugger extension (#6979)
1 parent 2f583e1 commit 4a8fec3

24 files changed

+113
-93
lines changed

docs/containers/docker-compose.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Create an **Attach** [launch configuration](/docs/editor/debugging.md#launch-con
107107

108108
For debugging Python with Docker Compose, follow these steps:
109109

110-
1. On the **Debug** tab, choose the **Configuration** dropdown, choose **New Configuration**, choose **Python**, and select the `Remote Attach` configuration template.
110+
1. On the **Debug** tab, choose the **Configuration** dropdown, choose **New Configuration**, choose **Python Debugger**, and select the `Remote Attach` configuration template.
111111

112112
![Screenshot of Python Remote Attach](images/compose/docker-compose-python-remote-attach.png)
113113

@@ -116,8 +116,8 @@ For debugging Python with Docker Compose, follow these steps:
116116
```json
117117
"configurations": [
118118
{
119-
"name": "Python: Remote Attach",
120-
"type": "python",
119+
"name": "Python Debugger: Remote Attach",
120+
"type": "debugpy",
121121
"request": "attach",
122122
"port": 5678,
123123
"host": "localhost",
@@ -130,7 +130,7 @@ For debugging Python with Docker Compose, follow these steps:
130130
}
131131
```
132132

133-
1. When done editing the **Attach** configuration, save the `launch.json`. Navigate to the **Debug** tab and select **Python: Remote Attach** as the active configuration.
133+
1. When done editing the **Attach** configuration, save the `launch.json`. Navigate to the **Debug** tab, and select **Python Debugger: Remote Attach** as the active configuration.
134134

135135
1. If you already have a valid Dockerfile, we recommend running the command **Docker: Add Docker Compose Files to Workspace**. This will create a `docker-compose.yml` file and also a `docker-compose.debug.yml`, which volume maps and starts the Python debugger in the container. If you do not have a Dockerfile already, we recommend running **Docker: Add Docker Files to Workspace** and selecting **Yes** to include Docker Compose files.
136136

@@ -153,7 +153,7 @@ For debugging Python with Docker Compose, follow these steps:
153153
- 5678:5678
154154
```
155155

156-
1. Once your container is built and running, attach the debugger by hitting `kb(workbench.action.debug.start)` with the **Python: Remote Attach** launch configuration selected.
156+
1. Once your container is built and running, attach the debugger by hitting `kb(workbench.action.debug.start)` with the **Python Debugger: Remote Attach** launch configuration selected.
157157

158158
![Screenshot of debugging in Python](images/compose/docker-compose-python-debug.png)
159159

Lines changed: 2 additions & 2 deletions
Loading

docs/languages/images/python/selected-interpreter-status-bar.png

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/languages/python.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The Python extension can apply a number of different linters including Pylint, p
7777

7878
## Debugging
7979

80-
No more `print` statement debugging! VS Code comes with great debugging support for Python, allowing you to set breakpoints, inspect variables, and use the debug console for an in-depth look at how your program is executing step by step. Debug a number of different types of Python applications, including multi-threaded, web, and remote applications.
80+
No more `print` statement debugging! VS Code comes with great debugging support for Python via the [Python Debugger extension](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy), allowing you to set breakpoints, inspect variables, and use the debug console for an in-depth look at how your program is executing step by step. Debug a number of different types of Python applications, including multi-threaded, web, and remote applications.
8181

8282
For more specific information on debugging in Python, such as configuring your `launch.json` settings and implementing remote debugging, see [Debugging](/docs/python/debugging.md). General VS Code debugging information is found in the [debugging document](/docs/editor/debugging.md).
8383

@@ -93,7 +93,7 @@ The Python extension automatically detects Python interpreters that are installe
9393

9494
The current environment is shown on the right side of the VS Code Status Bar:
9595

96-
![Status Bar showing a selected interpreter](images/python/selected-interpreter-status-bar.png)
96+
![Status Bar showing a selected interpreter](/docs/python/images/shared/environment-in-status-bar.png)
9797

9898
The Status Bar also indicates if no interpreter is selected:
9999

0 commit comments

Comments
 (0)