Source code for AutoArchive._infrastructure.configuration.configuration_base

# configuration_base.py
#
# Project: AutoArchive
# License: GNU GPLv3
#
# Copyright (C) 2003 - 2022 Róbert Čerňanský



""":class:`ConfigurationBase` class."""



__all__ = ["ConfigurationBase"]



# {{{ INCLUDES

from abc import abstractmethod
from . import OptionsUtils

# }}} INCLUDES



# {{{ CLASSES

class ConfigurationBase:
    "Provides access to configuration options."

    @abstractmethod
    def __init__(self):

        #: Stores options and their values.  Key is of :class:`.Option` type and value is `object`.
        self.options_ = {}



    def __getitem__(self, option):
        """Gets consolidated value of a configuration option.

        Method takes into account values of other option forms such as :term:`negation form <negation option form>` and
        :term:`force form <force option form>`.  For example if the raw value of the option FOO is 10 and raw value of
        FORCE_FOO is 5 then value 5 will be returned.

        The precedence order of option forms is following: force form > negation form > normal form; with force form
        as the highest and normal form as the lowest priority form.

        For options of type ``bool`` value ``None`` is never returned; it is converted to ``False``.

        :param option:  The option in the *normal form* for which the value should be returned.
        :type option: :class:`.Option`

        :return: The merged value of the passed ``option`` (can be ``None``).
        :rtype: ``object``

        :raise KeyError: If ``option`` does not exists."""

        optionForceForm = OptionsUtils.tryGetForceForm(option)
        if optionForceForm is not None:
            if self.isOptionPresent(optionForceForm):
                return self.getRawValue(optionForceForm)

        optionNegationForm = OptionsUtils.tryGetNegationForm(option)
        if optionNegationForm is not None:
            negationValue = self.getRawValue(optionNegationForm)
            if negationValue:
                return False

        # bool-type options can not return None
        if option._optType is bool:
            return self.getRawValue(option) or False

        return self.getRawValue(option)



    def getRawValue(self, option):
        """Gets the raw value of a configuration option or ``None``.

        Unlike the :meth:`__getitem__()` this method returns the real raw value of the ``option``.

        :param option: The option for which the value should be returned.
        :type option: :class:`.Option`

        :return: The raw value of the passed ``option`` (can be ``None``).
        :rtype: ``object``

        :raise KeyError: If ``option`` does not exists."""

        return self.options_[option]



    def isOptionPresent(self, option):
        """Determines whether ``option`` is specified (e. g. in command line or a configuration file).

        :param option: The option which presence shall be determined.
        :type option: :class:`.Option`

        :return: `True` if `option` is present, `False` otherwise.
        :rtype: `bool`

        :raise KeyError: If ``option`` does not exists."""

        return self.getRawValue(option) is not None

# }}} CLASSES