VS Code 中的 Python 调试

Python 扩展通过 Python 调试器扩展 支持多种 Python 应用程序的调试。有关基本调试的简短演示，请参阅教程 - 配置和运行调试器。另请参阅 Flask 教程。这两个教程都演示了设置断点和逐行执行代码等核心技能。

对于检查变量、设置断点和其他不依赖于语言的通用调试功能，请查阅 VS Code 调试。

本文主要介绍 Python 特有的调试*配置*，包括特定应用程序类型和远程调试所需的步骤。

Python 调试器扩展

适用于 VS Code 的 Python 调试器扩展 会随 Python 扩展 自动安装。它通过 debugpy 为多种 Python 应用程序提供调试功能，包括脚本、Web 应用程序、远程进程等。

要验证其是否已安装，请打开**扩展**视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)），然后搜索 @installed python debugger。你应该会在结果中看到 Python 调试器扩展。

你可以参考扩展的 README 页面，了解支持的 Python 版本信息。

初始化配置

配置决定了 VS Code 在调试会话期间的行为。配置定义在 launch.json 文件中，该文件存储在工作区中的 .vscode 文件夹内。

注意：要更改调试配置，你的代码必须存储在一个文件夹中。

要初始化调试配置，首先选择侧边栏中的**运行**视图

如果你还没有定义任何配置，你将看到一个**运行和调试**按钮以及一个创建配置 (launch.json) 文件的链接

要生成包含 Python 配置的 launch.json 文件，请执行以下步骤

1. 选择**创建 launch.json 文件**链接（如上图所示），或使用**运行** > **打开配置**菜单命令。

2. 从调试器选项列表中选择 **Python Debugger**。

3. 命令面板将打开一个配置菜单，允许你为你的 Python 项目文件选择要使用的调试配置类型。如果你想调试单个 Python 脚本，请在弹出的**选择调试配置**菜单中选择 **Python 文件**。

   

   注意：当没有配置存在时，通过调试面板、F5 或**运行 > 启动调试**启动调试会话也会弹出调试配置菜单，但不会创建 launch.json 文件。

4. Python 调试器扩展将创建并打开一个 launch.json 文件，其中包含基于你之前选择的预定义配置（在本例中为 **Python 文件**）。你可以修改配置（例如，添加参数），也可以添加自定义配置。

   

配置属性的详细信息将在本文后面的标准配置和选项中介绍。本文的调试特定应用程序类型部分也描述了其他配置。

其他配置

默认情况下，VS Code 只显示 Python 调试器扩展提供的最常见配置。你可以通过使用列表中和 launch.json 编辑器中显示的**添加配置**命令来选择其他配置以包含在 launch.json 中。当你使用此命令时，VS Code 会提示你所有可用配置的列表（请务必选择 **Python** 选项）

选择**使用进程 ID 附加**会得到以下结果：

有关所有这些配置的详细信息，请参阅调试特定应用程序类型。

调试期间，状态栏会显示当前配置和当前调试解释器。选择配置会弹出一个列表，从中你可以选择不同的配置

默认情况下，调试器使用为工作区选择的相同解释器，就像适用于 VS Code 的 Python 扩展的其他功能一样。要专门为调试使用不同的解释器，请在 launch.json 中为适用的调试器配置设置 python 的值。或者，使用状态栏上的 Python 解释器指示器来选择不同的解释器。

基本调试

如果你只对调试 Python 脚本感兴趣，最简单的方法是选择编辑器上运行按钮旁边的向下箭头，然后选择 **Python Debugger: Debug Python File**。

如果你希望调试使用 Flask、Django 或 FastAPI 的 Web 应用程序，Python 调试器扩展通过**运行和调试**视图，在**显示所有自动调试配置**选项下，根据你的项目结构提供动态创建的调试配置。

但是，如果你希望调试其他类型的应用程序，可以通过点击**运行和调试**按钮，通过**运行**视图启动调试器。

当没有设置配置时，你将获得一个调试选项列表。在这里，你可以选择适当的选项来快速调试你的代码。

