python - 通过 setuptools 或 distutils 安装 Python 包后如何访问可编辑的配置文件？

Question

如何允许使用“python setup.py install”安装的包访问外部配置文件？

我目前正在尝试使用 distutils/setuptools 为 RHEL 安装 Python 包。这个 Python 包最初的编写方式是作为一组脚本运行，需要文件系统访问各种配置文件、日志等。现在我正在尝试从此设置中创建一个可安装的包，我与文件系统交互以获得必要的文件时遇到困难。

这些文件应该是可编辑的。除了基本问题之外，此类行为的最佳实践是什么？ IE。管理通过 setuptools 或 distutils 安装的 Python 包的配置以及这些包与文件系统交互的最佳实践是什么。我假设这个硬币有两半:在安装端配置文件的位置，并在代码实现端访问信息。任何有关优化这两个方面的建议将不胜感激。

其他信息:

安装软件包后，我基本上需要访问“config”目录。 “config”目录的位置可以位于文件系统上的任何位置(用户有权限)，并且在安装包之前其本身应该是可配置的。该项目如下所示:

• 项目/
  • 主要/
    • __init__.py
    • 脚本1.py
    • script2.py
    • service.py(Flask Web 服务运行程序)
    • ...与上面交互的其他 python 文件
  • 配置/
    • 子目录/
      • 子目录/
        • config_file.ini
    • 子目录/
      • ...
    • ...
  • 日志/
    • log_file.log

Answer 1

您可以使用 data_files option in distutils 安装数据文件。然而，distutils/setuptools 在处理配置文件方面的范围非常有限。您只能指定安装这些文件的相对或绝对路径，没有选项可以让用户配置此安装位置。

处理安装和读取配置文件的最佳实践？我认为没有什么可以被规范地认为是“最好的”。 distutils 的功能非常有限，因此无法满足许多用例。您基本上可以按照满足您要求的任何方式处理配置文件。

如果您想在安装前配置配置文件的位置，您需要比 distutils 提供更多功能的东西。一些可能的方法来处理这个问题:

1. 将代码添加到 setup.py 脚本中以处理此问题。 setup.py 可以处理任意 Python 代码，因此它可以扩展到所需的 setup() 调用之外，以执行您需要的任何操作。然而，这样做被认为是意外且不标准的。在 setuptools 和 pip 等工具出现之前，软件包有时会有一个交互式提示，要求用户输入安装信息。但是，当该软件包由 pip 或 easy_install 等自动安装程序安装时，这种情况就会中断。

2. 编写您自己的安装程序。这会处理配置文件安装位置的详细信息，并在后台安装 Python 包。

3. 在 Linux 环境中，Buildout 工具对此很有帮助。这需要用户安装 Buildout，然后使用配置文件位置编辑 buildout.cfg 配置文件。它可能是管理应用程序配置的有用方法，但它确实要求安装人员安装 Buildout 并编辑基于 bulidout 的配置文件。 Plone 项目就是一个例子，它有一个复杂且可配置的安装过程，而 Buildout 用于管理这个过程。