simpleflow 0.34.2__tar.gz → 0.35.0__tar.gz

{simpleflow-0.34.2 → simpleflow-0.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simpleflow
-Version: 0.34.2
+Version: 0.35.0
 Summary: Python library for dataflow programming with Amazon SWF
 Project-URL: documentation, https://botify-labs.github.io/simpleflow
 Project-URL: repository, https://github.com/botify-labs/simpleflow

{simpleflow-0.34.2 → simpleflow-0.35.0}/simpleflow/__init__.py

@@ -5,6 +5,6 @@ from .runtime import logger  # NOQA
 from .signal import WaitForSignal  # NOQA
 from .workflow import Workflow  # NOQA
 
-__version__ = "0.34.2"
+__version__ = "0.35.0"
 __author__ = "Greg Leclercq"
 __license__ = "MIT"

{simpleflow-0.34.2 → simpleflow-0.35.0}/simpleflow/format.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import os
 from sqlite3 import OperationalError
-from typing import Any
+from typing import Any, cast
 from uuid import uuid4
 
 import lazy_object_proxy
@@ -23,7 +23,7 @@ def _jumbo_fields_bucket() -> str | None:
     # wrapped into a function so easier to override for tests
     bucket = os.getenv("SIMPLEFLOW_JUMBO_FIELDS_BUCKET")
     if not bucket:
-        return
+        return None
     # trim trailing / if there, would provoke double slashes down the road
     if bucket.endswith("/"):
         bucket = bucket[:-1]
@@ -122,9 +122,9 @@ def _set_cached(path: str, content: str) -> None:
 def _push_jumbo_field(message: str) -> str:
     size = len(message)
     uuid = str(uuid4())
-    bucket_with_dir = _jumbo_fields_bucket()
+    bucket_with_dir = cast(str, _jumbo_fields_bucket())
     if "/" in bucket_with_dir:
-        bucket, directory = _jumbo_fields_bucket().split("/", 1)
+        bucket, directory = bucket_with_dir.split("/", 1)
         path = f"{directory}/{uuid}"
     else:
         bucket = bucket_with_dir
@@ -149,43 +149,47 @@ def _pull_jumbo_field(location: str) -> str:
     return content
 
 
-def _log_message_too_long(message):
+def _log_message_too_long(message: str):
     if len(message) > constants.MAX_LOG_FIELD:
         message = f"{message[: constants.MAX_LOG_FIELD]} <...truncated to {constants.MAX_LOG_FIELD} chars>"
     logger.error(f"Message too long, will raise: {message}")
 
 
 # A few helpers to wrap common SWF fields
-def details(message):
+def details(message: str | None) -> str | None:
     return encode(message, constants.MAX_DETAILS_LENGTH)
 
 
-def execution_context(message):
+def execution_context(message: str | None) -> str | None:
     return encode(message, constants.MAX_EXECUTION_CONTEXT_LENGTH)
 
 
-def heartbeat_details(message):
+def heartbeat_details(message: str | None) -> str | None:
     return encode(message, constants.MAX_HEARTBEAT_DETAILS_LENGTH)
 
 
-def identity(message):
+def identity(message: str | None) -> str | None:
     # we don't allow the use of jumbo fields for identity because it's guaranteed
     # to change on every task, and we fear it makes the decider too slow
-    # NB: this should be revisited / questionned later, maybe not such a problem?
-    return encode(message, constants.MAX_IDENTITY_LENGTH, allow_jumbo_fields=False)
+    # NB: this should be revisited / questioned later, maybe not such a problem?
+    if not message:
+        return message
+    if len(message) > constants.MAX_IDENTITY_LENGTH:
+        message = f"{message[: constants.MAX_IDENTITY_LENGTH - 4]} ..."
+    return message
 
 
-def input(message):
-    return encode(json_dumps(message), constants.MAX_INPUT_LENGTH)
+def input(message: Any) -> str:
+    return cast(str, encode(json_dumps(message), constants.MAX_INPUT_LENGTH))
 
 
-def reason(message):
+def reason(message: str | None) -> str | None:
     return encode(message, constants.MAX_REASON_LENGTH)
 
 
-def result(message):
-    return encode(json_dumps(message), constants.MAX_RESULT_LENGTH)
+def result(message: Any) -> str:
+    return cast(str, encode(json_dumps(message), constants.MAX_RESULT_LENGTH))
 
 
-def control(message):
-    return encode(json_dumps(message), constants.MAX_CONTROL_LENGTH)
+def control(message: Any) -> str:
+    return cast(str, encode(json_dumps(message), constants.MAX_CONTROL_LENGTH))

{simpleflow-0.34.2 → simpleflow-0.35.0}/simpleflow/swf/mapper/models/event/factory.py

@@ -127,7 +127,7 @@ class EventFactory:
             Returns: 'start_initiated'
 
         """
-        left, sep, right = event_name.partition(event_type)
+        left, _, right = event_name.partition(event_type)
         return camel_to_underscore(left + right)
 
 

{simpleflow-0.34.2 → simpleflow-0.35.0}/simpleflow/swf/task.py

@@ -161,7 +161,14 @@ class WorkflowTask(task.WorkflowTask, SwfTask):
         """
         Casts a generic simpleflow.task.WorkflowTask into a SWF one.
         """
-        return cls(task.executor, task.workflow, *task._args, **task._kwargs)
+        # Preserve an explicit decision task list override set on the generic task.
+        return cls(
+            task.executor,
+            task.workflow,
+            *task._args,
+            workflow_task_list=task._task_list,
+            **task._kwargs,
+        )
 
     @property
     def name(self):
@@ -173,6 +180,11 @@ class WorkflowTask(task.WorkflowTask, SwfTask):
 
     @property
     def task_list(self) -> str | None:
+        # An explicit override (e.g. to make a child workflow inherit its
+        # parent's decision task list) wins over the workflow's own logic.
+        if self._task_list:
+            return self._task_list
+
         get_task_list = getattr(self.workflow, "get_task_list", None)
         if get_task_list:
             return get_task_list(self.workflow, *self.args, **self.kwargs)

{simpleflow-0.34.2 → simpleflow-0.35.0}/simpleflow/task.py

@@ -146,7 +146,14 @@ class WorkflowTask(Task):
     Child workflow.
     """
 
-    def __init__(self, executor: Executor | None, workflow: type[Workflow], *args, **kwargs) -> None:
+    def __init__(
+        self,
+        executor: Executor | None,
+        workflow: type[Workflow],
+        *args,
+        workflow_task_list: str | None = None,
+        **kwargs,
+    ) -> None:
         # Keep original arguments for use in subclasses
         # For instance this helps casting a generic class to a simpleflow.swf.task,
         # see simpleflow.swf.task.WorkflowTask.from_generic_task() factory
@@ -159,6 +166,11 @@ class WorkflowTask(Task):
         get_workflow_id = getattr(workflow, "get_workflow_id", None)
         self.args = self.resolve_args(*args)
         self.kwargs = self.resolve_kwargs(**kwargs)
+        # Explicit decision task list for the child workflow. When set, it takes
+        # precedence over the child workflow's own ``get_task_list``/``task_list``
+        # (see simpleflow.swf.task.WorkflowTask.task_list). It is *not* a run
+        # argument: it never reaches the child's ``run()``.
+        self._task_list = workflow_task_list
 
         if get_workflow_id:
             self.id: str | None = get_workflow_id(workflow, *self.args, **self.kwargs)
@@ -192,8 +204,8 @@ class ChildWorkflowTask(WorkflowTask):
     (yet).
     """
 
-    def __init__(self, workflow: type[Workflow], *args, **kwargs) -> None:
-        super().__init__(None, workflow, *args, **kwargs)
+    def __init__(self, workflow: type[Workflow], *args, workflow_task_list: str | None = None, **kwargs) -> None:
+        super().__init__(None, workflow, *args, workflow_task_list=workflow_task_list, **kwargs)
 
 
 class SignalTask(Task):