两个常见的选项是使用 **Python 文件**配置来运行当前打开的 Python 文件，或者使用**使用进程 ID 附加**配置将调试器附加到已运行的进程。

有关创建和使用调试配置的信息，请参阅初始化配置和其他配置部分。添加配置后，可以从下拉列表中选择它，然后使用**启动调试**按钮（F5）启动。

命令行调试

如果你的 Python 环境中安装了 debugpy，调试器也可以从命令行运行。

安装 debugpy

你可以使用 python -m pip install --upgrade debugpy 将 debugpy 安装到你的 Python 环境中。

提示：虽然不是必需的，但使用虚拟环境是推荐的最佳实践。你可以在 VS Code 中通过打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并运行**Python: Create Virtual Environment** 命令（）来创建虚拟环境。

命令行语法

调试器命令行语法如下

python -m debugpy
    --listen | --connect
    [<host>:]<port>
    [--wait-for-client]
    [--configure-<name> <value>]...
    [--log-to <path>] [--log-to-stderr]
    <filename> | -m <module> | -c <code> | --pid <pid>
    [<arg>]...

示例

从命令行，你可以使用以下语法启动调试器，指定端口 (5678) 和脚本。此示例假定脚本是长期运行的，并省略了 --wait-for-client 标志，这意味着脚本不会等待客户端附加。

python -m debugpy --listen 5678 ./myscript.py

然后，你将使用以下配置从 VS Code Python 调试器扩展附加。

{
  "name": "Python Debugger: Attach",
  "type": "debugpy",
  "request": "attach",
  "connect": {
    "host": "localhost",
    "port": 5678
  }
}

注意：对于**监听**，指定主机是可选的，默认使用 127.0.0.1。

如果要调试远程代码或在 docker 容器中运行的代码，在远程机器或容器上，你需要修改之前的 CLI 命令以指定一个主机。

python -m debugpy --listen 0.0.0.0:5678 ./myscript.py

相关的配置文件将如下所示。

{
  "name": "Attach",
  "type": "debugpy",
  "request": "attach",
  "connect": {
    "host": "remote-machine-name", // replace this with remote machine name
    "port": 5678
  }
}

注意：请注意，当你指定 127.0.0.1 或 localhost 以外的主机值时，你将打开一个端口以允许从任何机器访问，这会带来安全风险。在进行远程调试时，应确保采取适当的安全预防措施，例如使用 SSH 隧道。

命令行选项

注意：[<arg>] 可用于将命令行参数传递给正在启动的应用程序。

通过网络连接附加调试

本地脚本调试

有些情况下，你可能需要调试由另一个进程本地调用的 Python 脚本。例如，你可能正在调试一个运行不同 Python 脚本以完成特定处理作业的 Web 服务器。在这种情况下，一旦脚本启动，你就需要将 VS Code 调试器附加到该脚本。

1. 运行 VS Code，打开包含脚本的文件夹或工作区，如果该工作区尚不存在 launch.json 文件，则创建一个。

2. 在脚本代码中，添加以下内容并保存文件

   import debugpy
   
   # 5678 is the default attach port in the VS Code debug configurations. Unless a host and port are specified, host defaults to 127.0.0.1
   debugpy.listen(5678)
   print("Waiting for debugger attach")
   debugpy.wait_for_client()
   debugpy.breakpoint()
   print('break on this line')
   

3. 使用**终端: 创建新终端**打开一个终端，这将激活脚本所选的环境。

4. 在终端中，安装 debugpy 包。

5. 在终端中，使用脚本启动 Python，例如 python3 myscript.py。你应该会看到代码中包含的“Waiting for debugger attach”消息，并且脚本会在 debugpy.wait_for_client() 调用处暂停。

6. 切换到**运行和调试**视图（⇧⌘D (Windows, Linux Ctrl+Shift+D)），从调试器下拉列表中选择适当的配置，然后启动调试器。

