chore: add ANN type annotations to stackit, togetherai, unstructured, valkey, watsonx, weave, weaviate

integrations/stackit/pyproject.toml

@@ -79,6 +79,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -105,6 +106,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Ignore checks for possible passwords
   "S105",
@@ -129,7 +131,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/stackit/src/haystack_integrations/components/embedders/stackit/document_embedder.py

@@ -53,7 +53,7 @@ def __init__(
         timeout: float | None = None,
         max_retries: int | None = None,
         http_client_kwargs: dict[str, Any] | None = None,
-    ):
+    ) -> None:
         """
         Creates a STACKITDocumentEmbedder component.
 

integrations/stackit/src/haystack_integrations/components/embedders/stackit/text_embedder.py

@@ -42,7 +42,7 @@ def __init__(
         timeout: float | None = None,
         max_retries: int | None = None,
         http_client_kwargs: dict[str, Any] | None = None,
-    ):
+    ) -> None:
         """
         Creates a STACKITTextEmbedder component.
 

integrations/stackit/src/haystack_integrations/components/generators/stackit/chat/chat_generator.py

@@ -62,7 +62,7 @@ def __init__(
         timeout: float | None = None,
         max_retries: int | None = None,
         http_client_kwargs: dict[str, Any] | None = None,
-    ):
+    ) -> None:
         """
         Creates an instance of STACKITChatGenerator class.
 

integrations/togetherai/pyproject.toml

@@ -86,6 +86,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
     "A",
+    "ANN",
     "ARG",
     "B",
     "C",
@@ -112,6 +113,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Ignore checks for possible passwords
   "S105",
@@ -133,7 +135,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"examples/**/*" = ["ANN"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 # Examples can print their output
 "examples/**" = ["T201"]
 

integrations/togetherai/src/haystack_integrations/components/generators/togetherai/chat/chat_generator.py

@@ -70,7 +70,7 @@ def __init__(
         timeout: float | None = None,
         max_retries: int | None = None,
         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`.

integrations/togetherai/src/haystack_integrations/components/generators/togetherai/generator.py

@@ -41,7 +41,7 @@ def __init__(
         generation_kwargs: dict[str, Any] | None = None,
         timeout: float | None = None,
         max_retries: int | None = None,
-    ):
+    ) -> None:
         """
         Initialize the TogetherAIGenerator.
 

integrations/unstructured/pyproject.toml

@@ -86,6 +86,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -113,6 +114,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Allow boolean positional values in function calls, like `dict.get(... True)`
   "FBT003",
@@ -136,7 +138,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/unstructured/src/haystack_integrations/components/converters/unstructured/converter.py

@@ -54,8 +54,10 @@ def __init__(
         separator: str = "\n\n",
         unstructured_kwargs: dict[str, Any] | None = None,
         progress_bar: bool = True,  # noqa: FBT001, FBT002
-    ):
+    ) -> None:
         """
+        Create an `UnstructuredFileConverter` instance.
+
         :param api_url: URL of the Unstructured API. Defaults to the URL of the hosted version.
             If you run the API locally, specify the URL of your local API (e.g. `"http://localhost:8000/general/v0/general"`).
         :param api_key: API key for the Unstructured API.

integrations/valkey/pyproject.toml

@@ -84,6 +84,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -111,6 +112,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Allow boolean positional values in function calls, like `dict.get(... True)`
   "FBT003",
@@ -143,8 +145,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
-"examples/**/*" = ["T201"]
+"examples/**/*" = ["ANN", "T201"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/valkey/src/haystack_integrations/components/retrievers/valkey/embedding_retriever.py

@@ -66,8 +66,10 @@ def __init__(
         filters: dict[str, Any] | None = None,
         top_k: int = 10,
         filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
-    ):
+    ) -> None:
         """
+        Create a `ValkeyEmbeddingRetriever` instance.
+
         :param document_store: The Valkey Document Store.
         :param filters: Filters applied to the retrieved Documents.
         :param top_k: Maximum number of Documents to return.

integrations/valkey/src/haystack_integrations/document_stores/valkey/document_store.py

@@ -159,7 +159,7 @@ def __init__(
         distance_metric: Literal["l2", "cosine", "ip"] = "cosine",
         embedding_dim: int = 768,
         metadata_fields: dict[str, type[str] | type[int]] | None = None,
-    ):
+    ) -> None:
         """
         Creates a new ValkeyDocumentStore instance.
 

integrations/watsonx/pyproject.toml

@@ -89,6 +89,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -116,6 +117,7 @@ select = [
 ignore = [
   "T201", # print statements
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Ignore checks for possible passwords
   "S105",
@@ -145,7 +147,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"examples/**/*" = ["ANN"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/watsonx/src/haystack_integrations/components/embedders/watsonx/document_embedder.py

@@ -59,7 +59,7 @@ def __init__(
         max_retries: int | None = None,
         meta_fields_to_embed: list[str] | None = None,
         embedding_separator: str = "\n",
-    ):
+    ) -> None:
         """
         Creates a WatsonxDocumentEmbedder component.
 

