chore: Add type checking to test/tools

Author: maxdswain

haystack/tools/__init__.py

@@ -20,8 +20,10 @@
 # - list[Tool]: Most common pattern - list of Tool objects
 # - list[Toolset]: Less common pattern - list of Toolset objects
 # - list[Union[Tool, Toolset]]: Mixing Tools and Toolsets in one list
+# - list[ComponentTool]: List of ComponentTool objects
+# - list[PipelineTool]: List of PipelineTool objects
 # - Toolset: Single Toolset (not in a list)
-ToolsType = list[Tool] | list[Toolset] | list[Tool | Toolset] | Toolset
+ToolsType = list[Tool] | list[Toolset] | list[Tool | Toolset] | list[ComponentTool] | list[PipelineTool] | Toolset
 
 __all__ = [
     "_check_duplicate_tool_names",

haystack/tools/from_function.py

@@ -4,7 +4,7 @@
 
 import inspect
 from collections.abc import Callable
-from typing import Any
+from typing import Any, overload
 
 from pydantic import create_model
 
@@ -188,6 +188,30 @@ def get_weather(
     )
 
 
+@overload
+def tool(
+    function: Callable,
+    *,
+    name: str | None = None,
+    description: str | None = None,
+    inputs_from_state: dict[str, str] | None = None,
+    outputs_to_state: dict[str, dict[str, Any]] | None = None,
+    outputs_to_string: dict[str, Any] | None = None,
+) -> Tool: ...
+
+
+@overload
+def tool(
+    function: None = None,
+    *,
+    name: str | None = None,
+    description: str | None = None,
+    inputs_from_state: dict[str, str] | None = None,
+    outputs_to_state: dict[str, dict[str, Any]] | None = None,
+    outputs_to_string: dict[str, Any] | None = None,
+) -> Callable[[Callable], Tool]: ...
+
+
 def tool(
     function: Callable | None = None,
     *,

pyproject.toml

@@ -163,7 +163,7 @@ integration-only-slow = 'pytest --maxfail=5 -m "integration and slow" {args:test
 all = 'pytest {args:test}'
 
 # TODO We want to eventually type the whole test folder
-types = "mypy --install-types --non-interactive --cache-dir=.mypy_cache/ {args:haystack test/core/ test/marshal/ test/testing/ test/tracing/}"
+types = "mypy --install-types --non-interactive --cache-dir=.mypy_cache/ {args:haystack test/core/ test/marshal/ test/testing/ test/tracing/ test/tools/}"
 
 [tool.hatch.envs.e2e]
 template = "test"

test/tools/test_component_tool.py

@@ -46,6 +46,11 @@ def run(self, messages: list[ChatMessage]) -> dict[str, str]:
 class SimpleComponent:
     """A simple component that generates text."""
 
+    def warm_up(self):
+        """
+        Prepare the component for use.
+        """
+
     @component.output_types(reply=str)
     def run(self, text: str) -> dict[str, str]:
         """
@@ -143,7 +148,7 @@ def run(self, documents: list[Document], top_k: int = 5) -> dict[str, str]:
         :param top_k: The number of top documents to concatenate
         :returns: Dictionary containing the concatenated document contents
         """
-        return {"concatenated": "\n".join(doc.content for doc in documents[:top_k])}
+        return {"concatenated": "\n".join(doc.content for doc in documents[:top_k] if doc.content)}
 
 
 @component
@@ -215,7 +220,7 @@ def test_from_component_with_inputs_from_state_different_names(self):
     def test_from_component_with_invalid_inputs_from_state_nested_dict(self):
         """Test that ComponentTool rejects nested dict format for inputs_from_state"""
         with pytest.raises(TypeError, match="must be str, not dict"):
-            ComponentTool(component=SimpleComponent(), inputs_from_state={"documents": {"source": "documents"}})
+            ComponentTool(component=SimpleComponent(), inputs_from_state={"documents": {"source": "documents"}})  # type: ignore[dict-item]
 
     def test_from_component_with_outputs_to_state(self):
         tool = ComponentTool(component=SimpleComponent(), outputs_to_state={"replies": {"source": "reply"}})
@@ -369,13 +374,13 @@ def test_from_component_with_dynamic_input_types(self):
 
     def test_from_component_with_invalid_component(self):
         class NotAComponent:
-            def foo(self, text: str):
+            def foo(self, text: str) -> dict[str, str]:
                 return {"reply": f"Hello, {text}!"}
 
         not_a_component = NotAComponent()
 
         with pytest.raises(TypeError):
-            ComponentTool(component=not_a_component, name="invalid_tool", description="This should fail")
+            ComponentTool(component=not_a_component, name="invalid_tool", description="This should fail")  # type: ignore[arg-type]
 
     def test_component_invoker_with_chat_message_input(self):
         tool = ComponentTool(
@@ -392,7 +397,7 @@ class AnnotatedComponent:
             """An annotated component with descriptive parameter docstrings."""
 
             @component.output_types(result=str)
-            def run(self, text: str, number: int = 42):
+            def run(self, text: str, number: int = 42) -> dict[str, str]:
                 """
                 Process inputs and return result.
 
@@ -447,7 +452,7 @@ class ComponentA:
             """Component A with descriptive docstrings."""
 
             @component.output_types(output_a=str)
-            def run(self, query: str):
+            def run(self, query: str) -> dict[str, str]:
                 """
                 Process query in component A.
 
@@ -460,7 +465,7 @@ class ComponentB:
             """Component B with descriptive docstrings."""
 
             @component.output_types(output_b=str)
-            def run(self, text: str):
+            def run(self, text: str) -> dict[str, str]:
                 """
                 Process text in component B.
 
@@ -503,20 +508,20 @@ def run(self, text: str):
 
     def test_warm_up_is_idempotent(self):
         """Test that calling warm_up multiple times only warms up the component once."""
-        from unittest.mock import MagicMock
+        from unittest.mock import MagicMock, patch
 
         component = SimpleComponent()
-        component.warm_up = MagicMock()
 
         tool = ComponentTool(component=component)
 
-        # Call warm_up multiple times
-        tool.warm_up()
-        tool.warm_up()
-        tool.warm_up()
+        with patch.object(component, "warm_up", MagicMock()) as mock_warm_up:
+            # Call warm_up multiple times
+            tool.warm_up()
+            tool.warm_up()
+            tool.warm_up()
 
-        # Component's warm_up should only be called once
-        component.warm_up.assert_called_once()
+            # Component's warm_up should only be called once
+            mock_warm_up.assert_called_once()
 
     def test_from_component_with_callable_params_skipped(self, monkeypatch):
         monkeypatch.setenv("OPENAI_API_KEY", "test-api-key")

test/tools/test_from_function.py

@@ -87,15 +87,15 @@ def function_with_annotations(
 
 
 def test_from_function_missing_type_hint():
-    def function_missing_type_hint(city) -> str:
+    def function_missing_type_hint(city) -> str:  # type: ignore[no-untyped-def]
         return f"Weather report for {city}: 20°C, sunny"
 
     with pytest.raises(ValueError):
         create_tool_from_function(function=function_missing_type_hint)
 
 
 def test_from_function_schema_generation_error():
-    def function_with_invalid_type_hint(city: "invalid") -> str:  # noqa: F821
+    def function_with_invalid_type_hint(city: "invalid") -> str:  # type: ignore[name-defined] # noqa: F821
         return f"Weather report for {city}: 20°C, sunny"
 
     with pytest.raises(SchemaGenerationError):

test/tools/test_pipeline_tool.py

@@ -98,7 +98,7 @@ def test_init_invalid_pipeline(self):
         with pytest.raises(
             TypeError, match="The 'pipeline' parameter must be an instance of Pipeline or AsyncPipeline."
         ):
-            PipelineTool(pipeline="invalid_pipeline", name="test_tool", description="A test tool")
+            PipelineTool(pipeline="invalid_pipeline", name="test_tool", description="A test tool")  # type: ignore[arg-type]
 
     def test_to_dict(self, sample_pipeline, sample_pipeline_dict):
         tool = PipelineTool(
@@ -381,7 +381,7 @@ def test_pipeline_tool_with_invalid_inputs_from_state_nested_dict(self, sample_p
                 output_mapping={"ranker.documents": "documents"},
                 name="test_tool",
                 description="A test tool",
-                inputs_from_state={"user_query": {"source": "query"}},
+                inputs_from_state={"user_query": {"source": "query"}},  # type: ignore[dict-item]
             )
 
     def test_pipeline_tool_with_valid_outputs_to_state(self, sample_pipeline):

test/tools/test_searchable_toolset.py

@@ -4,6 +4,8 @@
 
 
 import os
+from collections.abc import Callable
+from typing import Any
 
 import pytest
 
@@ -82,30 +84,28 @@ def small_catalog(weather_tool, add_tool, multiply_tool):
 @pytest.fixture
 def large_catalog():
     """Larger catalog that requires discovery (>= 8 tools)."""
-    return [
-        create_tool_from_function(fn)
-        for fn in [
-            get_weather,
-            add_numbers,
-            multiply_numbers,
-            get_stock_price,
-            search_database,
-            send_email,
-            calculate_tax,
-            convert_currency,
-        ]
+    functions: list[Callable[..., Any]] = [
+        get_weather,
+        add_numbers,
+        multiply_numbers,
+        get_stock_price,
+        search_database,
+        send_email,
+        calculate_tax,
+        convert_currency,
     ]
+    return [create_tool_from_function(fn) for fn in functions]
 
 
 class TestSearchableToolset:
     def test_init_with_invalid_catalog(self):
         with pytest.raises(TypeError):
-            SearchableToolset(catalog=123)
+            SearchableToolset(catalog=123)  # type: ignore[arg-type]
         with pytest.raises(TypeError):
-            SearchableToolset(catalog=[123])
+            SearchableToolset(catalog=[123])  # type: ignore[arg-type]
         with pytest.raises(TypeError):
             SearchableToolset(
-                catalog=Tool(
+                catalog=Tool(  # type: ignore[arg-type]
                     name="test",
                     description="test",
                     parameters={"type": "object", "properties": {}},
@@ -132,6 +132,7 @@ def test_not_implemented_methods(self):
     def test_clear(self, large_catalog):
         toolset = SearchableToolset(catalog=large_catalog)
         toolset.warm_up()
+        assert toolset._bootstrap_tool is not None
         toolset._bootstrap_tool.invoke(tool_keywords="weather temperature city")
         assert len(toolset._discovered_tools) > 0
         toolset.clear()
@@ -187,7 +188,7 @@ def test_passthrough_contains_by_tool_invalid_type(self, small_catalog):
         toolset.warm_up()
 
         with pytest.raises(TypeError):
-            123 in toolset  # noqa: B015
+            123 in toolset  # type: ignore[operator] # noqa: B015
 
     def test_custom_search_threshold(self, large_catalog):
         """Test that custom search_threshold changes passthrough behavior."""
@@ -318,6 +319,7 @@ def test_contains_bootstrap_tool(self, large_catalog):
         toolset.warm_up()
 
         assert "search_tools" in toolset
+        assert toolset._bootstrap_tool is not None
         assert toolset._bootstrap_tool in toolset
 
     def test_contains_discovered_tool(self, large_catalog):
@@ -680,7 +682,7 @@ def warm_up(self) -> None:
             for i in range(5)
         ]
 
-        toolset = SearchableToolset(catalog=[LazyToolset()] + eager_tools)
+        toolset = SearchableToolset(catalog=[LazyToolset()] + eager_tools)  # type: ignore[arg-type]
         toolset.warm_up()
 
         # Should have 5 lazy + 5 eager = 10 tools

test/tools/test_serde_utils.py

@@ -2,6 +2,8 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+from typing import Any
+
 import pytest
 
 from haystack.tools import Tool, Toolset, deserialize_tools_or_toolset_inplace, serialize_tools_or_toolset
@@ -91,7 +93,7 @@ def test_deserialize_tools_inplace(self):
             name="weather", description="Get weather report", parameters=parameters, function=get_weather_report
         )
 
-        data = {"tools": [tool.to_dict()]}
+        data: dict[str, Any] = {"tools": [tool.to_dict()]}
         deserialize_tools_or_toolset_inplace(data)
         assert data["tools"] == [tool]
 
@@ -104,7 +106,7 @@ def test_deserialize_tools_inplace(self):
         assert data == {"no_tools": 123}
 
     def test_deserialize_tools_inplace_failures(self):
-        data = {"key": "value"}
+        data: dict[str, Any] = {"key": "value"}
         deserialize_tools_or_toolset_inplace(data)
         assert data == {"key": "value"}
 
@@ -186,7 +188,8 @@ def test_deserialize_list_of_toolsets_inplace(self):
 
         assert isinstance(data["tools"], list)
         assert len(data["tools"]) == 2
-        assert all(isinstance(ts, Toolset) for ts in data["tools"])
+        assert isinstance(data["tools"][0], Toolset)
+        assert isinstance(data["tools"][1], Toolset)
         assert data["tools"][0][0].name == "weather"
         assert data["tools"][1][0].name == "calculator"
 
@@ -201,7 +204,8 @@ def test_serialize_mixed_list_tools_and_toolsets(self):
 
         toolset = Toolset([tool2])
 
-        data = serialize_tools_or_toolset([tool1, toolset])
+        tools: list[Tool | Toolset] = [tool1, toolset]
+        data = serialize_tools_or_toolset(tools)
 
         assert isinstance(data, list)
         assert len(data) == 2
@@ -230,7 +234,8 @@ def test_serialize_mixed_list_multiple_tools_and_toolsets(self):
 
         toolset = Toolset([tool4, tool5])
 
-        data = serialize_tools_or_toolset([tool1, tool2, toolset, tool3])
+        tools: list[Tool | Toolset] = [tool1, tool2, toolset, tool3]
+        data = serialize_tools_or_toolset(tools)
 
         assert isinstance(data, list)
         assert len(data) == 4

test/tools/test_tool.py

@@ -77,7 +77,7 @@ def test_init_invalid_output_structure_config_not_dict(self):
                 description="irrelevant",
                 parameters={"type": "object", "properties": {"city": {"type": "string"}}},
                 function=get_weather_report,
-                outputs_to_state={"documents": ["some_value"]},
+                outputs_to_state={"documents": ["some_value"]},  # type: ignore[dict-item]
             )
 
     @pytest.mark.parametrize(
@@ -258,7 +258,7 @@ def test_inputs_from_state_validation_with_non_string_value(self):
                 description="Get weather report",
                 parameters=parameters,
                 function=get_weather_report,
-                inputs_from_state={"state_key": {"source": "city"}},
+                inputs_from_state={"state_key": {"source": "city"}},  # type: ignore[dict-item]
             )
 
     def test_inputs_from_state_validation_with_valid_parameter(self):