VSCode下配置python调试运行环境的方法

下面是详细的"VSCode下配置Python调试运行环境的方法"攻略：

1. 安装 Python 解释器

在 VSCode 之前，我们需要安装 Python 解释器。可以到 Python 官网下载。

安装好 Python 后，可以在命令行（terminal）执行以下命令来验证 Python 是否安装成功：

python --version

如果出现了 Python 版本号，说明已经安装成功了。

2. 安装 VSCode

这一步是非常简单的，到 VSCode 官网下载并安装即可。

3. 安装 Python 插件

在 VSCode 中安装 Python 扩展很简单。打开 VSCode 进入“Extensions”（扩展）视图。搜索 Python 并安装即可。

4. 配置 VSCode 地址

有时候，我们在使用 VSCode 调试 Python 代码时，可能会遇到一些权限问题。这是因为 VSCode 使用的是本地服务器。需要在用户设置中将 python.pythonPath 设置为 Python 解释器的路径。

打开 VSCode 的用户设置页面有多种方式，其中最简单的方式是，使用组合键 Ctrl + , 或者使用菜单栏中的 文件 > 首选项 > 设置 进入设置页面。

在设置页面中，直接搜索 python.pythonPath，然后将 Python 解释器的路径填写进去即可。比如在 Windows 下，如果 Python 安装在了 C 盘，Python 启动文件为 python.exe，则在设置页面中应该如下配置：

{
    "python.pythonPath": "C:\\Python\\Python39\\python.exe"
}

5. 创建 Python 调试配置

打开 VSCode，并打开一个 Python 文件，然后按 F5，选择 Python。

这时候 VSCode 会为我们自动生成一个名为 launch.json 的文件，该文件位于 .vscode 目录下。其中，文件中的 configurations 属性就是调试配置信息。

默认情况下，launch.json 文件的配置如下：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        }
    ]
}

这段配置信息的意思是，通过在终端中进入当前文件所在的目录，然后执行 python filename.py 命令来运行当前的 Python 文件。

如果我们想给该配置添加更多的自定义内容，可以在 configurations 数组中添加更多的子项，例如：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "args": ["--arg", "foo"],
            "cwd": "${workspaceFolder}",
            "env": {"FOO": "BAR"},
            "pythonPath": "${workspaceFolder}/venv/bin/python"
        }
    ]
}

在这个自定义的配置中，添加了 args，cwd，env，pythonPath 等项，可以根据实际需求任意添加。

示例

示例 1: 简单的 Python 调试示例

我们来看一个简单的示例。假设有一个名为 hello.py 的 Python 文件，内容如下：

def say_hello():
    print("Hello, world!")


if __name__ == '__main__':
    say_hello()

使用 VSCode 调试时，需要先打开该文件，然后按下 F5 键进入调试模式。此时，在命令行中应该看到以下信息：

c:\path\to\file.py

其中 c:\path\to\file.py 是当前活动文件的完整路径。

按下 F5 键后，会在 .vscode 目录下生成一个名为 launch.json 的文件，内容如下：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "c:\\path\\to\\file.py",
            "console": "integratedTerminal"
        }
    ]
}

此时可以在调试栏中看到一个名为“Python: Current File”的启动配置。

接下来，点击绿色的播放按钮启动调试。此时应该可以在内置终端中看到如下输出：

Hello, world!

示例 2: 使用 Flask 进行 Web 开发

假设我们正在使用 Flask 进行 Web 开发，并且我们需要在 VSCode 中进行代码调试。

首先，需要确保 Flask 扩展已经安装。可以使用以下命令检查：

pip show flask

如果显示信息中包含了 flask 组件而没有错误提示，说明 flask 扩展已经正确安装。

接下来，我们需要创建一个 Flask 的 Web 应用。假设我们在项目根目录下创建了一个名为 app.py 的文件，文件内容如下：

from flask import Flask

app = Flask(__name__)


@app.route("/")
def index():
    return "Hello, world!"


if __name__ == '__main__':
    app.run(debug=True)

然后，在 VSCode 中打开该文件，在文件的头部插入以下代码，以确保 Flask 知道我们正在调试的是哪个应用：

import os

os.environ["FLASK_APP"] = "app"

这段代码的作用是将环境变量 FLASK_APP 的值设置为 app，这样 Flask 将知道我们正在调试的是哪个应用。

现在，我们可以通过以下步骤来配置 VSCode：

使用 Ctrl + Shift + P 键打开命令面板，在里面输入 Python: Flask，选择“Python: Flask”。
选择你希望使用的 Python 版本。
执行完该命令后，VSCode 会在 launch.json 中生成一个名为“Python: Flask”（或类似的）的启动配置。

接下来，我们就可以进入调试模式，使用 Flask 进行 Web 开发了。

在启动服务后，可以在 Chrome 或 Firefox 等浏览器中输入 http://localhost:5000/，看到如下输出：

Hello, world!

这边只是简单的展示如何在 Flask 中进行调试，实际使用更为复杂。

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：VSCode下配置python调试运行环境的方法 - Python技术站