在 VS Code 中调试 Python

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

有关检查变量、设置断点和其他与语言无关的活动等通用调试功能，请参阅 VS Code 调试。

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

Python 调试器扩展

Python 调试器扩展随 VS Code 的 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 调试器。

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 调试器：调试 Python 文件。

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

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

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

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

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

命令行调试

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

安装 debugpy

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

提示：虽然不需要使用虚拟环境，但它是一种推荐的最佳实践。您可以通过打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并运行Python：创建虚拟环境命令 () 在 VS Code 中创建虚拟环境。

命令行语法

调试器命令行语法如下

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
  }
}

注意：对于listen，指定主机是可选的，默认使用 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。您应该看到代码中包含的“等待调试器附加”消息，脚本会在 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 应该会在您本地设置的断点处停止，允许您单步执行代码、检查变量并执行所有其他调试操作。您在调试控制台中输入的表达式也会在远程计算机上运行。

   标准输出（例如来自 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。

请求

指定启动调试的模式

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

程序

提供 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，调试器将程序运行到第一个断点。

控制台

只要未修改 redirectOutput 的默认值，就指定程序输出的显示方式。

目的

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

自动重新加载

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

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

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

子进程

指定是否启用子进程调试。默认为 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" 一起使用时，允许调试需要提升权限的应用程序。使用外部控制台是捕获密码所必需的。

金字塔

设置为 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"，在这种情况下，请修改配置以仅引用文件名。否则，您可能会看到“无法导入模块 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
},

故障排除

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

• 通过打开扩展视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 并搜索 @installed python debugger，确保 Python 调试器扩展已安装并在 VS Code 中启用。

• 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 的调试功能。