dex-python-sdk 0.4.0__tar.gz → 0.5.0__tar.gz

{dex_python_sdk-0.4.0 → dex_python_sdk-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dex-python-sdk
-Version: 0.4.0
+Version: 0.5.0
 Requires-Dist: grpcio>=1.83.0
 Requires-Dist: grpcio-status>=1.83.0
 Requires-Dist: protobuf>=7.35.1

{dex_python_sdk-0.4.0 → dex_python_sdk-0.5.0}/dex/__init__.py

@@ -103,6 +103,7 @@ from dex.stream import (
     BufferedTextStream,
     Stream,
     StreamMessage,
+    StreamMessagesPage,
 )
 from dex.subflow import SubFlow
 from dex.timer import Timer
@@ -190,6 +191,7 @@ __all__ = [
     "StepOptions",
     "Stream",
     "StreamMessage",
+    "StreamMessagesPage",
     "StopFlowOptions",
     "StopType",
     "Timer",

{dex_python_sdk-0.4.0 → dex_python_sdk-0.5.0}/dex/async_client.py

@@ -48,7 +48,7 @@ from dex.flow_result import FlowResult, flow_result_from_proto
 from dex.runtime_errors import FlowErrorType
 from dex.step import RetryPolicy, StepDurability
 from dex.step_execution import StepExecutionId, TimerId
-from dex.stream import Stream, StreamMessage
+from dex.stream import Stream, StreamMessage, StreamMessagesPage
 
 InputT = TypeVar("InputT")
 OutputT = TypeVar("OutputT")
@@ -767,6 +767,73 @@ class AsyncClient:
             response.message.source,
         )
 
+    async def list_stream_messages(
+        self,
+        flow_id: str,
+        stream: Stream[ValueT],
+        page_size: int,
+        before_page_token: str = "",
+    ) -> StreamMessagesPage[ValueT]:
+        """Await one newest-first page of retained Stream messages without waiting for writes.
+
+        An empty token starts at the retained tail. Pass the returned page token
+        unchanged to read older messages. Trimming may remove messages between pages.
+
+        Args:
+            flow_id: Logical Flow instance ID used as the Stream instance key.
+            stream: Exact Stream object registered in one Flow schema.
+            page_size: Positive maximum message count within the server-configured limit.
+            before_page_token: Opaque token from the preceding page, or ``""`` first.
+
+        Returns:
+            Decoded messages in newest-first order and the next-page token.
+
+        Raises:
+            ValueError: If ``page_size`` is not positive.
+            FlowDefinitionError: If the Stream is not registered.
+            ValueMappingError: If a retained message cannot be decoded.
+            DexServiceError: If FlowService cannot list the Stream.
+        """
+        if page_size < 1:
+            raise ValueError("Stream page size must be positive")
+        flow = self.registry._flow_for_stream(stream)
+        response = cast(
+            pb.ListStreamMessagesResponse,
+            await self._call(
+                self._service.ListStreamMessages,
+                pb.ListStreamMessagesRequest(
+                    flow_id=require_name(flow_id),
+                    flow_type=flow.name,
+                    stream_name=stream.name,
+                    page_size=page_size,
+                    before_page_token=before_page_token,
+                ),
+                "list_stream_messages",
+                flow_id,
+                "none",
+            ),
+        )
+        messages: list[StreamMessage[ValueT]] = []
+        for message in response.messages:
+            if (
+                not message.HasField("value")
+                or not message.HasField("created_time")
+                or not message.resume_token
+            ):
+                raise ValueError("Dex returned an incomplete Stream message")
+            messages.append(
+                StreamMessage(
+                    self._values.decode(
+                        message.value,
+                        self._values.codec(stream.value_type),
+                    ),
+                    message.resume_token,
+                    message.created_time.ToDatetime(tzinfo=timezone.utc),
+                    message.source,
+                )
+            )
+        return StreamMessagesPage(messages, response.next_page_token)
+
     async def wait_for_flow(
         self,
         flow_id: str,

{dex_python_sdk-0.4.0 → dex_python_sdk-0.5.0}/dex/client.py

@@ -48,7 +48,7 @@ from dex.flow_result import FlowResult, flow_result_from_proto
 from dex.runtime_errors import FlowErrorType
 from dex.step import RetryPolicy, StepDurability
 from dex.step_execution import StepExecutionId, TimerId
-from dex.stream import Stream, StreamMessage
+from dex.stream import Stream, StreamMessage, StreamMessagesPage
 
 InputT = TypeVar("InputT")
 OutputT = TypeVar("OutputT")
@@ -766,6 +766,73 @@ class Client:
             response.message.source,
         )
 
+    def list_stream_messages(
+        self,
+        flow_id: str,
+        stream: Stream[ValueT],
+        page_size: int,
+        before_page_token: str = "",
+    ) -> StreamMessagesPage[ValueT]:
+        """Return one newest-first page of retained Stream messages without waiting.
+
+        An empty token starts at the retained tail. Pass the returned page token
+        unchanged to read older messages. Trimming may remove messages between pages.
+
+        Args:
+            flow_id: Logical Flow instance ID used as the Stream instance key.
+            stream: Exact Stream object registered in one Flow schema.
+            page_size: Positive maximum message count within the server-configured limit.
+            before_page_token: Opaque token from the preceding page, or ``""`` first.
+
+        Returns:
+            Decoded messages in newest-first order and the next-page token.
+
+        Raises:
+            ValueError: If ``page_size`` is not positive.
+            FlowDefinitionError: If the Stream is not registered.
+            ValueMappingError: If a retained message cannot be decoded.
+            DexServiceError: If FlowService cannot list the Stream.
+        """
+        if page_size < 1:
+            raise ValueError("Stream page size must be positive")
+        flow = self.registry._flow_for_stream(stream)
+        response = cast(
+            pb.ListStreamMessagesResponse,
+            self._call(
+                self._service.ListStreamMessages,
+                pb.ListStreamMessagesRequest(
+                    flow_id=require_name(flow_id),
+                    flow_type=flow.name,
+                    stream_name=stream.name,
+                    page_size=page_size,
+                    before_page_token=before_page_token,
+                ),
+                "list_stream_messages",
+                flow_id,
+                "none",
+            ),
+        )
+        messages: list[StreamMessage[ValueT]] = []
+        for message in response.messages:
+            if (
+                not message.HasField("value")
+                or not message.HasField("created_time")
+                or not message.resume_token
+            ):
+                raise ValueError("Dex returned an incomplete Stream message")
+            messages.append(
+                StreamMessage(
+                    self._values.decode(
+                        message.value,
+                        self._values.codec(stream.value_type),
+                    ),
+                    message.resume_token,
+                    message.created_time.ToDatetime(tzinfo=timezone.utc),
+                    message.source,
+                )
+            )
+        return StreamMessagesPage(messages, response.next_page_token)
+
     def wait_for_flow(
         self,
         flow_id: str,