dex-python-sdk 0.11.0__tar.gz → 0.12.0__tar.gz

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dex-python-sdk
-Version: 0.11.0
+Version: 0.12.0
 Requires-Dist: grpcio>=1.83.0
 Requires-Dist: grpcio-status>=1.83.0
 Requires-Dist: protobuf>=7.35.1
@@ -362,15 +362,12 @@ include buffered publishes, and omit empty instances. Keys are decoded and
 sorted. Use `force_complete_if_channels_empty(...)` for conditional completion.
 
 Request IDs are optional for both durable waits. When omitted, the server
-derives a namespaced stable ID from the Step execution or Attribute condition,
-such as `wait-for-attribute:myInt>10`. Reuse an override only for the same
-logical wait. The Client automatically reattaches transport long polls. If an
-earlier Update with that ID exhausted its handler budget, the server appends an
-increasing `-N` suffix and starts a new Update. `maximum_wait_time` is optional
-and is the total handler budget across reattachments; zero waits indefinitely.
-A positive budget expiry raises `WaitHandlerTimeoutError`. An abandoned infinite
-wait remains accepted and counts against Temporal's in-flight Update limit until
-it completes or the Flow closes.
+derives a stable ID from the Step execution or Attribute condition. Reuse an
+override only for the same wait. `maximum_wait_time` is optional. Leave it at
+zero for normal use and bound one response with the caller deadline. Positive
+values are an exceptional safety valve: short budgets can add many Temporal
+Update events to Workflow history. If a positive value is truly needed, prefer
+at least one minute. A positive expiry raises `WaitHandlerTimeoutError`.
 
 `Client.wait_for_flow` and `AsyncClient.wait_for_flow` return a
 `FlowResult` after hydrating every output-bearing completion. Use

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/README.md

@@ -346,15 +346,12 @@ include buffered publishes, and omit empty instances. Keys are decoded and
 sorted. Use `force_complete_if_channels_empty(...)` for conditional completion.
 
 Request IDs are optional for both durable waits. When omitted, the server
-derives a namespaced stable ID from the Step execution or Attribute condition,
-such as `wait-for-attribute:myInt>10`. Reuse an override only for the same
-logical wait. The Client automatically reattaches transport long polls. If an
-earlier Update with that ID exhausted its handler budget, the server appends an
-increasing `-N` suffix and starts a new Update. `maximum_wait_time` is optional
-and is the total handler budget across reattachments; zero waits indefinitely.
-A positive budget expiry raises `WaitHandlerTimeoutError`. An abandoned infinite
-wait remains accepted and counts against Temporal's in-flight Update limit until
-it completes or the Flow closes.
+derives a stable ID from the Step execution or Attribute condition. Reuse an
+override only for the same wait. `maximum_wait_time` is optional. Leave it at
+zero for normal use and bound one response with the caller deadline. Positive
+values are an exceptional safety valve: short budgets can add many Temporal
+Update events to Workflow history. If a positive value is truly needed, prefer
+at least one minute. A positive expiry raises `WaitHandlerTimeoutError`.
 
 `Client.wait_for_flow` and `AsyncClient.wait_for_flow` return a
 `FlowResult` after hydrating every output-bearing completion. Use

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/async_client.py

@@ -738,23 +738,22 @@ class AsyncClient:
         step_execution_id: StepExecutionId,
         options: WaitForStepCompletionOptions,
     ) -> None:
-        """Await one Step execution's completion or its handler budget expiry.
+        """Await one Step execution's completion or its wait budget expiry.
 
         The server derives a stable Request ID from the Step execution when none
-        is supplied. Transport long polls automatically reattach to the same wait.
-        Leave the maximum wait time at zero for ordinary infinite waits. A positive
-        value releases per-Flow in-flight Update capacity for abandoned waits.
-        The budget spans Continue-as-New and is distinct from the caller's lifetime.
-        Retrying after expiry creates a new Update generation.
+        is supplied. Leave the maximum wait time at zero for normal use. Positive
+        values are exceptional because short budgets can add many Temporal Update
+        events to Workflow history; prefer at least one minute when nonzero. A
+        positive value bounds the caller-visible wait.
 
         Args:
             flow_id: The non-empty active Flow ID.
             step_execution_id: The Step type and positive execution number.
