Python: Add workflow cancellation sample #2732
Open
+104
−0
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
Add sample demonstrating how to cancel a running workflow using asyncio tasks. Shows both cancellation mid-execution and normal completion paths. Useful for implementing timeouts, graceful shutdown, or A2A executors.
markwallace-microsoft
added
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Python sample demonstrating workflow cancellation using asyncio tasks. The sample shows how to gracefully cancel a running workflow mid-execution as well as how to run a workflow to completion, providing a practical pattern for implementing timeouts, graceful shutdown, or cancellation support in agent-to-agent executors.
Key Changes:
- New workflow cancellation sample with clear demonstration of both cancellation and completion scenarios
- Three-step sequential workflow with timing designed to show mid-execution cancellation
- Documentation update in README.md to reference the new sample
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| python/samples/getting_started/workflows/control-flow/workflow_cancellation.py | New sample demonstrating workflow cancellation using asyncio.create_task() and task.cancel() patterns, with both cancellation and completion execution paths |
| python/samples/getting_started/workflows/README.md | Added reference to the new workflow cancellation sample in the control-flow section |
|
thx for the quick turn-around! |
TaoChenOSU
approved these changes
Dec 10, 2025
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.
Motivation and Context
Add sample demonstrating how to cancel a running workflow using asyncio
tasks. Shows both cancellation mid-execution and normal completion paths.
Useful for implementing timeouts, graceful shutdown, or A2A executors, or cancellation from web app interfaces.
Added this based on a dev request on "how to cancel workflows"
Description
Contribution Checklist