GitHub

Handlers

API reference for Handlers.

class Handlers[R = Never]

The handlers of a group so far, needing R. Immutable: handle gives a new one.

Attributes

AttributeTypeDescription
group= group
by_tagMapping[str, HandlerItem]

Functions

__init__

__init__(group, by_tag, context) -> None
ParameterTypeDescription
groupEventGroup[AnyEvent]
by_tagMapping[str, HandlerFn]
contextContext[Never]
def __init__(
    self, group: EventGroup[AnyEvent], by_tag: Mapping[str, HandlerFn], context: Context[Never]
) -> None:
    self.group = group
    self._by_tag = dict(by_tag)
    self._context = context

handle

handle[P, A, E, R1 = Never](event: Event[P, A, E], handler: Callable[[HandlerInput[P]], Effect[A, E, R1]], /) -> Handlers[R | R1]
handle[R1 = Never](event: str, handler: Callable[[HandlerInput[Never]], Effect[object, object, R1]], /) -> Handlers[R | R1]

Handle event (or the event of that tag) with handler. The log provides its Identity to the handler.

ParameterTypeDescription
event
handler
@overload
def handle[P, A, E, R1 = Never](
    self,
    event: Event[P, A, E],
    handler: Callable[[HandlerInput[P]], Effect[A, E, R1]],
    /,
) -> Handlers[R | R1]: ...
@overload
def handle[R1 = Never](
    self,
    event: str,
    handler: Callable[[HandlerInput[Never]], Effect[object, object, R1]],
    /,
) -> Handlers[R | R1]: ...
def handle(
    self,
    event: AnyEvent | str,
    handler: Callable[..., Effect[object, object, object]],
    /,
) -> Handlers[object]:
    """Handle ``event`` (or the event of that tag) with ``handler``. The
    log provides its ``Identity`` to the handler."""
    tag = event if isinstance(event, str) else event.tag
    found = self.group.events.get(tag)
    if found is None or (not isinstance(event, str) and found is not event):
        raise ValueError(f"{tag!r} is not an event of {self.group!r}")
    # The overloads tie the handler's payload to the event's.
    erased = cast("HandlerFn", handler)
    return Handlers(self.group, {**self._by_tag, tag: erased}, self._context)