kytos.core.common

Complexity

Total Complexity

28

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	GenericEntity.status()	0	8	4
A	GenericEntity.is_enabled()	0	3	1
A	GenericEntity.activate()	0	3	1
A	GenericEntity.is_active()	0	3	1
A	GenericEntity.__init__()	0	7	1
A	GenericEntity.deactivate()	0	3	1
A	GenericEntity.enable()	0	8	1
A	GenericEntity.disable()	0	7	1
A	GenericEntity.add_metadata()	0	7	2
A	GenericEntity.remove_metadata()	0	7	2
A	GenericEntity.extend_metadata()	0	11	3
A	GenericEntity.is_administrative_down()	0	3	1
A	GenericEntity.get_metadata()	0	3	1
A	GenericEntity.update_metadata()	0	3	1
A	GenericEntity.get_metadata_as_dict()	0	7	3
A	GenericEntity.clear_metadata()	0	3	1
A	GenericEntity.status_reason()	0	9	3

"""Module with common classes for the controller."""
from enum import Enum

from kytos.core.config import KytosConfig

__all__ = ('GenericEntity',)


class EntityStatus(Enum):
    """Enumeration of possible statuses for GenericEntity instances."""

    UP = "UP"
    DISABLED = "DISABLED"
    DOWN = "DOWN"


class GenericEntity:
    """Generic class that represents any Entity."""

    def __init__(self):
        """Create the GenericEntity object with empty metadata dictionary."""
        options = KytosConfig().options['daemon']
        self.metadata = {}

        self._active: bool = True
        self._enabled: bool = options.enable_entities_by_default

    def is_enabled(self) -> bool:
        """Return the *administrative* status of the entity."""
        return self._enabled

    def is_active(self) -> bool:
        """Return the *operational* status of the entity."""
        return self._active

    def activate(self):
        """Activate the entity."""
        self._active = True

    def deactivate(self):
        """Deactivate the entity."""
        self._active = False

    @property
    def status(self):
        """Return the current status of the Entity."""
        if self.is_enabled() and self.is_active():
            return EntityStatus.UP
        if self.is_administrative_down():
            return EntityStatus.DISABLED
        return EntityStatus.DOWN

    @property
    def status_reason(self):
        """Return the reason behind the current status of the entity."""
        reasons = set()
        if not self.is_enabled():
            reasons.add('disabled')
        if not self.is_active():
            reasons.add('deactivated')
        return reasons

    def is_administrative_down(self):
        """Return True for disabled Entities."""
        return not self.is_enabled()

    def enable(self):
        """Administratively enable the Entity.

        Although this method only sets an 'enabled' flag, always prefer to use
        it instead of setting it manually. This allows us to change the
        behavior in the future.
        """
        self._enabled = True

    def disable(self):
        """Administratively disable the Entity.

        This method can disable other related entities. For this behavior,
        rewrite it on the child classes.
        """
        self._enabled = False

    def add_metadata(self, key, value):
        """Add a new metadata (key, value)."""
        if key in self.metadata:
            return False

        self.metadata[key] = value
        return True

    def remove_metadata(self, key):
        """Try to remove a specific metadata."""
        try:
            del self.metadata[key]
            return True
        except KeyError:
            return False

    def get_metadata(self, key):
        """Try to get a specific metadata."""
        return self.metadata.get(key)

    def get_metadata_as_dict(self):
        """Get all metadata values as dict."""
        metadata = dict(self.metadata)
        for key, value in self.metadata.items():
            if hasattr(value, 'as_dict'):
                metadata[key] = value.as_dict()
        return metadata

    def update_metadata(self, key, value):
        """Overwrite a specific metadata."""
        self.metadata[key] = value

    def clear_metadata(self):
        """Remove all metadata information."""
        self.metadata = {}

    def extend_metadata(self, metadatas, force=True):
        """Extend the metadata information.

        If force is True any existing value is overwritten.
        """
        if force:
            self.metadata.update(metadatas)
            return

        for key, value in metadatas.items():
            self.add_metadata(key, value)