Address PR feedback: Add error handling and edge case tests

Co-Authored-By: Joe Moura <joao@crewai.com>
This commit is contained in:
Devin AI
2025-05-13 17:57:49 +00:00
parent 48f7721baf
commit 14035a98c3
2 changed files with 102 additions and 8 deletions

View File

@@ -136,15 +136,24 @@ class BaseTool(BaseModel, ABC):
def _generate_description(self):
import json
args_schema = {
name: {
"description": field.description,
"type": BaseTool._get_arg_annotations(field.annotation),
}
for name, field in self.args_schema.model_fields.items()
}
import logging
self.description = f"Tool Name: {self.name}\nTool Arguments: {json.dumps(args_schema)}\nTool Description: {self.description}"
logger = logging.getLogger(__name__)
try:
args_schema = {
name: {
"description": field.description,
"type": BaseTool._get_arg_annotations(field.annotation),
}
for name, field in self.args_schema.model_fields.items()
}
args_json = json.dumps(args_schema)
except Exception as e:
logger.warning(f"Failed to serialize args schema: {e}")
args_json = str(args_schema)
self.description = f"Tool Name: {self.name}\nTool Arguments: {args_json}\nTool Description: {self.description}"
@staticmethod
def _get_arg_annotations(annotation: type[Any] | None) -> str:

View File

@@ -0,0 +1,85 @@
import json
from unittest.mock import MagicMock
import pytest
from pydantic import BaseModel, Field
from crewai.tools import BaseTool
from crewai.tools.tool_usage import ToolUsage
class TestComplexInput(BaseModel):
special_chars: str = Field(
..., description="Parameter with special characters: \"'\\{}[]"
)
nested_dict: dict = Field(
..., description="A nested dictionary parameter"
)
unicode_text: str = Field(
..., description="Text with unicode characters: 你好, こんにちは, مرحبا"
)
class TestComplexTool(BaseTool):
name: str = "Complex JSON Tool"
description: str = "A tool for testing complex JSON formatting"
args_schema: type[BaseModel] = TestComplexInput
def _run(self, special_chars: str, nested_dict: dict, unicode_text: str) -> str:
return f"Processed complex input successfully"
def test_complex_json_formatting():
"""Test that complex JSON with special characters and nested structures is formatted correctly."""
tool = TestComplexTool()
assert "Tool Arguments:" in tool.description
description_parts = tool.description.split("Tool Arguments: ")
json_str = description_parts[1].split("\nTool Description:")[0]
parsed_json = json.loads(json_str)
assert "special_chars" in parsed_json
assert "nested_dict" in parsed_json
assert "unicode_text" in parsed_json
assert "\"'\\{}[]" in parsed_json["special_chars"]["description"]
assert "你好" in parsed_json["unicode_text"]["description"]
assert "こんにちは" in parsed_json["unicode_text"]["description"]
assert "مرحبا" in parsed_json["unicode_text"]["description"]
def test_complex_tool_usage_render():
"""Test that complex tool usage renders with proper JSON formatting."""
tool = TestComplexTool()
tool_usage = ToolUsage(
tools_handler=MagicMock(),
tools=[tool],
original_tools=[tool],
tools_description="Tool for testing complex JSON formatting",
tools_names="test_complex_tool",
task=MagicMock(),
function_calling_llm=MagicMock(),
agent=MagicMock(),
action=MagicMock(),
)
rendered = tool_usage._render()
rendered_parts = rendered.split("Tool Arguments: ")
if len(rendered_parts) > 1:
json_str = rendered_parts[1].split("\nTool Description:")[0]
try:
parsed_json = json.loads(json_str)
assert True # If we get here, JSON parsing succeeded
assert "special_chars" in parsed_json
assert "nested_dict" in parsed_json
assert "unicode_text" in parsed_json
except json.JSONDecodeError:
assert False, "The rendered tool arguments are not valid JSON"