使用 VS Code Workspace 调试依赖本地库的 Python 应用

本文旨在解决在 VS Code Workspace 环境下，Python 应用调试时如何实时加载本地开发库代码，避免频繁提交、推送和重新安装依赖的繁琐流程。核心在于利用 VS Code 的平台特定配置，设置 PYTHONPATH 环境变量，使得调试器能够优先加载本地库代码。这种方法既保证了跨平台兼容性，又提高了开发效率。

配置平台特定的 PYTHONPATH 环境变量

当你的 Python 应用依赖于多个本地开发的库时，直接修改虚拟环境中的依赖项可能不是最佳选择。一个更灵活的方法是在 VS Code 的 launch.json 配置文件中，针对不同的操作系统设置 PYTHONPATH 环境变量。

launch.json 文件允许你为不同的平台（Windows、macOS、Linux）定义不同的环境变量。通过这种方式，你可以避免硬编码特定于平台的路径分隔符，从而实现跨平台兼容性。

以下是一个示例 launch.json 配置：

立即学习“Python免费学习笔记（深入）”；

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "windows": {
                "env": {
                    "PYTHONPATH": "${workspaceFolder}/../lib1;${workspaceFolder}/../lib2"
                }
            },
            "osx": {
                "env": {
                    "PYTHONPATH": "${workspaceFolder}/../lib1:${workspaceFolder}/../lib2"
                }
            },
            "linux": {
                "env": {
                    "PYTHONPATH": "${workspaceFolder}/../lib1:${workspaceFolder}/../lib2"
                }
            }
        }
    ]
}

在这个配置中：

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

• "windows", "osx", 和 "linux" 分别定义了针对 Windows、macOS 和 Linux 的配置。
• "env" 字段用于设置环境变量。
• "PYTHONPATH" 变量被设置为包含 lib1 和 lib2 两个库的路径。注意 Windows 使用 ; 作为路径分隔符，而 macOS 和 Linux 使用 :。
• ${workspaceFolder} 表示当前工作区文件夹的路径，../lib1 和 ../lib2 则分别指向 lib1 和 lib2 库的相对路径。

注意事项：

• 确保 launch.json 文件位于 .vscode 目录下，并且在 VS Code 工作区中正确配置。
• 根据你的项目结构和库的路径，调整 PYTHONPATH 中的路径。
• 如果你的项目依赖于更多的本地库，可以在 PYTHONPATH 中添加更多的路径，用相应的分隔符隔开。

使用 VS Code 设置

如果你使用 VS Code 界面右上角的播放按钮来运行代码，而不是通过 launch.json 配置，那么你需要使用 VS Code 的设置来配置平台特定的环境变量。

可以在 settings.json 文件中进行如下配置：

{
    "terminal.integrated.env.windows": {
        "PYTHONPATH": "foo;bar"
    },
    "terminal.integrated.env.osx": {
        "PYTHONPATH": "foo:bar"
    },
    "terminal.integrated.env.linux": {
        "PYTHONPATH": "foo:bar"
    }
}

总结：

通过配置平台特定的 PYTHONPATH 环境变量，你可以在 VS Code Workspace 中轻松调试依赖于本地开发库的 Python 应用。这种方法避免了频繁重新安装依赖的麻烦，提高了开发效率，并且保证了跨平台兼容性。根据你的具体情况，选择 launch.json 配置或 VS Code 设置，以达到最佳的调试体验。

以上就是使用 VS Code Workspace 调试依赖本地库的 Python 应用的详细内容，更多请关注php中文网其它相关文章！