Add a reusable type alias for agent instructions callbacks #1781
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
### Summary Add a reusable type alias for agent instructions callbacks and use it in `Agent.instructions` to improve readability and consistency. ### Changes Made - Added `AgentInstructionsFunction` in `src/agents/agent.py`: - `AgentInstructionsFunction = Callable[[RunContextWrapper[TContext], "Agent[TContext]"], MaybeAwaitable[str]]` - Updated `Agent.instructions` type to: - `instructions: str | AgentInstructionsFunction | None = None` - No behavioral changes; typing/clarity only.
seratch reviewed Sep 22, 2025
| | ||
| | ||
| AgentInstructionsFunction: TypeAlias = Callable[ | ||
| [RunContextWrapper[TContext], "Agent[TContext]"], |
There was a problem hiding this comment.
We don't want to make this Agent[TContext] type be a string just for extracting the type here
| Thanks for sending this patch but:
For these reasons, let us close this. |
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
Add a reusable type alias for agent instructions callbacks and use it in
Agent.instructionsto improve readability and consistency.Changes Made
AgentInstructionsFunctioninsrc/agents/agent.py:AgentInstructionsFunction = Callable[[RunContextWrapper[TContext], "Agent[TContext]"], MaybeAwaitable[str]]Agent.instructionstype to:instructions: str | AgentInstructionsFunction | None = None