Source code for pyrigi.exception

"""

Module for defining exceptions.

"""

from collections.abc import Callable




class LoopError(ValueError):
    """
    Error raised when a graph is not loop-free.
    """

    def __init__(self, msg: str = "The graph needs to be loop-free.", *args, **kwargs):
        super().__init__(msg, *args, **kwargs)





class NotSupportedValueError(ValueError):
    """
    Error raised when an input value is not supported.
    """

    def __init__(
        self,
        wrong_param,
        parameter_name: str,
        method: Callable = None,
        msg: str = None,
        *args,
        **kwargs,
    ):
        if msg is not None:
            super().__init__(msg, *args, **kwargs)
        else:
            msg_str = (
                f"The specified value of the `{parameter_name}` "
                + f"parameter is '{wrong_param}', "
                + "which is not supported!\n"
            )
            if method is not None:
                msg_str += f"Call `help({method.__qualname__})` for further information"
            super().__init__(msg_str, *args, **kwargs)