Compare commits

...

2 Commits

Author SHA1 Message Date
Devin AI
f519b0d31c feat: improve error handling in _interpolate_only method
- Add comprehensive docstring with examples
- Add error handling for edge cases
- Add test cases for error scenarios

Co-Authored-By: Joe Moura <joao@crewai.com>
2025-02-16 05:37:29 +00:00
Devin AI
be11f9c036 fix: handle tool descriptions with curly braces in agent interpolation
- Add _interpolate_only helper method to escape curly braces
- Update interpolate_inputs to use new helper
- Add test case for tool descriptions
- Fixes #2145

Co-Authored-By: Joe Moura <joao@crewai.com>
2025-02-16 05:31:41 +00:00
2 changed files with 88 additions and 3 deletions

View File

@@ -314,6 +314,46 @@ class BaseAgent(ABC, BaseModel):
return copied_agent
def _interpolate_only(self, input_string: str, inputs: Dict[str, Any]) -> str:
"""Interpolate placeholders in a string while preserving JSON-like structures.
Args:
input_string (str): The string containing placeholders to interpolate.
inputs (Dict[str, Any]): Dictionary of values for interpolation.
Returns:
str: The interpolated string with JSON structures preserved.
Example:
>>> _interpolate_only("Name: {name}, Config: {'key': 'value'}", {"name": "John"})
"Name: John, Config: {'key': 'value'}"
Raises:
ValueError: If input_string is None or empty, or if inputs is empty
KeyError: If a required template variable is missing from inputs
"""
if not input_string:
raise ValueError("Input string cannot be None or empty")
if not inputs:
raise ValueError("Inputs dictionary cannot be empty")
try:
# First check if all required variables are present
required_vars = [
var.split("}")[0] for var in input_string.split("{")[1:]
if "}" in var
]
for var in required_vars:
if var not in inputs:
raise KeyError(f"Missing required template variable: {var}")
escaped_string = input_string.replace("{", "{{").replace("}", "}}")
for key in inputs.keys():
escaped_string = escaped_string.replace(f"{{{{{key}}}}}", f"{{{key}}}")
return escaped_string.format(**inputs)
except ValueError as e:
raise ValueError(f"Error during string interpolation: {str(e)}") from e
def interpolate_inputs(self, inputs: Dict[str, Any]) -> None:
"""Interpolate inputs into the agent description and backstory."""
if self._original_role is None:
@@ -324,9 +364,9 @@ class BaseAgent(ABC, BaseModel):
self._original_backstory = self.backstory
if inputs:
self.role = self._original_role.format(**inputs)
self.goal = self._original_goal.format(**inputs)
self.backstory = self._original_backstory.format(**inputs)
self.role = self._interpolate_only(self._original_role, inputs)
self.goal = self._interpolate_only(self._original_goal, inputs)
self.backstory = self._interpolate_only(self._original_backstory, inputs)
def set_cache_handler(self, cache_handler: CacheHandler) -> None:
"""Set the cache handler for the agent.

View File

@@ -1357,6 +1357,51 @@ def test_handle_context_length_exceeds_limit_cli_no():
mock_handle_context.assert_not_called()
def test_interpolate_inputs_with_tool_description():
from crewai.tools import BaseTool
class DummyTool(BaseTool):
name: str = "dummy_tool"
description: str = "Tool Arguments: {'arg': {'description': 'test arg', 'type': 'str'}}"
def _run(self, arg: str) -> str:
"""Run the tool."""
return f"Dummy result for: {arg}"
tool = DummyTool()
agent = Agent(
role="{topic} specialist",
goal="Figure {goal} out",
backstory="I am the master of {role}\nTools: {tool_desc}",
)
agent.interpolate_inputs({
"topic": "AI",
"goal": "life",
"role": "all things",
"tool_desc": tool.description
})
assert "Tool Arguments: {'arg': {'description': 'test arg', 'type': 'str'}}" in agent.backstory
def test_interpolate_only_error_handling():
agent = Agent(
role="{topic} specialist",
goal="Figure {goal} out",
backstory="I am the master of {role}",
)
# Test empty input string
with pytest.raises(ValueError, match="Input string cannot be None or empty"):
agent._interpolate_only("", {"topic": "AI"})
# Test empty inputs dictionary
with pytest.raises(ValueError, match="Inputs dictionary cannot be empty"):
agent._interpolate_only("test {topic}", {})
# Test missing template variable
with pytest.raises(KeyError, match="Missing required template variable"):
agent._interpolate_only("test {missing}", {"topic": "AI"})
def test_agent_with_all_llm_attributes():
agent = Agent(
role="test role",