-            options: The optional Request ID override and total handler wait budget.
+            options: The optional Request ID override and total wait budget.
 
         Raises:
-            ValueError: If the Request ID or handler wait budget is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            ValueError: If the Request ID or wait budget is invalid.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -792,24 +791,24 @@ class AsyncClient:
 
         The Client returns the value observed by the successful wait. The server
         derives a stable Request ID from the condition when none is supplied.
-        Leave the maximum wait time at zero for ordinary infinite waits. A positive
-        value releases per-Flow in-flight Update capacity for rarely matching waits.
-        The budget spans transport reattachments and Continue-as-New, and is distinct
-        from the caller's lifetime. Retrying after expiry creates a new Update generation.
+        Leave the maximum wait time at zero for normal use. Positive values are
+        exceptional because short budgets can add many Temporal Update events to
+        Workflow history; prefer at least one minute when nonzero. A positive value
+        bounds the caller-visible wait.
         JSON, bytes, and null operands raise ``ValueError`` before transport.
 
         Args:
             flow_id: The non-empty active Flow ID.
             attribute: The registered singleton Attribute to observe.
             match: The scalar predicate to await.
-            options: The optional Request ID override and total handler wait budget.
+            options: The optional Request ID override and total wait budget.
 
         Returns:
             The current Attribute value that satisfied ``match``.
 
         Raises:
             ValueError: If an identifier, option, or match operand is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -841,7 +840,7 @@ class AsyncClient:
 
         Raises:
             ValueError: If an identifier, option, or match operand is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -871,7 +870,7 @@ class AsyncClient:
         Raises:
             TypeError: If arguments do not match the Attribute definition.
             ValueError: If an identifier, option, or expected value is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/client.py

@@ -734,23 +734,22 @@ class Client:
         step_execution_id: StepExecutionId,
         options: WaitForStepCompletionOptions,
     ) -> None:
-        """Block until one Step execution completes or its handler budget expires.
+        """Block until one Step execution completes or its wait budget expires.
 
         The server derives a stable Request ID from the Step execution when none
-        is supplied. Transport long polls automatically reattach to the same wait.
-        Leave the maximum wait time at zero for ordinary infinite waits. A positive
-        value releases per-Flow in-flight Update capacity for abandoned waits.
-        The budget spans Continue-as-New and is distinct from the caller's lifetime.
-        Retrying after expiry creates a new Update generation.
+        is supplied. Leave the maximum wait time at zero for normal use. Positive
+        values are exceptional because short budgets can add many Temporal Update
+        events to Workflow history; prefer at least one minute when nonzero. A
+        positive value bounds the caller-visible wait.
 
         Args:
             flow_id: The non-empty active Flow ID.
             step_execution_id: The Step type and positive execution number.
-            options: The optional Request ID override and total handler wait budget.
+            options: The optional Request ID override and total wait budget.
 
         Raises:
-            ValueError: If the Request ID or handler wait budget is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            ValueError: If the Request ID or wait budget is invalid.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -788,24 +787,24 @@ class Client:
 
         The Client returns the value observed by the successful wait. The server
         derives a stable Request ID from the condition when none is supplied.
-        Leave the maximum wait time at zero for ordinary infinite waits. A positive
-        value releases per-Flow in-flight Update capacity for rarely matching waits.
-        The budget spans transport reattachments and Continue-as-New, and is distinct
-        from the caller's lifetime. Retrying after expiry creates a new Update generation.
+        Leave the maximum wait time at zero for normal use. Positive values are
+        exceptional because short budgets can add many Temporal Update events to
+        Workflow history; prefer at least one minute when nonzero. A positive value
+        bounds the caller-visible wait.
         JSON, bytes, and null operands raise ``ValueError`` before transport.
 
         Args:
             flow_id: The non-empty active Flow ID.
             attribute: The registered singleton Attribute to observe.
             match: The scalar predicate to await.