integrations/watsonx/src/haystack_integrations/components/embedders/watsonx/text_embedder.py

@@ -51,7 +51,7 @@ def __init__(
         suffix: str = "",
         timeout: float | None = None,
         max_retries: int | None = None,
-    ):
+    ) -> None:
         """
         Creates an WatsonxTextEmbedder component.
 

integrations/weave/pyproject.toml

@@ -78,6 +78,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -105,6 +106,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Allow boolean positional values in function calls, like `dict.get(... True)`
   "FBT003",
@@ -128,7 +130,8 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"example/**/*" = ["ANN"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/weaviate/pyproject.toml

@@ -85,6 +85,7 @@ line-length = 120
 [tool.ruff.lint]
 select = [
   "A",
+  "ANN",
   "ARG",
   "B",
   "C",
@@ -112,6 +113,7 @@ select = [
 ]
 ignore = [
   # Allow non-abstract empty methods in abstract base classes
+  "ANN401",
   "B027",
   # Allow boolean positional values in function calls, like `dict.get(... True)`
   "FBT003",
@@ -135,7 +137,7 @@ ban-relative-imports = "parents"
 
 [tool.ruff.lint.per-file-ignores]
 # Tests can use magic values, assertions, and relative imports
-"tests/**/*" = ["PLR2004", "S101", "TID252"]
+"tests/**/*" = ["ANN", "PLR2004", "S101", "TID252"]
 
 [tool.coverage.run]
 source = ["haystack_integrations"]

integrations/weaviate/src/haystack_integrations/components/retrievers/weaviate/bm25_retriever.py

@@ -38,7 +38,7 @@ def __init__(
         filters: dict[str, Any] | None = None,
         top_k: int = 10,
         filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
-    ):
+    ) -> None:
         """
         Create a new instance of WeaviateBM25Retriever.
 

integrations/weaviate/src/haystack_integrations/components/retrievers/weaviate/embedding_retriever.py

@@ -26,7 +26,7 @@ def __init__(
         distance: float | None = None,
         certainty: float | None = None,
         filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
-    ):
+    ) -> None:
         """
         Creates a new instance of WeaviateEmbeddingRetriever.
 

integrations/weaviate/src/haystack_integrations/components/retrievers/weaviate/hybrid_retriever.py

@@ -26,7 +26,7 @@ def __init__(
         alpha: float = 0.7,
         max_vector_distance: float | None = None,
         filter_policy: str | FilterPolicy = FilterPolicy.REPLACE,
-    ):
+    ) -> None:
         """
         Creates a new instance of WeaviateHybridRetriever.
 

integrations/weaviate/src/haystack_integrations/document_stores/weaviate/auth.py

@@ -26,7 +26,7 @@ class SupportedAuthTypes(Enum):
     CLIENT_CREDENTIALS = "client_credentials"
     CLIENT_PASSWORD = "client_password"
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.value
 
     @staticmethod
@@ -87,7 +87,9 @@ def _from_dict(cls, data: dict[str, Any]) -> "AuthCredentials":
         """
 
     @abstractmethod
-    def resolve_value(self):
+    def resolve_value(
+        self,
+    ) -> WeaviateAuthApiKey | WeaviateAuthBearerToken | WeaviateAuthClientCredentials | WeaviateAuthClientPassword:
         """
         Resolves all the secrets in the auth credentials object and returns the corresponding Weaviate object.
         All subclasses must implement this method.

integrations/weaviate/src/haystack_integrations/document_stores/weaviate/document_store.py

@@ -173,7 +173,7 @@ def __init__(
         }
         self._clean_connection_settings()
 
-    def _clean_connection_settings(self):
+    def _clean_connection_settings(self) -> None:
         # Set the class if not set
         _class_name = self._collection_settings.get("class", "Default")
         _class_name = _class_name[0].upper() + _class_name[1:]
@@ -184,7 +184,7 @@ def _clean_connection_settings(self):
         )
 
     @property
-    def client(self):
+    def client(self) -> weaviate.WeaviateClient:
         if self._client:
             return self._client
 
@@ -228,7 +228,7 @@ def client(self):
         return self._client
 
     @property
-    async def async_client(self):
+    async def async_client(self) -> weaviate.WeaviateAsyncClient:
         if self._async_client:
             return self._async_client