chore: enforce ruff docstring rules (D102/D103/D205/D209/D213/D417/D419) in integrations 41-47 (#3012)

julian-risch · claude · web-flow · commit 277d1232ac31 · 2026-03-24T10:17:25.000+01:00
Adds D102, D103, D205, D209, D213, D417, D419 ruff rules to pyproject.toml for: stackit, togetherai, unstructured, valkey, watsonx, weave, weaviate. Fixes all resulting docstring violations. Part of #2947 Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
diff --git a/integrations/stackit/pyproject.toml b/integrations/stackit/pyproject.toml
@@ -84,6 +84,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -132,7 +139,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/stackit/src/haystack_integrations/components/embedders/stackit/document_embedder.py b/integrations/stackit/src/haystack_integrations/components/embedders/stackit/document_embedder.py
@@ -12,6 +12,7 @@
 class STACKITDocumentEmbedder(OpenAIDocumentEmbedder):
     """
     A component for computing Document embeddings using STACKIT as model provider.
+
     The embedding of each Document is stored in the `embedding` field of the Document.
 
     Usage example:
@@ -110,6 +111,7 @@ def __init__(
     def to_dict(self) -> dict[str, Any]:
         """
         Serializes the component to a dictionary.
+
         :returns:
             Dictionary with serialized data.
         """
diff --git a/integrations/stackit/src/haystack_integrations/components/embedders/stackit/text_embedder.py b/integrations/stackit/src/haystack_integrations/components/embedders/stackit/text_embedder.py
@@ -86,6 +86,7 @@ def __init__(
     def to_dict(self) -> dict[str, Any]:
         """
         Serializes the component to a dictionary.
+
         :returns:
             Dictionary with serialized data.
         """
diff --git a/integrations/togetherai/pyproject.toml b/integrations/togetherai/pyproject.toml
@@ -91,6 +91,13 @@ select = [
     "ARG",
     "B",
     "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
     "DTZ",
     "E",
     "EM",
@@ -136,10 +143,10 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"examples/**/*" = ["ANN"]
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"examples/**/*" = ["D", "ANN"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 # Examples can print their output
-"examples/**" = ["T201"]
+"examples/**" = ["D", "T201"]
 
 
 [tool.coverage.run]
diff --git a/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/chat_generator.py b/integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/chat_generator.py
@@ -20,6 +20,7 @@
 class TogetherAIChatGenerator(OpenAIChatGenerator):
     """
     Enables text generation using Together AI generative models.
+
     For supported models, see [Together AI docs](https://docs.together.ai/docs).
 
     Users can pass any text generation parameters valid for the Together AI chat completion API
@@ -72,8 +73,7 @@ def __init__(
         http_client_kwargs: dict[str, Any] | None = None,
     ) -> None:
         """
-        Creates an instance of TogetherAIChatGenerator. Unless specified otherwise,
-        the default model is `meta-llama/Llama-3.3-70B-Instruct-Turbo`.
+        Creates an instance of TogetherAIChatGenerator.
 
         :param api_key:
             The Together API key.
diff --git a/integrations/unstructured/pyproject.toml b/integrations/unstructured/pyproject.toml
@@ -91,6 +91,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -139,7 +146,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/unstructured/src/haystack_integrations/components/converters/unstructured/converter.py b/integrations/unstructured/src/haystack_integrations/components/converters/unstructured/converter.py
@@ -115,6 +115,7 @@ def to_dict(self) -> dict[str, Any]:
     def from_dict(cls, data: dict[str, Any]) -> "UnstructuredFileConverter":
         """
         Deserializes the component from a dictionary.
+
         :param data:
             Dictionary to deserialize from.
         :returns:
diff --git a/integrations/valkey/pyproject.toml b/integrations/valkey/pyproject.toml
@@ -89,6 +89,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -146,8 +153,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"examples/**/*" = ["ANN", "T201"]
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"examples/**/*" = ["D", "ANN", "T201"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/valkey/src/haystack_integrations/components/retrievers/valkey/embedding_retriever.py b/integrations/valkey/src/haystack_integrations/components/retrievers/valkey/embedding_retriever.py
@@ -91,6 +91,7 @@ def __init__(
     def to_dict(self) -> dict[str, Any]:
         """
         Serializes the component to a dictionary.
+
         :returns:
             Dictionary with serialized data.
         """
@@ -106,6 +107,7 @@ def to_dict(self) -> dict[str, Any]:
     def from_dict(cls, data: dict[str, Any]) -> "ValkeyEmbeddingRetriever":
         """
         Deserializes the component from a dictionary.
+
         :param data:
             Dictionary to deserialize from.
         :returns:
diff --git a/integrations/valkey/src/haystack_integrations/document_stores/valkey/document_store.py b/integrations/valkey/src/haystack_integrations/document_stores/valkey/document_store.py
@@ -280,6 +280,7 @@ async def _get_connection_async(self) -> GlideClient | GlideClusterClient:
             raise ValkeyDocumentStoreError(msg) from e
 
     def close(self) -> None:
+        """Close the synchronous Valkey client connection."""
         if self._client:
             try:
                 self._client.close()
@@ -289,6 +290,7 @@ def close(self) -> None:
         self._client = None
 
     async def close_async(self) -> None:
+        """Close the asynchronous Valkey client connection."""
         if self._async_client:
             try:
                 await self._async_client.close()
diff --git a/integrations/valkey/src/haystack_integrations/document_stores/valkey/filters.py b/integrations/valkey/src/haystack_integrations/document_stores/valkey/filters.py
@@ -2,7 +2,8 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
-"""Valkey document store filtering utilities.
+"""
+Valkey document store filtering utilities.
 
 This module provides filter conversion from Haystack's filter format to Valkey Search query syntax.
 It supports both tag-based exact matching and numeric range filtering with logical operators.
diff --git a/integrations/watsonx/pyproject.toml b/integrations/watsonx/pyproject.toml
@@ -93,6 +93,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -147,8 +154,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"examples/**/*" = ["ANN"]
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"examples/**/*" = ["D", "ANN"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/weave/pyproject.toml b/integrations/weave/pyproject.toml
@@ -83,6 +83,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -131,8 +138,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"example/**/*" = ["ANN"]
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"example/**/*" = ["D", "ANN"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/weave/src/haystack_integrations/components/connectors/weave/weave_connector.py b/integrations/weave/src/haystack_integrations/components/connectors/weave/weave_connector.py
@@ -94,6 +94,7 @@ def warm_up(self) -> None:
 
     @component.output_types(pipeline_name=str)
     def run(self) -> dict[str, str]:
+        """Run the WeaveConnector, initializing the tracer if needed."""
         if self.tracer is None:
             self.warm_up()
         # NOTE: this is a no-op component - it simply triggers the Tracer to sends traces to Weights & Biases
diff --git a/integrations/weave/src/haystack_integrations/tracing/weave/tracer.py b/integrations/weave/src/haystack_integrations/tracing/weave/tracer.py
@@ -42,6 +42,7 @@ def set_tag(self, key: str, value: Any) -> None:
         self._attributes[key] = value
 
     def set_tags(self, tags: dict[str, Any]) -> None:
+        """Set multiple tags at once by iterating over the provided dictionary."""
         for k, v in tags.items():
             self.set_tag(k, v)
 
@@ -56,9 +57,11 @@ def get_correlation_data_for_logs(self) -> dict[str, Any]:
         return {"weave.call_id": self._call.id, "weave.run_id": getattr(self._call, "run_id", "")}
 
     def set_call(self, call: Call) -> None:
+        """Set the underlying Weave Call object for this span."""
         self._call = call
 
     def get_attributes(self) -> dict[str, Any]:
+        """Return the accumulated attributes dictionary for this span."""
         return self._attributes
 
 
@@ -92,6 +95,7 @@ def __init__(self, project_name: str, **weave_init_kwargs: Any) -> None:
 
     @staticmethod
     def create_call(attributes: dict, client: WeaveClient, parent_span: WeaveSpan | None, operation_name: str) -> Call:
+        """Create and return a Weave Call from the given span attributes and client."""
         comp_name = attributes.pop("haystack.component.name", "")
         comp_type = attributes.pop("haystack.component.type", "")
         comp_input = attributes.pop("haystack.component.input", {})
diff --git a/integrations/weaviate/pyproject.toml b/integrations/weaviate/pyproject.toml
@@ -90,6 +90,13 @@ select = [
   "ARG",
   "B",
   "C",
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D205",   # 1 blank line required between summary line and description
+  "D209",   # Closing triple quotes go to new line
+  "D213",   # summary lines must be positioned on the second physical line of the docstring
+  "D417",   # Missing argument descriptions in the docstring
+  "D419",   # Docstring is empty
   "DTZ",
   "E",
   "EM",
@@ -138,7 +145,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
+"tests/**/*" = ["D", "ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]
diff --git a/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/_filters.py b/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/_filters.py
@@ -61,6 +61,7 @@ def convert_filters(filters: dict[str, Any]) -> FilterReturn:
 def _invert_condition(filters: dict[str, Any]) -> dict[str, Any]:
     """
     Invert condition recursively.
+
     Weaviate doesn't support NOT filters so we need to invert them ourselves.
     """
     inverted_condition = filters.copy()
@@ -286,8 +287,9 @@ def _parse_comparison_condition(condition: dict[str, Any]) -> FilterReturn:
 
 def _match_no_document(field: str) -> FilterReturn:
     """
-    Returns a filters that will match no Document, this is used to keep the behavior consistent
-    between different Document Stores.
+    Returns a filter that will match no Document.
+
+    This is used to keep the behavior consistent between different Document Stores.
     """
 
     operands = [weaviate.classes.query.Filter.by_property(field).is_none(val) for val in [False, True]]
diff --git a/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/auth.py b/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/auth.py
diff --git a/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/document_store.py b/integrations/weaviate/src/haystack_integrations/document_stores/weaviate/document_store.py
