feat(agent): update AgentResult __str__ priority order #1553
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change string representation priority to: 1. Interrupts (if present) → stringified list of interrupt dicts 2. Structured output (if present) → JSON string 3. Text content from message → concatenated text blocks Previously, structured output was only used as fallback when no text content existed. Now structured output and interrupts take precedence over raw text content for more predictable serialization behavior.
afarntrog
had a problem deploying
to
auto-approve
GitHub Actions
Failure
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
afarntrog
had a problem deploying
to
auto-approve
GitHub Actions
Failure
mkmeral
reviewed
Jan 23, 2026
| """ | ||
| content_array = self.message.get("content", []) | ||
| if self.interrupts: | ||
| return str([interrupt.to_dict() for interrupt in self.interrupts]) |
Contributor
Author
There was a problem hiding this comment.
I think it's best we keep it like this to provide the stringified agent "output" as opposed to "interfering" by modifying it with some json. In addition, the majority case (just last message text) is also just text.
1asso
approved these changes
Jan 23, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This pull request updates the string representation logic for the
AgentResultclass to prioritize interrupts and structured output over message text, and adds comprehensive tests to ensure correct behavior. The changes clarify howAgentResult.__str__behaves in different scenarios and improve test coverage accordingly.AgentResult string representation logic:
__str__method inAgentResultto follow a clear priority: (1) interrupts (if present), (2) structured output (if present), and (3) concatenated message text. This ensures that the most important information is always returned first.Testing improvements:
test_agent_result.pyto:Related Issues
#1461
Documentation PR
Type of Change
Bug fix
Breaking change
Testing
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.