test/tools/test_naming.py

Rama main · réplica de lectura del repositorio original.

# Copyright (c) 2026, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
#
# SPDX-License-Identifier: Apache-2.0

from dataclasses import asdict
from typing import Annotated, Any

import pytest
from dirty_equals import IsPartialDict
from pydantic import Field

from ag2 import Depends, Inject
from ag2.tools import tool
from ag2.tools.final import FunctionTool

DEFAULT_SCHEMA = {
    "function": {
        "description": "Tool description.",
        "name": "my_tool",
        "parameters": {
            "properties": {
                "a": {
                    "title": "A",
                    "type": "string",
                },
                "b": {
                    "title": "B",
                    "type": "integer",
                },
            },
            "required": [
                "a",
                "b",
            ],
            "type": "object",
        },
    },
    "type": "function",
    "defer_loading": False,
}


def test_simple_tool() -> None:
    @tool
    def my_tool(a: str, b: int) -> str:
        """Tool description."""
        return ""

    assert asdict(my_tool.schema) == DEFAULT_SCHEMA


def test_tool_schema_ignores_di() -> None:
    def get_dep(b: int) -> int:
        return b

    @tool
    def my_tool(
        a: str,
        depends: Annotated[int, Depends(get_dep)],
        dep: Annotated[str, Inject()],
    ) -> str:
        """Tool description."""
        return ""

    assert asdict(my_tool.schema) == DEFAULT_SCHEMA


def test_override_options() -> None:
    @tool(name="another_name", description="another_description")
    def my_tool(a: str, b: int) -> str:
        """Tool description."""
        return ""

    assert asdict(my_tool.schema) == {
        "function": IsPartialDict({
            "description": "another_description",
            "name": "another_name",
        }),
        "type": "function",
        "defer_loading": False,
    }


def test_ensure_tools() -> None:
    def my_tool(a: str, b: int) -> str:
        """Tool description."""
        return ""

    assert asdict(FunctionTool.ensure_tool(my_tool).schema) == DEFAULT_SCHEMA


def test_ensure_tool_from_tool() -> None:
    @tool
    def my_tool(a: str, b: int) -> str:
        """Tool description."""
        return ""

    assert asdict(FunctionTool.ensure_tool(my_tool).schema) == DEFAULT_SCHEMA


def test_option_description() -> None:
    @tool
    def my_tool(
        a: Annotated[str, Field(..., description="Just A")],
        b: int = Field(..., description="Just B", ge=1),
    ) -> str:
        """Tool description."""
        return ""

    assert asdict(FunctionTool.ensure_tool(my_tool).schema) == {
        "function": IsPartialDict({
            "parameters": IsPartialDict({
                "properties": {
                    "a": {
                        "title": "A",
                        "description": "Just A",
                        "type": "string",
                    },
                    "b": {
                        "title": "B",
                        "description": "Just B",
                        "minimum": 1,
                        "type": "integer",
                    },
                }
            }),
        }),
        "type": "function",
        "defer_loading": False,
    }


def test_empty_args() -> None:
    @tool
    def my_tool() -> str:
        """Tool description."""
        return ""

    assert asdict(FunctionTool.ensure_tool(my_tool).schema) == {
        "function": {
            "description": "Tool description.",
            "name": "my_tool",
            "parameters": {
                "type": "object",
                "properties": {},
            },
        },
        "type": "function",
        "defer_loading": False,
    }


def test_explicit_schema_is_preserved() -> None:
    explicit = {"type": "object", "properties": {"x": {"type": "string"}}, "required": ["x"]}

    @tool(schema=explicit)
    def my_tool() -> str:
        """Tool description."""
        return ""

    assert asdict(my_tool.schema) == {
        "function": {
            "description": "Tool description.",
            "name": "my_tool",
            "parameters": explicit,
        },
        "type": "function",
        "defer_loading": False,
    }


@pytest.mark.xfail()
def test_create_dynamic_options() -> None:
    @tool
    def my_tool(a: str | None = None, **kwargs: Any) -> str:
        """Tool description."""
        return ""

    assert asdict(FunctionTool.ensure_tool(my_tool).schema) == {
        "function": {
            "description": "Tool description.",
            "name": "my_tool",
            "parameters": {
                "properties": {
                    "a": {
                        "title": "A",
                        "default": None,
                        "anyOf": [
                            {"type": "string"},
                            {"type": "null"},
                        ],
                    },
                },
                "type": "object",
                "additionalProperties": True,
            },
        },
        "type": "function",
        "defer_loading": False,
    }