X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=test%2Fvpp_object.py;h=8dd2afac97c05cf96c2a61786fd40acae105628a;hb=e63a2d44d16774a88763c5f6368a3f7210c64ddc;hp=088cc39ce0a90742e0022c433881a01ac764b74b;hpb=f051072f8518097cbce1a8a20510c4e43cb7167c;p=vpp.git diff --git a/test/vpp_object.py b/test/vpp_object.py index 088cc39ce0a..8dd2afac97c 100644 --- a/test/vpp_object.py +++ b/test/vpp_object.py @@ -1,47 +1,65 @@ """ abstract vpp object and object registry """ -from abc import ABCMeta, abstractmethod +import abc -class VppObject(object): +class VppObject(metaclass=abc.ABCMeta): """ Abstract vpp object """ - __metaclass__ = ABCMeta - @abstractmethod - def add_vpp_config(self): + @abc.abstractmethod + def add_vpp_config(self) -> None: """ Add the configuration for this object to vpp. """ pass - @abstractmethod - def query_vpp_config(self): + @abc.abstractmethod + def query_vpp_config(self) -> bool: """Query the vpp configuration. :return: True if the object is configured""" pass - @abstractmethod - def remove_vpp_config(self): + @abc.abstractmethod + def remove_vpp_config(self) -> None: """ Remove the configuration for this object from vpp. """ pass - @abstractmethod - def object_id(self): + def object_id(self) -> str: """ Return a unique string representing this object. """ - pass + return "Undefined. for <%s %s>" % (self.__class__.__name__, id(self)) + + def __str__(self) -> str: + return self.object_id() + + def __repr__(self) -> str: + return '<%s>' % self.object_id() + + def __hash__(self) -> int: + return hash(self.object_id()) + + def __eq__(self, other) -> bool: + if not isinstance(other, self.__class__): + return NotImplemented + if other.object_id() == self.object_id(): + return True + return False + + # This can be removed when python2 support is dropped. + def __ne__(self, other): + return not self.__eq__(other) -class VppObjectRegistry(object): +class VppObjectRegistry: """ Class which handles automatic configuration cleanup. """ _shared_state = {} - def __init__(self): + def __init__(self) -> None: self.__dict__ = self._shared_state if not hasattr(self, "_object_registry"): self._object_registry = [] if not hasattr(self, "_object_dict"): self._object_dict = dict() - def register(self, obj, logger): + def register(self, obj: VppObject, logger) -> None: """ Register an object in the registry. """ if obj.object_id() not in self._object_dict: self._object_registry.append(obj) @@ -50,13 +68,13 @@ class VppObjectRegistry(object): else: logger.debug("REG: duplicate add, ignoring (%s)" % obj) - def unregister_all(self, logger): + def unregister_all(self, logger) -> None: """ Remove all object registrations from registry. """ logger.debug("REG: removing all object registrations") self._object_registry = [] self._object_dict = dict() - def remove_vpp_config(self, logger): + def remove_vpp_config(self, logger) -> None: """ Remove configuration (if present) from vpp and then remove all objects from the registry.