tiramisu/tiramisu/error.py

# -*- coding: utf-8 -*-
# Copyright (C) 2012-2018 Team tiramisu (see AUTHORS for all contributors)
#
# This program 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.
#
# This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
# ____________________________________________________________
"user defined exceptions"
from .i18n import _


def display_list(lst, separator='and', add_quote=False):
    if separator == 'and':
        separator = _('and')
    elif separator == 'or':
        separator = _('or')
    if len(lst) == 1:
        ret = lst[0]
        if not isinstance(ret, str):
            ret = str(ret)
        if add_quote:
            ret = '"{}"'.format(ret)
        return ret
    else:
        if isinstance(lst, tuple):
            lst = list(lst)
        lst.sort()
        lst_ = []
        for l in lst[:-1]:
            if not isinstance(l, str):
                l = str(l)
            if add_quote:
                l = '"{}"'.format(l)
            lst_.append(_(l))
        last = lst[-1]
        if not isinstance(last, str):
            last = str(_(last))
        if add_quote:
            last = '"{}"'.format(last)
        return ', '.join(lst_) + _(' {} ').format(separator) + '{}'.format(last)


# Exceptions for an Option
class PropertiesOptionError(AttributeError):
    "attempt to access to an option with a property that is not allowed"
    def __init__(self,
                 path,
                 index,
                 config_bag,
                 proptype,
                 settings,
                 opt_type=None,
                 requires=None,
                 name=None,
                 orig_opt=None):
        self._path = path
        self._index = index
        if opt_type:
            self._opt_type = opt_type
            self._requires = requires
            self._name = name
            self._orig_opt = orig_opt
        else:
            if config_bag.option.impl_is_optiondescription():
                self._opt_type = 'optiondescription'
            else:
                self._opt_type = 'option'
            self._requires = config_bag.option.impl_getrequires()
            self._name = config_bag.option.impl_get_display_name()
            self._orig_opt = None
        self._config_bag = config_bag.copy()
        self.proptype = proptype
        self._settings = settings
        self.msg = None
        super(PropertiesOptionError, self).__init__(None)

    def set_orig_opt(self, opt):
        self._orig_opt = opt

    def __str__(self):
        #this part is a bit slow, so only execute when display
        if self.msg:
            return self.msg
        req = self._settings.apply_requires(self._path,
                                            self._requires,
                                            self._index,
                                            True,
                                            self._config_bag,
                                            self._name)
        #if req != {} or self._orig_opt is not None:
        if req != {}:
            only_one = len(req) == 1
            msg = []
            for action, msg_ in req.items():
                msg.append('"{0}" ({1})'.format(action, display_list(msg_)))
            msg = display_list(msg)
        else:
            only_one = len(self.proptype) == 1
            msg = display_list(list(self.proptype), add_quote=True)
        if only_one:
            prop_msg = _('property')
        else:
            prop_msg = _('properties')
        if self._orig_opt:
            self.msg = str(_('cannot access to {0} "{1}" because "{2}" has {3} {4}'
                             '').format(self._opt_type,
                                        self._orig_opt.impl_get_display_name(),
                                        self._name,
                                        prop_msg,
                                        msg))
        else:
            self.msg = str(_('cannot access to {0} "{1}" because has {2} {3}'
                             '').format(self._opt_type,
                                        self._name,
                                        prop_msg,
                                        msg))
        del self._path, self._index, self._requires, self._opt_type, self._name, self._config_bag
        del self._settings, self._orig_opt
        return self.msg


#____________________________________________________________
# Exceptions for a Config
class ConfigError(Exception):
    """attempt to change an option's owner without a value
    or in case of `_cfgimpl_descr` is None
    or if a calculation cannot be carried out"""
    pass


class ConflictError(Exception):
    "duplicate options are present in a single config"
    pass


#____________________________________________________________
# miscellaneous exceptions
class RequirementError(Exception):
    """a recursive loop occurs in the requirements tree
    requires
    """
    pass


class SlaveError(Exception):
    "problem with a slave's value length"
    pass


class ConstError(TypeError):
    "no uniq value in _NameSpace"
    pass


#Warning
class ValueWarning(UserWarning):  # pragma: optional cover
    """Option could warn user and not raise ValueError.

    Example:

    >>> import warnings
    >>> from tiramisu.error import ValueWarning
    >>> from tiramisu.option import StrOption, OptionDescription
    >>> from tiramisu.config import Config
    >>> warnings.simplefilter("always", ValueWarning)
    >>> def a(val):
    ...  raise ValueError('pouet')
    ...
    >>> s=StrOption('s', '', validator=a, warnings_only=True)
    >>> o=OptionDescription('o', '', [s])
    >>> c=Config(o)
    >>> c.s = 'val'
    StrOption:0: ValueWarning: invalid value val for option s: pouet
    >>> with warnings.catch_warnings(record=True) as w:
    ...     c.s = 'val'
    ...
    >>> w[0].message.opt() == s
    True
    >>> print(str(w[0].message))
    invalid value val for option s: pouet
    """
    def __init__(self, msg, opt):
        self.opt = opt
        super(ValueWarning, self).__init__(msg)


class APIError(Exception):
    pass