Update logging

Author: BenConstable9

text_2_sql/autogen/src/autogen_text_2_sql/custom_agents/parallel_query_solving_agent.py

@@ -22,17 +22,26 @@
 
 
 class FilteredParallelMessagesCollection(BaseModel):
+    """A collection of filtered parallel messages."""
+
     database_results: dict[str, list] = Field(default_factory=dict)
     disambiguation_requests: dict[str, list] = Field(default_factory=dict)
 
-    def add_identifier(self, identifier):
+    def add_identifier(self, identifier: str):
+        """Add an identifier to the collection.
+
+        Args:
+        ----
+            identifier (str): The identifier to add."""
         if identifier not in self.database_results:
             self.database_results[identifier] = []
         if identifier not in self.disambiguation_requests:
             self.disambiguation_requests[identifier] = []
 
 
 class ParallelQuerySolvingAgent(BaseChatAgent):
+    """An agent that solves each query in parallel."""
+
     def __init__(self, **kwargs: dict):
         super().__init__(
             "parallel_query_solving_agent",
@@ -98,7 +107,7 @@ async def on_messages_stream(
         # Load the json of the last message to populate the final output object
         sequential_steps = json.loads(last_response)
 
-        logging.info(f"Query Rewrites: {sequential_steps}")
+        logging.info("Sequential Steps: %s", sequential_steps)
 
         async def consume_inner_messages_from_agentic_flow(
             agentic_flow, identifier, filtered_parallel_messages
@@ -115,7 +124,7 @@ async def consume_inner_messages_from_agentic_flow(
                 # Add message to results dictionary, tagged by the function name
                 filtered_parallel_messages.add_identifier(identifier)
 
-                logging.info(f"Checking Inner Message: {inner_message}")
+                logging.info("Checking Inner Message: %s", inner_message)
 
                 try:
                     if isinstance(inner_message, ToolCallExecutionEvent):
@@ -124,7 +133,7 @@ async def consume_inner_messages_from_agentic_flow(
                             parsed_message = self.parse_inner_message(
                                 call_result.content
                             )
-                            logging.info(f"Inner Loaded: {parsed_message}")
+                            logging.info("Inner Loaded: %s", parsed_message)
 
                             if isinstance(parsed_message, dict):
                                 if (
@@ -145,7 +154,7 @@ async def consume_inner_messages_from_agentic_flow(
                     elif isinstance(inner_message, TextMessage):
                         parsed_message = self.parse_inner_message(inner_message.content)
 
-                        logging.info(f"Inner Loaded: {parsed_message}")
+                        logging.info("Inner Loaded: %s", parsed_message)
 
                         # Search for specific message types and add them to the final output object
                         if isinstance(parsed_message, dict):
@@ -186,7 +195,7 @@ async def consume_inner_messages_from_agentic_flow(
                                     ].append(disambiguation_request)
 
                 except Exception as e:
-                    logging.warning(f"Error processing message: {e}")
+                    logging.warning("Error processing message: %s", e)
 
                 yield inner_message
 
@@ -209,10 +218,10 @@ async def consume_inner_messages_from_agentic_flow(
 
         # Start processing sub-queries
         for sequential_round in sequential_steps["steps"]:
-            logging.info(f"Processing round: {sequential_round}")
+            logging.info("Processing round: %s", sequential_round)
 
             for parallel_message in sequential_round:
-                logging.info(f"Parallel Message: {parallel_message}")
+                logging.info("Parallel Message: %s", parallel_message)
 
                 # Create an instance of the InnerAutoGenText2Sql class
                 inner_autogen_text_2_sql = InnerAutoGenText2Sql(**self.kwargs)
@@ -250,7 +259,7 @@ async def consume_inner_messages_from_agentic_flow(
             async with combined_message_streams.stream() as streamer:
                 async for inner_message in streamer:
                     if isinstance(inner_message, TextMessage):
-                        logging.debug(f"Inner Solving Message: {inner_message}")
+                        logging.debug("Inner Solving Message: %s", inner_message)
                         yield inner_message
 
             # Log final results for debugging or auditing