fix: preserve unknown CLI wire fields on ResultMessage and AssistantMessage#1043
Open
ashishpatel26 wants to merge 1 commit into
Open
fix: preserve unknown CLI wire fields on ResultMessage and AssistantMessage#1043ashishpatel26 wants to merge 1 commit into
ashishpatel26 wants to merge 1 commit into
Conversation
…essage (anthropics#1026) parse_message was silently dropping fields not explicitly modeled (e.g. ttft_ms, terminal_reason, stop_details). Add a raw passthrough field on ResultMessage and AssistantMessage so callers on newer CLI versions can access fields that haven't been promoted yet.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Resolves #1026
parse_messagewas silently discarding CLI wire fields not yet modeled in the SDK (e.g.ttft_ms,terminal_reason,stop_details). Users on newer CLI versions had no way to access these fields.This PR adds a
raw: dict[str, Any]passthrough field toResultMessageandAssistantMessagethat stores the original wire dict, giving callers an escape hatch for unmodeled fields.Changes Made
src/claude_agent_sdk/types.py: addraw: dict[str, Any] = field(default_factory=dict)toResultMessageandAssistantMessagesrc/claude_agent_sdk/_internal/message_parser.py: passraw=datawhen constructing those messagestests/test_message_parser.py: 5 regression tests covering unknown-field passthrough for both message typesTesting
TestRawFieldPassthrough, 5 tests)Related Issue
Closes #1026