Python：如何处理库的配置文件（依赖项）

Question

上下文：

我目前正在开发一个由 3 个不同的 Python 项目组成的产品：P1、D1、D2。

D1 和D2 是独立的库（也是我开发的），应该通过setuptools 安装。 P1 是主要项目，它依赖于D1 和D2。 D1 和 D2 库需要配置文件才能设置一些自定义参数 - 比如 config_d1.json 和 config_d2.json。

问题：

由于P1需要自定义D1和D2的配置，我想知道设置这些文件位置的最佳方式。

当前解决方案：

我正在考虑通过使用环境变量为D1_CONF_HOME 和D2_CONF_HOME 以及在D1 和D2 内部执行类似的操作来设置配置文件的位置

D1_CONF_HOME = os.getenv('D1_CONF_HOME', '')
SETTINGS_LOCATION = path.join(D1_CONF_HOME, 'config_d1.json')

但我想知道这是否真的是 Pythonic 的方式（我来自 Java 世界，我们通常这样做）。

Answer 1

我不知道它是如何 Pythonian 的，但我就是这样做的。在 setup.py 我有：

setup(name='pkg-name',
     ...
     packages=['pkg-name'],
     package_dir={'pkg-name':'pkg-dir'},
     package_data={'pkg-name':['config/cfg1.json', 'config/cfg1.json']},
     ...

请注意，“config”是您项目中“pkg-dir”的子文件夹。

您需要做的最后一件事是编写能够找到包和配置路径的函数。这些函数仅在您在库中实现时才起作用，而不是在您的项目 P1 中。在我的例子中，我在我的 lib 中创建了一个 Helper 模块并将它们放入该模块，所以我可以将我的项目 P1 中的所有它们作为 Helper.get_config_dir()。

def get_pkg_dir():
  f = __file__
  for _ in range(100)
    f = os.path.abspath(os.path.dirname(f))
    if re.search(r'pkg-name$', f) is not None:
      break;
  return f

def get_config_dir():
  return os.path.abspath(os.path.join(get_pkg_dir(), 'config')

我认为这种方法比处理环境变量要好。