dotflow 0.16.0.dev2__tar.gz → 0.16.0.dev4__tar.gz

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dotflow
-Version: 0.16.0.dev2
+Version: 0.16.0.dev4
 Summary: 🎲 Dotflow turns an idea into flow! Lightweight Python library for execution pipelines with retry, parallel, cron and async support.
 License: Apache License
                                     Version 2.0, January 2004

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/__init__.py

@@ -1,6 +1,6 @@
 """Dotflow __init__ module."""
 
-__version__ = "0.16.0.dev2"
+__version__ = "0.16.0.dev4"
 __description__ = "🎲 Dotflow turns an idea into flow!"
 
 from .core.action import Action as action

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/cli/commands/start.py

@@ -1,23 +1,32 @@
 """Command start module"""
 
-import os
 from os import system
 
 from dotflow import Config, DotFlow
 from dotflow.cli.command import Command
+from dotflow.core.exception import InvalidWorkflowFactory, WorkflowFlagConflict
+from dotflow.core.module import Module
 from dotflow.core.types.execution import TypeExecution
 from dotflow.providers import (
-    ServerAPI,
-    ServerDefault,
     StorageDefault,
     StorageFile,
     StorageGCS,
     StorageS3,
 )
+from dotflow.utils.basic_functions import basic_callback
 
 
 class StartCommand(Command):
     def setup(self):
