Fix ruff lint errors: return types, docstrings, noqa

- Added return type annotation (-> type) to all __getattr__ deprecation shims
- Added noqa: B027 to display_image_async intentional no-op default
- Added Returns/Raises sections to short docstrings (DOC201, DOC501)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: rlundeen2

pyrit/executor/attack/printer/__init__.py

@@ -11,7 +11,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     _deprecated = {
         "ConsoleAttackResultPrinter": "pyrit.printer.attack_result.console",
         "MarkdownAttackResultPrinter": "pyrit.printer.attack_result.markdown",

pyrit/executor/attack/printer/console_printer.py

@@ -9,7 +9,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     if name == "ConsoleAttackResultPrinter":
         _warnings.warn(
             "Importing ConsoleAttackResultPrinter from pyrit.executor.attack.printer.console_printer is deprecated "

pyrit/executor/attack/printer/markdown_printer.py

@@ -9,7 +9,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     if name == "MarkdownAttackResultPrinter":
         _warnings.warn(
             "Importing MarkdownAttackResultPrinter from pyrit.executor.attack.printer.markdown_printer is deprecated "

pyrit/printer/attack_result/base.py

@@ -41,7 +41,7 @@ async def get_scores_async(self, *, prompt_ids: list[str]) -> list[Score]:
             list[Score]: The scores associated with the given piece IDs.
         """
 
-    async def display_image_async(self, piece: object) -> None:
+    async def display_image_async(self, piece: object) -> None:  # noqa: B027
         """
         Display an image from a message piece. No-op by default.
 

pyrit/printer/attack_result/console.py

@@ -507,11 +507,21 @@ def __init__(self, *, width: int = 100, indent_size: int = 2, enable_colors: boo
         self._memory = CentralMemory.get_memory_instance()
 
     async def get_conversation_async(self, conversation_id: str) -> list[Message]:
-        """Fetch conversation messages from CentralMemory."""
+        """
+        Fetch conversation messages from CentralMemory.
+
+        Returns:
+            list[Message]: The conversation messages.
+        """
         return list(self._memory.get_conversation(conversation_id=conversation_id))
 
     async def get_scores_async(self, *, prompt_ids: list[str]) -> list[Score]:
-        """Fetch scores from CentralMemory."""
+        """
+        Fetch scores from CentralMemory.
+
+        Returns:
+            list[Score]: The scores.
+        """
         return list(self._memory.get_prompt_scores(prompt_ids=prompt_ids))
 
     async def display_image_async(self, piece: object) -> None:

pyrit/printer/attack_result/markdown.py

@@ -574,9 +574,19 @@ def __init__(self, *, display_inline: bool = True) -> None:
         self._memory = CentralMemory.get_memory_instance()
 
     async def get_conversation_async(self, conversation_id: str) -> list[Message]:
-        """Fetch conversation messages from CentralMemory."""
+        """
+        Fetch conversation messages from CentralMemory.
+
+        Returns:
+            list[Message]: The conversation messages.
+        """
         return list(self._memory.get_conversation(conversation_id=conversation_id))
 
     async def get_scores_async(self, *, prompt_ids: list[str]) -> list[Score]:
-        """Fetch scores from CentralMemory."""
+        """
+        Fetch scores from CentralMemory.
+
+        Returns:
+            list[Score]: The scores.
+        """
         return list(self._memory.get_prompt_scores(prompt_ids=prompt_ids))

pyrit/printer/scorer/console.py

@@ -27,6 +27,9 @@ def __init__(self, *, indent_size: int = 2, enable_colors: bool = True) -> None:
         Args:
             indent_size (int): Number of spaces for indentation. Defaults to 2.
             enable_colors (bool): Whether to enable ANSI color output. Defaults to True.
+
+        Raises:
+            ValueError: If indent_size is negative.
         """
         if indent_size < 0:
             raise ValueError("indent_size must be non-negative")
@@ -220,15 +223,25 @@ class ConsoleScorerMemoryPrinter(ConsoleScorerPrinterBase):
     """
 
     def get_objective_metrics(self, *, eval_hash: str) -> Any:
-        """Fetch objective scorer evaluation metrics from the registry."""
+        """
+        Fetch objective scorer evaluation metrics from the registry.
+
+        Returns:
+            ObjectiveScorerMetrics or None: The metrics, or None if not found.
+        """
         from pyrit.score.scorer_evaluation.scorer_metrics_io import (
             find_objective_metrics_by_eval_hash,
         )
 
         return find_objective_metrics_by_eval_hash(eval_hash=eval_hash)
 
     def get_harm_metrics(self, *, eval_hash: str, harm_category: str) -> Any:
-        """Fetch harm scorer evaluation metrics from the registry."""
+        """
+        Fetch harm scorer evaluation metrics from the registry.
+
+        Returns:
+            HarmScorerMetrics or None: The metrics, or None if not found.
+        """
         from pyrit.score.scorer_evaluation.scorer_metrics_io import (
             find_harm_metrics_by_eval_hash,
         )

pyrit/scenario/printer/__init__.py

@@ -11,7 +11,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     _deprecated = {
         "ConsoleScenarioResultPrinter": "pyrit.printer.scenario_result.console",
         "ScenarioResultPrinter": "pyrit.printer.scenario_result.base",

pyrit/scenario/printer/console_printer.py

@@ -9,7 +9,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     if name == "ConsoleScenarioResultPrinter":
         _warnings.warn(
             "Importing ConsoleScenarioResultPrinter from pyrit.scenario.printer.console_printer is deprecated "

pyrit/score/printer/__init__.py

@@ -11,7 +11,7 @@
 import warnings as _warnings
 
 
-def __getattr__(name: str):  # noqa: N807
+def __getattr__(name: str) -> type:  # noqa: N807
     _deprecated = {
         "ConsoleScorerPrinter": "pyrit.printer.scorer.console",
         "ScorerPrinter": "pyrit.printer.scorer.base",