kytos.core.exceptions

Complexity

Total Complexity

14

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Test Coverage

Coverage

95.74%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	KytosSwitchOfflineException.__str__()	0	5	1
A	KytosNoTagAvailableError.__init__()	0	9	1
A	KytosCoreException.__str__()	0	3	1
A	KytosEventException.__init__()	0	10	1
A	KytosNAppException.__init__()	0	8	1
A	KytosNAppMissingInitArgument.__init__()	0	7	1
A	KytosNoTagAvailableError.__str__()	0	4	1
A	KytosSwitchOfflineException.__init__()	0	8	1
A	KytosNAppException.__str__()	0	3	1
A	KytosEventException.__str__()	0	6	2
A	KytosDBInitException.__str__()	0	3	2
A	KytosDBInitException.__init__()	0	5	1

"""Kytos Core-Defined Exceptions."""


class KytosCoreException(Exception):
    """Exception thrown when KytosCore is broken."""

    def __str__(self):
        """Return message of KytosCoreException."""
        return 'KytosCore exception: ' + super().__str__()


class KytosSwitchOfflineException(Exception):
    """Exception thrown when a switch is offline."""

    def __init__(self, switch):
        """Require a switch.

        Args:
            switch (:class:`~kytos.core.switch.Switch`): A switch offline.
        """
        super().__init__()
        self.switch = switch

    def __str__(self):
        """Return message of KytosSwitchOfflineException."""
        msg = 'The switch {} is not reachable. Please check the connection '
        msg += 'between the switch and the controller.'
        return msg.format(self.switch.dpid)


class KytosEventException(Exception):
    """Exception thrown when a KytosEvent have an illegal use."""

    def __init__(self, message="KytosEvent exception", event=None):
        """Assign parameters to instance variables.

        Args:
            message (string): message from KytosEventException.
            event (:class:`~kytos.core.events.KytosEvent`): Event malformed.
        """
        super().__init__()
        self.message = message
        self.event = event

    def __str__(self):
        """Return the full message from KytosEventException."""
        message = self.message
        if self.event:
            message += ". EventType: " + type(self.event)
        return message


class KytosWrongEventType(KytosEventException):
    """Exception related to EventType.

    When related to buffers, it means that the EventType is not allowed on
    that buffer.
    """


class KytosNoTagAvailableError(Exception):
    """Exception raised when a link has no vlan available."""

    def __init__(self, link):
        """Require a link.

        Args:
            link (:class:`~kytos.core.link.Link`): A link with no vlan
            available.
        """
        super().__init__()
        self.link = link

    def __str__(self):
        """Full message."""
        msg = f'Link {self.link.id} has no vlan available.'
        return msg


class KytosLinkCreationError(Exception):
    """Exception thrown when the link has an empty endpoint."""


# Exceptions related  to NApps


class KytosNAppException(Exception):
    """Exception raised on a KytosNApp."""

    def __init__(self, message="KytosNApp exception"):
        """Assign the parameters to instance variables.

        Args:
            message (string): message from KytosNAppException.
        """
        super().__init__()
        self.message = message

    def __str__(self):
        """Return the message from KytosNAppException."""
        return self.message


class KytosNAppMissingInitArgument(KytosNAppException):
    """Exception thrown when NApp have a missing init argument."""

    def __init__(self, message="KytosNAppMissingInitArgument"):
        """Assing parameters to instance variables.

        Args:
            message (str): Name of the missed argument.
        """
        super().__init__(message=message)


class KytosDBInitException(Exception):
    """Exception raised on Database initialization issues."""

    def __init__(self, message: str, _class=None) -> None:
        """KytosDBInitException."""
        super().__init__()
        self.message = message
        self._class = _class

    def __str__(self):
        _class = f" {self._class.__class__.__name__}" if self._class else ""
        return f"KytosDBInitException{_class}: {self.message}"