Використання ConfigParser для читання файлу без імені розділу


87

Я використовую ConfigParserдля читання конфігурації сценарію виконання.

Я хотів би мати гнучкість, не надаючи назви розділу (є сценарії, які є досить простими; їм не потрібен „розділ“). ConfigParserвикине NoSectionErrorвиняток і не прийме файл.

Як я можу змусити ConfigParser просто отримувати (key, value)кортежі конфігураційного файлу без імен розділів?

Наприклад:

key1=val1
key2:val2

Я волів би не писати у конфігураційний файл.


Відповіді:


52

Алекс Мартеллі запропонував рішення для ConfigParserаналізу .propertiesфайлів (які, очевидно, не містять розділів конфігураційних файлів).

Його рішення полягає у файлоподібній обгортці, яка автоматично вставить фіктивний заголовок розділу, щоб задовольнити ConfigParserвимоги.


+1, тому що саме це я збирався запропонувати. Навіщо додавати всю складність, коли все, що вам потрібно зробити, це просто додати розділ!
ятанізм

5
@jathanism: бувають випадки, коли ви хочете працювати з існуючими файлами конфігурації / властивостей, які зчитуються існуючим кодом Java, і ви не знаєте ризику зміни цих заголовків
tshepang

43

Просвітлений цією відповіддю 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 для майбутніх googlers: станом на 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 , натхненний цією відповіддю.
скутий

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').

Ви можете використовувати StringIO і в python 3, можливо, для сумісності як зі старим, так і з новим інтерпретаторами 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

Найпростіший спосіб зробити це - використовувати CSV-аналізатор python, на мій погляд. Ось функція читання / запису, яка демонструє цей підхід, а також тест-драйвер. Це має спрацювати за умови, що значенням заборонено бути багаторядковими. :)

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

Натрапивши на цю проблему сам, я написав повну обгортку для 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)

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.