如何使用 VSCode 调试器调试 Python console_script 命令行应用程序？

Question

我有一个 Python 包package_name ，它提供了一个命令行应用程序command-line-app-name作为console_script ：

setup.py ：

setup(
    ...
    entry_points={"console_scripts": ["command-line-app-name=package_name.cli:main"]},
    ...
)

virtualenv 位于<project>/.venv并使用pipenv管理。 pipenv管理的 venv 应该支持 VSCode 调试集成。 我创建了一个调试器配置launch.json文件，其中设置了 venv ( pythonPath ) 的 Python 路径：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: command-line-app-name",
            "type": "python",
            "request": "launch",
            "stopOnEntry": false,
            "program": "command-line-app-name",
            "linux": {
                "pythonPath": "${workspaceFolder}/.venv/bin/python",
                "args": ["-r", "/home/florian/gitlab/package_name/data/Test_MRM.d"]
            },
            "windows": {
                "pythonPath": "${workspaceFolder}/.venv/Scripts/python.exe",
                "args": ["-r", "D:\\MassHunter\\Data\\demo_0000.d"],
            },
            "console": "integratedTerminal"
        }
    ]
}

Windows 和 Linux 特定的 venv python 可执行文件和命令行参数不应该有影响。 如果我运行调试器，我会得到： FileNotFoundError: [Errno 2] No such file or directory: '/home/florian/gitlab/package-name/command-line-app-name' 。 似乎我以某种方式误解了文档。 我试图找到帮助 wrt vscode-python以及debugpy没有成功。 如何调试控制台脚本命令行应用程序（而不是包模块）？

Answer 1

console_scripts不能开箱即console_scripts调试。 解决方案是直接调用入口点函数（ "program": "${workspaceRoot}/package_name/cli.py", ）。 这需要在相应的模块中添加if __name__ == '__main__': idiom（这里是： cli.py ）。 在我的情况下，使用的命令行参数解析器是click 。 然而，其他命令行解析器库的伪代码应该非常相似。

package_name/cli.py ：

@click.command()
@click.option(...)
def main(<args>, <kwargs>):
    ...


if __name__ == '__main__':
    main()  # pylint: disable=no-value-for-parameter

.vscode/launch.json ：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: command-line-app-name",
            "type": "python",
            "request": "launch",
            "stopOnEntry": false,
            "program": "${workspaceRoot}/package_name/cli.py",
            "linux": {
                "pythonPath": "${workspaceFolder}/.venv/bin/python",
                "args": ["-r", "/home/florian/gitlab/package_name/data/Test_MRM.d"]
            },
            "windows": {
                "pythonPath": "${workspaceFolder}/.venv/Scripts/python.exe",
                "args": ["-r", "D:\\MassHunter\\Data\\demo_0000.d"],
            },
            "console": "integratedTerminal"
        }
    ]
}

注意：用于管理 venv 的工具有所不同。 该解决方案确实以防VENV与管理工作pipenv 。 如果 venv 是用poetry管理的，则该解决方案不起作用。