Add validation for hook callback return types#534
Draft
wingding12 wants to merge 1 commit intoanthropics:mainfrom
Draft
Add validation for hook callback return types#534wingding12 wants to merge 1 commit intoanthropics:mainfrom
wingding12 wants to merge 1 commit intoanthropics:mainfrom
Conversation
When a hook callback returns None or a non-dict value, the SDK would crash with a confusing AttributeError when trying to call .items() on the return value. This change adds explicit validation with clear error messages to help users debug their hook callbacks. Changes: - Add HookCallbackError exception class for hook-related errors - Validate hook callback return type before processing - Provide helpful error messages including the callback ID - Add comprehensive tests for invalid return types
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
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
When a hook callback returns
Noneor a non-dict value, the SDK currently crashes with a confusingAttributeErrorwhen trying to call.items()on the return value in_convert_hook_output_for_cli(). This PR adds explicit validation with clear error messages to help users debug their hook callbacks.Changes
HookCallbackErrorexception class for hook-related errorsExample
Before this change, a hook returning
Nonewould cause:After this change:
Test plan
None