fix: export ShellOnApprovalFunction and ShellOnApprovalFunctionResult from public API#3450
Open
rmotgi1227 wants to merge 1 commit into
Open
fix: export ShellOnApprovalFunction and ShellOnApprovalFunctionResult from public API#3450rmotgi1227 wants to merge 1 commit into
rmotgi1227 wants to merge 1 commit into
Conversation
… from public API ShellTool accepts an on_approval callback typed as ShellOnApprovalFunction, and the callback must return ShellOnApprovalFunctionResult. Neither type was exported from the agents package, forcing callers to import from the private agents.tool module. Export both types from agents.__init__ alongside the other Shell types, and update examples/tools/shell.py to import from agents instead of agents.tool.
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
2 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.
Summary
ShellToolaccepts anon_approvalcallback typed asShellOnApprovalFunction, and that callback must returnShellOnApprovalFunctionResult. Neither type was exported from theagentspackage — callers had to import directly from the privateagents.toolmodule.Before (workaround required):
After:
Changes
src/agents/__init__.py: AddShellOnApprovalFunctionandShellOnApprovalFunctionResultto the imports from.tooland to__all__, alongside the other Shell types already exported there.examples/tools/shell.py: Update the example to importShellOnApprovalFunctionResultfromagentsinstead ofagents.tool.Why this matters
ShellOnApprovalFunctionResultis aTypedDictthat users must construct and return in theiron_approvalhandler. Without a public export, type checkers point users to private internals, and the type does not appear inhelp(agents)or IDE auto-complete.