aiverify-moonshot 0.4.10__py3-none-any.whl → 0.5.0__py3-none-any.whl

moonshot/src/api/api_cookbook.py

@@ -14,7 +14,7 @@ def api_create_cookbook(name: str, description: str, recipes: list[str]) -> str:
 
     This function takes the name, description, and recipes for a new cookbook as input. It then creates a new
     CookbookArguments object with these details and an empty id. The id is left empty because it will be generated
-    from the name during the creation process. The function then calls the Cookbook's create_cookbook method to
+    from the name during the creation process. The function then calls the Cookbook's create method to
     create the new cookbook.
 
     Args:
@@ -43,7 +43,7 @@ def api_read_cookbook(cb_id: str) -> dict:
     """
     Retrieves a cookbook based on the provided cookbook ID.
 
-    This function reads a cookbook using the `read_cookbook` method
+    This function reads a cookbook using the `read` method
     of the `Cookbook` class, and converts the returned `Cookbook` object to a dictionary using its `to_dict` method.
 
     Args:
@@ -60,7 +60,7 @@ def api_read_cookbooks(cb_ids: conlist(str, min_length=1)) -> list[dict]:
     """
     Retrieves a list of cookbooks based on the provided list of cookbook IDs.
 
-    This function iterates over the list of provided cookbook IDs, reads each cookbook using the `read_cookbook` method
+    This function iterates over the list of provided cookbook IDs, reads each cookbook using the `read` method
     of the `Cookbook` class, and converts the returned `Cookbook` objects to dictionaries using their `to_dict` method.
     It then returns a list of these dictionary representations.
 
@@ -90,7 +90,7 @@ def api_update_cookbook(cb_id: str, **kwargs) -> bool:
         bool: True if the cookbook was successfully updated.
 
     Raises:
-        Exception: If there's an error during the update process.
+        RuntimeError: If the cookbook with the given ID does not exist.
     """
     # Check if the cookbook exists
     try:
@@ -134,7 +134,7 @@ def api_get_all_cookbook() -> list[dict]:
     """
     Retrieves all available cookbooks.
 
-    This function calls the `get_available_cookbooks` method of the `Cookbook` class, which returns a tuple
+    This function calls the `get_available_items` method of the `Cookbook` class, which returns a tuple
     containing a list of cookbook IDs and a list of `CookbookArguments` objects. The function then returns a list
     of dictionaries, each representing a cookbook.
 
@@ -149,7 +149,7 @@ def api_get_all_cookbook_name() -> list[str]:
     """
     Retrieves the names of all available cookbooks.
 
-    This function calls the `get_available_cookbooks` method of the `Cookbook` class, which returns a tuple
+    This function calls the `get_available_items` method of the `Cookbook` class, which returns a tuple
     containing a list of cookbook IDs and a list of `CookbookArguments` objects. The function then returns the
     list of cookbook IDs, which are the names of the cookbooks.
 

moonshot/src/api/api_dataset.py

@@ -16,7 +16,7 @@ def api_delete_dataset(ds_id: str) -> bool:
         ds_id (str): The unique identifier for the dataset to be deleted.
 
     Returns:
-        bool: True if the dataset was successfully deleted.
+        bool: True if the dataset was successfully deleted, False otherwise.
 
     Raises:
         Exception: If the deletion process encounters an error.
@@ -27,10 +27,10 @@ def api_delete_dataset(ds_id: str) -> bool:
 def api_get_all_datasets() -> list[dict]:
     """
     This function retrieves all available datasets and returns them as a list of dictionaries. Each dictionary
-    represents a result and contains its information.
+    represents a dataset and contains its information.
 
     Returns:
-        list[dict]: A list of dictionaries, each representing a result.
+        list[dict]: A list of dictionaries, each representing a dataset.
     """
     _, datasets = Dataset.get_available_items()
     return [dataset.to_dict() for dataset in datasets]
@@ -38,10 +38,10 @@ def api_get_all_datasets() -> list[dict]:
 
 def api_get_all_datasets_name() -> list[str]:
     """
-    This function retrieves all available datasets names and returns them as a list.
+    This function retrieves all available dataset names and returns them as a list.
 
     Returns:
-        list[str]: A list of datasets names.
+        list[str]: A list of dataset names.
     """
     datasets_name, _ = Dataset.get_available_items()
     return datasets_name

moonshot/src/api/api_environment_variables.py

@@ -8,6 +8,9 @@ def api_set_environment_variables(env_vars: dict) -> None:
     """
     Sets the environment variables for the current session.
 
