DOC update pyrit.common API reference

doc/api.rst

@@ -70,7 +70,23 @@ API Reference
     :nosignatures:
     :toctree: _autosummary/
 
-
+    combine_dict
+    combine_list
+    display_image_response
+    download_chunk
+    download_file
+    download_files
+    download_specific_files
+    get_available_files
+    get_httpx_client
+    get_non_required_value
+    get_required_value
+    initialize_pyrit
+    is_in_ipython_session
+    make_request_and_raise_if_error_async
+    print_chat_messages_with_color
+    Singleton
+    YamlLoadable
 
 :py:mod:`pyrit.datasets`
 ========================

pyrit/common/__init__.py

@@ -1,16 +1,49 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT license.
 
+# from pyrit.common.batch_helper import batch_task_async
+from pyrit.common.default_values import get_non_required_value, get_required_value
+from pyrit.common.display_response import display_image_response
+from pyrit.common.download_hf_model import (
+    download_chunk,
+    download_file,
+    download_files,
+    download_specific_files,
+    get_available_files,
+)
 from pyrit.common.initialization import (
     initialize_pyrit,
     AZURE_SQL,
     DUCK_DB,
     IN_MEMORY,
 )
+from pyrit.common.net_utility import get_httpx_client, make_request_and_raise_if_error_async
+from pyrit.common.notebook_utils import is_in_ipython_session
+from pyrit.common.print import print_chat_messages_with_color
+from pyrit.common.singleton import Singleton
+from pyrit.common.utils import combine_dict, combine_list
+from pyrit.common.yaml_loadable import YamlLoadable
 
 __all__ = [
     "AZURE_SQL",
     "DUCK_DB",
     "IN_MEMORY",
+    # "batch_task_async",
+    "combine_dict",
+    "combine_list",
+    "display_image_response",
+    "download_chunk",
+    "download_file",
+    "download_files",
+    "download_specific_files",
+    "get_available_files",
+    "get_httpx_client",
+    "get_non_required_value",
+    "get_required_value",
     "initialize_pyrit",
+    "is_in_ipython_session",
+    "make_request_and_raise_if_error_async",
+    "print_chat_messages_with_color",
+    "Singleton",
+    "YamlLoadable",
 ]

pyrit/common/display_response.py

@@ -7,7 +7,6 @@
 from PIL import Image
 
 from pyrit.common.notebook_utils import is_in_ipython_session
-from pyrit.memory import CentralMemory
 from pyrit.models import PromptRequestPiece
 
 logger = logging.getLogger(__name__)
@@ -19,6 +18,8 @@ async def display_image_response(response_piece: PromptRequestPiece) -> None:
     Args:
         response_piece (PromptRequestPiece): The response piece to display.
     """
+    from pyrit.memory import CentralMemory
+
     memory = CentralMemory.get_memory_instance()
     if (
         response_piece.response_error == "none"

pyrit/common/utils.py

@@ -7,12 +7,15 @@
 
 def combine_dict(existing_dict: dict = None, new_dict: dict = None) -> dict:
     """
-    Combines two dictionaries containing string keys and values into one
+    Combines two dictionaries containing string keys and values into one.
+
     Args:
         existing_dict: Dictionary with existing values
         new_dict: Dictionary with new values to be added to the existing dictionary.
             Note if there's a key clash, the value in new_dict will be used.
-    Returns: combined dictionary
+
+    Returns:
+        dict: combined dictionary
     """
     result = {**(existing_dict or {})}
     result.update(new_dict or {})
@@ -21,12 +24,15 @@ def combine_dict(existing_dict: dict = None, new_dict: dict = None) -> dict:
 
 def combine_list(list1: Union[str, List[str]], list2: Union[str, List[str]]) -> list:
     """
-    Combines two lists containing string keys, keeping only unique values
+    Combines two lists containing string keys, keeping only unique values.
+
     Args:
         existing_dict: Dictionary with existing values
         new_dict: Dictionary with new values to be added to the existing dictionary.
             Note if there's a key clash, the value in new_dict will be used.
-    Returns: combined dictionary
+
+    Returns:
+        list: combined dictionary
     """
     if isinstance(list1, str):
         list1 = [list1]