如何在通过setuptools的data_files安装的Python用户配置文件中配置路径

方案1：安装时自动注入绝对路径 #

在setuptools的安装流程中增加自定义逻辑，安装完成后自动将data目录的实际安装路径写入配置文件，不需要用户手动填写绝对路径：

• 原始config.ini中预留占位符，比如data_dir = {{DATA_DIR_PLACEHOLDER}}，用户可以提前修改其他配置项
• 重写install命令，在默认安装逻辑执行完成后，获取文件实际安装路径，替换配置文件中的占位符

示例代码如下：

from setuptools import setup
from setuptools.command.install import install
import configparser
import os

class CustomInstallCommand(install):
    def run(self):
        # 执行默认安装逻辑
        super().run()
        # 配置文件安装路径，此处对应安装到sys.prefix/etc/myproject目录
        installed_config_path = os.path.join(self.install_data, "etc", "myproject", "config.ini")
        # data目录实际安装路径，对应你data_files中配置的安装位置
        installed_data_path = os.path.join(self.install_data, "share", "myproject", "data")
        # 替换配置中的占位符
        conf = configparser.ConfigParser()
        conf.read(installed_config_path)
        conf.set("default", "data_dir", installed_data_path)
        with open(installed_config_path, "w") as f:
            conf.write(f)

setup(
    # 其余基础配置省略
    data_files = [
        ("etc/myproject", ["config.ini"]),
        # 如果需要随包分发data文件，在此处配置映射关系，不需要分发则删除该行
        ("share/myproject/data", [os.path.join("data", f) for f in os.listdir("data")])
    ],
    cmdclass = {
        "install": CustomInstallCommand
    }
)

方案2：代码层动态解析相对路径 #

如果不想修改安装逻辑，可以在代码中以配置文件的实际所在目录为基准，拼接相对路径：

• 配置文件中直接写data目录相对于config.ini的路径，比如两个文件在项目根目录平级的话，就写data_dir = ./data
• 代码中读取到配置后，先判断路径是否为绝对路径，不是的话用config.ini的父目录拼接成绝对路径

示例代码如下：

import configparser
import os
import sys

# 按优先级查找配置文件，支持用户自定义配置覆盖系统默认配置
config_candidates = [
    os.path.expanduser("~/.myproject/config.ini"),
    os.path.join(sys.prefix, "etc", "myproject", "config.ini"),
    "./config.ini"
]
config_path = None
for candidate in config_candidates:
    if os.path.exists(candidate):
        config_path = candidate
        break

conf = configparser.ConfigParser()
conf.read(config_path)
raw_data_dir = conf.get("default", "data_dir")

# 动态解析为绝对路径
if not os.path.isabs(raw_data_dir):
    data_dir = os.path.abspath(os.path.join(os.path.dirname(config_path), raw_data_dir))
else:
    data_dir = raw_data_dir

补充说明 #

如果你不需要将data目录随安装包分发，仅需要让代码能读取用户自行部署的data文件，可以直接使用方案2即可，无需配置setuptools的data_files参数，灵活度更高。

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