+    This function takes a dictionary of environment variables and sets them for the current session
+    by loading them into the EnvironmentVars configuration.
+
     Args:
         env_vars (dict): A dictionary containing the environment variables to set.
 

moonshot/src/api/api_metrics.py

@@ -15,7 +15,7 @@ def api_delete_metric(met_id: str) -> bool:
         met_id (str): The unique identifier for the metric to be deleted.
 
     Returns:
-        bool: True if the metric was successfully deleted.
+        bool: True if the metric was successfully deleted, False otherwise.
 
     Raises:
         Exception: If the deletion process encounters an error.

moonshot/src/api/api_prompt_template.py

@@ -10,6 +10,9 @@ def api_get_all_prompt_template_detail() -> list[dict]:
     """
     Retrieves all available prompt template details and returns them as a list of dictionaries.
 
+    This function calls the `get_all_prompt_template_details` method from the `PromptTemplate` class
+    to fetch the details of all prompt templates. It then returns these details as a list of dictionaries.
+
     Returns:
         list[dict]: A list of dictionaries, each representing the details of a prompt template.
     """
@@ -20,6 +23,9 @@ def api_get_all_prompt_template_name() -> list[str]:
     """
     Retrieves all available prompt template names and returns them as a list.
 
+    This function calls the `get_all_prompt_template_names` method from the `PromptTemplate` class
+    to fetch the names of all prompt templates. It then returns these names as a list of strings.
+
     Returns:
         list[str]: A list of prompt template names.
     """
@@ -31,6 +37,9 @@ def api_delete_prompt_template(pt_id: str) -> bool:
     """
     Deletes a prompt template by its identifier.
 
+    This function calls the `delete` method from the `PromptTemplate` class to delete a prompt template
+    identified by its unique ID. It returns True if the deletion was successful, otherwise it raises an exception.
+
     Args:
         pt_id (str): The unique identifier of the prompt template to be deleted.
 

moonshot/src/api/api_recipe.py

@@ -79,7 +79,7 @@ def api_read_recipes(rec_ids: conlist(str, min_length=1)) -> list[dict]:
     and returns a list of dictionaries containing each recipe's information.
 
     Args:
-        rec_ids (list[str]): The IDs of the recipes.
+        rec_ids (conlist(str, min_length=1)): The IDs of the recipes.
 
     Returns:
         list[dict]: A list of dictionaries, each containing a recipe's information.
@@ -155,7 +155,7 @@ def api_get_all_recipe() -> list[dict]:
     """
     Retrieves all available recipes.
 
-    This function calls the get_available_recipes method to retrieve all available recipes. It then converts each
+    This function calls the get_available_items method to retrieve all available recipes. It then converts each
     recipe into a dictionary using the to_dict method and returns a list of these dictionaries.
 
     Returns:
@@ -169,7 +169,7 @@ def api_get_all_recipe_name() -> list[str]:
     """
     Retrieves all available recipe names.
 
-    This function calls the get_available_recipes method to retrieve all available recipes. It then extracts the names
+    This function calls the get_available_items method to retrieve all available recipes. It then extracts the names
     of each recipe and returns a list of these names.
 
     Returns:

moonshot/src/api/api_red_teaming.py

@@ -11,9 +11,7 @@ def api_get_all_attack_modules() -> list[str]:
     Retrieves all available attack module IDs.
 
     This function calls the `get_available_items` method from the `AttackModule` class to retrieve all available
-    attack modules.
-
-    It then extracts the IDs of each attack module and returns a list of these IDs.
+    attack modules. It then extracts the IDs of each attack module and returns a list of these IDs.
 
     Returns:
         list[str]: A list of strings, each representing an attack module ID.
@@ -27,10 +25,8 @@ def api_get_all_attack_module_metadata() -> list[dict]:
     Retrieves metadata for all available attack modules.
 
     This function calls the `get_available_items` method from the `AttackModule` class to retrieve all available
-    attack modules metadata.
-
-    It then extracts the metadata for each attack module and returns a list of dictionaries, each containing the
-    metadata of an attack module.
+    attack modules. It then extracts the metadata for each attack module and returns a list of dictionaries,
+    each containing the metadata of an attack module.
 
     Returns:
         list[dict]: A list of dictionaries, each representing the metadata of an attack module.
@@ -44,7 +40,7 @@ def api_delete_attack_module(am_id: str) -> bool:
     """
     Deletes an attack module by its identifier.
 
-    This function takes an attack module ID as input and calls the delete method from the AttackModule class
+    This function takes an attack module ID as input and calls the `delete` method from the `AttackModule` class
     to remove the specified attack module from storage.
 
     Args:

moonshot/src/api/api_result.py