-            options: The optional Request ID override and total handler wait budget.
+            options: The optional Request ID override and total wait budget.
 
         Returns:
             The current Attribute value that satisfied ``match``.
 
         Raises:
             ValueError: If an identifier, option, or match operand is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -838,7 +837,7 @@ class Client:
 
         Raises:
             ValueError: If an identifier, option, or match operand is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """
@@ -868,7 +867,7 @@ class Client:
         Raises:
             TypeError: If arguments do not match the Attribute definition.
             ValueError: If an identifier, option, or expected value is invalid.
-            WaitHandlerTimeoutError: If a positive handler budget expires first.
+            WaitHandlerTimeoutError: If a positive wait budget expires first.
             FlowNotActiveError: If the Flow closes first.
             DexServiceError: If FlowService cannot perform the wait.
         """

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/dexpb/dex_pb2_grpc.py

@@ -51,7 +51,7 @@ class FlowServiceStub:
     Aborted           — locking RPC attribute lock contention
     sub_status WORKER_API_ERROR
     ResourceExhausted — worker connection pool / message size limits
-    DeadlineExceeded  — transport long poll or durable wait handler deadline
+    DeadlineExceeded  — transport long poll or caller-visible wait deadline
     sub_status LONG_POLL_TIME_OUT or WAIT_HANDLER_TIME_OUT
     Canceled          — caller canceled the RPC context
     Unavailable       — Temporal/Cadence backend or Stream Store backend unavailable;
@@ -69,7 +69,7 @@ class FlowServiceStub:
     WORKER_API_ERROR + OriginalWorker* when present.
     WaitForStepCompletion / WaitForAttribute — Temporal-only sync updates; API
     retries CONTINUE_AS_NEW_PREEMPTED (not exposed as Internal). Transport
-    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Handler timeout →
+    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Wait-budget timeout →
     DeadlineExceeded + WAIT_HANDLER_TIME_OUT. WaitForAttribute rejects waiting
     on blob-backed stored attributes with FailedPrecondition.
     WaitForFlow — long-poll timeout while still running → DeadlineExceeded +
@@ -250,7 +250,7 @@ class FlowServiceServicer:
     Aborted           — locking RPC attribute lock contention
     sub_status WORKER_API_ERROR
     ResourceExhausted — worker connection pool / message size limits
-    DeadlineExceeded  — transport long poll or durable wait handler deadline
+    DeadlineExceeded  — transport long poll or caller-visible wait deadline
     sub_status LONG_POLL_TIME_OUT or WAIT_HANDLER_TIME_OUT
     Canceled          — caller canceled the RPC context
     Unavailable       — Temporal/Cadence backend or Stream Store backend unavailable;
@@ -268,7 +268,7 @@ class FlowServiceServicer:
     WORKER_API_ERROR + OriginalWorker* when present.
     WaitForStepCompletion / WaitForAttribute — Temporal-only sync updates; API
     retries CONTINUE_AS_NEW_PREEMPTED (not exposed as Internal). Transport
-    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Handler timeout →
+    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Wait-budget timeout →
     DeadlineExceeded + WAIT_HANDLER_TIME_OUT. WaitForAttribute rejects waiting
     on blob-backed stored attributes with FailedPrecondition.
     WaitForFlow — long-poll timeout while still running → DeadlineExceeded +
@@ -615,7 +615,7 @@ class FlowService:
     Aborted           — locking RPC attribute lock contention
     sub_status WORKER_API_ERROR
     ResourceExhausted — worker connection pool / message size limits
-    DeadlineExceeded  — transport long poll or durable wait handler deadline
+    DeadlineExceeded  — transport long poll or caller-visible wait deadline
     sub_status LONG_POLL_TIME_OUT or WAIT_HANDLER_TIME_OUT
     Canceled          — caller canceled the RPC context
     Unavailable       — Temporal/Cadence backend or Stream Store backend unavailable;
@@ -633,7 +633,7 @@ class FlowService:
     WORKER_API_ERROR + OriginalWorker* when present.
     WaitForStepCompletion / WaitForAttribute — Temporal-only sync updates; API
     retries CONTINUE_AS_NEW_PREEMPTED (not exposed as Internal). Transport
-    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Handler timeout →
+    timeout → DeadlineExceeded + LONG_POLL_TIME_OUT. Wait-budget timeout →
     DeadlineExceeded + WAIT_HANDLER_TIME_OUT. WaitForAttribute rejects waiting
     on blob-backed stored attributes with FailedPrecondition.
     WaitForFlow — long-poll timeout while still running → DeadlineExceeded +

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/flow_options.py

