chore: import upstream snapshot with attribution
This commit is contained in:
wehub-resource-sync
@@ -0,0 +1,271 @@
|
||||
import asyncio
|
||||
import inspect
|
||||
import json
|
||||
from typing import Any
|
||||
|
||||
import pytest
|
||||
from inline_snapshot import snapshot
|
||||
|
||||
from agents import function_tool
|
||||
from agents.run_context import RunContextWrapper
|
||||
from agents.tool_context import ToolContext
|
||||
|
||||
|
||||
class DummyContext:
|
||||
def __init__(self):
|
||||
self.data = "something"
|
||||
|
||||
|
||||
def ctx_wrapper() -> ToolContext[DummyContext]:
|
||||
return ToolContext(
|
||||
context=DummyContext(), tool_name="dummy", tool_call_id="1", tool_arguments=""
|
||||
)
|
||||
|
||||
|
||||
@function_tool
|
||||
def sync_no_context_no_args() -> str:
|
||||
return "test_1"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_no_context_no_args_invocation():
|
||||
tool = sync_no_context_no_args
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), "")
|
||||
assert output == "test_1"
|
||||
|
||||
|
||||
@function_tool
|
||||
def sync_no_context_with_args(a: int, b: int) -> int:
|
||||
return a + b
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_no_context_with_args_invocation():
|
||||
tool = sync_no_context_with_args
|
||||
input_data = {"a": 5, "b": 7}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert int(output) == 12
|
||||
|
||||
|
||||
@function_tool
|
||||
def sync_with_context(ctx: ToolContext[DummyContext], name: str) -> str:
|
||||
return f"{name}_{ctx.context.data}"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_with_context_invocation():
|
||||
tool = sync_with_context
|
||||
input_data = {"name": "Alice"}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "Alice_something"
|
||||
|
||||
|
||||
@function_tool
|
||||
async def async_no_context(a: int, b: int) -> int:
|
||||
await asyncio.sleep(0) # Just to illustrate async
|
||||
return a * b
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_async_no_context_invocation():
|
||||
tool = async_no_context
|
||||
input_data = {"a": 3, "b": 4}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert int(output) == 12
|
||||
|
||||
|
||||
@function_tool
|
||||
async def async_with_context(ctx: ToolContext[DummyContext], prefix: str, num: int) -> str:
|
||||
await asyncio.sleep(0)
|
||||
return f"{prefix}-{num}-{ctx.context.data}"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_async_with_context_invocation():
|
||||
tool = async_with_context
|
||||
input_data = {"prefix": "Value", "num": 42}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "Value-42-something"
|
||||
|
||||
|
||||
@function_tool(name_override="my_custom_tool", description_override="custom desc")
|
||||
def sync_no_context_override() -> str:
|
||||
return "override_result"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_sync_no_context_override_invocation():
|
||||
tool = sync_no_context_override
|
||||
assert tool.name == "my_custom_tool"
|
||||
assert tool.description == "custom desc"
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), "")
|
||||
assert output == "override_result"
|
||||
|
||||
|
||||
@function_tool(failure_error_function=None)
|
||||
def will_fail_on_bad_json(x: int) -> int:
|
||||
return x * 2 # pragma: no cover
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_error_on_invalid_json():
|
||||
tool = will_fail_on_bad_json
|
||||
# Passing an invalid JSON string
|
||||
with pytest.raises(Exception) as exc_info:
|
||||
await tool.on_invoke_tool(ctx_wrapper(), "{not valid json}")
|
||||
assert "Invalid JSON input for tool" in str(exc_info.value)
|
||||
|
||||
|
||||
def sync_error_handler(ctx: RunContextWrapper[Any], error: Exception) -> str:
|
||||
return f"error_{error.__class__.__name__}"
|
||||
|
||||
|
||||
@function_tool(failure_error_function=sync_error_handler)
|
||||
def will_not_fail_on_bad_json(x: int) -> int:
|
||||
return x * 2 # pragma: no cover
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_error_on_invalid_json():
|
||||
tool = will_not_fail_on_bad_json
|
||||
# Passing an invalid JSON string
|
||||
result = await tool.on_invoke_tool(ctx_wrapper(), "{not valid json}")
|
||||
assert result == "error_ModelBehaviorError"
|
||||
|
||||
|
||||
def async_error_handler(ctx: RunContextWrapper[Any], error: Exception) -> str:
|
||||
return f"error_{error.__class__.__name__}"
|
||||
|
||||
|
||||
@function_tool(failure_error_function=sync_error_handler)
|
||||
def will_not_fail_on_bad_json_async(x: int) -> int:
|
||||
return x * 2 # pragma: no cover
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_no_error_on_invalid_json_async():
|
||||
tool = will_not_fail_on_bad_json_async
|
||||
result = await tool.on_invoke_tool(ctx_wrapper(), "{not valid json}")
|
||||
assert result == "error_ModelBehaviorError"
|
||||
|
||||
|
||||
@function_tool(defer_loading=True)
|
||||
def deferred_lookup(customer_id: str) -> str:
|
||||
return customer_id
|
||||
|
||||
|
||||
def test_function_tool_defer_loading():
|
||||
assert deferred_lookup.defer_loading is True
|
||||
|
||||
|
||||
@function_tool(strict_mode=False)
|
||||
def optional_param_function(a: int, b: int | None = None) -> str:
|
||||
if b is None:
|
||||
return f"{a}_no_b"
|
||||
return f"{a}_{b}"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_non_strict_mode_function():
|
||||
tool = optional_param_function
|
||||
|
||||
assert tool.strict_json_schema is False, "strict_json_schema should be False"
|
||||
|
||||
assert tool.params_json_schema.get("required") == ["a"], "required should only be a"
|
||||
|
||||
input_data = {"a": 5}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "5_no_b"
|
||||
|
||||
input_data = {"a": 5, "b": 10}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "5_10"
|
||||
|
||||
|
||||
@function_tool(strict_mode=False)
|
||||
def all_optional_params_function(
|
||||
x: int = 42,
|
||||
y: str = "hello",
|
||||
z: int | None = None,
|
||||
) -> str:
|
||||
if z is None:
|
||||
return f"{x}_{y}_no_z"
|
||||
return f"{x}_{y}_{z}"
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_all_optional_params_function():
|
||||
tool = all_optional_params_function
|
||||
|
||||
assert tool.strict_json_schema is False, "strict_json_schema should be False"
|
||||
|
||||
assert tool.params_json_schema.get("required") is None, "required should be empty"
|
||||
|
||||
input_data: dict[str, Any] = {}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "42_hello_no_z"
|
||||
|
||||
input_data = {"x": 10, "y": "world"}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "10_world_no_z"
|
||||
|
||||
input_data = {"x": 10, "y": "world", "z": 99}
|
||||
output = await tool.on_invoke_tool(ctx_wrapper(), json.dumps(input_data))
|
||||
assert output == "10_world_99"
|
||||
|
||||
|
||||
@function_tool
|
||||
def get_weather(city: str) -> str:
|
||||
"""Get the weather for a given city.
|
||||
|
||||
Args:
|
||||
city: The city to get the weather for.
|
||||
"""
|
||||
return f"The weather in {city} is sunny."
|
||||
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_extract_descriptions_from_docstring():
|
||||
"""Ensure that we extract function and param descriptions from docstrings."""
|
||||
|
||||
tool = get_weather
|
||||
assert tool.description == "Get the weather for a given city."
|
||||
params_json_schema = tool.params_json_schema
|
||||
assert params_json_schema == snapshot(
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"city": {
|
||||
"description": "The city to get the weather for.",
|
||||
"title": "City",
|
||||
"type": "string",
|
||||
}
|
||||
},
|
||||
"title": "get_weather_args",
|
||||
"required": ["city"],
|
||||
"additionalProperties": False,
|
||||
}
|
||||
)
|
||||
|
||||
|
||||
@function_tool(
|
||||
timeout=1.25,
|
||||
timeout_behavior="raise_exception",
|
||||
timeout_error_function=sync_error_handler,
|
||||
)
|
||||
async def timeout_configured_tool() -> str:
|
||||
return "ok"
|
||||
|
||||
|
||||
def test_decorator_timeout_configuration_is_applied() -> None:
|
||||
assert timeout_configured_tool.timeout_seconds == 1.25
|
||||
assert timeout_configured_tool.timeout_behavior == "raise_exception"
|
||||
assert timeout_configured_tool.timeout_error_function is sync_error_handler
|
||||
|
||||
|
||||
def test_function_tool_timeout_arguments_are_keyword_only() -> None:
|
||||
signature = inspect.signature(function_tool)
|
||||
|
||||
assert signature.parameters["timeout"].kind is inspect.Parameter.KEYWORD_ONLY
|
||||
assert signature.parameters["timeout_behavior"].kind is inspect.Parameter.KEYWORD_ONLY
|
||||
assert signature.parameters["timeout_error_function"].kind is inspect.Parameter.KEYWORD_ONLY
|
||||
Reference in New Issue
Block a user