7. 调试器应在 debugpy.breakpoint() 调用处停止，从该点开始，你可以正常使用调试器。你还可以选择使用 UI 而不是 debugpy.breakpoint() 在脚本代码中设置其他断点。

使用 SSH 进行远程脚本调试

远程调试允许你在 VS Code 中本地逐行调试程序，而该程序在远程计算机上运行。无需在远程计算机上安装 VS Code。为了增加安全性，调试时你可能希望或需要使用安全连接（例如 SSH）连接到远程计算机。

注意：在 Windows 计算机上，你可能需要安装 Windows 10 OpenSSH 才能使用 ssh 命令。

以下步骤概述了设置 SSH 隧道的通用过程。SSH 隧道允许你在本地计算机上工作，就像直接在远程计算机上工作一样，并且比为公共访问打开端口更安全。

在远程计算机上

1. 通过打开 sshd_config 配置文件（在 Linux 上位于 /etc/ssh/ 下，在 Windows 上位于 %programfiles(x86)%/openssh/etc 下），并添加或修改以下设置来启用端口转发

   AllowTcpForwarding yes
   

   注意：AllowTcpForwarding 的默认值为 yes，因此你可能不需要进行更改。

2. 如果你必须添加或修改 AllowTcpForwarding，请重新启动 SSH 服务器。在 Linux/macOS 上，运行 sudo service ssh restart；在 Windows 上，运行 services.msc，在服务列表中选择 OpenSSH 或 sshd，然后选择**重新启动**。

在本地计算机上

1. 通过运行 ssh -2 -L sourceport:localhost:destinationport -i identityfile user@remoteaddress 创建 SSH 隧道，其中 destinationport 使用所选端口，user@remoteaddress 使用适当的用户名和远程计算机的 IP 地址。例如，要在 IP 地址 1.2.3.4 上使用端口 5678，命令将是 ssh -2 -L 5678:localhost:5678 -i identityfile user@1.2.3.4。你可以使用 -i 标志指定身份文件的路径。

2. 验证你是否可以在 SSH 会话中看到提示符。

3. 在你的 VS Code 工作区中，在 launch.json 文件中为远程调试创建配置，将端口设置为与 ssh 命令中使用的端口匹配，并将主机设置为 localhost。你在此处使用 localhost 是因为你已设置了 SSH 隧道。

   {
     "name": "Python Debugger: Attach",
     "type": "debugpy",
     "request": "attach",
     "port": 5678,
     "host": "localhost",
     "pathMappings": [
       {
         "localRoot": "${workspaceFolder}", // Maps C:\Users\user1\project1
         "remoteRoot": "." // To current working directory ~/project1
       }
     ]
   }
   

启动调试

现在已经设置了到远程计算机的 SSH 隧道，你可以开始调试了。

1. 两台计算机：确保源代码一致。

2. 两台计算机：安装 debugpy。

3. 远程计算机：有两种方法可以指定如何附加到远程进程。

   1. 在源代码中，添加以下行，将 address 替换为远程计算机的 IP 地址和端口号（此处显示 IP 地址 1.2.3.4 仅用于说明）。

      import debugpy
      
      # Allow other computers to attach to debugpy at this IP address and port.
      debugpy.listen(('1.2.3.4', 5678))
      
      # Pause the program until a remote debugger is attached
      debugpy.wait_for_client()
      

      listen 中使用的 IP 地址应是远程计算机的私有 IP 地址。然后你可以正常启动程序，使其暂停，直到调试器附加。

   2. 通过 debugpy 启动远程进程，例如

      python3 -m debugpy --listen 1.2.3.4:5678 --wait-for-client -m myproject
      

      这将使用 python3 启动包 myproject，远程计算机的私有 IP 地址为 1.2.3.4，并在端口 5678 上监听（你也可以通过指定文件路径而不是使用 -m 来启动远程 Python 进程，例如 ./hello.py）。

