当前位置：首页 > article >正文

配置 VS Code 调试 ROS Python 脚本：完整步骤

article 2025/2/10 1:14:15

在 Ubuntu 系统上使用 ROS 和 VS Code 进行 Python 开发时，可能会遇到一些环境配置的问题，特别是当需要加载 ROS 环境变量以及确保正确使用 Python 3 环境时。以下是如何配置 launch.json 和 tasks.json 来确保 VS Code 调试环境能够正确加载 ROS 和 Python 3。

背景

在终端中运行 ROS Python 脚本时，source /opt/ros/noetic/setup.bash 命令会加载 ROS 环境变量，并确保 Python 3 能够正确访问 ROS 模块，如 rospy、rosbag 等。问题通常出现在 VS Code 中调试时，VS Code 的集成终端和调试环境没有正确继承这些环境变量。因此，我们需要通过 VS Code 配置文件来确保环境变量被正确加载。

配置步骤

1. 创建 `tasks.json` 文件

tasks.json 文件用于配置 VS Code 在调试之前运行的任务。在这里，我们需要一个任务来运行 source /opt/ros/noetic/setup.bash，该命令用于加载 ROS 环境变量。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "source ROS setup.bash",
      "type": "shell",
      "command": "bash",
      "args": [
        "-c",
        "source /opt/ros/noetic/setup.bash && echo 'ROS environment sourced'"
      ],
      "problemMatcher": [],
      "isBackground": false
    }
  ]
}

解释：

label 是任务的名称，在 launch.json 中用作引用。
type 设置为 shell，表示任务将通过 Shell 执行。
command 是 bash，args 包含 -c 选项，允许我们在 Shell 中执行命令。命令 source /opt/ros/noetic/setup.bash 将加载 ROS 环境。
isBackground 设置为 false，表示任务完成后将结束，而不会在后台运行。

这个任务将确保 ROS 环境在 VS Code 调试之前正确加载。

2. 创建 `launch.json` 文件

launch.json 文件配置了 VS Code 调试器的行为。为了确保 ROS 环境在调试时可用，我们需要在 launch.json 中配置以下内容：

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Python Debugger: Current File",
      "type": "debugpy",
      "request": "launch",
      "program": "${file}",
      "console": "integratedTerminal",
      "env": {
        "PYTHONPATH": "/opt/ros/noetic/lib/python3/dist-packages"
      },
      "preLaunchTask": "source ROS setup.bash"
    }
  ]
}

解释：

name 设置为 "Python Debugger: Current File"，表示调试当前文件。
type 设置为 "debugpy"，指定使用 Python 调试器。
request 设置为 "launch"，表示启动调试会话。
program 设置为 ${file}，表示调试当前文件。
console 设置为 "integratedTerminal"，确保使用 VS Code 的集成终端来运行程序。
env 配置项用于设置环境变量。在这里，我们明确设置了 PYTHONPATH 环境变量，指向 ROS Python 模块的位置：/opt/ros/noetic/lib/python3/dist-packages。这样可以确保在调试时能够找到 ROS 的 Python 包，如 rospy、rosbag 等。
preLaunchTask 设置为 "source ROS setup.bash"，引用之前在 tasks.json 中定义的任务，确保 ROS 环境被加载。

3. 确认 ROS 环境和 Python 解释器

在配置了 launch.json 和 tasks.json 之后，还需要确保你使用的是正确的 Python 解释器，特别是 Python 3，因为 ROS Noetic 默认使用 Python 3。

在 VS Code 中，按 Ctrl+Shift+P 打开命令面板，输入 Python: Select Interpreter，选择与 ROS 环境兼容的 Python 3 解释器。
确保 Python 环境中安装了所有需要的包。你可以在终端中运行以下命令确认 rosbag 是否已正确安装：
```
python3 -c "import rosbag"
```
如果没有安装，请运行以下命令安装 rosbag：
```
sudo apt-get install ros-noetic-rosbag
```