forked from openai/openai-agents-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtest_function_tool.py
More file actions
974 lines (754 loc) · 30.4 KB
/
test_function_tool.py
File metadata and controls
974 lines (754 loc) · 30.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
import asyncio
import contextlib
import copy
import dataclasses
import json
import time
from collections.abc import Callable
from typing import Any, cast
import pytest
from pydantic import BaseModel
from typing_extensions import TypedDict
import agents.tool as tool_module
from agents import (
Agent,
AgentBase,
FunctionTool,
HostedMCPTool,
ModelBehaviorError,
RunContextWrapper,
ToolGuardrailFunctionOutput,
ToolInputGuardrailData,
ToolOutputGuardrailData,
ToolSearchTool,
ToolTimeoutError,
UserError,
function_tool,
tool_input_guardrail,
tool_namespace,
tool_output_guardrail,
)
from agents.tool import default_tool_error_function
from agents.tool_context import ToolContext
def argless_function() -> str:
return "ok"
def test_tool_namespace_copies_tools_with_metadata() -> None:
tool = function_tool(argless_function)
namespaced_tools = tool_namespace(
name="crm",
description="CRM tools",
tools=[tool],
)
assert len(namespaced_tools) == 1
assert namespaced_tools[0] is not tool
assert namespaced_tools[0]._tool_namespace == "crm"
assert namespaced_tools[0]._tool_namespace_description == "CRM tools"
assert namespaced_tools[0].qualified_name == "crm.argless_function"
assert tool._tool_namespace is None
assert tool.qualified_name == "argless_function"
def test_tool_namespace_requires_keyword_arguments() -> None:
tool = function_tool(argless_function)
with pytest.raises(TypeError):
tool_namespace("crm", "CRM tools", [tool]) # type: ignore[misc]
def test_tool_namespace_requires_non_empty_description() -> None:
tool = function_tool(argless_function)
with pytest.raises(UserError, match="non-empty description"):
tool_namespace(
name="crm",
description=None,
tools=[tool],
)
with pytest.raises(UserError, match="non-empty description"):
tool_namespace(
name="crm",
description=" ",
tools=[tool],
)
def test_tool_namespace_rejects_reserved_same_name_shape() -> None:
tool = function_tool(argless_function, name_override="lookup_account")
with pytest.raises(UserError, match="synthetic namespace `lookup_account.lookup_account`"):
tool_namespace(
name="lookup_account",
description="Same-name namespace",
tools=[tool],
)
@pytest.mark.asyncio
async def test_argless_function():
tool = function_tool(argless_function)
assert tool.name == "argless_function"
result = await tool.on_invoke_tool(
ToolContext(context=None, tool_name=tool.name, tool_call_id="1", tool_arguments=""), ""
)
assert result == "ok"
def argless_with_context(ctx: ToolContext[str]) -> str:
return "ok"
@pytest.mark.asyncio
async def test_argless_with_context():
tool = function_tool(argless_with_context)
assert tool.name == "argless_with_context"
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=""), ""
)
assert result == "ok"
# Extra JSON should not raise an error
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"a": 1}'),
'{"a": 1}',
)
assert result == "ok"
def simple_function(a: int, b: int = 5):
return a + b
@pytest.mark.asyncio
async def test_simple_function():
tool = function_tool(simple_function, failure_error_function=None)
assert tool.name == "simple_function"
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"a": 1}'),
'{"a": 1}',
)
assert result == 6
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"a": 1, "b": 2}'),
'{"a": 1, "b": 2}',
)
assert result == 3
# Missing required argument should raise an error
with pytest.raises(ModelBehaviorError):
await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=""), ""
)
@pytest.mark.asyncio
async def test_sync_function_runs_via_to_thread(monkeypatch: pytest.MonkeyPatch) -> None:
calls = {"to_thread": 0, "func": 0}
def sync_func() -> str:
calls["func"] += 1
return "ok"
async def fake_to_thread(
func: Callable[..., Any],
/,
*args: Any,
**kwargs: Any,
) -> Any:
calls["to_thread"] += 1
return func(*args, **kwargs)
monkeypatch.setattr(asyncio, "to_thread", fake_to_thread)
tool = function_tool(sync_func)
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=""), ""
)
assert result == "ok"
assert calls["to_thread"] == 1
assert calls["func"] == 1
@pytest.mark.asyncio
async def test_sync_function_does_not_block_event_loop() -> None:
def sync_func() -> str:
time.sleep(0.2)
return "ok"
tool = function_tool(sync_func)
async def run_tool() -> Any:
return await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=""), ""
)
tool_task: asyncio.Task[Any] = asyncio.create_task(run_tool())
background_task: asyncio.Task[None] = asyncio.create_task(asyncio.sleep(0.01))
done, pending = await asyncio.wait(
{tool_task, background_task},
return_when=asyncio.FIRST_COMPLETED,
)
try:
assert background_task in done
assert tool_task in pending
assert await tool_task == "ok"
finally:
if not background_task.done():
background_task.cancel()
with contextlib.suppress(asyncio.CancelledError):
await background_task
if not tool_task.done():
tool_task.cancel()
with contextlib.suppress(asyncio.CancelledError):
await tool_task
class Foo(BaseModel):
a: int
b: int = 5
class Bar(TypedDict):
x: str
y: int
def complex_args_function(foo: Foo, bar: Bar, baz: str = "hello"):
return f"{foo.a + foo.b} {bar['x']}{bar['y']} {baz}"
@tool_input_guardrail
def reject_args_guardrail(data: ToolInputGuardrailData) -> ToolGuardrailFunctionOutput:
"""Reject tool calls for test purposes."""
return ToolGuardrailFunctionOutput.reject_content(
message="blocked",
output_info={"tool": data.context.tool_name},
)
@tool_output_guardrail
def allow_output_guardrail(data: ToolOutputGuardrailData) -> ToolGuardrailFunctionOutput:
"""Allow tool outputs for test purposes."""
return ToolGuardrailFunctionOutput.allow(output_info={"echo": data.output})
@pytest.mark.asyncio
async def test_complex_args_function():
tool = function_tool(complex_args_function, failure_error_function=None)
assert tool.name == "complex_args_function"
valid_json = json.dumps(
{
"foo": Foo(a=1).model_dump(),
"bar": Bar(x="hello", y=10),
}
)
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=valid_json),
valid_json,
)
assert result == "6 hello10 hello"
valid_json = json.dumps(
{
"foo": Foo(a=1, b=2).model_dump(),
"bar": Bar(x="hello", y=10),
}
)
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=valid_json),
valid_json,
)
assert result == "3 hello10 hello"
valid_json = json.dumps(
{
"foo": Foo(a=1, b=2).model_dump(),
"bar": Bar(x="hello", y=10),
"baz": "world",
}
)
result = await tool.on_invoke_tool(
ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments=valid_json),
valid_json,
)
assert result == "3 hello10 world"
# Missing required argument should raise an error
with pytest.raises(ModelBehaviorError):
await tool.on_invoke_tool(
ToolContext(
None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"foo": {"a": 1}}'
),
'{"foo": {"a": 1}}',
)
def test_function_config_overrides():
tool = function_tool(simple_function, name_override="custom_name")
assert tool.name == "custom_name"
tool = function_tool(simple_function, description_override="custom description")
assert tool.description == "custom description"
tool = function_tool(
simple_function,
name_override="custom_name",
description_override="custom description",
)
assert tool.name == "custom_name"
assert tool.description == "custom description"
def test_func_schema_is_strict():
tool = function_tool(simple_function)
assert tool.strict_json_schema, "Should be strict by default"
assert (
"additionalProperties" in tool.params_json_schema
and not tool.params_json_schema["additionalProperties"]
)
tool = function_tool(complex_args_function)
assert tool.strict_json_schema, "Should be strict by default"
assert (
"additionalProperties" in tool.params_json_schema
and not tool.params_json_schema["additionalProperties"]
)
@pytest.mark.asyncio
async def test_manual_function_tool_creation_works():
def do_some_work(data: str) -> str:
return f"{data}_done"
class FunctionArgs(BaseModel):
data: str
async def run_function(ctx: RunContextWrapper[Any], args: str) -> str:
parsed = FunctionArgs.model_validate_json(args)
return do_some_work(data=parsed.data)
tool = FunctionTool(
name="test",
description="Processes extracted user data",
params_json_schema=FunctionArgs.model_json_schema(),
on_invoke_tool=run_function,
)
assert tool.name == "test"
assert tool.description == "Processes extracted user data"
for key, value in FunctionArgs.model_json_schema().items():
assert tool.params_json_schema[key] == value
assert tool.strict_json_schema
result = await tool.on_invoke_tool(
ToolContext(
None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"data": "hello"}'
),
'{"data": "hello"}',
)
assert result == "hello_done"
tool_not_strict = FunctionTool(
name="test",
description="Processes extracted user data",
params_json_schema=FunctionArgs.model_json_schema(),
on_invoke_tool=run_function,
strict_json_schema=False,
)
assert not tool_not_strict.strict_json_schema
assert "additionalProperties" not in tool_not_strict.params_json_schema
result = await tool_not_strict.on_invoke_tool(
ToolContext(
None,
tool_name=tool_not_strict.name,
tool_call_id="1",
tool_arguments='{"data": "hello", "bar": "baz"}',
),
'{"data": "hello", "bar": "baz"}',
)
assert result == "hello_done"
@pytest.mark.asyncio
async def test_function_tool_default_error_works():
def my_func(a: int, b: int = 5):
raise ValueError("test")
tool = function_tool(my_func)
ctx = ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments="")
result = await tool.on_invoke_tool(ctx, "")
assert "Invalid JSON" in str(result)
result = await tool.on_invoke_tool(ctx, "{}")
assert "Invalid JSON" in str(result)
result = await tool.on_invoke_tool(ctx, '{"a": 1}')
assert result == default_tool_error_function(ctx, ValueError("test"))
result = await tool.on_invoke_tool(ctx, '{"a": 1, "b": 2}')
assert result == default_tool_error_function(ctx, ValueError("test"))
@pytest.mark.asyncio
async def test_sync_custom_error_function_works():
def my_func(a: int, b: int = 5):
raise ValueError("test")
def custom_sync_error_function(ctx: RunContextWrapper[Any], error: Exception) -> str:
return f"error_{error.__class__.__name__}"
tool = function_tool(my_func, failure_error_function=custom_sync_error_function)
ctx = ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments="")
result = await tool.on_invoke_tool(ctx, "")
assert result == "error_ModelBehaviorError"
result = await tool.on_invoke_tool(ctx, "{}")
assert result == "error_ModelBehaviorError"
result = await tool.on_invoke_tool(ctx, '{"a": 1}')
assert result == "error_ValueError"
result = await tool.on_invoke_tool(ctx, '{"a": 1, "b": 2}')
assert result == "error_ValueError"
@pytest.mark.asyncio
async def test_async_custom_error_function_works():
async def my_func(a: int, b: int = 5):
raise ValueError("test")
def custom_sync_error_function(ctx: RunContextWrapper[Any], error: Exception) -> str:
return f"error_{error.__class__.__name__}"
tool = function_tool(my_func, failure_error_function=custom_sync_error_function)
ctx = ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments="")
result = await tool.on_invoke_tool(ctx, "")
assert result == "error_ModelBehaviorError"
result = await tool.on_invoke_tool(ctx, "{}")
assert result == "error_ModelBehaviorError"
result = await tool.on_invoke_tool(ctx, '{"a": 1}')
assert result == "error_ValueError"
result = await tool.on_invoke_tool(ctx, '{"a": 1, "b": 2}')
assert result == "error_ValueError"
class BoolCtx(BaseModel):
enable_tools: bool
@pytest.mark.asyncio
async def test_is_enabled_bool_and_callable():
@function_tool(is_enabled=False)
def disabled_tool():
return "nope"
async def cond_enabled(ctx: RunContextWrapper[BoolCtx], agent: AgentBase) -> bool:
return ctx.context.enable_tools
@function_tool(is_enabled=cond_enabled)
def another_tool():
return "hi"
async def third_tool_on_invoke_tool(ctx: RunContextWrapper[Any], args: str) -> str:
return "third"
third_tool = FunctionTool(
name="third_tool",
description="third tool",
on_invoke_tool=third_tool_on_invoke_tool,
is_enabled=lambda ctx, agent: ctx.context.enable_tools,
params_json_schema={},
)
agent = Agent(name="t", tools=[disabled_tool, another_tool, third_tool])
context_1 = RunContextWrapper(BoolCtx(enable_tools=False))
context_2 = RunContextWrapper(BoolCtx(enable_tools=True))
tools_with_ctx = await agent.get_all_tools(context_1)
assert tools_with_ctx == []
tools_with_ctx = await agent.get_all_tools(context_2)
assert len(tools_with_ctx) == 2
assert tools_with_ctx[0].name == "another_tool"
assert tools_with_ctx[1].name == "third_tool"
@pytest.mark.asyncio
async def test_get_all_tools_preserves_explicit_tool_search_when_deferred_tools_are_disabled():
async def deferred_enabled(ctx: RunContextWrapper[BoolCtx], agent: AgentBase) -> bool:
return ctx.context.enable_tools
@function_tool(defer_loading=True, is_enabled=deferred_enabled)
def deferred_lookup() -> str:
return "loaded"
agent = Agent(name="t", tools=[deferred_lookup, ToolSearchTool()])
tools_with_disabled_context = await agent.get_all_tools(
RunContextWrapper(BoolCtx(enable_tools=False))
)
assert len(tools_with_disabled_context) == 1
assert isinstance(tools_with_disabled_context[0], ToolSearchTool)
tools_with_enabled_context = await agent.get_all_tools(
RunContextWrapper(BoolCtx(enable_tools=True))
)
assert tools_with_enabled_context[0] is deferred_lookup
assert isinstance(tools_with_enabled_context[1], ToolSearchTool)
@pytest.mark.asyncio
async def test_get_all_tools_keeps_tool_search_for_namespace_only_tools():
namespaced_lookup = tool_namespace(
name="crm",
description="CRM tools",
tools=[function_tool(lambda account_id: account_id, name_override="lookup_account")],
)[0]
agent = Agent(name="t", tools=[namespaced_lookup, ToolSearchTool()])
tools = await agent.get_all_tools(RunContextWrapper(BoolCtx(enable_tools=False)))
assert tools[0] is namespaced_lookup
assert isinstance(tools[1], ToolSearchTool)
@pytest.mark.asyncio
async def test_get_all_tools_keeps_tool_search_for_deferred_hosted_mcp() -> None:
hosted_mcp = HostedMCPTool(
tool_config=cast(
Any,
{
"type": "mcp",
"server_label": "crm_server",
"server_url": "https://example.com/mcp",
"defer_loading": True,
},
)
)
agent = Agent(name="t", tools=[hosted_mcp, ToolSearchTool()])
tools = await agent.get_all_tools(RunContextWrapper(BoolCtx(enable_tools=False)))
assert tools[0] is hosted_mcp
assert isinstance(tools[1], ToolSearchTool)
@pytest.mark.asyncio
async def test_async_failure_error_function_is_awaited() -> None:
async def failure_handler(ctx: RunContextWrapper[Any], exc: Exception) -> str:
return f"handled:{exc}"
@function_tool(failure_error_function=lambda ctx, exc: failure_handler(ctx, exc))
def boom() -> None:
"""Always raises to trigger the failure handler."""
raise RuntimeError("kapow")
ctx = ToolContext(None, tool_name=boom.name, tool_call_id="boom", tool_arguments="{}")
result = await boom.on_invoke_tool(ctx, "{}")
assert result.startswith("handled:")
@pytest.mark.asyncio
async def test_failure_error_function_normalizes_cancelled_error_to_exception() -> None:
seen_error: Exception | None = None
def failure_handler(_ctx: RunContextWrapper[Any], error: Exception) -> str:
nonlocal seen_error
assert isinstance(error, Exception)
assert not isinstance(error, asyncio.CancelledError)
seen_error = error
return f"handled:{error}"
tool = function_tool(lambda: "ok", failure_error_function=failure_handler)
result = await tool_module.maybe_invoke_function_tool_failure_error_function(
function_tool=tool,
context=RunContextWrapper(None),
error=asyncio.CancelledError(),
)
assert result == "handled:Tool execution cancelled."
assert seen_error is not None
assert str(seen_error) == "Tool execution cancelled."
@pytest.mark.asyncio
async def test_default_failure_error_function_is_resolved_at_invoke_time(
monkeypatch: pytest.MonkeyPatch,
) -> None:
def boom(a: int) -> None:
raise ValueError(f"boom:{a}")
tool = function_tool(boom)
def patched_default(_ctx: RunContextWrapper[Any], error: Exception) -> str:
return f"patched:{error}"
monkeypatch.setattr(tool_module, "default_tool_error_function", patched_default)
ctx = ToolContext(None, tool_name=tool.name, tool_call_id="1", tool_arguments='{"a": 7}')
result = await tool.on_invoke_tool(ctx, '{"a": 7}')
assert result == "patched:boom:7"
@pytest.mark.asyncio
async def test_manual_function_tool_uses_default_failure_error_function() -> None:
async def on_invoke_tool(_ctx: ToolContext[Any], _args: str) -> str:
raise asyncio.CancelledError("manual-tool-cancelled")
manual_tool = FunctionTool(
name="manual_cancel_tool",
description="manual cancel",
params_json_schema={},
on_invoke_tool=on_invoke_tool,
)
result = await tool_module.maybe_invoke_function_tool_failure_error_function(
function_tool=manual_tool,
context=RunContextWrapper(None),
error=asyncio.CancelledError("manual-tool-cancelled"),
)
expected = (
"An error occurred while running the tool. Please try again. Error: manual-tool-cancelled"
)
assert result == expected
assert (
tool_module.resolve_function_tool_failure_error_function(manual_tool)
is default_tool_error_function
)
@pytest.mark.asyncio
async def test_failure_error_function_survives_dataclasses_replace() -> None:
def failure_handler(_ctx: RunContextWrapper[Any], error: Exception) -> str:
return f"handled:{error}"
tool = function_tool(lambda: "ok", failure_error_function=failure_handler)
copied_tool = dataclasses.replace(tool, name="copied_tool")
result = await tool_module.maybe_invoke_function_tool_failure_error_function(
function_tool=copied_tool,
context=RunContextWrapper(None),
error=asyncio.CancelledError(),
)
assert result == "handled:Tool execution cancelled."
assert tool_module.resolve_function_tool_failure_error_function(copied_tool) is failure_handler
@pytest.mark.asyncio
async def test_replaced_function_tool_normal_failure_uses_replaced_policy() -> None:
def boom() -> None:
raise RuntimeError("kapow")
replaced_tool = dataclasses.replace(
function_tool(boom),
name="replaced_tool",
_failure_error_function=None,
_use_default_failure_error_function=False,
)
with pytest.raises(RuntimeError, match="kapow"):
await replaced_tool.on_invoke_tool(
ToolContext(None, tool_name=replaced_tool.name, tool_call_id="1", tool_arguments=""),
"",
)
@pytest.mark.asyncio
async def test_shallow_copied_function_tool_normal_failure_uses_copied_policy() -> None:
def boom() -> None:
raise RuntimeError("kapow")
original_tool = function_tool(boom)
custom_state = {"cache": ["alpha"]}
cast(Any, original_tool).custom_state = custom_state
copied_tool = copy.copy(original_tool)
copied_tool.name = "copied_tool"
copied_tool._failure_error_function = None
copied_tool._use_default_failure_error_function = False
with pytest.raises(RuntimeError, match="kapow"):
await copied_tool.on_invoke_tool(
ToolContext(None, tool_name=copied_tool.name, tool_call_id="1", tool_arguments=""),
"",
)
assert cast(Any, copied_tool).custom_state is custom_state
@pytest.mark.asyncio
@pytest.mark.parametrize("copy_style", ["replace", "shallow_copy"])
async def test_copied_function_tool_invalid_input_uses_current_name(copy_style: str) -> None:
def echo(value: str) -> str:
return value
original_tool = function_tool(
echo,
name_override="original_tool",
failure_error_function=None,
)
if copy_style == "replace":
copied_tool = dataclasses.replace(original_tool, name="copied_tool")
else:
copied_tool = copy.copy(original_tool)
copied_tool.name = "copied_tool"
with pytest.raises(ModelBehaviorError, match="Invalid JSON input for tool copied_tool"):
await copied_tool.on_invoke_tool(
ToolContext(
None,
tool_name=copied_tool.name,
tool_call_id="1",
tool_arguments="{}",
),
"{}",
)
def test_function_tool_does_not_mutate_params_json_schema() -> None:
async def noop(ctx: ToolContext[Any], input: str) -> str:
return ""
schema = {"type": "object", "properties": {"x": {"type": "string"}}}
schema_snapshot = copy.deepcopy(schema)
tool = FunctionTool(
name="t",
description="d",
params_json_schema=schema,
on_invoke_tool=noop,
strict_json_schema=True,
)
assert schema == schema_snapshot
assert tool.params_json_schema is not schema
assert tool.params_json_schema["additionalProperties"] is False
assert tool.params_json_schema["required"] == ["x"]
@pytest.mark.asyncio
async def test_default_failure_error_function_survives_deepcopy() -> None:
def boom() -> None:
raise RuntimeError("kapow")
tool = function_tool(boom)
copied_tool = copy.deepcopy(tool)
result = await tool_module.maybe_invoke_function_tool_failure_error_function(
function_tool=copied_tool,
context=RunContextWrapper(None),
error=asyncio.CancelledError(),
)
expected = (
"An error occurred while running the tool. Please try again. "
"Error: Tool execution cancelled."
)
assert result == expected
assert (
tool_module.resolve_function_tool_failure_error_function(copied_tool)
is default_tool_error_function
)
def test_function_tool_accepts_guardrail_arguments():
tool = function_tool(
simple_function,
tool_input_guardrails=[reject_args_guardrail],
tool_output_guardrails=[allow_output_guardrail],
)
assert tool.tool_input_guardrails == [reject_args_guardrail]
assert tool.tool_output_guardrails == [allow_output_guardrail]
def test_function_tool_decorator_accepts_guardrail_arguments():
@function_tool(
tool_input_guardrails=[reject_args_guardrail],
tool_output_guardrails=[allow_output_guardrail],
)
def guarded(a: int) -> int:
return a
assert guarded.tool_input_guardrails == [reject_args_guardrail]
assert guarded.tool_output_guardrails == [allow_output_guardrail]
@pytest.mark.asyncio
async def test_invoke_function_tool_timeout_returns_default_message() -> None:
@function_tool(timeout=0.01)
async def slow_tool() -> str:
await asyncio.sleep(0.2)
return "slow"
ctx = ToolContext(None, tool_name=slow_tool.name, tool_call_id="slow", tool_arguments="{}")
result = await tool_module.invoke_function_tool(
function_tool=slow_tool,
context=ctx,
arguments="{}",
)
assert isinstance(result, str)
assert "timed out" in result.lower()
assert "0.01" in result
@pytest.mark.asyncio
async def test_invoke_function_tool_timeout_uses_custom_error_function() -> None:
def custom_timeout_error(_ctx: RunContextWrapper[Any], error: Exception) -> str:
assert isinstance(error, ToolTimeoutError)
return f"custom_timeout:{error.tool_name}:{error.timeout_seconds:g}"
@function_tool(timeout=0.01, timeout_error_function=custom_timeout_error)
async def slow_tool() -> str:
await asyncio.sleep(0.2)
return "slow"
ctx = ToolContext(None, tool_name=slow_tool.name, tool_call_id="slow", tool_arguments="{}")
result = await tool_module.invoke_function_tool(
function_tool=slow_tool,
context=ctx,
arguments="{}",
)
assert result == "custom_timeout:slow_tool:0.01"
@pytest.mark.asyncio
async def test_invoke_function_tool_timeout_can_raise_exception() -> None:
@function_tool(timeout=0.01, timeout_behavior="raise_exception")
async def slow_tool() -> str:
await asyncio.sleep(0.2)
return "slow"
ctx = ToolContext(None, tool_name=slow_tool.name, tool_call_id="slow", tool_arguments="{}")
with pytest.raises(ToolTimeoutError, match="timed out"):
await tool_module.invoke_function_tool(
function_tool=slow_tool,
context=ctx,
arguments="{}",
)
@pytest.mark.asyncio
async def test_invoke_function_tool_does_not_rewrite_tool_raised_timeout_error() -> None:
@function_tool(timeout=1.0, failure_error_function=None)
async def timeout_tool() -> str:
raise TimeoutError("tool_internal_timeout")
ctx = ToolContext(
None, tool_name=timeout_tool.name, tool_call_id="timeout", tool_arguments="{}"
)
with pytest.raises(TimeoutError, match="tool_internal_timeout"):
await tool_module.invoke_function_tool(
function_tool=timeout_tool,
context=ctx,
arguments="{}",
)
@pytest.mark.asyncio
async def test_invoke_function_tool_does_not_rewrite_manual_tool_raised_timeout_error() -> None:
async def on_invoke_tool(_ctx: ToolContext[Any], _args: str) -> str:
raise TimeoutError("manual_tool_internal_timeout")
manual_tool = FunctionTool(
name="manual_timeout_tool",
description="manual timeout",
params_json_schema={},
on_invoke_tool=on_invoke_tool,
timeout_seconds=1.0,
)
ctx = ToolContext(None, tool_name=manual_tool.name, tool_call_id="timeout", tool_arguments="{}")
with pytest.raises(TimeoutError, match="manual_tool_internal_timeout"):
await tool_module.invoke_function_tool(
function_tool=manual_tool,
context=ctx,
arguments="{}",
)
async def _noop_on_invoke_tool(_ctx: ToolContext[Any], _args: str) -> str:
return "ok"
def test_function_tool_timeout_seconds_must_be_positive_number() -> None:
with pytest.raises(ValueError, match="greater than 0"):
FunctionTool(
name="bad_timeout",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_seconds=0.0,
)
with pytest.raises(TypeError, match="positive number"):
FunctionTool(
name="bad_timeout_type",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_seconds=cast(Any, "1"),
)
with pytest.raises(ValueError, match="finite number"):
FunctionTool(
name="bad_timeout_inf",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_seconds=float("inf"),
)
with pytest.raises(ValueError, match="finite number"):
FunctionTool(
name="bad_timeout_nan",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_seconds=float("nan"),
)
def test_function_tool_timeout_not_supported_for_sync_handlers() -> None:
def sync_tool() -> str:
return "ok"
with pytest.raises(ValueError, match="only supported for async @function_tool handlers"):
function_tool(sync_tool, timeout=1.0)
with pytest.raises(ValueError, match="only supported for async @function_tool handlers"):
@function_tool(timeout=1.0)
def sync_tool_decorator_style() -> str:
return "ok"
def test_function_tool_timeout_behavior_must_be_supported() -> None:
with pytest.raises(ValueError, match="timeout_behavior must be one of"):
FunctionTool(
name="bad_timeout_behavior",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_behavior=cast(Any, "unsupported"),
)
def test_function_tool_timeout_error_function_must_be_callable() -> None:
with pytest.raises(TypeError, match="timeout_error_function must be callable"):
FunctionTool(
name="bad_timeout_error_function",
description="bad",
params_json_schema={},
on_invoke_tool=_noop_on_invoke_tool,
timeout_error_function=cast(Any, "not-callable"),
)