在 python 包中添加和读取 config.ini 文件

我正在编写我的第一个 python 包，我想将其上传到 PyPI 上。我基于此构建了我的代码博客文章.

我想将用户设置存储在 config.ini 文件中。在同一包中的单独 python 模块中读取一次（每次运行包时），并将用户设置保存在该模块的全局变量中。稍后将其导入其他模块中。

为了重现错误，我只是在博客文章中描述的模板中编辑了几行代码。 （请参考它，因为重新创建整个有问题的内容需要太多的输入。）

唯一的区别是我的stuff.py像这样从配置文件中读取：

from ConfigParser import SafeConfigParser

config = SafeConfigParser()
config.read('config.ini')

TEST_KEY = config.get('main', 'test_key')

以下是内容config.ini（放置在与stuff.py):

[main]
test_key=value

And my bootstrap.py只需导入并打印TEST_KEY

from .stuff import TEST_KEY

def main():
    print(TEST_KEY)

但是在执行包时，导入失败并出现此错误

Traceback (most recent call last):
    File "D:\Coding\bootstrap\bootstrap-runner.py", line 8, in <module>
    from bootstrap.bootstrap import main
    File "D:\Coding\bootstrap\bootstrap\bootstrap.py", line 11, in <module>
    from .stuff import TEST_KEY
    File "D:\Coding\bootstrap\bootstrap\stuff.py", line 14, in <module>
    TEST_KEY = config.get('main', 'test_key')
    File "C:\Python27\Lib\ConfigParser.py", line 607, in get
    raise NoSectionError(section)
ConfigParser.NoSectionError: No section: 'main'

进口不断给予ConfigParser.NoSectionError，但是如果你只构建/运行 stuff.py（我使用 sublime3），该模块不会给出错误并打印TEST_KEY gives value作为输出。

另外，当我只在目录中使用 3 个文件（config、stuff、main）并仅将 main 作为脚本执行时，这种导入方法确实有效。但我必须像这样导入它

from stuff import TEST_KEY

我只是使用该文章中描述的显式相对导入，但对这些没有足够的理解。我猜错误是由于项目结构和导入造成的，因为运行stuff.py因为独立脚本不会引发ConfigParser.NoSectionError.

其他读取配置文件一次然后在其他模块中使用数据的方法也将非常有用。

这个问题有两个方面。First是奇怪的行为ConfigParser. When ConfigParser无法找到.ini文件;由于某些烦人的原因，它永远不会给出IOError或指示无法读取文件的错误。

就我而言，它不断给予ConfigParser.NoSectionError当。。。的时候section明显存在。当我抓住了ConfigParser.NoSectionError它给出了错误ImportError！但它永远不会告诉您它根本无法读取该文件。

Second是如何安全地阅读包中包含的数据文件。我发现做到这一点的唯一方法是使用__file__范围。这就是您安全阅读的方式config.ini在上面的问题中，对于Python27和Python3：

import os

try:
    # >3.2
    from configparser import ConfigParser
except ImportError:
    # python27
    # Refer to the older SafeConfigParser as ConfigParser
    from ConfigParser import SafeConfigParser as ConfigParser

config = ConfigParser()

# get the path to config.ini
config_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'config.ini')

# check if the path is to a valid file
if not os.path.isfile(config_path):
    raise BadConfigError # not a standard python exception

config.read(config_path)

TEST_KEY = config.get('main', 'test_key') # value

这取决于以下事实：config.ini位于我们的包裹内bootstrap并预计将随之发货。

重要的是你如何获得config_path:

config_path = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'config.ini')

__file__指的是当前的位置script正在执行。在我的问题中，这意味着stuff.py，即在里面bootstrap文件夹，也是如此config.ini.

上面这行代码的意思是：获取绝对路径stuff.py;从该获取路径到包含它的目录；并加入config.ini（因为它位于同一目录中）给出绝对路径config.ini。然后您可以继续阅读并提出exception万一。

即使您在以下位置发布软件包，这也将起作用pip用户从那里安装它。

As a bonus，并且稍微偏离这个问题，如果您要在pip数据文件在你的包里，你必须告诉setuptools在构建时将它们包含在您的包中sdist and bdists。所以要包括config.ini在上面的包中添加以下行setup班级呼入setup.py:

include_package_data = True,
package_data = {
    # If any package contains *.ini files, include them
    '': ['*.ini'],
},

但在某些情况下它仍然可能不起作用，例如。造轮子等。所以你也在你的MANIFEST.IN file:

include LICENSE
include bootstrap/*.ini