docs: add docstrings to ManagerConsumer

Author: Apolo151

manager/comms/new_consumer.py

@@ -1,3 +1,9 @@
+"""
+WebSocket consumer module for the Robotics Application Manager (RAM).
+
+Handles client connections, message processing, and communication with manager queue.
+"""
+
 import json
 import logging
 from queue import Queue
@@ -13,20 +19,32 @@
 
 
 class Client:
+    """Represents a client connected to the WebSocket server."""
+
     def __init__(self, **kwargs):
+        """Initialize a Client instance with id, handler, and address."""
         self.id = kwargs["id"]
         self.handler = kwargs["handler"]
         self.address = kwargs["address"]
 
 
 class ManagerConsumer:
     """
-    Websocket server consumer for new Robotics Application Manager aka. RAM
+    Websocket server consumer for new Robotics Application Manager aka: RAM.
+
     Supports single client connection to RAM
     TODO: Better handling of single client connections, closing and redirecting
     """
 
     def __init__(self, host, port, manager_queue: Queue):
+        """
+        Initialize the ManagerConsumer with host, port, and manager_queue.
+
+        Args:
+            host (str): The host address for the WebSocket server.
+            port (int): The port number for the WebSocket server.
+            manager_queue (Queue): The queue for communication with the manager.
+        """
         self.host = host
         self.port = port
         self.server = WebsocketServer(host=host, port=port, loglevel=logging.INFO)
@@ -37,7 +55,8 @@ def __init__(self, host, port, manager_queue: Queue):
         ws_logger.setLevel(logging.INFO)
         ws_logger.handlers.clear()
         ws_formatter = logging.Formatter(
-            "%(asctime)s [%(threadName)-12.12s] [%(levelname)-5.5s] (%(name)s)  %(message)s",
+            "%(asctime)s [%(threadName)-12.12s] [%(levelname)-5.5s] "
+            "(%(name)s)  %(message)s",
             "%H:%M:%S",
         )
         ws_console_handler = logging.StreamHandler()
@@ -51,11 +70,25 @@ def __init__(self, host, port, manager_queue: Queue):
         self.manager_queue = manager_queue
 
     def handle_client_new(self, client, server):
+        """
+        Handle a new client connection event.
+
+        Args:
+            client: The client object representing the connected client.
+            server: The WebSocket server instance.
+        """
         LogManager.logger.info(f"client connected: {client}")
         self.client = client
         self.server.deny_new_connections()
 
     def handle_client_disconnect(self, client, server):
+        """
+        Handle a client disconnection event.
+
+        Args:
+            client: The client object representing the disconnected client.
+            server: The WebSocket server instance.
+        """
         if client is None:
             return
         LogManager.logger.info(f"client disconnected: {client}")
@@ -70,6 +103,14 @@ def handle_client_disconnect(self, client, server):
         self.server.allow_new_connections()
 
     def handle_message_received(self, client, server, websocket_message):
+        """
+        Handle a message received from a client.
+
+        Args:
+            client: The client object that sent the message.
+            server: The WebSocket server instance.
+            websocket_message (str): The message received from the client.
+        """
         LogManager.logger.info(
             f"message received length: {len(websocket_message)} from client {client}"
         )
@@ -90,6 +131,15 @@ def handle_message_received(self, client, server, websocket_message):
             raise e
 
     def send_message(self, message_data, command=None):
+        """
+        Send a message to the connected client.
+
+        Args:
+            message_data: The message data to send, can be a ManagerConsumerMessage,
+                ManagerConsumerMessageException, or other data.
+            command (str, optional): The command associated with the message,
+                used if message_data is not a ManagerConsumerMessage.
+        """
         if self.client is not None and self.server is not None:
             if isinstance(message_data, ManagerConsumerMessage):
                 message = message_data
@@ -103,7 +153,9 @@ def send_message(self, message_data, command=None):
             self.server.send_message(self.client, str(message))
 
     def start(self):
+        """Start the WebSocket server in a separate thread."""
         self.server.run_forever(threaded=True)
 
     def stop(self):
+        """Stop the WebSocket server gracefully."""
         self.server.shutdown_gracefully()