Comments, small bugfixes removed legacy elements

marl_factory_grid/environment/entity/object.py

@@ -6,40 +6,85 @@ import marl_factory_grid.utils.helpers as h
 
 
 class Object:
-    """Generell Objects for Organisation and Maintanance such as Actions etc..."""
 
     _u_idx = defaultdict(lambda: 0)
 
-    def __bool__(self):
-        return True
+    @property
+    def bound_entity(self):
+        """
+        TODO
+
+
+        :return:
+        """
+        return self._bound_entity
 
     @property
-    def var_can_be_bound(self):
+    def var_can_be_bound(self) -> bool:
+        """
+        TODO
+        Indicates if it is possible to bind this object to another Entity or Object.
+
+        :return: Whether this object can be bound.
+        """
         try:
             return self._collection.var_can_be_bound or False
         except AttributeError:
             return False
 
     @property
-    def observers(self):
+    def observers(self) -> set:
+        """
+        TODO
+
+
+        :return:
+        """
         return self._observers
 
     @property
     def name(self):
+        """
+        TODO
+
+
+        :return:
+        """
         return f'{self.__class__.__name__}[{self.identifier}]'
 
     @property
     def identifier(self):
+        """
+        TODO
+
+
+        :return:
+        """
         if self._str_ident is not None:
             return self._str_ident
         else:
             return self.u_int
 
     def reset_uid(self):
+        """
+        TODO
+
+
+        :return:
+        """
         self._u_idx = defaultdict(lambda: 0)
         return True
 
     def __init__(self, str_ident: Union[str, None] = None, **kwargs):
+        """
+        Generell Objects for Organisation and Maintanance such as Actions etc...
+
+        TODO
+
+        :param str_ident:
+
+        :return:
+        """
         self._status = None
         self._bound_entity = None
         self._observers = set()
@@ -50,6 +95,9 @@ class Object:
         if kwargs:
             print(f'Following kwargs were passed, but ignored: {kwargs}')
 
+    def __bool__(self) -> bool:
+        return True
+
     def __repr__(self):
         name = self.name
         if self.bound_entity:
@@ -67,39 +115,61 @@ class Object:
     def __hash__(self):
         return hash(self.identifier)
 
-    def _identify_and_count_up(self):
+    def _identify_and_count_up(self) -> int:
+        """Internal Usage"""
         idx = Object._u_idx[self.__class__.__name__]
         Object._u_idx[self.__class__.__name__] += 1
         return idx
 
     def set_collection(self, collection):
+        """Internal Usage"""
         self._collection = collection
+        return self
 
     def add_observer(self, observer):
+        """Internal Usage"""
         self.observers.add(observer)
         observer.notify_add_entity(self)
+        return self
 
     def del_observer(self, observer):
+        """Internal Usage"""
         self.observers.remove(observer)
+        return self
 
     def summarize_state(self):
         return dict()
 
     def clear_temp_state(self):
+        """Internal Usage"""
         self._status = None
         return self
 
     def bind_to(self, entity):
-        # noinspection PyAttributeOutsideInit
+        """
+        TODO
+
+
+        :return:
+        """
         self._bound_entity = entity
         return c.VALID
 
     def belongs_to_entity(self, entity):
+        """
+        TODO
+
+
+        :return:
+        """
         return self._bound_entity == entity
 
-    @property
-    def bound_entity(self):
-        return self._bound_entity
-
     def unbind(self):
+        """
+        TODO
+
+        :return:
+        """
+        previously_bound = self._bound_entity
         self._bound_entity = None
+        return previously_bound