Python工作目录变更后相对路径处理及Jupyter Notebook最佳实践

针对当前问题的优雅解决方法 #

1. 基于模块自身位置构建路径（最通用） #

利用Python模块的__file__属性获取自身所在目录的绝对路径，再拼接目标文件路径，完全不依赖调用方的工作目录。

用os模块实现：

# utils.py 中的代码
import os
# 获取当前模块所在目录的绝对路径
module_dir = os.path.dirname(os.path.abspath(__file__))
# 拼接b.json的完整路径
json_file_path = os.path.join(module_dir, "b", "b.json")
with open(json_file_path, "r") as tmp:
    # 读取文件内容
    content = tmp.read()

用pathlib实现（Python3.4+，更简洁直观）：

# utils.py 中的代码
from pathlib import Path
# 获取当前模块所在目录
module_dir = Path(__file__).parent
# 拼接路径（支持/运算符）
json_file_path = module_dir / "b" / "b.json"
with open(json_file_path, "r") as tmp:
    content = tmp.read()

2. 利用importlib.resources管理包内资源（适合可分发项目） #

如果你的项目是可安装的Python包，推荐使用标准库的importlib.resources（Python3.7+）来读取包内资源，无需手动拼接路径。

假设项目根目录a是一个Python包（需要包含__init__.py），b是子包（同样需要__init__.py），可以这样读取：

# utils.py 中的代码
import importlib.resources
# 直接读取文件内容
content = importlib.resources.read_text("a.b", "b.json")

# 或者获取文件路径（适合需要文件对象的场景）
with importlib.resources.path("a.b", "b.json") as json_file_path:
    with open(json_file_path, "r") as tmp:
        content = tmp.read()

开发项目时的路径处理最佳实践 #

通用原则 #

• 模块内的文件读取绝对不要依赖相对路径（./xxx）：这种路径解析基于调用方的工作目录，极易引发路径错误。
• 统一路径逻辑：把所有资源文件的读取逻辑集中在工具模块（比如utils.py）中，其他脚本/Notebook直接调用工具方法，避免重复实现路径拼接。

Jupyter Notebook场景特殊处理 #

• Notebook中读取文件时，基于自身位置构建路径：

# c.ipynb 中的代码
from pathlib import Path
# 获取当前Notebook所在目录的绝对路径
notebook_dir = Path().resolve()
# 读取上级目录的b.json
json_file_path = notebook_dir.parent / "b" / "b.json"

• 优先调用工具模块的方法：如果已经导入utils，直接用utils中封装好的读取方法，不要在Notebook中重复处理路径，保证逻辑一致性。
• 避免修改全局工作目录：不要轻易用os.chdir()切换工作目录，会影响其他代码的路径解析，尤其是多Notebook同时运行的场景。

项目结构规范 #

建议采用清晰的分层结构，比如：

/a
  __init__.py
  utils.py
  /resources
    b.json
  /notebooks
    c.ipynb

这样资源文件统一放在resources目录，代码集中在根目录，Notebook单独归类，既便于管理，也更容易用importlib.resources或pathlib定位资源。

内容的提问来源于stack exchange，提问作者T_Y