Added docstrings to class intialisers

src/primaite/nodes/active_node.py

@@ -11,19 +11,7 @@ _LOGGER: Final[logging.Logger] = logging.getLogger(__name__)
 
 
 class ActiveNode(Node):
-    """Active Node class.
-
-    :param node_id: The node ID
-    :param name: The node name
-    :param node_type: The node type (enum)
-    :param priority: The node priority (enum)
-    :param hardware_state: The node Hardware State
-    :param ip_address: The node IP address
-    :param software_state: The node Software State
-    :param file_system_state: The node file system state
-    :param config_values: The config values
-
-    """
+    """Active Node class."""
 
     def __init__(
         self,
@@ -37,6 +25,19 @@ class ActiveNode(Node):
         file_system_state: FileSystemState,
         config_values: TrainingConfig,
     ):
+        """
+        Initialise an active node.
+
+        :param node_id: The node ID
+        :param name: The node name
+        :param node_type: The node type (enum)
+        :param priority: The node priority (enum)
+        :param hardware_state: The node Hardware State
+        :param ip_address: The node IP address
+        :param software_state: The node Software State
+        :param file_system_state: The node file system state
+        :param config_values: The config values
+        """
         super().__init__(node_id, name, node_type, priority, hardware_state, config_values)
         self.ip_address: str = ip_address
         # Related to Software

src/primaite/nodes/node.py

@@ -7,15 +7,7 @@ from primaite.config.training_config import TrainingConfig
 
 
 class Node:
-    """Node class.
-
-    :param node_id: The node id.
-    :param name: The name of the node.
-    :param node_type: The type of the node.
-    :param priority: The priority of the node.
-    :param hardware_state: The state of the node.
-    :param config_values: Config values.
-    """
+    """Node class."""
 
     def __init__(
         self,
@@ -26,6 +18,16 @@ class Node:
         hardware_state: HardwareState,
         config_values: TrainingConfig,
     ):
+        """
+        Initialise a node.
+
+        :param node_id: The node id.
+        :param name: The name of the node.
+        :param node_type: The type of the node.
+        :param priority: The priority of the node.
+        :param hardware_state: The state of the node.
+        :param config_values: Config values.
+        """
         self.node_id: Final[str] = node_id
         self.name: Final[str] = name
         self.node_type: Final[NodeType] = node_type

src/primaite/nodes/node_state_instruction_green.py

@@ -3,16 +3,7 @@
 
 
 class NodeStateInstructionGreen(object):
-    """The Node State Instruction class.
-
-    :param _id: The node state instruction id
-    :param _start_step: The start step of the instruction
-    :param _end_step: The end step of the instruction
-    :param _node_id: The id of the associated node
-    :param _node_pol_type: The pattern of life type
-    :param _service_name: The service name
-    :param _state: The state (node or service)
-    """
+    """The Node State Instruction class."""
 
     def __init__(
         self,
@@ -24,6 +15,17 @@ class NodeStateInstructionGreen(object):
         _service_name,
         _state,
     ):
+        """
+        Initialise the Node State Instruction.
+
+        :param _id: The node state instruction id
+        :param _start_step: The start step of the instruction
+        :param _end_step: The end step of the instruction
+        :param _node_id: The id of the associated node
+        :param _node_pol_type: The pattern of life type
+        :param _service_name: The service name
+        :param _state: The state (node or service)
+        """
         self.id = _id
         self.start_step = _start_step
         self.end_step = _end_step

src/primaite/nodes/node_state_instruction_red.py

@@ -7,20 +7,7 @@ from primaite.common.enums import NodePOLType
 
 @dataclass()
 class NodeStateInstructionRed(object):
-    """The Node State Instruction class.
-
-    :param _id: The node state instruction id
-    :param _start_step: The start step of the instruction
-    :param _end_step: The end step of the instruction
-    :param _target_node_id: The id of the associated node
-    :param -pol_initiator: The way the PoL is applied (DIRECT, IER or SERVICE)
-    :param _pol_type: The pattern of life type
-    :param pol_protocol: The pattern of life protocol/service affected
-    :param _pol_state: The state (node or service)
-    :param _pol_source_node_id: The source node Id (used for initiator type SERVICE)
-    :param _pol_source_node_service: The source node service (used for initiator type SERVICE)
-    :param _pol_source_node_service_state: The source node service state (used for initiator type SERVICE)
-    """
+    """The Node State Instruction class."""
 
     def __init__(
         self,
@@ -36,6 +23,21 @@ class NodeStateInstructionRed(object):
         _pol_source_node_service,
         _pol_source_node_service_state,
     ):
+        """
+        Initialise the Node State Instruction for the red agent.
+
+        :param _id: The node state instruction id
+        :param _start_step: The start step of the instruction
+        :param _end_step: The end step of the instruction
+        :param _target_node_id: The id of the associated node
+        :param -pol_initiator: The way the PoL is applied (DIRECT, IER or SERVICE)
+        :param _pol_type: The pattern of life type
+        :param pol_protocol: The pattern of life protocol/service affected
+        :param _pol_state: The state (node or service)
+        :param _pol_source_node_id: The source node Id (used for initiator type SERVICE)
+        :param _pol_source_node_service: The source node service (used for initiator type SERVICE)
+        :param _pol_source_node_service_state: The source node service state (used for initiator type SERVICE)
+        """
         self.id = _id
         self.start_step = _start_step
         self.end_step = _end_step

src/primaite/nodes/passive_node.py

@@ -6,15 +6,7 @@ from primaite.nodes.node import Node
 
 
 class PassiveNode(Node):
-    """The Passive Node class.
-
-    :param node_id: The node id.
-    :param name: The name of the node.
-    :param node_type: The type of the node.
-    :param priority: The priority of the node.
-    :param hardware_state: The state of the node.
-    :param config_values: Config values.
-    """
+    """The Passive Node class."""
 
     def __init__(
         self,
@@ -25,6 +17,16 @@ class PassiveNode(Node):
         hardware_state: HardwareState,
         config_values: TrainingConfig,
     ):
+        """
+        Initialise a passive node.
+
+        :param node_id: The node id.
+        :param name: The name of the node.
+        :param node_type: The type of the node.
+        :param priority: The priority of the node.
+        :param hardware_state: The state of the node.
+        :param config_values: Config values.
+        """
         # Pass through to Super for now
         super().__init__(node_id, name, node_type, priority, hardware_state, config_values)
 

src/primaite/nodes/service_node.py

@@ -12,18 +12,7 @@ _LOGGER: Final[logging.Logger] = logging.getLogger(__name__)
 
 
 class ServiceNode(ActiveNode):
-    """ServiceNode class.
-
-    :param node_id: The node ID
-    :param name: The node name
-    :param node_type: The node type (enum)
-    :param priority: The node priority (enum)
-    :param hardware_state: The node Hardware State
-    :param ip_address: The node IP address
-    :param software_state: The node Software State
-    :param file_system_state: The node file system state
-    :param config_values: The config values
-    """
+    """ServiceNode class."""
 
     def __init__(
         self,
@@ -37,6 +26,19 @@ class ServiceNode(ActiveNode):
         file_system_state: FileSystemState,
         config_values: TrainingConfig,
     ):
+        """
+        Initialise a Service Node.
+
+        :param node_id: The node ID
+        :param name: The node name
+        :param node_type: The node type (enum)
+        :param priority: The node priority (enum)
+        :param hardware_state: The node Hardware State
+        :param ip_address: The node IP address
+        :param software_state: The node Software State
+        :param file_system_state: The node file system state
+        :param config_values: The config values
+        """
         super().__init__(
             node_id,
             name,