在 Python 中将配置文件放在哪里？

Question

在开发模式下，我有以下目录树：

| my_project/
| setup.py
| my_project/
    | __init__.py
    | main.py
    | conf/
        | myproject.conf

我使用ConfigParser来解析myproject.conf文件。

在我的代码中，很容易用一个好的路径加载文件： my_project/conf/myproject.conf

问题是：当我使用 setup.py 安装我的项目时，配置文件位于/etc/my_project/myproject.conf （感谢 setup.py），而我的应用程序位于/usr/lib/python<version>/site-packages/my_project/ 。

如何在“生产”模式下在我的项目中引用my_project/conf/myproject.conf文件，并在“开发”模式下引用本地文件（ my_project/conf/myproject.conf ）。

另外，如果可能的话，我希望是便携的（例如在 Windows 上工作）。

这样做的好做法是什么？

Answer 1

你见过配置文件是如何工作的吗？ 阅读“rc”文件，因为它们有时被称为。 "bashrc"、"vimrc" 等

通常对配置文件进行多步搜索。

1. 本地目录。 ./myproject.conf 。

2. 用户的主目录 ( ~user/myproject.conf )

3. 标准的系统范围目录 ( /etc/myproject/myproject.conf )

4. 由环境变量 ( MYPROJECT_CONF ) 命名的地方

Python 安装将是最后一个查看的地方。

config= None
for loc in os.curdir, os.path.expanduser("~"), "/etc/myproject", os.environ.get("MYPROJECT_CONF"):
    try: 
        with open(os.path.join(loc,"myproject.conf")) as source:
            config.readfp( source )
    except IOError:
        pass

Answer 2

appdirs包在为各种平台上的已安装应用程序找到标准位置方面做得很好。 我想知道扩展它以发现或允许开发人员处于某种“卸载”状态是否有意义。

Answer 3

如果您使用setuptools ，请参阅有关使用非包数据文件的章节。 不要试图自己查找文件。

Answer 4

更新 S.Lott 的回答。

现在不推荐使用configparser.ConfigParser.readfp()方法。

您可以直接对多文件使用configparser.ConfigParser.read()方法。

例如：

import configparser

config = configparser.ConfigParser()

all_config_files = ['/path/to/file1', '/path/to/file2', '/path/to/file3']

config.read(all_config_files)

笔记：

• 后面的配置文件中的配置选项将覆盖之前的。
• 如果配置文件不存在， read()将忽略它。
• 如果您有必需的选项需要从文件中读取， read_file()使用read_file() 。

configparser.ConfigParser.read()

Answer 5

我不认为有一个干净的方法来处理这个问题。 您可以简单地选择测试“本地”文件是否存在，这将在开发模式下工作。 否则，退回到生产路径：

import os.path

main_base = os.path.dirname(__file__)
config_file = os.path.join(main_base, "conf", "myproject.conf")

if not os.path.exists(config_file):
    config_file = PROD_CONFIG_FILE   # this could also be different based on the OS

Answer 6

另一种选择是将所有.cfg和.ini文件保存在主目录中，就像 'boto' 所做的那样。

import os.path
config_file = os.path.join(os.path.expanduser("~"), '.myproject')

Answer 7

编写安装脚本的文档，在第2.7节下。 安装附加文件提到：

data_files选项可用于指定模块分发所需的其他文件：配置文件、消息目录、数据文件，以及任何不属于上述类别的文件。