如何在VSCode中调试使用环境与Makefile编译的多文件Python代码

问题描述 #

需要调试Subhodip Biswas的空间分区memetic算法项目SPATIAL——这套多文件Python代码依赖特定环境，只能通过Makefile运行。用VSCode默认Python调试器直接调试主文件时，即便激活了安装全依赖的环境，仍提示部分包不存在，且默认调试器仅支持单文件调试，无法复现Makefile的运行逻辑。

附上项目的Makefile内容：

runable:
    chmod u+x ./run_algo.py
    chmod u+x ./run_algo.py

SPATIAL:
    export PYTHONHASHSEED=0
    ./run_spatial.py -l ES -d lcps -i 1
    export PYTHONHASHSEED=0
    ./run_spatial.py -l MS -d lcps -i 1
    export PYTHONHASHSEED=0
    ./run_spatial.py -l HS -d lcps -i 1
    export PYTHONHASHSEED=0
    ./run_spatial.py -l ES -d fcps -i 1
    export PYTHONHASHSEED=0
    ./run_spatial.py -l MS -d fcps -i 1
    export PYTHONHASHSEED=0
    ./run_spatial.py -l HS -d fcps -i 1

解决方案 #

方法1：直接配置VSCode调试目标复现Makefile逻辑 #

1. 打开VSCode调试面板，创建launch.json文件（选择Python环境），替换为以下配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Debug SPATIAL (ES-lcps)",
            "type": "python",
            "request": "launch",
            "program": "${workspaceFolder}/run_spatial.py",
            "args": ["-l", "ES", "-d", "lcps", "-i", "1"],
            "env": {
                "PYTHONHASHSEED": "0",
                "PYTHONPATH": "${workspaceFolder}:${env:PYTHONPATH}"
            },
            "console": "integratedTerminal",
            "justMyCode": false
        }
    ]
}

• 核心逻辑：直接指定要调试的脚本、Makefile里的参数和环境变量，同时把项目根目录加入Python搜索路径，解决依赖找不到的问题。
• 如需调试其他参数组合，复制这份配置，修改name和args即可（比如把args改成["-l", "MS", "-d", "fcps", "-i", "1"]）。

2. 确认VSCode使用的是项目的虚拟环境：点击右下角的Python解释器，选择安装了所有依赖的环境；终端里激活该环境后启动调试。

方法2：通过Makefile触发调试，VSCode远程附加 #

1. 先安装调试依赖：pip install ptvsd
2. 修改Makefile，新增DEBUG目标：

DEBUG:
    export PYTHONHASHSEED=0 && python -m ptvsd --wait --host localhost --port 5678 ./run_spatial.py -l ES -d lcps -i 1

• 注意用&&连接命令，确保环境变量生效后再启动调试进程。

3. 在launch.json里添加附加调试配置：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Attach to Make Debug",
            "type": "python",
            "request": "attach",
            "connect": {
                "host": "localhost",
                "port": 5678
            },
            "justMyCode": false
        }
    ]
}

4. 使用流程：

• 终端执行make DEBUG，进程会卡在调试器连接状态
• VSCode里启动"Attach to Make Debug"配置，即可开始调试

依赖包找不到的额外排查点 #

• 如果还是提示包不存在，检查项目中是否有__init__.py文件（确保目录被视为Python包）
• 手动打印sys.path：在run_spatial.py开头添加import sys; print(sys.path)，对比调试和Makefile运行时的路径差异，调整PYTHONPATH配置

内容的提问来源于stack exchange，提问作者confusedProgrammer39