Source code for wonambi.utils.exceptions

"""Module contains all the exceptions

"""

class UnrecognizedFormat(Exception):
    """Could not recognize the format of the file for channels.

    """
    def __init__(self, value):
        self.value = value

    def __str__(self):
        return repr(self.value)


class MissingDependency():
    """Class to handle missing dependencies in an elegant and consistent way.

    Examples
    --------
    When importing a function from an optional dependency, use this construct:

    >>> try:
    >>>     from optdep import function
    >>> except ImportError as err:
    >>>     function = MissingDependency(err)

    and the use ``function`` in your code normally. It'll raise an ImportError
    only if the code calls that specific function.
    """
    def __init__(self, error):
        self.error = error

    def __call__(self, *args, **kwargs):
        raise ImportError(f"You need to install the optional dependency '{self.error.name}' to run this function") from self.error