使用ConfigParser读取没有节名的文件


87

ConfigParser用来读取脚本的运行时配置。

我想拥有不提供部分名称的灵活性(有些脚本很简单;它们不需要“部分”)。ConfigParser将抛出NoSectionError异常,并且不接受该文件。

如何才能使ConfigParser仅仅检索(key, value)没有节名的配置文件的元组?

例如:

key1=val1
key2:val2

我宁愿不写配置文件。


Answers:


52

Alex Martelli提供了一种用于ConfigParser解析.properties文件(显然是无节配置文件)的解决方案

他的解决方案是一个类似文件的包装器,该包装器将自动插入一个虚拟节标题来满足ConfigParser的要求。


+1,因为这正是我要建议的内容。当您只需要添加一个部分时,为什么还要添加所有复杂性!
贾坦教徒

5
@jathanism:在某些情况下,您想使用现有的config / properties文件,这些文件由现有的Java代码读取,并且您不知道修改这些标头的风险
tshepang 2010年

42

开明的这个答案由jterrace,我想出了这个解决方案:

  1. 将整个文件读入字符串
  2. 带有默认节名称的前缀
  3. 使用StringIO模仿类似文件的对象
ini_str = '[root]\n' + open(ini_path, 'r').read()
ini_fp = StringIO.StringIO(ini_str)
config = ConfigParser.RawConfigParser()
config.readfp(ini_fp)


面向未来的Google员工进行编辑:从Python 3.4+开始,readfp已弃用,并且StringIO不再需要。相反,我们可以read_string直接使用:

with open('config_file') as f:
    file_content = '[dummy_section]\n' + f.read()

config_parser = ConfigParser.RawConfigParser()
config_parser.read_string(file_content)

这也有助于解析简单的Makefile(仅具有别名)!这是一个完整的脚本,可以用此命令中的别名用Python中的完整命令替换别名
2015年

41

您可以在一行代码中完成此操作。

在python 3中,将伪造的节头添加到配置文件数据之前,并将其传递给read_string()

from configparser import ConfigParser

parser = ConfigParser()
with open("foo.conf") as stream:
    parser.read_string("[top]\n" + stream.read())  # This line does the trick.

您还可以itertools.chain()用来模拟的节标题read_file()。这可能比上述方法更节省内存,如果在受约束的运行时环境中有较大的配置文件,则可能会有所帮助。

from configparser import ConfigParser
from itertools import chain

parser = ConfigParser()
with open("foo.conf") as lines:
    lines = chain(("[top]",), lines)  # This line does the trick.
    parser.read_file(lines)

在python 2中,将伪造的节头添加到配置文件数据之前,将结果包装在StringIO对象中,然后将其传递给readfp()

from ConfigParser import ConfigParser
from StringIO import StringIO

parser = ConfigParser()
with open("foo.conf") as stream:
    stream = StringIO("[top]\n" + stream.read())  # This line does the trick.
    parser.readfp(stream)

使用这些方法中的任何一种,您的配置设置都将在中提供parser.items('top')

您也可以在python 3中使用StringIO,也许是为了与新旧python解释器兼容,但是请注意,它现在位于io程序包中,readfp()并且已弃用。

或者,您可以考虑使用TOML解析器而不是ConfigParser。


18

您可以使用ConfigObj库简单地做到这一点:http ://www.voidspace.org.uk/python/configobj.html

已更新:在此处查找最新代码。

如果您在Debian / Ubuntu下,则可以使用软件包管理器安装此模块:

apt-get install python-configobj

使用示例:

from configobj import ConfigObj

config = ConfigObj('myConfigFile.ini')
config.get('key1') # You will get val1
config.get('key2') # You will get val2

8

在我看来,最简单的方法是使用python的CSV解析器。这是一个演示此方法的读/写功能以及一个测试驱动程序。如果不允许将值设置为多行,则此方法应该有效。:)

import csv
import operator

