temporalio.workflow._event_groups.EventGroup

class documentation

class EventGroup(ABC): (source)

Known subclasses: temporalio.workflow._event_groups._ImplicitEventGroup, temporalio.workflow._event_groups._LabelEventGroup, temporalio.workflow._event_groups._StubImplicitEventGroup

View In Hierarchy

A discrete token associating workflow commands, and the history events they produce, with a logical group for UI and observability purposes.

Multiple Event Groups may be attached to a single command, and a single Event Group may be attached to multiple commands.

Instances are created with create_event_group. They may be attached to specific commands via the event_groups option of the API producing the command, or to every command produced within a block of workflow code via scope.

Warning

Event Groups is an experimental API and may change without notice.

Method scope Context manager attaching this Event Group to every command produced within it.
Method _applied_over Return the active set resulting from entering this group's scope.
Method _to_proto Serialize as the marker attached to a workflow command.
def scope(self) -> Iterator[None]: (source)

Context manager attaching this Event Group to every command produced within it.

Scopes nest and compose: a command produced inside an inner scope carries the Event Groups of all enclosing scopes. Coroutines started within a scope inherit it, since they capture the context active at their creation.

Only usable from within a workflow.

Warning

Event Groups is an experimental API and may change without notice.

def _applied_over(self, active: _ActiveEventGroups) -> _ActiveEventGroups: (source)
overridden in temporalio.workflow._event_groups._ImplicitEventGroup, temporalio.workflow._event_groups._LabelEventGroup, temporalio.workflow._event_groups._StubImplicitEventGroup

Return the active set resulting from entering this group's scope.

def _to_proto(self) -> temporalio.api.sdk.v1.EventGroupMarker: (source)
overridden in temporalio.workflow._event_groups._ImplicitEventGroup, temporalio.workflow._event_groups._LabelEventGroup, temporalio.workflow._event_groups._StubImplicitEventGroup

Serialize as the marker attached to a workflow command.