temporalio.contrib.workflow_streams

package documentation
(source)

Workflow Streams for Temporal workflows.

Warning

This package is experimental and may change in future versions.

The Workflow Streams contrib library gives a workflow a durable, offset-addressed event channel built from Signals and polling Updates with an SSE bridge. Cost scales with durable batches, not tokens. Latency is around 100ms per roundtrip; not for ultra-low-latency voice.

See WorkflowStream for the workflow-side stream object and WorkflowStreamClient for the external client interface.

Module _client External-side client for Workflow Streams.
Module _stream Workflow-side stream object for Workflow Streams.
Module _topic_handle Typed topic handles for Workflow Streams.
Module _types Shared data types for the Workflow Streams contrib module.

From __init__.py:

Class PollInput Update payload: request to poll for new items.
Class PollResult Update response: items matching the poll request.
Class PublishEntry A single entry to publish via signal (wire type).
Class PublisherState Per-publisher dedup state.
Class PublishInput Signal payload: batch of entries to publish.
Class TopicHandle Client-side handle for publishing to and subscribing from a single topic.
Class WorkflowStream Workflow-side stream object — append-only log with publish/poll handlers.
Class WorkflowStreamClient Client for publishing to and subscribing from a workflow stream.
Class WorkflowStreamItem A single item in the workflow stream's log.
Class WorkflowStreamState Serializable snapshot of stream state for continue-as-new.
Class WorkflowTopicHandle Workflow-side handle for publishing to a single topic.