解决VSCode无法识别相对路径的问题

奇文怪式

12075人浏览 · 2024-12-12 17:42:45

奇文怪式 · 2024-12-12 17:42:45 发布

前言：
近日在学习Python文件操作，发现使用VSCode作为编辑器时，文件的相对路径会出问题，提示报错“指定路径下找不到文件”。在《解决VSCode无法识别相对路径的问题》之前，我们先普及以下2个知识点：

知识点①：不同操作系统所使用的路径斜杠不同，Linux系统是/，Windows系统是\。
知识点②：对于相对路径，明确使用 ./ 表示 “ 当前文件所在目录 ” ，使用 ../ 表示 “ 当前文件所在目录 ” 的父目录（即上一级目录）。一般地，” 当前文件所在目录 “ 我们也称为 “ 参照位置 ” 。

问题：
Python_project工程存储于E:/code文件夹下，笔者欲在draw_chart.py编码文件里调用&处理1836A.xlsx文件。
这里先贴上笔者在draw_chart.py中调用相对路径的 Python 代码段：

# 该代码片段位于 draw_chart.py 文件中
chart_title = '1836A'
file_path = f"../pending_files/{chart_title}.xlsx"   # 欲使用相对路径引用 1836A.xlsx 文件

再列出笔者的工程目录树：
Python_project
└─ .vscode
│ ├─ launch.json
│ └─ settings.json
├─ app_sample
│ └─ draw_chart.py
├─ pending_files
│ └─ 1836A.xlsx

笔者的工程视图：
在这里插入图片描述
在基于以上的情况下，出现了相对路径报错的问题。报错提示如下图所示：

🌵 解决方案（一）
⭐修改要点：将相对路径引用的代码段修改成当前目录引用，即../改成./，如下所示。

# 该代码片段位于 draw_chart.py 文件中
chart_title = '1836A'
file_path = f"./pending_files/{chart_title}.xlsx"   # 欲使用相对路径引用 1836A.xlsx 文件

修改后可正常运行，问题解决。
在这里插入图片描述

⭐修改原理：
important：在VSCode的默认配置中，相对路径的【参照位置】是打开的“工程项目文件夹”，不是draw_chart.py源代码文件目录所在位置。
以笔者的工程项目Python_project为示例，此时工程中相对路径的【参照位置】已经是项目文件夹Python_project，而不是draw_chart.py编码文件所在的app_sample文件夹！！！
所以此时的相对路径./pending_files/{chart_title}.xlsx等效于绝对路径E:/code/Python_project/pending_files/1836A.xlsx。

🌵 解决方案（二）
我们要将相对路径的【参照位置】，从打开的 “工程项目文件夹” 修改到 “当前源代码文件目录” 。
⭐修改要点1：首先我们不修改相对路径的引用，即代码段保持../不变。

# 该代码片段位于 draw_chart.py 文件中
chart_title = '1836A'
file_path = f"../pending_files/{chart_title}.xlsx"   # 欲使用相对路径引用 1836A.xlsx 文件

⭐修改要点2：其次使用UI形式设置，依次打开设置→搜索execute→勾选 Execute in file Dir 选项，如下图所示：
在这里插入图片描述
或者使用json文本形式设置，即在settings.json中添加"python.terminal.executeInFileDir": true,，如下图所示：

上述两者效果是一致的，VSCode有UI和json文本两种形式设置，任选一种即可，笔者推荐json文本形式设置。
最后运行Python代码，可以看到正常运行，问题解决。
在这里插入图片描述

⭐修改原理：此时相对路径的【参照位置】，是“当前源代码draw_chart.py所在的文件目录”。
以笔者的工程项目Python_project为示例，由于需要调用相对路径的代码存在于draw_chart.py，draw_chart.py在app_sample文件夹下，此时相对路径的【参照位置】是app_sample。
所以相对路径../pending_files/{chart_title}.xlsx等价于 ../先从当前目录app_sample回退到父目录Python_project，再追加/pending_files/{chart_title}.xlsx，最终的等效绝对路径是E:/code/Python_project/pending_files/1836A.xlsx。