def read_properties(filename):
    """ Reads a given properties file with each line of the format key=value.  Returns a dictionary containing the pairs.

    Keyword arguments:
        filename -- the name of the file to be read
    """
    result={ }
    with open(filename, "rb") as csvfile:
        reader = csv.reader(csvfile, delimiter='=', escapechar='\\', quoting=csv.QUOTE_NONE)
        for row in reader:
            if len(row) != 2:
                raise csv.Error("Too many fields on row with contents: "+str(row))
            result[row[0]] = row[1] 
    return result

def write_properties(filename,dictionary):
    """ Writes the provided dictionary in key-sorted order to a properties file with each line of the format key=value

    Keyword arguments:
        filename -- the name of the file to be written
        dictionary -- a dictionary containing the key/value pairs.
    """
    with open(filename, "wb") as csvfile:
        writer = csv.writer(csvfile, delimiter='=', escapechar='\\', quoting=csv.QUOTE_NONE)
        for key, value in sorted(dictionary.items(), key=operator.itemgetter(0)):
                writer.writerow([ key, value])

def main():
    data={
        "Hello": "5+5=10",
        "World": "Snausage",
        "Awesome": "Possum"
    }

    filename="test.properties"
    write_properties(filename,data)
    newdata=read_properties(filename)

    print "Read in: "
    print newdata
    print

    contents=""
    with open(filename, 'rb') as propfile:
        contents=propfile.read()
    print "File contents:"
    print contents

    print ["Failure!", "Success!"][data == newdata]
    return

if __name__ == '__main__': 
     main() 

+1巧妙地使用该csv模块来解决常见的ConfigParser投诉。易于更广泛地概括并使其与Python 2和3兼容
martineau

6

我自己遇到了这个问题,我根据Martelli接受的答案链接了ConfigParser(Python 2中的版本)的完整包装,该包装可以透明地读取和写入文件而没有任何部分。它应该是ConfigParser的任何用法的直接替代。如果有需要的人找到此页面,则将其发布。

import ConfigParser
import StringIO

class SectionlessConfigParser(ConfigParser.RawConfigParser):
    """
    Extends ConfigParser to allow files without sections.

    This is done by wrapping read files and prepending them with a placeholder
    section, which defaults to '__config__'
    """

    def __init__(self, *args, **kwargs):
        default_section = kwargs.pop('default_section', None)
        ConfigParser.RawConfigParser.__init__(self, *args, **kwargs)

        self._default_section = None
        self.set_default_section(default_section or '__config__')

    def get_default_section(self):
        return self._default_section

    def set_default_section(self, section):
        self.add_section(section)

        # move all values from the previous default section to the new one
        try:
            default_section_items = self.items(self._default_section)
            self.remove_section(self._default_section)
        except ConfigParser.NoSectionError:
            pass
        else:
            for (key, value) in default_section_items:
                self.set(section, key, value)

        self._default_section = section

    def read(self, filenames):
        if isinstance(filenames, basestring):
            filenames = [filenames]

        read_ok = []
        for filename in filenames:
            try:
                with open(filename) as fp:
                    self.readfp(fp)
            except IOError:
                continue
            else:
                read_ok.append(filename)

        return read_ok

    def readfp(self, fp, *args, **kwargs):
        stream = StringIO()

        try:
            stream.name = fp.name
        except AttributeError:
            pass

        stream.write('[' + self._default_section + ']\n')
        stream.write(fp.read())
        stream.seek(0, 0)

        return ConfigParser.RawConfigParser.readfp(self, stream, *args,
                                                   **kwargs)

    def write(self, fp):
        # Write the items from the default section manually and then remove them
        # from the data. They'll be re-added later.
        try:
            default_section_items = self.items(self._default_section)
            self.remove_section(self._default_section)

            for (key, value) in default_section_items:
                fp.write("{0} = {1}\n".format(key, value))

            fp.write("\n")
        except ConfigParser.NoSectionError:
            pass

        ConfigParser.RawConfigParser.write(self, fp)

        self.add_section(self._default_section)
        for (key, value) in default_section_items:
            self.set(self._default_section, key, value)

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.