4. 本地计算机：**仅当你按照上述概述修改了远程计算机上的源代码时**，才在源代码中添加与远程计算机上添加的相同代码的注释掉的副本。添加这些行可确保两台计算机上的源代码逐行匹配。

   #import debugpy
   
   # Allow other computers to attach to debugpy at this IP address and port.
   #debugpy.listen(('1.2.3.4', 5678))
   
   # Pause the program until a remote debugger is attached
   #debugpy.wait_for_client()
   

5. 本地计算机：切换到 VS Code 中的**运行和调试**视图（⇧⌘D (Windows, Linux Ctrl+Shift+D)），选择 **Python 调试器: 附加**配置

6. 本地计算机：在要开始调试的代码处设置断点。

7. 本地计算机：使用修改后的 **Python 调试器: 附加**配置和“启动调试”按钮启动 VS Code 调试器。VS Code 应该在你的本地设置的断点处停止，允许你逐行执行代码、检查变量并执行所有其他调试操作。你在**调试控制台**中输入的表达式也会在远程计算机上运行。

   输出到 stdout 的文本（例如来自 print 语句的文本）会同时显示在两台计算机上。然而，其他输出（例如来自 matplotlib 等包的图形绘制）仅显示在远程计算机上。

8. 远程调试期间，调试工具栏显示如下

   

   在此工具栏上，断开连接按钮（⇧F5 (Windows, Linux Shift+F5)）停止调试器并允许远程程序运行完成。重新启动按钮（⇧⌘F5 (Windows, Linux Ctrl+Shift+F5)）在本地计算机上重新启动调试器，但**不会**重新启动远程程序。仅当你已重新启动远程程序并需要重新附加调试器时才使用重新启动按钮。

设置配置选项

初次创建 launch.json 时，有两个标准配置，它们可以在集成终端（VS Code 内部）或外部终端（VS Code 外部）中运行编辑器中的活动文件。

{
  "configurations": [
    {
      "name": "Python Debugger: Current File (Integrated Terminal)",
      "type": "debugpy",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal"
    },
    {
      "name": "Python Debugger: Current File (External Terminal)",
      "type": "debugpy",
      "request": "launch",
      "program": "${file}",
      "console": "externalTerminal"
    }
  ]
}

具体设置将在以下部分中描述。你还可以添加标准配置中不包含的其他设置，例如 args。

提示：在项目中创建一个运行特定启动文件的配置通常很有帮助。例如，如果你希望在启动调试器时始终使用参数 --port 1593 启动 startup.py，请按如下方式创建配置条目

 {
     "name": "Python Debugger: startup.py",
     "type": "debugpy",
     "request": "launch",
     "program": "${workspaceFolder}/startup.py",
     "args" : ["--port", "1593"]
 },

name

提供调试配置的名称，该名称将显示在 VS Code 下拉列表中。

type

标识要使用的调试器类型；对于调试 Python 代码，请将其设置为 debugpy。

request

指定启动调试的模式

• launch：在 program 中指定的文件上启动调试器
• attach：将调试器附加到已在运行的进程。有关示例，请参阅远程调试。

program

提供 Python 程序入口模块（启动文件）的完全限定路径。${file} 值（通常在默认配置中使用）使用编辑器中当前活动的文件。通过指定特定的启动文件，你可以始终确保以相同的入口点启动程序，无论打开了哪些文件。例如

"program": "/Users/Me/Projects/MyProject/src/event_handlers/__init__.py",

你也可以依赖工作区根目录的相对路径。例如，如果根目录是 /Users/Me/Projects/MyProject，那么你可以使用以下示例

"program": "${workspaceFolder}/src/event_handlers/__init__.py",

module

提供指定要调试模块名称的能力，类似于在命令行运行时的 -m 参数。有关更多信息，请参阅Python.org

python

指向用于调试的 Python 解释器的完整路径。

如果未指定，此设置默认为为你的工作区选择的解释器，这相当于使用 ${command:python.interpreterPath} 值。要使用不同的解释器，请在调试配置的 python 属性中指定其路径。

或者，你可以使用在每个平台上定义的自定义环境变量来包含要使用的 Python 解释器的完整路径，这样就不需要其他文件夹路径了。

