mirror of
https://github.com/crewAIInc/crewAI.git
synced 2025-12-16 04:18:35 +00:00
Compare commits
10 Commits
1.2.1
...
devin/1739
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
18a38ba436 | ||
|
|
369ee46ff3 | ||
|
|
39a290b4d3 | ||
|
|
d2cc61028f | ||
|
|
edcd55d19f | ||
|
|
097fac6c87 | ||
|
|
ae4ca7748c | ||
|
|
8b58feb5e0 | ||
|
|
a4856a9805 | ||
|
|
364a31ca8b |
@@ -1 +1,2 @@
|
||||
from .base_tool import BaseTool, tool
|
||||
from .human_tool import HumanTool
|
||||
|
||||
98
src/crewai/tools/human_tool.py
Normal file
98
src/crewai/tools/human_tool.py
Normal file
@@ -0,0 +1,98 @@
|
||||
"""Tool for handling human input using LangGraph's interrupt mechanism."""
|
||||
|
||||
import logging
|
||||
from typing import Any, Dict, Optional
|
||||
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from crewai.tools import BaseTool
|
||||
|
||||
|
||||
class HumanToolSchema(BaseModel):
|
||||
"""Schema for HumanTool input validation."""
|
||||
query: str = Field(
|
||||
...,
|
||||
description="The question to ask the user. Must be a non-empty string."
|
||||
)
|
||||
timeout: Optional[float] = Field(
|
||||
default=None,
|
||||
description="Optional timeout in seconds for waiting for user response"
|
||||
)
|
||||
|
||||
class HumanTool(BaseTool):
|
||||
"""Tool for getting human input using LangGraph's interrupt mechanism.
|
||||
|
||||
This tool allows agents to request input from users through LangGraph's
|
||||
interrupt mechanism. It supports timeout configuration and input validation.
|
||||
"""
|
||||
|
||||
name: str = "human"
|
||||
description: str = "Useful to ask user to enter input."
|
||||
args_schema: type[BaseModel] = HumanToolSchema
|
||||
result_as_answer: bool = False # Don't use the response as final answer
|
||||
|
||||
def _run(self, query: str, timeout: Optional[float] = None) -> str:
|
||||
"""Execute the human input tool.
|
||||
|
||||
Args:
|
||||
query: The question to ask the user
|
||||
timeout: Optional timeout in seconds
|
||||
|
||||
Returns:
|
||||
The user's response
|
||||
|
||||
Raises:
|
||||
ImportError: If LangGraph is not installed
|
||||
TimeoutError: If response times out
|
||||
ValueError: If query is invalid
|
||||
"""
|
||||
if not query or not isinstance(query, str):
|
||||
raise ValueError("Query must be a non-empty string")
|
||||
|
||||
try:
|
||||
from langgraph.prebuilt.state_graphs import interrupt
|
||||
logging.info(f"Requesting human input: {query}")
|
||||
human_response = interrupt({"query": query, "timeout": timeout})
|
||||
return human_response["data"]
|
||||
except ImportError:
|
||||
logging.error("LangGraph not installed")
|
||||
raise ImportError(
|
||||
"LangGraph is required for HumanTool. "
|
||||
"Install with `pip install langgraph`"
|
||||
)
|
||||
except Exception as e:
|
||||
logging.error(f"Error during human input: {str(e)}")
|
||||
raise
|
||||
|
||||
async def _arun(self, query: str, timeout: Optional[float] = None) -> str:
|
||||
"""Execute the human input tool asynchronously.
|
||||
|
||||
Args:
|
||||
query: The question to ask the user
|
||||
timeout: Optional timeout in seconds
|
||||
|
||||
Returns:
|
||||
The user's response
|
||||
|
||||
Raises:
|
||||
ImportError: If LangGraph is not installed
|
||||
TimeoutError: If response times out
|
||||
ValueError: If query is invalid
|
||||
"""
|
||||
if not query or not isinstance(query, str):
|
||||
raise ValueError("Query must be a non-empty string")
|
||||
|
||||
try:
|
||||
from langgraph.prebuilt.state_graphs import interrupt
|
||||
logging.info(f"Requesting async human input: {query}")
|
||||
human_response = interrupt({"query": query, "timeout": timeout})
|
||||
return human_response["data"]
|
||||
except ImportError:
|
||||
logging.error("LangGraph not installed")
|
||||
raise ImportError(
|
||||
"LangGraph is required for HumanTool. "
|
||||
"Install with `pip install langgraph`"
|
||||
)
|
||||
except Exception as e:
|
||||
logging.error(f"Error during async human input: {str(e)}")
|
||||
raise
|
||||
@@ -182,6 +182,10 @@ class ToolUsage:
|
||||
else:
|
||||
result = tool.invoke(input={})
|
||||
except Exception as e:
|
||||
# Check if this is a LangGraph interrupt that should be propagated
|
||||
if hasattr(e, '__class__') and e.__class__.__name__ == 'Interrupt':
|
||||
raise e # Propagate interrupt up
|
||||
|
||||
self.on_tool_error(tool=tool, tool_calling=calling, e=e)
|
||||
self._run_attempts += 1
|
||||
if self._run_attempts > self._max_parsing_attempts:
|
||||
|
||||
83
tests/tools/test_human_tool.py
Normal file
83
tests/tools/test_human_tool.py
Normal file
@@ -0,0 +1,83 @@
|
||||
"""Test HumanTool functionality."""
|
||||
|
||||
from unittest.mock import patch
|
||||
import pytest
|
||||
|
||||
from crewai.tools import HumanTool
|
||||
|
||||
def test_human_tool_basic():
|
||||
"""Test basic HumanTool creation and attributes."""
|
||||
tool = HumanTool()
|
||||
assert tool.name == "human"
|
||||
assert "ask user to enter input" in tool.description.lower()
|
||||
assert not tool.result_as_answer
|
||||
|
||||
@pytest.mark.vcr(filter_headers=["authorization"])
|
||||
def test_human_tool_with_langgraph_interrupt():
|
||||
"""Test HumanTool with LangGraph interrupt handling."""
|
||||
tool = HumanTool()
|
||||
|
||||
with patch('langgraph.prebuilt.state_graphs.interrupt') as mock_interrupt:
|
||||
mock_interrupt.return_value = {"data": "test response"}
|
||||
result = tool._run("test query")
|
||||
assert result == "test response"
|
||||
mock_interrupt.assert_called_with({"query": "test query", "timeout": None})
|
||||
|
||||
|
||||
def test_human_tool_timeout():
|
||||
"""Test HumanTool timeout handling."""
|
||||
tool = HumanTool()
|
||||
timeout = 30.0
|
||||
|
||||
with patch('langgraph.prebuilt.state_graphs.interrupt') as mock_interrupt:
|
||||
mock_interrupt.return_value = {"data": "test response"}
|
||||
result = tool._run("test query", timeout=timeout)
|
||||
assert result == "test response"
|
||||
mock_interrupt.assert_called_with({"query": "test query", "timeout": timeout})
|
||||
|
||||
|
||||
def test_human_tool_invalid_input():
|
||||
"""Test HumanTool input validation."""
|
||||
tool = HumanTool()
|
||||
|
||||
with pytest.raises(ValueError, match="Query must be a non-empty string"):
|
||||
tool._run("")
|
||||
|
||||
with pytest.raises(ValueError, match="Query must be a non-empty string"):
|
||||
tool._run(None)
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_human_tool_async():
|
||||
"""Test async HumanTool functionality."""
|
||||
tool = HumanTool()
|
||||
|
||||
with patch('langgraph.prebuilt.state_graphs.interrupt') as mock_interrupt:
|
||||
mock_interrupt.return_value = {"data": "test response"}
|
||||
result = await tool._arun("test query")
|
||||
assert result == "test response"
|
||||
mock_interrupt.assert_called_with({"query": "test query", "timeout": None})
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_human_tool_async_timeout():
|
||||
"""Test async HumanTool timeout handling."""
|
||||
tool = HumanTool()
|
||||
timeout = 30.0
|
||||
|
||||
with patch('langgraph.prebuilt.state_graphs.interrupt') as mock_interrupt:
|
||||
mock_interrupt.return_value = {"data": "test response"}
|
||||
result = await tool._arun("test query", timeout=timeout)
|
||||
assert result == "test response"
|
||||
mock_interrupt.assert_called_with({"query": "test query", "timeout": timeout})
|
||||
|
||||
|
||||
def test_human_tool_without_langgraph():
|
||||
"""Test HumanTool behavior when LangGraph is not installed."""
|
||||
tool = HumanTool()
|
||||
|
||||
with patch.dict('sys.modules', {'langgraph': None}):
|
||||
with pytest.raises(ImportError) as exc_info:
|
||||
tool._run("test query")
|
||||
assert "LangGraph is required" in str(exc_info.value)
|
||||
assert "pip install langgraph" in str(exc_info.value)
|
||||
@@ -1,12 +1,13 @@
|
||||
import json
|
||||
import random
|
||||
from unittest.mock import MagicMock
|
||||
from unittest.mock import MagicMock, patch
|
||||
|
||||
import pytest
|
||||
from pydantic import BaseModel, Field
|
||||
|
||||
from crewai import Agent, Task
|
||||
from crewai.tools import BaseTool
|
||||
from crewai.tools.tool_calling import ToolCalling
|
||||
from crewai.tools.tool_usage import ToolUsage
|
||||
|
||||
|
||||
@@ -85,6 +86,36 @@ def test_random_number_tool_schema():
|
||||
)
|
||||
|
||||
|
||||
def test_tool_usage_interrupt_handling():
|
||||
"""Test that tool usage properly propagates LangGraph interrupts."""
|
||||
class InterruptingTool(BaseTool):
|
||||
name: str = "interrupt_test"
|
||||
description: str = "A tool that raises LangGraph interrupts"
|
||||
|
||||
def _run(self, query: str) -> str:
|
||||
raise type('Interrupt', (Exception,), {})("test interrupt")
|
||||
|
||||
tool = InterruptingTool()
|
||||
tool_usage = ToolUsage(
|
||||
tools_handler=MagicMock(),
|
||||
tools=[tool],
|
||||
original_tools=[tool],
|
||||
tools_description="Sample tool for testing",
|
||||
tools_names="interrupt_test",
|
||||
task=MagicMock(),
|
||||
function_calling_llm=MagicMock(),
|
||||
agent=MagicMock(),
|
||||
action=MagicMock(),
|
||||
)
|
||||
|
||||
# Test that interrupt is propagated
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
tool_usage.use(
|
||||
ToolCalling(tool_name="interrupt_test", arguments={"query": "test"}, log="test"),
|
||||
"test"
|
||||
)
|
||||
assert "test interrupt" in str(exc_info.value)
|
||||
|
||||
def test_tool_usage_render():
|
||||
tool = RandomNumberTool()
|
||||
|
||||
|
||||
Reference in New Issue
Block a user