+        if getattr(self.params, "workflow", None):
+            self._start_from_factory()
+        else:
+            self._start_from_step()
+
+        if self.params.mode == TypeExecution.BACKGROUND:
+            system("/bin/bash")
+
+    def _start_from_step(self):
         workflow = self._new_workflow()
 
         workflow.task.add(
@@ -28,36 +37,32 @@ class StartCommand(Command):
 
         workflow.start(mode=self.params.mode)
 
-        if self.params.mode == TypeExecution.BACKGROUND:
-            system("/bin/bash")
-
-    def _new_workflow(self):
-        config = self._build_config()
-        workflow_id = os.getenv("WORKFLOW_ID")
+    def _start_from_factory(self):
+        step_only_flags = {
+            "--callback": self.params.callback is not basic_callback,
+            "--initial-context": self.params.initial_context is not None,
+        }
+        for flag, provided in step_only_flags.items():
+            if provided:
+                raise WorkflowFlagConflict(flag=flag)
 
-        if config is None:
-            return DotFlow(workflow_id=workflow_id)
-        return DotFlow(config=config, workflow_id=workflow_id)
+        factory = Module(self.params.workflow)
 
-    def _build_config(self):
-        storage = self._build_storage()
-        server = self._build_server()
+        if not callable(factory):
+            raise InvalidWorkflowFactory(factory=self.params.workflow)
 
-        if storage is None and server is None:
-            return None
+        result = factory()
 
-        return Config(
-            storage=storage or StorageDefault(),
-            server=server or ServerDefault(),
-        )
+        if not isinstance(result, DotFlow):
+            raise InvalidWorkflowFactory(factory=self.params.workflow)
 
-    def _build_server(self):
-        base_url = os.getenv("SERVER_BASE_URL")
-        user_token = os.getenv("SERVER_USER_TOKEN")
+        result.start(mode=self.params.mode)
 
-        if not base_url or not user_token:
-            return None
-        return ServerAPI(base_url=base_url, user_token=user_token)
+    def _new_workflow(self):
+        storage = self._build_storage()
+        if storage is None:
+            return DotFlow()
+        return DotFlow(config=Config(storage=storage))
 
     def _build_storage(self):
         if not self.params.storage:

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/cli/setup.py

@@ -16,7 +16,9 @@ from dotflow.core.exception import (
     MESSAGE_UNKNOWN_ERROR,
     ExecutionModeNotExist,
     ImportModuleError,
+    InvalidWorkflowFactory,
     MissingActionDecorator,
+    WorkflowFlagConflict,
 )
 from dotflow.core.types import TypeExecution, TypeOverlap, TypeStorage
 from dotflow.logging import logger
@@ -56,12 +58,16 @@ class Command:
         self.cmd_init.set_defaults(exec=InitCommand)
 
     def setup_start(self):
-        self.cmd_start = self.subparsers.add_parser("start", help="Start")
-        self.cmd_start = self.cmd_start.add_argument_group(
-            "Usage: dotflow start [OPTIONS]"
+        cmd_start_parser = self.subparsers.add_parser("start", help="Start")
+        entry_group = cmd_start_parser.add_mutually_exclusive_group(
+            required=True
         )
+        entry_group.add_argument("-s", "--step")
+        entry_group.add_argument("-w", "--workflow")
 
-        self.cmd_start.add_argument("-s", "--step", required=True)
+        self.cmd_start = cmd_start_parser.add_argument_group(
+            "Usage: dotflow start [OPTIONS]"
+        )
         self.cmd_start.add_argument("-c", "--callback", default=basic_callback)
         self.cmd_start.add_argument("-i", "--initial-context")
         self.cmd_start.add_argument(
@@ -88,7 +94,7 @@ class Command:
             ],
         )
 
-        self.cmd_start.set_defaults(exec=StartCommand)
+        cmd_start_parser.set_defaults(exec=StartCommand)
 
     def setup_schedule(self):
         self.cmd_schedule = self.subparsers.add_parser(
@@ -233,6 +239,12 @@ class Command:
         except ImportModuleError as err:
             print(settings.WARNING_ALERT, err)
 
+        except InvalidWorkflowFactory as err:
+            print(settings.WARNING_ALERT, err)
+
+        except WorkflowFlagConflict as err:
+            print(settings.WARNING_ALERT, err)
+
         except KeyboardInterrupt:
             print("\n", settings.INFO_ALERT, "Aborted.")
 

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/core/engine.py

@@ -257,13 +257,14 @@ class TaskEngine:
 
         for new in ordered_list:
             new_object = getattr(class_instance, new[1])
+            task_ulid = str(ULID())
             try:
                 subcontext = new_object(
                     initial_context=self.task.initial_context,
                     previous_context=previous_context,
                     task=self.task,
                 )
-                subcontext.task_id = str(ULID())
+                subcontext.task_id = task_ulid
                 new_context.storage.append(subcontext)
                 previous_context = subcontext
 
@@ -277,7 +278,7 @@ class TaskEngine:
                     previous_context=previous_context,
                     task=self.task,
                 )
-                subcontext.task_id = str(ULID())
+                subcontext.task_id = task_ulid
                 new_context.storage.append(subcontext)
                 previous_context = subcontext
 

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/core/exception.py

@@ -15,6 +15,12 @@ MESSAGE_PROBLEM_ORDERING = (
 MESSAGE_MODULE_NOT_FOUND = (
     "Module '{module}' not found. Please install with 'pip install {library}'"
 )
+MESSAGE_INVALID_WORKFLOW_FACTORY = (
+    "'{factory}' must be a callable that returns a DotFlow instance."
+)
+MESSAGE_WORKFLOW_FLAG_CONFLICT = (
+    "{flag} is only valid with --step and cannot be used with --workflow."
+)
 
 
 class MissingActionDecorator(Exception):
@@ -49,6 +55,18 @@ class ModuleNotFound(Exception):
         )
 
 
+class InvalidWorkflowFactory(Exception):
+    def __init__(self, factory: str):
+        super().__init__(
+            MESSAGE_INVALID_WORKFLOW_FACTORY.format(factory=factory)
+        )
+
+
+class WorkflowFlagConflict(Exception):
+    def __init__(self, flag: str):
+        super().__init__(MESSAGE_WORKFLOW_FLAG_CONFLICT.format(flag=flag))
+
+
 class ExecutionWithClassError(Exception):
     def __init__(self):
         super().__init__("Unknown")

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/dotflow/providers/__init__.py

@@ -6,7 +6,6 @@ from dotflow.providers.notify_default import NotifyDefault
 from dotflow.providers.notify_discord import NotifyDiscord
 from dotflow.providers.notify_telegram import NotifyTelegram
 from dotflow.providers.scheduler_default import SchedulerDefault
-from dotflow.providers.server_api import ServerAPI
 from dotflow.providers.server_default import ServerDefault
 from dotflow.providers.storage_default import StorageDefault
 from dotflow.providers.storage_file import StorageFile
@@ -21,7 +20,6 @@ __all__ = [
     "NotifyTelegram",
     "SchedulerCron",
     "SchedulerDefault",
-    "ServerAPI",
     "ServerDefault",
     "StorageDefault",
     "StorageFile",

dotflow-0.16.0.dev4/dotflow/providers/server_default.py

@@ -0,0 +1,116 @@
+"""ServerDefault — no-op or managed HTTP server provider."""
+
+from __future__ import annotations
+
+import os
+from functools import wraps
+from typing import Any
+
+from requests import patch, post
+from requests.exceptions import RequestException
+
+from dotflow.abc.server import Server
+from dotflow.logging import logger
+
+
+def managed(method):
+    @wraps(method)
+    def wrapper(self, *args, **kwargs):
+        if not self._managed:
+            return
+        return method(self, *args, **kwargs)
+
+    return wrapper
+
+
+class ServerDefault(Server):
+    """Default Server provider with auto-detected managed mode.
+
+    When ``SERVER_BASE_URL`` and ``SERVER_USER_TOKEN`` env vars are set,
+    sends workflow and task events to the remote API. Otherwise, all
+    methods are no-ops.
+    """
+
+    MAX_RESULT_SIZE = 5_000_000
+    TIMEOUT = 15.0
+
+    ENDPOINT_WORKFLOWS = "/workflows"
+    ENDPOINT_WORKFLOW = "/workflows/{workflow_id}"
+    ENDPOINT_TASKS = "/workflows/{workflow_id}/tasks"
+    ENDPOINT_TASK = "/workflows/{workflow_id}/tasks/{task_id}"
+
+    def __init__(self) -> None:
+        base_url = os.getenv("SERVER_BASE_URL")
+        user_token = os.getenv("SERVER_USER_TOKEN")
+        self._managed = bool(base_url and user_token)
+
+        self._base_url = base_url.rstrip("/") if base_url else None
+        self._user_token = user_token
+
+    @property
+    def _headers(self) -> dict:
+        return {
+            "Authorization": f"Bearer {self._user_token}",
+            "Content-Type": "application/json",
+        }
+
+    def _post(self, url: str, json: dict) -> None:
+        try:
+            response = post(
+                url,
+                json=json,
+                headers=self._headers,
+                timeout=self.TIMEOUT,
+            )
+            logger.info("POST %s [%s]", url, response.status_code)
+        except RequestException as error:
+            logger.error("POST %s failed: %s", url, error)
+
+    def _patch(self, url: str, json: dict) -> None:
+        try:
+            response = patch(
+                url,
+                json=json,
+                headers=self._headers,
+                timeout=self.TIMEOUT,
+            )
+            logger.info("PATCH %s [%s]", url, response.status_code)
+        except RequestException as error:
+            logger.error("PATCH %s failed: %s", url, error)
+
+    @managed
+    def create_workflow(self, workflow: Any) -> None:
+        self._post(
+            self._base_url + self.ENDPOINT_WORKFLOWS,
+            json={"id": str(workflow)},
+        )
+
+    @managed
+    def update_workflow(self, workflow: Any, status: str = "") -> None:
+        self._patch(
+            self._base_url
+            + self.ENDPOINT_WORKFLOW.format(workflow_id=workflow),
+            json={"status": status},
+        )
+
+    @managed
+    def create_task(self, task: Any) -> None:
+        data = task.result(max=self.MAX_RESULT_SIZE)
+        data["id"] = data.pop("task_id", task.task_id)
+        self._post(
+            self._base_url
+            + self.ENDPOINT_TASKS.format(workflow_id=task.workflow_id),
+            json=data,
+        )
+
+    @managed
+    def update_task(self, task: Any) -> None:
+        data = task.result(max=self.MAX_RESULT_SIZE)
+        self._patch(
+            self._base_url
+            + self.ENDPOINT_TASK.format(
+                workflow_id=task.workflow_id,
+                task_id=task.task_id,
+            ),
+            json=data,
+        )

{dotflow-0.16.0.dev2 → dotflow-0.16.0.dev4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dotflow"
-version = "0.16.0.dev2"
+version = "0.16.0.dev4"
 authors = [
   { name="Fernando Celmer", email="email@fernandocelmer.com" },
 ]
@@ -67,7 +67,7 @@ sentry = ["sentry-sdk"]
 
 [tool.poetry]
 name = "dotflow"
-version = "0.16.0.dev2"
+version = "0.16.0.dev4"
 description = "🎲 Dotflow turns an idea into flow! Lightweight Python library for execution pipelines with retry, parallel, cron and async support."
 authors = ["Fernando Celmer <email@fernandocelmer.com>"]
 readme = "README.md"

dotflow-0.16.0.dev2/dotflow/providers/server_api.py

@@ -1,88 +0,0 @@
-"""ServerAPI — sends workflow/task events to a remote HTTP endpoint."""
-
-from __future__ import annotations
-
-import logging
-from typing import Any
-
-from requests import patch, post
-from requests.exceptions import RequestException
-
-from dotflow.abc.server import Server
-
-logger = logging.getLogger(__name__)
-
-
-class ServerAPI(Server):
-    """HTTP implementation of the Server ABC."""
-
-    def __init__(
-        self,
-        base_url: str,
-        user_token: str,
-        timeout: float = 15.0,
-    ):
-        self._base_url = base_url.rstrip("/")
-        self._user_token = user_token
-        self._timeout = timeout
-
-    @property
-    def _headers(self) -> dict:
-        return {
-            "Authorization": f"Bearer {self._user_token}",
-            "Content-Type": "application/json",
-        }
-
-    def _post(self, url: str, json: dict) -> None:
-        try:
-            response = post(
-                url,
-                json=json,
-                headers=self._headers,
-                timeout=self._timeout,
-            )
-            logger.info("POST %s [%s]", url, response.status_code)
-        except RequestException as error:
-            logger.error("POST %s failed: %s", url, error)
-
-    def _patch(self, url: str, json: dict) -> None:
-        try:
-            response = patch(
-                url,
-                json=json,
-                headers=self._headers,
-                timeout=self._timeout,
-            )
-            logger.info("PATCH %s [%s]", url, response.status_code)
-        except RequestException as error:
-            logger.error("PATCH %s failed: %s", url, error)
-
-    def create_workflow(self, workflow: Any) -> None:
-        self._post(
-            f"{self._base_url}/workflows",
-            json={"id": str(workflow)},
-        )
-
-    def update_workflow(self, workflow: Any, status: str = "") -> None:
-        self._patch(
-            f"{self._base_url}/workflows/{workflow}",
-            json={"status": status},
-        )
-
-    def create_task(self, task: Any) -> None:
-        data = task.result(max=5_000_000)
-        data["id"] = data.pop("task_id", task.task_id)
-        self._post(
-            f"{self._base_url}/workflows/{task.workflow_id}/tasks",
-            json=data,
-        )
-
-    def update_task(self, task: Any) -> None:
-        data = task.result(max=5_000_000)
-        self._patch(
-            (
-                f"{self._base_url}/workflows/{task.workflow_id}"
-                f"/tasks/{task.task_id}"
-            ),
-            json=data,
-        )

dotflow-0.16.0.dev2/dotflow/providers/server_default.py

@@ -1,23 +0,0 @@
-"""ServerDefault — no-op server provider."""
-
-from __future__ import annotations
-
-from typing import Any
-
-from dotflow.abc.server import Server
-
-
-class ServerDefault(Server):
-    """Default Server implementation (no-op)."""
-
-    def create_workflow(self, workflow: Any) -> None:
-        pass
-
-    def update_workflow(self, workflow: Any, status: str = "") -> None:
-        pass
-
-    def create_task(self, task: Any) -> None:
-        pass
-
-    def update_task(self, task: Any) -> None:
-        pass