Added a done() method to BackgroundService to check for completion
#1231
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
ela-kotulska-frequenz
requested review from
Marenz
and removed request for
a team
ela-kotulska-frequenz
added
type:enhancement
ela-kotulska-frequenz
requested review from
llucax
and removed request for
Marenz and
Copilot
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new done() method to the BackgroundService to allow checking if all tasks have completed. It updates the BackgroundService implementation, adjusts tests to validate the new behavior, and documents the change in the release notes.
- Added done() method in BackgroundService.
- Updated tests to assert the correct done() states before, during, and after service execution.
- Updated release notes to capture the new feature.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| tests/actor/test_background_service.py | Added assertions to validate the done() method's behavior in various execution scenarios. |
| src/frequenz/sdk/actor/_background_service.py | Implemented the done() method that inverts the is_running status to indicate completion. |
| RELEASE_NOTES.md | Documented the new done() method feature for BackgroundService. |
This is usefull if we have type: `asyncio.Task | Actor` and need to check if actor finished. Signed-off-by: Elzbieta Kotulska <[email protected]>
ela-kotulska-frequenz
force-pushed
the
check_done
branch
from
9160642 to
8f2562e
Compare
llucax
approved these changes
Jun 3, 2025
github-project-automation
bot
moved this from To do
to Review approved
in Python SDK Roadmap
github-project-automation
bot
moved this from Review approved
to Done
in Python SDK Roadmap
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.
This is usefull if we have type:
asyncio.Task | Actorand need to check if actor finished.