Skip to content

Commit 170d570

Browse files
jssmithclaude
andcommitted
workflow_streams: rename module from workflow_stream
Public surface moves from temporalio.contrib.workflow_stream to temporalio.contrib.workflow_streams. Internal signal/update/query names (__temporal_workflow_stream_*) are wire identifiers and stay unchanged so existing histories and mixed-version clients keep working. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent a412d64 commit 170d570

14 files changed

Lines changed: 16 additions & 16 deletions

File tree

temporalio/contrib/google_adk_agents/_model.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
import temporalio.workflow
1010
from temporalio import activity, workflow
11-
from temporalio.contrib.workflow_stream import WorkflowStreamClient
11+
from temporalio.contrib.workflow_streams import WorkflowStreamClient
1212
from temporalio.exceptions import ApplicationError
1313
from temporalio.workflow import ActivityConfig
1414

@@ -121,7 +121,7 @@ def __init__(
121121
callers invoke ``generate_content_async(stream=True)``;
122122
if ``None``, the streaming call raises before scheduling
123123
an activity. The workflow must host a
124-
:class:`temporalio.contrib.workflow_stream.WorkflowStream`
124+
:class:`temporalio.contrib.workflow_streams.WorkflowStream`
125125
to receive the publishes; otherwise the signals are
126126
unhandled and dropped. Streaming support is
127127
experimental and may change in future versions.

temporalio/contrib/openai_agents/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ agents-SDK `StreamEvent` union (so raw model events arrive as
590590
`RawResponsesStreamEvent.data`).
591591

592592
External consumers (UIs, tracing pipelines, etc.) observe events as
593-
they arrive by hosting a [`WorkflowStream`](../workflow_stream/README.md)
593+
they arrive by hosting a [`WorkflowStream`](../workflow_streams/README.md)
594594
in the workflow and subscribing with `WorkflowStreamClient`. The
595595
streaming activity publishes each event to the topic configured on
596596
`ModelActivityParameters.streaming_event_topic`. The topic is required
@@ -621,7 +621,7 @@ class MyAgent:
621621

622622
To publish raw model events to external subscribers, host a
623623
`WorkflowStream` in the workflow and configure
624-
`OpenAIAgentsPlugin(model_params=ModelActivityParameters(streaming_event_topic="events"))`. See [`temporalio.contrib.workflow_stream`](../workflow_stream/README.md) for the
624+
`OpenAIAgentsPlugin(model_params=ModelActivityParameters(streaming_event_topic="events"))`. See [`temporalio.contrib.workflow_streams`](../workflow_streams/README.md) for the
625625
publisher and subscriber API.
626626

627627
`RunResultStreaming.stream_events()` yields the agents-SDK

temporalio/contrib/openai_agents/_invoke_model_activity.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444

4545
from temporalio import activity
4646
from temporalio.contrib.openai_agents._heartbeat_decorator import _auto_heartbeater
47-
from temporalio.contrib.workflow_stream import WorkflowStreamClient
47+
from temporalio.contrib.workflow_streams import WorkflowStreamClient
4848
from temporalio.exceptions import ApplicationError
4949

5050

temporalio/contrib/openai_agents/_model_parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class ModelActivityParameters:
7474
calls ``Runner.run_streamed``. Required for ``Runner.run_streamed``;
7575
if left as ``None``, ``run_streamed`` raises before scheduling any
7676
activity. The workflow must host a
77-
:class:`temporalio.contrib.workflow_stream.WorkflowStream` to receive
77+
:class:`temporalio.contrib.workflow_streams.WorkflowStream` to receive
7878
the publishes; otherwise the signals are unhandled and dropped.
7979
8080
Streaming is incompatible with ``use_local_activity`` (local activities
File renamed without changes.

temporalio/contrib/workflow_stream/__init__.py renamed to temporalio/contrib/workflow_streams/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
:py:class:`WorkflowStreamClient` for the external client interface.
1313
"""
1414

15-
from temporalio.contrib.workflow_stream._client import WorkflowStreamClient
16-
from temporalio.contrib.workflow_stream._stream import WorkflowStream
17-
from temporalio.contrib.workflow_stream._types import (
15+
from temporalio.contrib.workflow_streams._client import WorkflowStreamClient
16+
from temporalio.contrib.workflow_streams._stream import WorkflowStream
17+
from temporalio.contrib.workflow_streams._types import (
1818
PollInput,
1919
PollResult,
2020
PublishEntry,
File renamed without changes.
File renamed without changes.
File renamed without changes.

tests/contrib/google_adk_agents/test_adk_streaming.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
from temporalio import workflow
2424
from temporalio.client import Client, WorkflowFailureError
2525
from temporalio.contrib.google_adk_agents import GoogleAdkPlugin, TemporalModel
26-
from temporalio.contrib.workflow_stream import WorkflowStream, WorkflowStreamClient
26+
from temporalio.contrib.workflow_streams import WorkflowStream, WorkflowStreamClient
2727
from temporalio.worker import Worker
2828

2929
logger = logging.getLogger(__name__)

0 commit comments

Comments
 (0)