ConfigParserを使用してセクション名のないファイルを読み取る


87

ConfigParserスクリプトのランタイム構成を読み取るために使用しています。

セクション名を指定しない柔軟性が必要です(十分に単純なスクリプトがあります。「セクション」は必要ありません)。例外ConfigParserをスローしNoSectionError、ファイルを受け入れません。

ConfigParserに(key, value)セクション名のない構成ファイルのタプルを単純に取得させるにはどうすればよいですか?

例えば:

key1=val1
key2:val2

設定ファイルには書きたくありません。


回答:


52

Alex Martelliは、ファイル(明らかにセクションのない構成ファイル)のConfigParser解析に使用するためのソリューション提供しました.properties

彼の解決策は、ConfigParserの要件を満たすためにダミーのセクション見出しを自動的に挿入するファイルのようなラッパーです。


+1は、まさに私が提案しようとしていたことだからです。セクションを追加するだけなのに、なぜすべての複雑さを追加するのですか?
ジャサニズム2010年

5
@jathanism:既存のJavaコードによって読み取られる既存のconfig / propertiesファイルを操作したいが、それらのヘッダーを変更するリスクがわからない場合があります
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)


将来のグーグルのための編集: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

これは、1行のコードで実行できます。

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インタープリターと新しいPythonインタープリターの両方との互換性のために、Python 3でもStringIOを使用できますが、現在はioパッケージに含まれており、readfp()非推奨になっていることに注意してください。

または、ConfigParserの代わりにTOMLパーサーを使用することを検討してください


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() 

+1csv一般的なConfigParser苦情を解決するためのモジュールの巧妙な使用。より簡単に一般化され、Python2と3の両方と互換性があります。
martineau 2013

6

自分でこの問題に遭遇したので、受け入れられた回答にリンクされたAlex 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)

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.