Python项目配置：src模块如何访问项目根目录下的data路径？

问题背景 #

项目结构如下：

|-setup.toml
|-README.md
|-tests/...
|-data/...
|-src/
   |-package1
   |-package2
         |-module1.py
   |-package3
         |-subpackage4
                |-module2.py

实际包含更多分散的文件/文件夹，需要从多数模块中访问$ROOT/data/...路径，且希望移动文件时无需修改大量路径字符串。

现有方案的不足 #

通过pip install -e安装包，在src/顶层模块用import os拼接../data/再供其他模块导入的方法存在明显缺点：

• 需要硬编码相对路径（如../data/），若调整包结构或移动文件，可能需要修改路径字符串
• 代码不够简洁直观，依赖顶层模块的位置关系，维护成本高

2023年的最优解决方案 #

无需再采用上述笨拙方式，以下是更优雅可靠的实现：

方法1：通过顶层包路径推导根目录 #

在src下创建一个顶层包（比如命名为myproject，所有子包都属于它），在其__init__.py中定义项目根目录常量：

# src/myproject/__init__.py
from pathlib import Path

# 路径逻辑：src/myproject/__init__.py → src/myproject → src → 项目根目录
PROJECT_ROOT = Path(__file__).parent.parent.parent

其他模块只需导入该常量即可访问data目录：

# src/package2/module1.py
from myproject import PROJECT_ROOT

# 拼接data路径，支持跨平台
data_file_path = PROJECT_ROOT / "data" / "sample_data.json"

方法2：更健壮的模块路径推导（兼容特殊场景） #

如果需要兼容模块被打包成zip等特殊场景，可使用importlib.util来获取模块信息：

# src/myproject/__init__.py
import importlib.util
from pathlib import Path

def get_project_root() -> Path:
    spec = importlib.util.find_spec(__name__)
    if spec is None or spec.origin is None:
        raise RuntimeError(f"无法获取模块 {__name__} 的路径信息")
    # 从模块文件路径推导根目录
    return Path(spec.origin).parent.parent.parent

# 初始化时计算一次
PROJECT_ROOT = get_project_root()

方案优势 #

• 无需硬编码路径：根目录由顶层包的位置自动推导，调整包结构时只要顶层包与根目录的相对关系不变，无需修改代码
• 跨平台兼容：使用pathlib.Path的路径拼接，避免Windows/Linux路径分隔符的问题
• 支持开发与生产环境：无论是pip install -e的开发模式，还是生产环境安装后的包，都能正确获取根目录

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