web-dev-qa-db-ja.com

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

ConfigParserを使用して、スクリプトのランタイム構成を読み取ります。

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

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

key1=val1
key2:val2

構成ファイルには書き込みたくない。

pythonparsingconfiguration-files
76
Escualo

Alex Martelli ソリューションを提供ConfigParserを使用して.propertiesファイル（明らかにセクションのない設定ファイルです）。

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

45
Will McCutchen

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)


[〜＃〜] edit [〜＃〜]将来のGoogleユーザー向け：Python 3.4+ readfpは廃止され、StringIOは不要になりました。代わりにread_string 直接：

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

config_parser = RawConfigParser()
config_parser.read_string(file_content)
40
xmo

これは、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')で構成設定を使用できます。

StringIOをpython 3でも使用できます。おそらく古いものと新しいpythonインタープリターとの互換性のためですが、現在はioパッケージとreadfp()は非推奨になりました。

または、ConfigParserの代わりに [〜＃〜] toml [〜＃〜] パーサーの使用を検討することもできます。

32
ʇsәɹoɈ

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
16
Blueicefield

これを行う最も簡単な方法は、私の意見では、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 __== '__main__': 
     main()
7
nacitar sevaht

自分でこの問題にぶつかったので、ConfigParserに完全なラッパー（Python 2のバージョン））を作成しました。これは、受け入れられた回答にリンクされたAlex Martelliのアプローチに基づいて、セクションなしでファイルを透過的に読み書きできます。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)
6
danielkza

Blueicefieldの答えはconfigobjに言及しましたが、元のライブラリはPython 2のみをサポートします。現在、Python 3+互換ポートがあります。

https://github.com/DiffSK/configobj

APIは変更されていません。 doc を参照してください。

5
laike9m