dex-python-sdk 0.9.0__tar.gz → 0.11.2__tar.gz

{dex_python_sdk-0.9.0 → dex_python_sdk-0.11.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dex-python-sdk
-Version: 0.9.0
+Version: 0.11.2
 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.9.0 → dex_python_sdk-0.11.2}/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.9.0 → dex_python_sdk-0.11.2}/dex/async_client.py

@@ -254,13 +254,18 @@ class AsyncClient:
         """Invoke a registered RPC and await its typed result.
 
         Pass the bound method from the registered Flow instance. RPC timeout and
-        Attribute locks come from ``@rpc`` configuration.
+        Attribute locks come from ``@rpc`` configuration. A non-transactional RPC
+        without Attribute locks starts from a backend query. If the handler returns no
+        durable effects, a retained terminal execution can serve that query. Locks,
+        transactional execution, returned effects, or server policy can require an
+        active execution.
 
         Args:
             rpc_method: A bound method decorated with ``@rpc``.
             flow_id: The non-empty target Flow ID.
             input: The annotated input, or ``None`` for an input-free RPC.
-            run_id: Optional exact run; ``""`` targets the active run.
+            run_id: Optional exact run. With ``""``, the server resolves the current
+                execution.
 
         Returns:
             The decoded ``RPCResult.output``, or ``None`` for a no-output RPC.
@@ -270,7 +275,8 @@ class AsyncClient:
             RpcLockConflictError: If Attribute locks cannot be acquired.
             WorkerInvocationError: If the application handler fails.
             ValueMappingError: If input or output mapping fails.
-            DexServiceError: If the Flow is inactive or the service call fails.
+            DexServiceError: If the selected path requires an active execution or the
+                service call otherwise fails.
         """
         _, rpc = self.registry._rpc_for_method(rpc_method)
         encoded_input = (
@@ -732,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.
         """
@@ -786,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.
         """
@@ -835,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.
         """
@@ -865,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.9.0 → dex_python_sdk-0.11.2}/dex/client.py

@@ -250,17 +250,21 @@ class Client:
         *,
         run_id: str = "",
     ) -> Any:
-        """Synchronously invoke a registered RPC on an active Flow.
+        """Synchronously invoke a registered RPC on a Flow execution.
 
         Pass the bound method from the same registered Flow instance. RPC timeout and
         Attribute locks come from its ``@rpc`` decorator. The call blocks until the
-        handler returns, fails, or times out.
+        handler returns, fails, or times out. A non-transactional RPC without Attribute
+        locks starts from a backend query. If the handler returns no durable effects, a
+        retained terminal execution can serve that query. Locks, transactional execution,
+        returned effects, or server policy can require an active execution.
 
         Args:
             rpc_method: A bound method decorated with ``@rpc``.
             flow_id: The non-empty target Flow ID.
             input: The annotated RPC input, or ``None`` for an input-free RPC.
-            run_id: Optional exact run; ``""`` targets the active run.
+            run_id: Optional exact run. With ``""``, the server resolves the current
+                execution.
 
         Returns:
             The decoded ``RPCResult.output``, or ``None`` for a no-output RPC.
@@ -270,7 +274,8 @@ class Client:
             RpcLockConflictError: If requested Attribute locks cannot be acquired.
             WorkerInvocationError: If the application handler fails.
             ValueMappingError: If input or output mapping fails.
-            DexServiceError: If the Flow is inactive or the service call fails.
+            DexServiceError: If the selected path requires an active execution or the
+                service call otherwise fails.
         """
         _, rpc = self.registry._rpc_for_method(rpc_method)
         encoded_input = (
@@ -729,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.
         """
@@ -783,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.
         """
@@ -833,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.
         """
@@ -863,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.
         """