feat: add CancellationToken for graceful agent execution cancellation#1772
Open
jgoyani1 wants to merge 1 commit intostrands-agents:mainfrom
Open
feat: add CancellationToken for graceful agent execution cancellation#1772jgoyani1 wants to merge 1 commit intostrands-agents:mainfrom
jgoyani1 wants to merge 1 commit intostrands-agents:mainfrom
Conversation
Implement CancellationToken to enable graceful cancellation of agent execution from external contexts (e.g., web requests, background threads). Key features: - Thread-safe CancellationToken class with cancel() and is_cancelled() methods - Agent accepts optional cancellation_token parameter at creation time - Four cancellation checkpoints in event loop: 1. Start of event loop cycle 2. Before model execution 3. During model response streaming 4. Before tool execution - New 'cancelled' stop reason in StopReason type - Token automatically added to invocation_state for event loop access Implementation details: - CancellationToken uses threading.Lock for thread safety - Zero usage/metrics returned when cancelled (no model execution occurred) - Cancellation detected at checkpoints returns proper empty message structure - Token shared by reference across packages in same process Tests included: - Unit tests for CancellationToken thread safety and behavior - Unit tests for agent cancellation at different checkpoints - Integration tests with real model providers (require credentials)
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.
Description
Implement CancellationToken to enable graceful cancellation of agent execution from external contexts (e.g., web requests, background threads).
Key features:
Implementation details:
Tests included:
Related Issues
#81
Documentation PR
Type of Change
New feature
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
Tests included:
Unit tests for CancellationToken thread safety and behavior
Unit tests for agent cancellation at different checkpoints
Integration tests with real model providers (require credentials)
I ran
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.