如何在VSCode中调试GitHub仓库中的git-sim Python模块？

问题背景 #

我有一个托管在GitHub的Python库git-sim，包含setup.py及pip发布包，可通过pip install git-sim或python3 setup.py install安装。安装后，系统路径会添加对应命令，终端可直接执行git-sim命令。

核心需求：克隆仓库并在VSCode中打开，调试终端执行git-sim时运行的代码，使断点命中仓库内的文件。

已尝试的方案：

• 方案1：使用pip install -e .安装编辑模式（成功），但不知如何调试；
• 方案2：在launch.json中配置模块调试项，运行时提示no module named git-sim，但终端中git-sim和python3 -m git_sim均可正常执行。

问题原因 #

调试配置报错的核心原因是：git-sim是终端命令（由setup.py的entry_points定义的可执行脚本别名），而非Python模块名——该库的实际Python模块名为git_sim（下划线），而Python模块名不允许包含横杠，因此VSCode无法识别git-sim这个模块名。

可行解决方案 #

方案一：修正模块调试配置 #

1. 确保已通过pip install -e .安装本地编辑模式（关联仓库代码，保证断点命中本地文件）；
2. 修改launch.json的调试配置，将module字段改为正确的模块名git_sim：

{
    "name": "Python: git_sim Module",
    "type": "python",
    "request": "launch",
    "module": "git_sim",
    "justMyCode": false,
    "args": ["log"] // 可添加git-sim的命令参数，比如查看提交日志的log
}

3. 运行该调试配置，即可直接启动git-sim，断点会命中仓库内的代码。

方案二：直接调试入口脚本 #

如果习惯使用终端命令的逻辑，可直接调试git-sim的入口脚本：

1. 同样确保已通过pip install -e .安装编辑模式；
2. 找到git-sim的入口脚本：可通过终端执行which git-sim查看路径，或查看setup.py的entry_points字段（通常为git_sim/cli.py）；
3. 在VSCode中打开该入口脚本，设置断点，或配置launch.json指定脚本路径：

{
    "name": "Python: git-sim Script",
    "type": "python",
    "request": "launch",
    "program": "${workspaceFolder}/git_sim/cli.py", // 替换为实际入口脚本路径
    "justMyCode": false,
    "args": ["diff"] // 添加需要调试的命令参数
}

4. 运行调试配置即可触发断点。

额外注意事项 #

• 确认VSCode使用的Python解释器与执行pip install -e .的解释器一致（可通过VSCode左下角状态栏切换），避免环境不一致导致的调试异常；
• 开启justMyCode: false可确保调试时能命中第三方依赖或库内的所有代码，若仅需调试自己的代码可关闭。

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