VSCode中调试与运行代码时如何设置配置文件

1. 问题描述

在VSCode中调试与运行Python代码时，可能会出现相对路径问题，导致无法调试与运行代码。

比如在代码中的sys.path.append('../')，可能会由于相对路径问题，导致无法找到文件。

这种情况下，可以通过设置配置文件将当前文件夹设置为工作文件夹，从而解决相对路径问题。

2. 路径检查

Python 提供了一些包os、sys、pathlib来处理路径问题。

os包用于与操作系统交互，sys包用于与Python解释器交互，pathlib包用于处理路径。

2.1 使用 os 包

import os

# 获取当前工作目录
current_dir = os.getcwd()

# 获取文件的绝对路径
abs_path = os.path.abspath(__file__)

# 获取文件所在目录
file_dir = os.path.dirname(__file__)

# 路径拼接
new_path = os.path.join(file_dir, 'subfolder', 'file.txt')

# 检查路径是否存在
exists = os.path.exists(new_path)

# 切换工作目录
os.chdir(file_dir)  

#获取环境变量
os.environ['PATH']

2.2 使用 sys 包

import sys

# 获取Python解释器的搜索路径
search_paths = sys.path

# 添加搜索路径
sys.path.append('../')

# 获取当前脚本的完整路径
script_path = sys.argv[0]

2.3 使用 pathlib 包

from pathlib import Path

# 获取当前文件路径
current_file = Path(__file__)

# 获取父目录
parent_dir = current_file.parent

# 路径拼接
new_path = parent_dir / 'subfolder' / 'file.txt'

# 检查路径是否存在
exists = new_path.exists()

# 创建目录
new_path.parent.mkdir(parents=True, exist_ok=True)

3. 配置方法

VSCode项目中有两个配置文件：

• .vscode/settings.json：设置VSCode的运行配置。
• .vscode/launch.json：设置VSCode的调试配置。

3.1 安装插件

Code Runner插件：运行Python代码。点击右上角的播放按钮▶或使用快捷键 Ctrl + Alt + N）运行 Python 文件。
Python Debugger插件：调试Python代码。使用快捷键 F5 调试 Python 文件。

3.2 设置.vscode/settings.json

settings.json文件可以打开命令面板（快捷键：Windows: Ctrl + Shift + P，Mac: Command + Shift + P），输入Preferences: Open Settings (JSON)打开。

或者，直接在.vscode文件夹下新建settings.json文件。

在settings.json文件中输入以下内容：

{
    "code-runner.fileDirectoryAsCwd": true,
    // 可选的其他 Code Runner 相关设置
    "code-runner.runInTerminal": true,  // 在终端中运行代码
    "code-runner.saveFileBeforeRun": true,  // 运行前保存文件
    "code-runner.preserveFocus": false,  // 运行后焦点切换到终端
    "code-runner.clearPreviousOutput": true  // 运行前清除之前的输出
}

接下来，就可以点击右上角的播放按钮▶或使用快捷键 Ctrl + Alt + N）运行 Python 文件。

3.3 设置.vscode/launch.json

点击右上角的调试按钮（或使用快捷键 F5）调试 Python 文件。系统会提示是否创建launch.json文件。

也可以通过在.vscode文件夹下新建launch.json文件。

在launch.json文件中输入以下内容：

{
    // 使用 IntelliSense 了解相关属性。 
    // 悬停以查看现有属性的描述。
    // 欲了解更多信息，请访问: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Current File",
            "type": "debugpy",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal",
            "justMyCode": true,
            "cwd": "${fileDirname}"  // 这行设置会让调试模式也使用文件所在目录作为工作目录
        }
    ]
}

接下来，就可以使用快捷键 F5 调试 Python 文件。