@@ -28,7 +28,7 @@ class IdReusePolicy(Enum):
     """Control whether ``start_flow`` may reuse an existing Flow ID.
 
     Attributes:
-        DEFAULT: Use the Dex server's default reuse policy.
+        DEFAULT: Use the Dex server default, which rejects every previously used Flow ID.
         ALLOW_IF_PREVIOUS_FAILED: Reuse only after an unsuccessful closed run.
         ALLOW_IF_NOT_RUNNING: Reuse after any closed run.
         ALLOW_TERMINATE_IF_RUNNING: Terminate an active run and start the new run.

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/runtime_errors.py

@@ -24,7 +24,7 @@ class ErrorSubStatus(Enum):
         WORKER_API_ERROR: An application Worker rejected or failed an invocation.
         LONG_POLL_TIMEOUT: A wait ended without observing its condition.
         CHANNEL_MESSAGE_NOT_FOUND: A pending Channel message ID no longer exists.
-        WAIT_HANDLER_TIMEOUT: A durable wait reached its total handler budget.
+        WAIT_HANDLER_TIMEOUT: A caller-visible wait budget expired.
     """
 
     UNCATEGORIZED = "uncategorized"
@@ -166,7 +166,7 @@ class LongPollTimeoutError(DexServiceError):
 
 
 class WaitHandlerTimeoutError(DexServiceError):
-    """Indicate that a durable wait reached its caller-defined total budget."""
+    """Indicate that a caller-defined wait budget expired."""
 
     pass
 

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/dex/wait_options.py

@@ -24,17 +24,16 @@ class WaitForStepCompletionOptions:
 
     The server derives a stable Request ID from the Step execution when
     ``request_id`` is empty. Reuse an override only for the same logical wait.
-    Leave ``maximum_wait_time`` at zero for ordinary infinite waits. A positive
-    value releases per-Flow in-flight Update capacity for abandoned or rarely
-    completing waits. It spans transport reattachments and Continue-as-New,
-    unlike a caller or transport deadline. Retrying after expiry creates a new
-    Update generation.
+    Leave ``maximum_wait_time`` at zero for normal use. Positive values are an
+    exceptional safety valve. Short budgets can add many Temporal Update events
+    to Workflow history; prefer at least one minute when nonzero. A positive
+    value bounds the caller-visible wait.
 
     Attributes:
         request_id: An optional override for the server-derived stable ID.
-        maximum_wait_time: The accepted handler lifetime. Zero waits indefinitely
-            and is recommended for ordinary waits. A positive value releases
-            per-Flow in-flight capacity.
+        maximum_wait_time: The caller-visible wait budget. Zero waits indefinitely.
+            Positive values are rare; prefer at least one minute to limit Temporal
+            Update history growth.
     """
 
     request_id: str = ""
@@ -47,17 +46,16 @@ class WaitForAttributeOptions:
 
     The server derives a stable Request ID from the Attribute condition when
     ``request_id`` is empty. Reuse an override only for the same logical predicate.
-    Leave ``maximum_wait_time`` at zero for ordinary infinite waits. A positive
-    value releases per-Flow in-flight Update capacity for abandoned or rarely
-    matching waits. It spans transport reattachments and Continue-as-New,
-    unlike a caller or transport deadline. Retrying after expiry creates a new
-    Update generation.
+    Leave ``maximum_wait_time`` at zero for normal use. Positive values are an
+    exceptional safety valve. Short budgets can add many Temporal Update events
+    to Workflow history; prefer at least one minute when nonzero. A positive
+    value bounds the caller-visible wait.
 
     Attributes:
         request_id: An optional override for the server-derived stable ID.
-        maximum_wait_time: The accepted handler lifetime. Zero waits indefinitely
-            and is recommended for ordinary waits. A positive value releases
-            per-Flow in-flight capacity.
+        maximum_wait_time: The caller-visible wait budget. Zero waits indefinitely.
+            Positive values are rare; prefer at least one minute to limit Temporal
+            Update history growth.
     """
 
     request_id: str = ""

{dex_python_sdk-0.11.0 → dex_python_sdk-0.12.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "dex-python-sdk"
 # Publish uses tag sdk-python/v*; CI stamps this for release builds.
-version = "0.11.0"
+version = "0.12.0"
 description = "Python SDK for the Dex workflow engine"
 authors = [{name = "Super Durable"}]
 readme = "README.md"