@@ -11,7 +11,7 @@ def api_read_result(res_id: str) -> dict:
     """
     Reads a result and returns its information.
 
-    This function takes a result ID as input, reads the corresponding database file from the storage manager,
+    This function takes a result ID as input, reads the corresponding result from the storage manager,
     and returns a dictionary containing the result's information.
 
     Args:
@@ -28,7 +28,7 @@ def api_read_results(res_ids: conlist(str, min_length=1)) -> list[dict]:
     """
     Reads multiple results and returns their information.
 
-    This function takes a list of result IDs as input, reads the corresponding database files from the storage manager,
+    This function takes a list of result IDs as input, reads the corresponding results from the storage manager,
     and returns a list of dictionaries, each containing a result's information.
 
     Args:
@@ -37,7 +37,6 @@ def api_read_results(res_ids: conlist(str, min_length=1)) -> list[dict]:
     Returns:
         list[dict]: A list of dictionaries, each containing a result's information.
     """
-
     return [Result.read(res_id) for res_id in res_ids]
 
 
@@ -63,11 +62,13 @@ def api_delete_result(res_id: str) -> bool:
 
 def api_get_all_result() -> list[dict]:
     """
-    This function retrieves all available results and returns them as a list of dictionaries. Each dictionary
-    represents a result and contains its information.
+    This function retrieves all available results and returns them as a list of dictionaries.
+
+    This function calls the get_available_items method from the Result class to retrieve all available results.
+    It then returns a list of dictionaries, each containing the details of a result.
 
     Returns:
-        list[dict]: A list of dictionaries, each representing a result.
+        list[dict]: A list of dictionaries, each representing a result's details.
     """
     _, results = Result.get_available_items()
     return [result for result in results]
@@ -77,6 +78,9 @@ def api_get_all_result_name() -> list[str]:
     """
     This function retrieves all available result names and returns them as a list.
 
+    This function calls the get_available_items method from the Result class to retrieve all available results.
+    It then extracts the names of each result and returns a list of these names.
+
     Returns:
         list[str]: A list of result names.
     """

moonshot/src/api/api_run.py

@@ -14,7 +14,7 @@ def api_get_all_run(runner_id: str = "") -> list[dict]:
 
     Args:
         runner_id (str, optional): The ID of the runner to retrieve runs for. If empty, runs for all runners
-        are retrieved.
+                                   are retrieved.
 
     Returns:
         list[dict]: A list of dictionaries, each representing a run's data.
@@ -34,8 +34,8 @@ def _api_get_available_runs(
     RunArguments instances representing the runs.
 
     Args:
-        runner_id (str): The ID of the runner for which to retrieve run information. If empty, information for
-                         all runners is retrieved.
+        runner_id (str, optional): The ID of the runner for which to retrieve run information. If empty, information
+                                   for all runners is retrieved.
 
     Returns:
         tuple[list[str], list[RunArguments]]: A tuple containing a list of runner IDs and a list of RunArguments

moonshot/src/api/api_runner.py

@@ -20,7 +20,7 @@ def api_create_runner(
     Creates a new runner.
 
     This function takes the name, endpoints, and an optional progress callback function to create a new Runner instance.
-    The id of the runner is generated from the name of the runner using the slugify function,
+    The ID of the runner is generated from the name of the runner using the slugify function,
     so it does not need to be provided.
 
     Args:
@@ -59,7 +59,8 @@ def api_load_runner(
 
     Args:
         runner_id (str): The ID of the runner to be loaded.
-        progress_callback_func (Callable | None): The progress callback function to be used by the runner.
+        progress_callback_func (Callable | None, optional): An optional progress callback function for the runner.
+        Defaults to None.
 
     Returns:
         Runner: An initialized Runner object.
@@ -108,8 +109,8 @@ def api_get_all_runner() -> list[dict]:
     """
     Retrieves all available runners.
 
-    This function calls the get_available_items method to retrieve all available runners. It then converts each
-    runner into a dictionary using the to_dict method and returns a list of these dictionaries.
+    This function calls the get_available_items method from the Runner class to retrieve all available runners.
+    It then converts each runner into a dictionary using the to_dict method and returns a list of these dictionaries.
 
     Returns:
         list[dict]: A list of dictionaries, each representing a runner.
