dex-python-sdk 0.2.4__tar.gz → 0.2.5__tar.gz

{dex_python_sdk-0.2.4 → dex_python_sdk-0.2.5}/PKG-INFO

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

{dex_python_sdk-0.2.4 → dex_python_sdk-0.2.5}/dex/__init__.py

@@ -8,6 +8,7 @@
 # Legacy Materials remain under their original licenses.
 # See LICENSE and LEGACY_NOTICES.md.
 
+from dex._grpc_errors import RetryAfterError, retry_after
 from dex.async_client import AsyncClient
 from dex.async_worker import AsyncWorker
 from dex.attribute import (
@@ -140,6 +141,7 @@ __all__ = [
     "LongPollTimeoutError",
     "PersistenceSchema",
     "RPCResult",
+    "RetryAfterError",
     "RpcLockConflictError",
     "Registry",
     "TimeTravelOptions",
@@ -184,4 +186,5 @@ __all__ = [
     "go_to_many",
     "open_blob_cache",
     "rpc",
+    "retry_after",
 ]

{dex_python_sdk-0.2.4 → dex_python_sdk-0.2.5}/dex/_grpc_errors.py

@@ -37,7 +37,18 @@ _STACK_TRACE_TRUNCATION_MARKER = b"\n... stack trace truncated by Dex Python SDK
 
 @dataclass(frozen=True)
 class RetryAfterError(Exception):
-    """Requests a delay before the next retry while preserving the current failure."""
+    """Requests a delay before Dex retries a failed worker method.
+
+    Raise an instance with :func:`retry_after` from a Step method when the
+    failure is retryable but the next attempt should happen at a known time.
+    Dex reports the original cause as the worker failure and uses the requested
+    delay instead of the retry policy's calculated interval.
+
+    Attributes:
+        after_seconds (int): Positive delay in seconds before the next retry.
+        cause (BaseException): Original failure reported to Dex and re-raised
+            as the retry cause.
+    """
 
     after_seconds: int
     cause: BaseException
@@ -47,6 +58,23 @@ class RetryAfterError(Exception):
 
 
 def retry_after(after_seconds: int, cause: BaseException) -> RetryAfterError:
+    """Creates an error that sets the delay before Dex retries a worker method.
+
+    Raise the returned error from a Step method after an external dependency
+    reports that it is not ready. For example::
+
+        raise retry_after(5, RuntimeError("service is not ready"))
+
+    Args:
+        after_seconds (int): Positive delay in seconds before the next retry.
+        cause (BaseException): Failure that Dex records as the worker error.
+
+    Returns:
+        RetryAfterError: Error to raise from the worker method.
+
+    Raises:
+        ValueError: If **after_seconds** is not positive or **cause** is None.
+    """
     if cause is None:
         raise ValueError("cause is required")
     if after_seconds <= 0:

{dex_python_sdk-0.2.4 → dex_python_sdk-0.2.5}/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.2.4"
+version = "0.2.5"
 description = "Python SDK for the Dex workflow engine"
 authors = [{name = "Super Durable"}]
 readme = "README.md"