Skip to content
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

Jump to bottom

Add a tip about the returned receiver type for map() #271

Merged
merged 1 commit into from
Feb 2, 2024
Merged

Add a tip about the returned receiver type for map() #271

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
6 changes: 6 additions & 0 deletions src/frequenz/channels/_receiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,12 @@ async def receive(self) -> _T_co:
def map(self, call: Callable[[_T_co], _U_co]) -> Receiver[_U_co]:
"""Return a receiver with `call` applied on incoming messages.

Tip:
The returned receiver type won't have all the methods of the original
receiver. If you need to access methods of the original receiver that are
not part of the `Receiver` interface you should save a reference to the
original receiver and use that instead.

Args:
call: function to apply on incoming messages.

Expand Down
Loading