@@ -122,8 +123,8 @@ def api_get_all_runner_name() -> list[str]:
     """
     Retrieves all available runner names.
 
-    This function calls the get_available_items method to retrieve all available runners. It then extracts the names of
-    each runner and returns a list of these names.
+    This function calls the get_available_items method from the Runner class to retrieve all available runners.
+    It then extracts the names of each runner and returns a list of these names.
 
     Returns:
         list[str]: A list of runner names.

moonshot/src/api/api_session.py

@@ -43,11 +43,14 @@ def api_create_session(
     Args:
         runner_id (str): The unique identifier of the runner for which the session is to be created.
         database_instance (Any): The database instance to be used for the session.
-        endpoints (list): A list of endpoints for the session.
+        endpoints (list[str]): A list of endpoints for the session.
         runner_args (dict): A dictionary of arguments for the runner.
 
     Returns:
-        Session
+        Session: A new Session object.
+
+    Raises:
+        RuntimeError: If the runner_id is empty or if the database_instance is not provided.
     """
     if isinstance(database_instance, DBInterface):
         if runner_id:
@@ -86,16 +89,16 @@ def api_get_all_session_names() -> list[str]:
     return session_names
 
 
-def api_get_available_session_info() -> tuple[list, list]:
+def api_get_available_session_info() -> tuple[list[str], list[dict]]:
     """
-    Retrieves the IDs and database instances of runners with active sessions.
+    Retrieves the IDs and metadata of runners with active sessions.
 
-    This function retrieves the IDs and database instances of runners with active sessions by querying all runners
+    This function retrieves the IDs and metadata of runners with active sessions by querying all runners
     and checking if each runner has an active session. It returns a tuple containing a list of runner IDs and a list
     of corresponding session metadata for runners with active sessions.
 
     Returns:
-        tuple[list[str], list[str]]: A tuple containing a list of runner IDs and a list of corresponding session
+        tuple[list[str], list[dict]]: A tuple containing a list of runner IDs and a list of corresponding session
         metadata for runners with active sessions.
     """
     runners_info = api_get_all_runner()
@@ -122,7 +125,8 @@ def api_get_all_session_metadata() -> list[dict]:
     This function retrieves the metadata for all active sessions by calling the `api_get_available_session_info` method.
 
     Returns:
-        list: A list containing the metadata for all active sessions, sorted by created datetime in descending order.
+        list[dict]: A list containing the metadata for all active sessions, sorted by created datetime in
+                    descending order.
     """
     _, session_metadata_list = api_get_available_session_info()
     return sorted(

moonshot/src/bookmark/bookmark.py

@@ -11,9 +11,9 @@ from moonshot.src.messages_constants import (
     BOOKMARK_ADD_BOOKMARK_VALIDATION_ERROR,
     BOOKMARK_DELETE_ALL_BOOKMARK_ERROR,
     BOOKMARK_DELETE_ALL_BOOKMARK_SUCCESS,
-    BOOKMARK_DELETE_BOOKMARK_FAIL,
     BOOKMARK_DELETE_BOOKMARK_ERROR,
     BOOKMARK_DELETE_BOOKMARK_ERROR_1,
+    BOOKMARK_DELETE_BOOKMARK_FAIL,
     BOOKMARK_DELETE_BOOKMARK_SUCCESS,
     BOOKMARK_EXPORT_BOOKMARK_ERROR,
     BOOKMARK_EXPORT_BOOKMARK_VALIDATION_ERROR,
@@ -186,7 +186,9 @@ class Bookmark:
             if (
                 bookmark_info is not None
                 and isinstance(bookmark_info, tuple)
-                and all(isinstance(item, str) for item in bookmark_info)
+                and all(
+                    isinstance(item, str) for item in bookmark_info[1:]
+                )  # Check if the rest are strings besides id
             ):
                 return BookmarkArguments.from_tuple_to_dict(bookmark_info)
             else:
@@ -210,9 +212,11 @@ class Bookmark:
         """
         if isinstance(bookmark_name, str) and bookmark_name:
             try:
-
                 bookmark_info = Storage.read_database_record(
-                self.db_instance, (bookmark_name,), Bookmark.sql_select_bookmark_record)
+                    self.db_instance,
+                    (bookmark_name,),
+                    Bookmark.sql_select_bookmark_record,
+                )
                 if bookmark_info is not None:
                     sql_delete_bookmark_record = textwrap.dedent(
                         f"""
@@ -222,7 +226,10 @@ class Bookmark:
                     Storage.delete_database_record_in_table(
                         self.db_instance, sql_delete_bookmark_record
                     )
-                    return {"success": True, "message": BOOKMARK_DELETE_BOOKMARK_SUCCESS}
+                    return {
+                        "success": True,
+                        "message": BOOKMARK_DELETE_BOOKMARK_SUCCESS,
+                    }
                 else:
                     return {"success": False, "message": BOOKMARK_DELETE_BOOKMARK_FAIL}
             except Exception as e: