Source code for woob.tools.config.iniconfig

# Copyright(C) 2010-2011 Christophe Benz
#
# This file is part of woob.
#
# woob is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# woob is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with woob. If not, see <http://www.gnu.org/licenses/>.

import os
from collections import OrderedDict
from configparser import DEFAULTSECT, RawConfigParser
from decimal import Decimal

from .iconfig import IConfig
from .util import LOGGER


__all__ = ["INIConfig"]


class INIConfig(IConfig):
    ROOTSECT = "ROOT"

    def __init__(self, path):
        self.path = path
        self.values = OrderedDict()
        self.config = RawConfigParser()

    def load(self, default={}):
        self.values = OrderedDict(default)

        if os.path.exists(self.path):
            LOGGER.debug("Loading application configuration file: %s.", self.path)
            self.config.read(self.path, encoding="utf-8")
            for section in self.config.sections():
                args = section.split(":")
                if args[0] == self.ROOTSECT:
                    args.pop(0)
                for key, value in self.config.items(section):
                    self.set(*(args + [key, value]))
            # retro compatibility
            if len(self.config.sections()) == 0:
                first = True
                for key, value in self.config.items(DEFAULTSECT):
                    if first:
                        LOGGER.warning('The configuration file "%s" uses an old-style', self.path)
                        LOGGER.warning("Please rename the %s section to %s", (DEFAULTSECT, self.ROOTSECT))
                        first = False
                    self.set(key, value)
            LOGGER.debug("Application configuration file loaded: %s.", self.path)
        else:
            self.save()
            LOGGER.debug(
                "Application configuration file created with default values: %s. " "Please customize it.", self.path
            )
        return self.values

    def save(self):
        def save_section(values, root_section=self.ROOTSECT):
            for k, v in values.items():
                if isinstance(v, (int, Decimal, float, str)):
                    if not self.config.has_section(root_section):
                        self.config.add_section(root_section)
                    self.config.set(root_section, k, str(v))
                elif isinstance(v, dict):
                    new_section = (
                        ":".join((root_section, k)) if (root_section != self.ROOTSECT or k == self.ROOTSECT) else k
                    )
                    if not self.config.has_section(new_section):
                        self.config.add_section(new_section)
                    save_section(v, new_section)

        save_section(self.values)
        with open(self.path, "w", encoding="utf-8") as f:
            self.config.write(f)

    def get(self, *args, **kwargs):
        default = None
        if "default" in kwargs:
            default = kwargs["default"]

        v = self.values
        for k in args[:-1]:
            if k in v:
                v = v[k]
            else:
                return default
        try:
            return v[args[-1]]
        except KeyError:
            return default

    def set(self, *args):
        v = self.values
        for k in args[:-2]:
            if k not in v:
                v[k] = OrderedDict()
            v = v[k]
        v[args[-2]] = args[-1]

    def delete(self, *args):
        v = self.values
        for k in args[:-1]:
            if k not in v:
                return
            v = v[k]
        v.pop(args[-1], None)