fix: make ContentToolResult.error JSON serializable #267
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
ContentToolResult.errorfield when calling.get_turns()followed by.model_dump_json()Problem
When a tool call fails and the error is stored in
ContentToolResult.error, attempting to serialize the chat turns would fail because PythonExceptionobjects are not JSON serializable by default.Reprex
Solution
Add a
field_serializerandfield_validatortoContentToolResultto handle theerrorfield:serialize_error: convertsExceptionto string for JSON outputvalidate_error: accepts string orExceptionduring deserialization, reconstructing a genericExceptionfrom the stringThis allows round-trip serialization/deserialization of turns containing failed tool results, though the specific exception type is not preserved (only the error message).
Test plan
test_json_serialize_with_tool_failuretest that verifies serialization and deserialization of turns with tool errors🤖 Generated with Claude Code