Skip to content

Use asyncio.Event instead of asyncio.Future in NopReceiver #429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 20, 2025
Merged

Use asyncio.Event instead of asyncio.Future in NopReceiver #429

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions src/frequenz/channels/experimental/_nop_receiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ class NopReceiver(Receiver[ReceiverMessageT_co]):

def __init__(self) -> None:
"""Initialize this instance."""
self._ready_future: asyncio.Future[bool] = (
asyncio.get_running_loop().create_future()
)
self._close_event: asyncio.Event = asyncio.Event()

@override
async def ready(self) -> bool:
Expand All @@ -31,9 +29,10 @@ async def ready(self) -> bool:
Returns:
Whether the receiver is still active.
"""
if self._ready_future.done():
if self._close_event.is_set():
return False
return await self._ready_future
await self._close_event.wait()
return False

@override
def consume(self) -> ReceiverMessageT_co: # noqa: DOC503 (raised indirectly)
Expand All @@ -48,12 +47,11 @@ def consume(self) -> ReceiverMessageT_co: # noqa: DOC503 (raised indirectly)
ReceiverStoppedError: If the receiver stopped producing messages.
ReceiverError: If there is some problem with the underlying receiver.
"""
if self._ready_future.done():
if self._close_event.is_set():
raise ReceiverStoppedError(self)
raise ReceiverError("`consume()` must be preceded by a call to `ready()`", self)

@override
def close(self) -> None:
"""Stop the receiver."""
if not self._ready_future.done():
self._ready_future.set_result(False)
self._close_event.set()
Loading