如果你需要将参数传递给 Python 解释器，可以使用 pythonArgs 属性。

pythonArgs

使用语法 "pythonArgs": ["<arg 1>", "<arg 2>",...] 指定要传递给 Python 解释器的参数。

args

指定要传递给 Python 程序的参数。参数字符串中每个由空格分隔的元素都应包含在引号中，例如

"args": ["--quiet", "--norepeat", "--port", "1593"],

如果你希望每次调试运行都提供不同的参数，可以将 args 设置为 "${command:pickArgs}"。这将提示你在每次启动调试会话时输入参数。

注意："${command:pickArgs}" 和 ["${command:pickArgs}"] 的解析方式有所不同，尤其要注意 [] 的使用。作为数组，所有参数都作为单个字符串传递；不带方括号时，每个参数都作为其自己的字符串传递。

stopOnEntry

当设置为 true 时，调试器会在被调试程序的第一行中断。如果省略（默认）或设置为 false，调试器会运行程序直到第一个断点。

console

指定程序输出的显示方式，前提是 redirectOutput 的默认值未被修改。

purpose

使用 purpose 选项配置**运行**按钮的方式不止一种。将选项设置为 debug-test，定义了该配置应在 VS Code 中调试测试时使用。但是，将选项设置为 debug-in-terminal，定义了该配置只能在访问编辑器右上角的**运行 Python 文件**按钮时使用（无论使用按钮提供的**运行 Python 文件**还是**调试 Python 文件**选项）。注意：purpose 选项不能用于通过 F5 或**运行 > 启动调试**来启动调试器。

autoReload

当调试器执行命中断点后对代码进行更改时，允许自动重新加载调试器。要启用此功能，请将 {"enable": true} 设置为以下代码所示。

{
  "name": "Python Debugger: Current File",
  "type": "debugpy",
  "request": "launch",
  "program": "${file}",
  "console": "integratedTerminal",
  "autoReload": {
    "enable": true
  }
}

注意：当调试器执行重新加载时，导入时运行的代码可能会再次执行。为了避免这种情况，请尝试仅在模块中使用导入、常量和定义，并将所有代码放入函数中。或者，你也可以使用 if __name__=="__main__" 检查。

subProcess

指定是否启用子进程调试。默认为 false，设置为 true 以启用。有关更多信息，请参阅多目标调试。

cwd

指定调试器的当前工作目录，这是代码中使用的任何相对路径的基文件夹。如果省略，则默认为 ${workspaceFolder}（在 VS Code 中打开的文件夹）。

例如，假设 ${workspaceFolder} 包含一个包含 app.py 的 py_code 文件夹，以及一个包含 salaries.csv 的 data 文件夹。如果你在 py_code/app.py 上启动调试器，那么数据文件的相对路径会根据 cwd 的值而变化

redirectOutput

当设置为 true（internalConsole 的默认值）时，调试器会将程序的所有输出打印到 VS Code 调试输出窗口。如果设置为 false（integratedTerminal 和 externalTerminal 的默认值），则程序输出不会显示在调试器输出窗口中。

当使用 "console": "integratedTerminal" 或 "console": "externalTerminal" 时，通常会禁用此选项，因为无需在调试控制台中重复输出。

justMyCode

当省略或设置为 true（默认）时，调试仅限于用户编写的代码。设置为 false 可同时启用标准库函数的调试。

django

当设置为 true 时，激活特定于 Django Web 框架的调试功能。

sudo

当设置为 true 并与 "console": "externalTerminal" 配合使用时，允许调试需要提升权限的应用程序。使用外部控制台是捕获密码所必需的。

pyramid

当设置为 true 时，确保 Pyramid 应用程序使用必要的 pserve 命令启动。

env

为调试器进程设置可选的环境变量，这些变量超出系统环境变量（调试器始终继承这些变量）。这些变量的值必须作为字符串输入。

envFile

包含环境变量定义的可选文件路径。请参阅配置 Python 环境 - 环境变量定义文件。

gevent

如果设置为 true，则启用对 gevent monkey-patched 代码的调试。

