Framework for orchestrating role-playing, autonomous AI agents. By fostering collaborative intelligence, CrewAI empowers agents to work together seamlessly, tackling complex tasks.
fix(utilities): stop json-schema models warning about BaseModel-shadowing fields (#8085)
João Moura7b07ee5b6ab4
diff --git a/lib/crewai-tools/tests/tools/crewai_platform_tools/test_crewai_platform_action_tool.py b/lib/crewai-tools/tests/tools/crewai_platform_tools/test_crewai_platform_action_tool.pyindex 2692a4794..2e39eac4b 100644--- a/lib/crewai-tools/tests/tools/crewai_platform_tools/test_crewai_platform_action_tool.py+++ b/lib/crewai-tools/tests/tools/crewai_platform_tools/test_crewai_platform_action_tool.py@@ -165,3 +165,33 @@ class TestCrewAIPlatformActionToolVerify:mock_post.assert_called_once()call_args = mock_post.call_argsassert call_args.kwargs["verify"] is False+++class TestCrewAIPlatformActionToolBaseModelAttributeNames:+ tool_info = ToolInfo(+ app="slack",+ action="create_list",+ connection_id=None,+ description="Create a Slack list",+ parameters={+ "properties": {+ "name": {"type": "string"},+ "schema": {"type": "object", "description": "Column definitions"},+ },+ "required": ["name", "schema"],+ },+ )++ def test_run_sends_the_argument_under_its_original_name(self):+ client = Mock(spec=IntegrationsClient)+ client.execute_action.return_value = ToolExecutionSuccess(output={"ok": True})+ tool = CrewAIPlatformActionTool(+ self.tool_info, client=cast(IntegrationsClient, client)+ )++ tool.run(name="Launch plan", schema={"columns": ["owner", "due"]})++ assert client.execute_action.call_args.args[1] == {+ "name": "Launch plan",+ "schema": {"columns": ["owner", "due"]},+ }diff --git a/lib/crewai/tests/utilities/test_pydantic_schema_utils.py b/lib/crewai/tests/utilities/test_pydantic_schema_utils.pyindex 35ea177bd..caa4688aa 100644--- a/lib/crewai/tests/utilities/test_pydantic_schema_utils.py+++ b/lib/crewai/tests/utilities/test_pydantic_schema_utils.py@@ -522,6 +522,92 @@ class TestModelName:assert Model.__name__ == "DynamicModel"+# Property names that collide with BaseModel attributes+#+# Pydantic warns that such a field "shadows an attribute in parent BaseModel". The+# warning is cosmetic and is left on: the field keeps its own name everywhere, which+# is what tools, flow state restore and structured output read.+++class TestBaseModelAttributeNames:+ @pytest.mark.parametrize("name", ["schema", "json", "copy"])+ def test_property_keeps_its_name(self, name: str) -> None:+ schema = {+ "type": "object",+ "title": "ActionRequest",+ "properties": {name: {"type": "string"}},+ "required": [name],+ }+ Model = create_model_from_schema(schema)+ instance = Model(**{name: "value"})++ assert list(Model.model_fields) == [name]+ assert getattr(instance, name) == "value"+ assert instance.model_dump() == {name: "value"}+ assert list(Model.model_json_schema()["properties"]) == [name]++ def test_nested_object_property_keeps_its_name(self) -> None:+ schema = {+ "type": "object",+ "title": "CreateList",+ "properties": {+ "list": {+ "type": "object",+ "properties": {"schema": {"type": "string"}},+ "required": ["schema"],+ }+ },+ "required": ["list"],+ }+ Model = create_model_from_schema(schema)++ dumped = Model(list={"schema": "columns"}).model_dump()+ assert dumped == {"list": {"schema": "columns"}}++ def test_shadowing_property_is_still_validated(self) -> None:+ schema = {+ "type": "object",+ "title": "ActionRequest",+ "properties": {"schema": {"type": "integer"}},+ "required": ["schema"],+ }+ Model = create_model_from_schema(schema)++ with pytest.raises(ValueError, match="schema\n Field required"):+ Model()+ with pytest.raises(ValueError, match="schema\n Input should be a valid integer"):+ Model(schema="not a number")++ def test_recursive_defs_keep_shadowing_names(self) -> None:+ # B refers back to A, so it is built incomplete and finished by model_rebuild.+ schema = {+ "type": "object",+ "title": "Root",+ "properties": {"a": {"$ref": "#/$defs/A"}},+ "$defs": {+ "A": {+ "type": "object",+ "properties": {+ "schema": {"type": "string"},+ "b": {"$ref": "#/$defs/B"},+ },+ },+ "B": {+ "type": "object",+ "properties": {+ "json": {"type": "string"},+ "a": {"$ref": "#/$defs/A"},+ },+ },+ },+ }+ Model = create_model_from_schema(schema)++ dumped = Model(a={"schema": "s", "b": {"json": "j"}}).model_dump()+ assert dumped["a"]["schema"] == "s"+ assert dumped["a"]["b"]["json"] == "j"++# enrich_descriptions