Improve typing

Author: Flova

dynamic_stack_decider/dynamic_stack_decider/abstract_action_element.py

@@ -1,7 +1,11 @@
 from abc import ABCMeta
+from typing import TYPE_CHECKING
 
 from dynamic_stack_decider.abstract_stack_element import AbstractStackElement
 
+if TYPE_CHECKING:
+    from dynamic_stack_decider.dsd import DSD
+
 
 class AbstractActionElement(AbstractStackElement, metaclass=ABCMeta):
     """
@@ -14,7 +18,7 @@ class AbstractActionElement(AbstractStackElement, metaclass=ABCMeta):
     If the action is complete, it can remove itself from the stack by performing a pop command.
     """
 
-    def __init__(self, blackboard, dsd, parameters=None):
+    def __init__(self, blackboard, dsd: "DSD", parameters: dict[str, bool | int | float | str]):
         """
         Constructor of the action element
         :param blackboard: Shared blackboard for data exchange between elements
@@ -23,10 +27,7 @@ def __init__(self, blackboard, dsd, parameters=None):
         """
         super().__init__(blackboard, dsd, parameters)
         # Reevaluation can be disabled by setting 'r' or 'reevaluate' to False
-        if parameters is not None:
-            self.never_reevaluate = not parameters.get("r", True) or not parameters.get("reevaluate", True)
-        else:
-            self.never_reevaluate = False
+        self.never_reevaluate = not parameters.get("r", True) or not parameters.get("reevaluate", True)
 
     def do_not_reevaluate(self):
         """
@@ -41,6 +42,6 @@ def repr_dict(self) -> dict:
         """
         return {
             "type": "action",
-            "name": self.__class__.__name__,
+            "name": self.name,
             "debug_data": self._debug_data,
         }

dynamic_stack_decider/dynamic_stack_decider/abstract_decision_element.py

@@ -26,7 +26,7 @@ def repr_dict(self) -> dict:
         """
         return {
             "type": "decision",
-            "name": self.__class__.__name__,
+            "name": self.name,
             "debug_data": self._debug_data,
         }
 

dynamic_stack_decider/dynamic_stack_decider/abstract_stack_element.py

@@ -1,8 +1,11 @@
 from abc import ABCMeta, abstractmethod
-from typing import Union
+from typing import TYPE_CHECKING, Union
 
 from dynamic_stack_decider.logger import get_logger
 
+if TYPE_CHECKING:
+    from dynamic_stack_decider.dsd import DSD
+
 
 class AbstractStackElement(metaclass=ABCMeta):
     """
@@ -12,14 +15,14 @@ class AbstractStackElement(metaclass=ABCMeta):
     Each element which inherits from the AbstractStackElement can be used as a root element on the stack.
     """
 
-    _dsd = None
-    _init_data = None
+    _dsd: "DSD"
+    parameters: dict[str, bool | int | float | str]
 
-    def __init__(self, blackboard, dsd, parameters=None):
+    def __init__(self, blackboard, dsd: "DSD", parameters: dict[str, bool | int | float | str]):
         """
         :param blackboard: Shared blackboard for data exchange between elements
         :param dsd: The stack decider which has this element on its stack.
-        :param parameters: Optional parameters which serve as arguments to this element
+        :param parameters: Parameters which serve as arguments to this element
         """
         self._debug_data = {}
         """
@@ -28,8 +31,16 @@ def __init__(self, blackboard, dsd, parameters=None):
         """
 
         self._dsd = dsd
+        self.parameters = parameters
         self.blackboard = blackboard
 
+    @property
+    def name(self) -> str:
+        """
+        Returns the name of the action
+        """
+        return self.__class__.__name__
+
     def pop(self):
         """
         Help method which pops the element of the stack.
@@ -90,6 +101,6 @@ def repr_dict(self) -> dict:
         """Represent this stack element as dictionary which is JSON encodable"""
         return {
             "type": "abstract",
-            "name": self.__class__.__name__,
+            "name": self.name,
             "debug_data": self._debug_data,
         }

dynamic_stack_decider/dynamic_stack_decider/sequence_element.py

@@ -1,5 +1,11 @@
+from typing import TYPE_CHECKING, Optional
+
+from dynamic_stack_decider.abstract_action_element import AbstractActionElement
 from dynamic_stack_decider.abstract_stack_element import AbstractStackElement
 
+if TYPE_CHECKING:
+    from dynamic_stack_decider.dsd import DSD
+
 
 class SequenceElement(AbstractStackElement):
     """
@@ -10,11 +16,11 @@ class SequenceElement(AbstractStackElement):
     This is not an abstract class to inherit from.
     """
 
-    def __init__(self, blackboard, dsd, actions=()):
+    def __init__(self, blackboard, dsd: "DSD", actions: list[AbstractActionElement]):
         """
         :param actions: list of initialized action elements
         """
-        super().__init__(blackboard, dsd)
+        super().__init__(blackboard, dsd, dict())
         self.actions = actions
         self.current_action_index = 0
 
@@ -40,21 +46,17 @@ def in_last_element(self):
         return self.current_action_index == len(self.actions) - 1
 
     @property
-    def current_action(self):
+    def current_action(self) -> AbstractActionElement:
         """
         Returns the currently executed action of the sequence element
-
-        :rtype: AbstractActionElement
         """
         return self.actions[self.current_action_index]
 
-    def repr_dict(self):
+    def repr_dict(self) -> dict:
         """
         Represent this stack element as dictionary which is JSON encodable
-
-        :rtype: dict
         """
-        self.publish_debug_data("Active Element", self.current_action.__class__.__name__)
+        self.publish_debug_data("Active Element", self.current_action.name)
         if self.current_action._debug_data:
             self.publish_debug_data("Corresponding debug data", self.current_action._debug_data)
         data = {