Skip to content

Ensure ToolCallPart.args resulting from TestModel(custom_output_args=...) is always a dict #3254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 24, 2025
Merged

Ensure ToolCallPart.args resulting from TestModel(custom_output_args=...) is always a dict #3254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions pydantic_ai_slim/pydantic_ai/models/test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,14 @@ class _WrappedTextOutput:
value: str | None


@dataclass
@dataclass(init=False)
class _WrappedToolOutput:
"""A wrapper class to tag an output that came from the custom_output_args field."""

value: Any | None
value: dict[str, Any] | None

def __init__(self, value: Any | None):
self.value = pydantic_core.to_jsonable_python(value)


@dataclass(init=False)
Expand Down Expand Up @@ -364,7 +367,7 @@ def __init__(self, schema: _utils.ObjectJsonSchema, seed: int = 0):
self.defs = schema.get('$defs', {})
self.seed = seed

def generate(self) -> Any:
def generate(self) -> dict[str, Any]:
"""Generate data for the JSON schema."""
return self._gen_any(self.schema)

Expand Down
102 changes: 102 additions & 0 deletions tests/models/test_model_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,40 @@ def test_custom_output_args():
agent = Agent(output_type=tuple[str, str])
result = agent.run_sync('x', model=TestModel(custom_output_args=['a', 'b']))
assert result.output == ('a', 'b')
assert result.all_messages() == snapshot(
[
ModelRequest(
parts=[
UserPromptPart(
content='x',
timestamp=IsNow(tz=timezone.utc),
)
]
),
ModelResponse(
parts=[
ToolCallPart(
tool_name='final_result',
args={'response': ['a', 'b']},
tool_call_id='pyd_ai_tool_call_id__final_result',
)
],
usage=RequestUsage(input_tokens=51, output_tokens=7),
model_name='test',
timestamp=IsNow(tz=timezone.utc),
),
ModelRequest(
parts=[
ToolReturnPart(
tool_name='final_result',
content='Final result processed.',
tool_call_id='pyd_ai_tool_call_id__final_result',
timestamp=IsNow(tz=timezone.utc),
)
]
),
]
)


def test_custom_output_args_model():
Expand All @@ -79,12 +113,80 @@ class Foo(BaseModel):
agent = Agent(output_type=Foo)
result = agent.run_sync('x', model=TestModel(custom_output_args={'foo': 'a', 'bar': 1}))
assert result.output == Foo(foo='a', bar=1)
assert result.all_messages() == snapshot(
[
ModelRequest(
parts=[
UserPromptPart(
content='x',
timestamp=IsNow(tz=timezone.utc),
)
]
),
ModelResponse(
parts=[
ToolCallPart(
tool_name='final_result',
args={'foo': 'a', 'bar': 1},
tool_call_id='pyd_ai_tool_call_id__final_result',
)
],
usage=RequestUsage(input_tokens=51, output_tokens=6),
model_name='test',
timestamp=IsNow(tz=timezone.utc),
),
ModelRequest(
parts=[
ToolReturnPart(
tool_name='final_result',
content='Final result processed.',
tool_call_id='pyd_ai_tool_call_id__final_result',
timestamp=IsNow(tz=timezone.utc),
)
]
),
]
)


def test_output_type():
agent = Agent(output_type=tuple[str, str])
result = agent.run_sync('x', model=TestModel())
assert result.output == ('a', 'a')
assert result.all_messages() == snapshot(
[
ModelRequest(
parts=[
UserPromptPart(
content='x',
timestamp=IsNow(tz=timezone.utc),
)
]
),
ModelResponse(
parts=[
ToolCallPart(
tool_name='final_result',
args={'response': ['a', 'a']},
tool_call_id='pyd_ai_tool_call_id__final_result',
)
],
usage=RequestUsage(input_tokens=51, output_tokens=7),
model_name='test',
timestamp=IsNow(tz=timezone.utc),
),
ModelRequest(
parts=[
ToolReturnPart(
tool_name='final_result',
content='Final result processed.',
tool_call_id='pyd_ai_tool_call_id__final_result',
timestamp=IsNow(tz=timezone.utc),
)
]
),
]
)


def test_tool_retry():
Expand Down