ใช้ ConfigParser เพื่ออ่านไฟล์ที่ไม่มีชื่อส่วน


90

ฉันใช้ConfigParserเพื่ออ่านการกำหนดค่ารันไทม์ของสคริปต์

ฉันต้องการความยืดหยุ่นในการไม่ระบุชื่อส่วน (มีสคริปต์ที่ง่ายพอไม่จำเป็นต้องมี 'ส่วน') ConfigParserจะส่งNoSectionErrorข้อยกเว้นและจะไม่ยอมรับไฟล์

ฉันจะสร้าง ConfigParser เพียงแค่ดึงสิ่งที่สอง(key, value)ของไฟล์ config โดยไม่มีชื่อส่วนได้อย่างไร

ตัวอย่างเช่น:

key1=val1
key2:val2

ฉันไม่อยากเขียนลงในไฟล์ config


อาจซ้ำกันของการแยกไฟล์ .
properties

คำตอบ:


53

Alex Martelli ได้จัดเตรียมโซลูชันสำหรับใช้ConfigParserในการแยกวิเคราะห์.propertiesไฟล์ (ซึ่งเห็นได้ชัดว่าเป็นไฟล์ config ที่ไม่มีส่วน)

โซลูชันของเขาคือกระดาษห่อหุ้มที่มีลักษณะคล้ายไฟล์ซึ่งจะแทรกส่วนหัวของส่วนดัมมี่โดยอัตโนมัติเพื่อตอบสนองConfigParserความต้องการของ


+1 เพราะนั่นคือสิ่งที่ผมกำลังจะแนะนำ ทำไมต้องเพิ่มความซับซ้อนทั้งหมดในเมื่อสิ่งที่คุณต้องทำก็แค่เพิ่มส่วน!
jathanism

5
@jathanism: มีบางกรณีที่คุณต้องการทำงานกับไฟล์ config / properties ที่มีอยู่ซึ่งอ่านโดยโค้ด Java ที่มีอยู่และคุณไม่ทราบความเสี่ยงในการแก้ไขส่วนหัวเหล่านั้น
tshepang

44

รู้แจ้งโดยคำตอบนี้โดย 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)


แก้ไขสำหรับ Googler ในอนาคต: เนื่องจาก 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ซึ่งได้รับแรงบันดาลใจจากคำตอบนี้
พูดไม่ออก

42

คุณสามารถทำได้ในโค้ดบรรทัดเดียว

ในหลาม 3 ย่อหน้าส่วนหัวส่วนปลอมข้อมูลไฟล์ config 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)

ในหลาม 2 ย่อหน้าส่วนหัวส่วนปลอมข้อมูลไฟล์ config ของคุณห่อผลในวัตถุและผ่านมันไปStringIOreadfp()

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


19

คุณสามารถใช้ไลบรารี ConfigObj เพื่อทำได้ง่ายๆ: http://www.voidspace.org.uk/python/configobj.html

Updated: ค้นหารหัสล่าสุดที่นี่

หากคุณอยู่ภายใต้ 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ข้อร้องเรียนทั่วไป ทั่วไปได้ง่ายขึ้นและทำให้มีทั้งงูหลาม 2 และ 3 ที่เข้ากันได้
martineau

6

เมื่อพบปัญหานี้ด้วยตัวเองฉันจึงเขียน Wrapper ฉบับสมบูรณ์ไปยัง 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)

5

คำตอบของ Blueicefield กล่าวถึง configobj แต่ lib ดั้งเดิมรองรับเฉพาะ Python 2 ตอนนี้มีพอร์ตที่เข้ากันได้กับ Python 3+:

https://github.com/DiffSK/configobj

API ที่ยังไม่ได้เปลี่ยนให้ดูมันdoc


แม้ว่าลิงก์นี้อาจตอบคำถามได้ แต่ควรรวมส่วนสำคัญของคำตอบไว้ที่นี่และระบุลิงก์เพื่อการอ้างอิง คำตอบแบบลิงก์เท่านั้นอาจไม่ถูกต้องหากหน้าที่เชื่อมโยงเปลี่ยนไป - จากรีวิว
ks

แล้วถ้า API เปลี่ยนล่ะ? คุณสามารถแก้ไขคำตอบได้ตลอดเวลาหากคำตอบล้าสมัยไม่ว่าจะเป็นลิงก์หรือข้อมูลโค้ด ฉันทำมาหลายครั้งแล้วฉันไม่เห็นว่าทำไมคุณถึงคิดว่ามันเป็นปัญหา
laike9m
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.