Implement a NopReceiver
#419
Merged
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
Signed-off-by: Sahas Subramanian <[email protected]>
Signed-off-by: Sahas Subramanian <[email protected]>
Signed-off-by: Sahas Subramanian <[email protected]>
Signed-off-by: Sahas Subramanian <[email protected]>
github-actions
bot
added
part:docs
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new experimental NopReceiver that acts as a place‐holder receiver, along with updates to tests and deprecation of OptionalReceiver.
- Updated tests across multiple modules to use asynchronous closing via aclose().
- Added a new experimental NopReceiver and its corresponding tests.
- Deprecated OptionalReceiver and updated the export order in the experimental module.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/test_merge_integration.py | Replaced synchronous close() calls with asynchronous aclose() calls in channel handling. |
| tests/test_broadcast.py | Updated broadcast channel closing to use aclose() consistently. |
| tests/test_anycast.py | Updated anycast channel closing to use aclose() consistently. |
| tests/experimental/test_nop_receiver.py | Added tests to verify the behavior of the new NopReceiver. |
| src/frequenz/channels/experimental/_optional_receiver.py | Deprecated OptionalReceiver with a recommendation to use NopReceiver instead. |
| src/frequenz/channels/experimental/_nop_receiver.py | Introduced the new NopReceiver implementation that never receives a message. |
| src/frequenz/channels/experimental/init.py | Updated the module exports to include NopReceiver and reposition WithPrevious for clarity. |
| RELEASE_NOTES.md | Documented the new NopReceiver feature and migration notes for OptionalReceiver deprecation. |
| from ._with_previous import WithPrevious | ||
|
|
||
| __all__ = [ | ||
| "NopReceiver", |
There was a problem hiding this comment.
[nitpick] Consider sorting the all list alphabetically to improve readability and maintainability.
|
Can drop the deprecation commit, if you want to postpone it. |
Marenz
reviewed
May 14, 2025
|
|
||
| @override | ||
| async def ready(self) -> bool: | ||
| """Wait for ever unless the receiver is closed. |
Marenz
approved these changes
May 14, 2025
llucax
reviewed
May 15, 2025
There was a problem hiding this comment.
I know I suggested this name, but recently I needed something similar for a context manager and bumped into nullcontext, so maybe NullReceiver could be more familiar to python users.
But just an idea, I think the gain, if any, is marginal anyways...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
It is useful as a place-holder receiver for use in contexts where a receiver is necessary, but one is not available.