Fixes

communication_subroutine.py

@@ -16,6 +16,12 @@ app = Flask(__name__)
 
 @app.route("/conjurer", methods=["POST"])
 def answer_external_command():
+    """
+    The function `answer_external_command` logs the request data, loads the data as JSON, logs the
+    record, and then puts the record into an incoming queue before returning a success message.
+    :return: The function `answer_external_command()` is returning a JSON response with the message
+    "SUCCESS".
+    """
     app.logger.info(request)
     record = json.loads(request.data)
     app.logger.info(record)
@@ -25,6 +31,13 @@ def answer_external_command():
 
 @app.route("/conjurer", methods=["GET"])
 def check_alive():
+    """
+    The function "check_alive" returns a JSON response with the message "ALIVE" when the "/conjurer"
+    route is accessed via a GET request.
+    :return: The code snippet is a Flask route that listens for GET requests to the "/conjurer"
+    endpoint. When a GET request is made to this endpoint, the function check_alive() is called, which
+    returns a JSON response with the message "ALIVE".
+    """
     return jsonify("ALIVE")
 
 def flask_debug(_logger):
@@ -46,12 +59,29 @@ def waitress_run(_logger):
     serve(app, host=HOST_ADDRESS, port=PORT_ADDRESS)
 
 def scan_queue(_logger):
+    """
+    The function `scan_queue` reads data from a queue, logs it, and appends it to another queue.
+
+    :param _logger: The `_logger` parameter is typically an instance of a logging object that is used to
+    record and store log messages. It is commonly used to track the flow of the program, record errors,
+    and provide information for debugging purposes. In this code snippet, the `_logger` object is used
+    to log the
+    """
     while True:
         data = OUT_COMM_Q.get()
         _logger.info(data)
         awaiting_q.append(data)
 
 def scan_incoming(_logger):
+    """
+    The `scan_incoming` function continuously checks for incoming data, processes it, and logs when data
+    is found.
+
+    :param _logger: The `_logger` parameter in the `scan_incoming` function is a logger object that is
+    used to log messages or information during the execution of the function. It is typically used for
+    debugging, monitoring, or tracking the flow of the program. In this case, the `_logger` is being
+    used
+    """
     while True:
         try:
             answer = incoming_q.get(block=False)
@@ -66,6 +96,13 @@ def scan_incoming(_logger):
 
 
 def comm_subroutine(logger):
+    """
+    The `comm_subroutine` function starts multiple threads to run different tasks concurrently.
+
+    :param logger: The `logger` parameter in the `comm_subroutine` function is an instance of a logger
+    object that is used for logging messages at various levels (e.g., debug, info, warning, error). In
+    the provided code snippet, the logger is used to log messages at the "info" level
+    """
     #logger.setLevel(logging.DEBUG)
     logger.info("Started")
     threads = []