jinja

当设置为 true 时，激活特定于 Jinja 模板框架的调试功能。

断点和日志点

Python 调试器扩展支持用于调试代码的断点和日志点。有关基本调试和使用断点的简短演练，请参阅教程 - 配置和运行调试器。

条件断点

断点还可以设置为根据表达式、命中次数或两者的组合触发。Python 调试器扩展支持整数命中次数，以及前面带有 ==、>、>=、<、<= 和 % 运算符的整数。例如，你可以通过将命中次数设置为 >5 来设置断点，使其在发生五次后触发。有关更多信息，请参阅主 VS Code 调试文章中的条件断点。

在代码中调用断点

在你的 Python 代码中，你可以在调试会话期间的任何时候调用 debugpy.breakpoint()，以暂停调试器。

断点验证

Python 调试器扩展会自动检测设置在不可执行行上的断点，例如 pass 语句或多行语句的中间。在这种情况下，运行调试器会将断点移动到最近的有效行，以确保代码执行在该点停止。

调试特定应用程序类型

配置下拉菜单为常见的应用程序类型提供了各种不同的选项

远程调试和 Google App Engine 还需要特定步骤。有关调试测试的详细信息，请参阅测试。

要调试需要管理员权限的应用程序，请使用 "console": "externalTerminal" 和 "sudo": "True"。

Flask 调试

{
    "name": "Python Debugger: Flask",
    "type": "debugpy",
    "request": "launch",
    "module": "flask",
    "env": {
        "FLASK_APP": "app.py"
    },
    "args": [
        "run",
        "--no-debugger"
    ],
    "jinja": true
},

如你所见，此配置指定了 "env": {"FLASK_APP": "app.py"} 和 "args": ["run", "--no-debugger"]。"module": "flask" 属性用于替代 program。（你可能会在 env 属性中看到 "FLASK_APP": "${workspaceFolder}/app.py"，在这种情况下，请修改配置以仅引用文件名。否则，你可能会看到“Cannot import module C”错误，其中 C 是驱动器号。）

"jinja": true 设置还为 Flask 的默认 Jinja 模板引擎启用了调试。

如果要在开发模式下运行 Flask 的开发服务器，请使用以下配置

{
    "name": "Python Debugger: Flask (development mode)",
    "type": "debugpy",
    "request": "launch",
    "module": "flask",
    "env": {
        "FLASK_APP": "app.py",
        "FLASK_ENV": "development"
    },
    "args": [
        "run"
    ],
    "jinja": true
},

故障排除

调试器可能无法工作的原因有很多。有时调试控制台会揭示具体原因，但主要原因如下：

• 确保在 VS Code 中安装并启用了 Python 调试器扩展，方法是打开**扩展**视图（⇧⌘X (Windows, Linux Ctrl+Shift+X)），然后搜索 @installed python debugger。

• Python 可执行文件的路径不正确：通过运行 **Python: 选择解释器**命令并查看当前值来检查所选解释器的路径

  

• 你的 launch.json 文件中 "type" 设置为已弃用的值 "python"：请将其替换为 "debugpy"，以便与 Python 调试器扩展一起使用。

• 监视窗口中存在无效表达式：清除监视窗口中的所有表达式并重新启动调试器。

• 如果你正在使用一个使用原生线程 API（例如 Win32 的 CreateThread 函数而非 Python 线程 API）的多线程应用程序，目前需要在你希望调试的任何文件的顶部包含以下源代码

  import debugpy
  debugpy.debug_this_thread()
  

• 如果你使用的是 **Linux** 系统，在尝试将调试器附加到任何正在运行的进程时，可能会收到“timed out”错误消息。为防止出现此问题，你可以暂时运行以下命令

  echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope
  

后续步骤

• Python 环境 - 控制用于编辑和调试的 Python 解释器。
• 测试 - 配置测试环境并发现、运行和调试测试。
• 设置参考 - 探索 VS Code 中与 Python 相关的所有设置。
• 通用调试 - 了解 VS Code 的调试功能。