Add docs and format code

scripts/promptgenerator.py

@@ -2,7 +2,14 @@ import json
 
 
 class PromptGenerator:
+    """
+    A class for generating custom prompt strings based on constraints, commands, resources, and performance evaluations.
+    """
+
     def __init__(self):
+        """
+        Initialize the PromptGenerator object with empty lists of constraints, commands, resources, and performance evaluations.
+        """
         self.constraints = []
         self.commands = []
         self.resources = []
@@ -24,14 +31,28 @@ class PromptGenerator:
         }
 
     def add_constraint(self, constraint):
+        """
+        Add a constraint to the constraints list.
+
+        Args:
+            constraint (str): The constraint to be added.
+        """
         self.constraints.append(constraint)
 
-    # {CommandLabel}: "{CommandName}", args: "{arg#Name}": "{arg#Prompt}"
     def add_command(self, command_label, command_name, args=None):
+        """
+        Add a command to the commands list with a label, name, and optional arguments.
+
+        Args:
+            command_label (str): The label of the command.
+            command_name (str): The name of the command.
+            args (dict, optional): A dictionary containing argument names and their values. Defaults to None.
+        """
         if args is None:
             args = {}
-            
-        command_args = {arg_key: arg_value for arg_key, arg_value in args.items()}
+
+        command_args = {arg_key: arg_value for arg_key,
+                        arg_value in args.items()}
 
         command = {
             "label": command_label,
@@ -42,23 +63,60 @@ class PromptGenerator:
         self.commands.append(command)
 
     def _generate_command_string(self, command):
-        args_string = ', '.join(f'"{key}": "{value}"' for key, value in command['args'].items())
+        """
+        Generate a formatted string representation of a command.
+
+        Args:
+            command (dict): A dictionary containing command information.
+
+        Returns:
+            str: The formatted command string.
+        """
+        args_string = ', '.join(
+            f'"{key}": "{value}"' for key, value in command['args'].items())
         return f'{command["label"]}: "{command["name"]}", args: {args_string}'
-    
+
     def add_resource(self, resource):
+        """
+        Add a resource to the resources list.
+
+        Args:
+            resource (str): The resource to be added.
+        """
         self.resources.append(resource)
 
     def add_performance_evaluation(self, evaluation):
+        """
+        Add a performance evaluation item to the performance_evaluation list.
+
+        Args:
+            evaluation (str): The evaluation item to be added.
+        """
         self.performance_evaluation.append(evaluation)
 
-
     def _generate_numbered_list(self, items, item_type='list'):
+        """
+        Generate a numbered list from given items based on the item_type.
+
+        Args:
+            items (list): A list of items to be numbered.
+            item_type (str, optional): The type of items in the list. Defaults to 'list'.
+
+        Returns:
+            str: The formatted numbered list.
+        """
         if item_type == 'command':
             return "\n".join(f"{i+1}. {self._generate_command_string(item)}" for i, item in enumerate(items))
         else:
             return "\n".join(f"{i+1}. {item}" for i, item in enumerate(items))
 
     def generate_prompt_string(self):
+        """
+        Generate a prompt string based on the constraints, commands, resources, and performance evaluations.
+
+        Returns:
+            str: The generated prompt string.
+        """
         formatted_response_format = json.dumps(self.response_format, indent=4)
         prompt_string = (
             f"Constraints:\n{self._generate_numbered_list(self.constraints)}\n\n"