Python包开发与安装场景下conf目录相对路径失效问题咨询
路径不匹配问题来源于src开发布局和安装后部署布局的结构差异,不需要硬编码开发/生产两套路径规则,按照以下方案处理即可统一适配两种场景:
核心解决方案
- 优先使用标准库
importlib.resources读取包内资源,该库会自动适配开发模式、wheel安装、egg安装等不同场景下的路径,无需手动处理层级差异。 - 正确配置打包规则,将conf目录声明为包数据:
- 若使用
pyproject.toml配置,在setuptools字段下添加:[tool.setuptools.package-data] "my_package" = ["conf/**/*"] - 若使用
setup.py配置,添加:setup( # ...其他配置 package_data={"my_package": ["conf/**/*"]}, include_package_data=True )
- 若使用
- 配置三层查找优先级,同时满足开箱即用、自定义修改、开发调试三类需求:
- 最高优先级:用户主动传入的自定义配置路径,支持用户自定义存放位置
- 次优先级:当前工作目录下的
conf目录,用户克隆仓库后直接修改根目录下的配置即可生效 - 兜底优先级:通过
importlib.resources读取包内置的默认配置,安装后无需额外配置即可正常运行
示例代码
import os from importlib.resources import files from typing import Optional import yaml def load_config(custom_path: Optional[str] = None) -> dict: # 1. 优先使用自定义路径 if custom_path: if not os.path.exists(custom_path): raise FileNotFoundError(f"自定义配置文件不存在: {custom_path}") config_path = custom_path # 2. 其次读取工作目录下的配置 elif os.path.exists(local_conf := os.path.join(os.getcwd(), "conf", "config.yaml")): config_path = local_conf # 3. 兜底读取包内置默认配置 else: config_path = files("my_package").joinpath("conf", "config.yaml") # 解析配置 with open(config_path, "r", encoding="utf-8") as f: return yaml.safe_load(f)
提示:Python3.9以下版本需要安装兼容包
pip install importlib-resources,并将导入语句替换为from importlib_resources import files。
内容的提问来源于stack exchange,提问作者FenryrMKIII
相关产品推荐
相关产品推荐

