MAINT: Reword property docstrings to noun phrases (D421) (#2097)

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

Author: 3 people

pyrit/backend/models/attacks.py

@@ -44,7 +44,7 @@ class ScoreView(Score):
     @computed_field  # type: ignore[prop-decorator]
     @property
     def scorer_type(self) -> str:
-        """Return the scorer class name, or ``"Unknown"`` when unavailable."""
+        """The scorer class name, or ``"Unknown"`` when unavailable."""
         identifier = self.scorer_class_identifier
         if identifier and identifier.class_name:
             return identifier.class_name
@@ -188,19 +188,19 @@ class MessageView(Message):
     @computed_field  # type: ignore[prop-decorator]
     @property
     def turn_number(self) -> int:
-        """Return the sequence of the first piece (the conversation turn)."""
+        """The sequence of the first piece (the conversation turn)."""
         return self.message_pieces[0].sequence if self.message_pieces else 0
 
     @computed_field  # type: ignore[prop-decorator]
     @property
     def role(self) -> ChatMessageRole:
-        """Return the role of the first piece."""
+        """The role of the first piece."""
         return self.message_pieces[0].role if self.message_pieces else "user"
 
     @computed_field  # type: ignore[prop-decorator]
     @property
     def created_at(self) -> datetime:
-        """Return the timestamp of the first piece."""
+        """The timestamp of the first piece."""
         return self.message_pieces[0].timestamp if self.message_pieces else datetime.now(timezone.utc)
 
 
@@ -242,21 +242,21 @@ def _serialize_related_conversations(self, conversations: set[ConversationRefere
     @computed_field  # type: ignore[prop-decorator]
     @property
     def attack_type(self) -> str:
-        """Return the attack strategy class name, or ``"Unknown"``."""
+        """The attack strategy class name, or ``"Unknown"``."""
         identifier = self.get_attack_strategy_identifier()
         return identifier.class_name if identifier else "Unknown"
 
     @computed_field  # type: ignore[prop-decorator]
     @property
     def attack_specific_params(self) -> dict[str, Any] | None:
-        """Return the attack strategy params, or ``None``."""
+        """The attack strategy params, or ``None``."""
         identifier = self.get_attack_strategy_identifier()
         return (identifier.params or None) if identifier else None
 
     @computed_field  # type: ignore[prop-decorator]
     @property
     def target(self) -> TargetInfo | None:
-        """Return the objective target info extracted from the identifier."""
+        """The objective target info extracted from the identifier."""
         identifier = self.get_attack_strategy_identifier()
         target_id = identifier.get_child("objective_target") if identifier else None
         if not target_id:
@@ -270,15 +270,15 @@ def target(self) -> TargetInfo | None:
     @computed_field  # type: ignore[prop-decorator]
     @property
     def converters(self) -> list[str]:
-        """Return the request-converter class names applied in this attack."""
+        """The request-converter class names applied in this attack."""
         identifier = self.get_attack_strategy_identifier()
         converter_ids = identifier.get_child_list("request_converters") if identifier else []
         return [c.class_name for c in converter_ids]
 
     @computed_field  # type: ignore[prop-decorator]
     @property
     def related_conversation_ids(self) -> list[str]:
-        """Return the IDs of related conversations, sorted for stable output."""
+        """The IDs of related conversations, sorted for stable output."""
         return sorted(ref.conversation_id for ref in self.related_conversations)
 
 

pyrit/common/apply_defaults.py

@@ -152,7 +152,7 @@ def reset_defaults(self) -> None:
 
     @property
     def all_defaults(self) -> dict[DefaultValueScope, Any]:
-        """Get a copy of all current default values."""
+        """A copy of all current default values."""
         return self._default_values.copy()
 
 

pyrit/datasets/seed_datasets/local/jailbreak_dataset.py

@@ -51,7 +51,7 @@ def __init__(self, *, templates_path: Path = JAILBREAK_TEMPLATES_PATH) -> None:
     @property
     @override
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "jailbreak_templates"
 
     @override

pyrit/datasets/seed_datasets/local/local_dataset_loader.py

@@ -50,7 +50,7 @@ def __init__(self, *, file_path: Path) -> None:
 
     @property
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return self._dataset_name
 
     async def fetch_dataset_async(self, *, cache: bool = True) -> SeedDataset:

pyrit/datasets/seed_datasets/remote/aegis_ai_content_safety_dataset.py

@@ -115,7 +115,7 @@ def __init__(
     @property
     @override
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "aegis_content_safety"
 
     @override

pyrit/datasets/seed_datasets/remote/agent_threat_rules_dataset.py

@@ -204,7 +204,7 @@ def __init__(
     @property
     @override
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "agent_threat_rules"
 
     @override

pyrit/datasets/seed_datasets/remote/aya_redteaming_dataset.py

@@ -100,7 +100,7 @@ def __init__(
     @property
     @override
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "aya_redteaming"
 
     @override

pyrit/datasets/seed_datasets/remote/babelscape_alert_dataset.py

@@ -80,7 +80,7 @@ def __init__(
     @property
     @override
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "babelscape_alert"
 
     @override

pyrit/datasets/seed_datasets/remote/beaver_tails_dataset.py

@@ -54,7 +54,7 @@ def __init__(
 
     @property
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "beaver_tails"
 
     async def fetch_dataset_async(self, *, cache: bool = True) -> SeedDataset:

pyrit/datasets/seed_datasets/remote/categorical_harmful_qa_dataset.py

@@ -68,7 +68,7 @@ def __init__(
 
     @property
     def dataset_name(self) -> str:
-        """Return the dataset name."""
+        """The dataset name."""
         return "categorical_harmful_qa"
 
     async def fetch_dataset_async(self, *, cache: bool = True) -> SeedDataset: