dotflow 0.9.0.dev2__tar.gz → 0.10.0.dev1__tar.gz

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: dotflow
-Version: 0.9.0.dev2
+Version: 0.10.0.dev1
 Summary: 🎲 Dotflow turns an idea into flow!
 License: MIT License
          
@@ -36,6 +36,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: pydantic
 Requires-Dist: rich
+Requires-Dist: typing-extensions
 Project-URL: Documentation, https://github.com/dotflow-io/dotflow/blob/master/README.md
 Project-URL: Homepage, https://github.com/dotflow-io/dotflow
 Project-URL: Issues, https://github.com/dotflow-io/dotflow/issues
@@ -106,7 +107,7 @@ workflow.start()
 
 #### 1 - Import
 
-Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow-class/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/))
+Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action/))
 
 ```python
 from dotflow import DotFlow, action
@@ -114,7 +115,7 @@ from dotflow import DotFlow, action
 
 #### 2 - Callback function
 
-Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter.
+Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_callback)
 
 ```python
 def my_callback(*args, **kwargs):
@@ -123,7 +124,7 @@ def my_callback(*args, **kwargs):
 
 #### 3 - Task function
 
-Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails.
+Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_function)
 
 ```python
 @action(retry=5)
@@ -133,7 +134,7 @@ def my_task():
 
 #### 4 - DotFlow Class
 
-Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow-class/).
+Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/).
 
 ```python
 workflow = DotFlow()
@@ -141,7 +142,7 @@ workflow = DotFlow()
 
 #### 5 - Add Task
 
-Now, simply add the `my_task` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow.
+Now, simply add the `my_task` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow. [More details](https://dotflow-io.github.io/dotflow/nav/reference/task-builder/#dotflow.core.task.TaskBuilder.add)
 
 ```python
 workflow.task.add(step=my_task, callback=my_callback)
@@ -149,7 +150,7 @@ workflow.task.add(step=my_task, callback=my_callback)
 
 #### 6 - Start
 
-Finally, just execute the workflow with the following code snippet.
+Finally, just execute the workflow with the following code snippet. [More details](https://dotflow-io.github.io/dotflow/nav/reference/workflow/#dotflow.core.workflow.Workflow)
 
 ```python
 workflow.start()
@@ -196,7 +197,7 @@ workflow.start()
 - ⚠️ SECURITY
 
 ## License
-![GitHub License](https://img.shields.io/github/license/FernandoCelmer/dotflow)
+![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
 
 This project is licensed under the terms of the MIT License.
 

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/README.md

@@ -62,7 +62,7 @@ workflow.start()
 
 #### 1 - Import
 
-Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow-class/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/))
+Start with the basics, which is importing the necessary classes and methods. ([DotFlow](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/), [action](https://dotflow-io.github.io/dotflow/nav/reference/action/))
 
 ```python
 from dotflow import DotFlow, action
@@ -70,7 +70,7 @@ from dotflow import DotFlow, action
 
 #### 2 - Callback function
 
-Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter.
+Create a `my_callback` function to receive execution information of a task. `It is not necessary` to include this function, as you will still have a report at the end of the execution in the instantiated object of the `DotFlow` class. This `my_callback` function is only needed if you need to do something after the execution of the task, for example: sending a message to someone, making a phone call, or sending a letter. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_callback)
 
 ```python
 def my_callback(*args, **kwargs):
@@ -79,7 +79,7 @@ def my_callback(*args, **kwargs):
 
 #### 3 - Task function
 
-Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action-decorator/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails.
+Now, create the function responsible for executing your task. It's very simple; just use the [action](https://dotflow-io.github.io/dotflow/nav/reference/action/) decorator above the function, and that's it—you've created a task. If necessary, you can also add the parameter called `retry` to set the maximum number of execution attempts if the function fails. [More details](https://dotflow-io.github.io/dotflow/nav/reference/utils/#dotflow.utils.basic_functions.basic_function)
 
 ```python
 @action(retry=5)
@@ -89,7 +89,7 @@ def my_task():
 
 #### 4 - DotFlow Class
 
-Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow-class/).
+Instantiate the DotFlow class in a `workflow` variable to be used in the following steps. [More details](https://dotflow-io.github.io/dotflow/nav/reference/dotflow/).
 
 ```python
 workflow = DotFlow()
@@ -97,7 +97,7 @@ workflow = DotFlow()
 
 #### 5 - Add Task
 
-Now, simply add the `my_task` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow.
+Now, simply add the `my_task` and `my_callback` functions you created earlier to the workflow using the code below. This process is necessary to define which tasks will be executed and the order in which they will run. The execution order follows the sequence in which they were added to the workflow. [More details](https://dotflow-io.github.io/dotflow/nav/reference/task-builder/#dotflow.core.task.TaskBuilder.add)
 
 ```python
 workflow.task.add(step=my_task, callback=my_callback)
@@ -105,7 +105,7 @@ workflow.task.add(step=my_task, callback=my_callback)
 
 #### 6 - Start
 
-Finally, just execute the workflow with the following code snippet.
+Finally, just execute the workflow with the following code snippet. [More details](https://dotflow-io.github.io/dotflow/nav/reference/workflow/#dotflow.core.workflow.Workflow)
 
 ```python
 workflow.start()
@@ -152,6 +152,6 @@ workflow.start()
 - ⚠️ SECURITY
 
 ## License
-![GitHub License](https://img.shields.io/github/license/FernandoCelmer/dotflow)
+![GitHub License](https://img.shields.io/github/license/dotflow-io/dotflow)
 
 This project is licensed under the terms of the MIT License.

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/__init__.py

@@ -1,21 +1,19 @@
 """Dotflow __init__ module."""
 
-__version__ = "0.9.0.dev2"
+__version__ = "0.10.0.dev1"
 __description__ = "🎲 Dotflow turns an idea into flow!"
 
-from .core.config import Config
 from .core.action import Action as action
+from .core.config import Config
 from .core.context import Context
 from .core.dotflow import DotFlow
 from .core.task import Task
-from .core.decorators import retry  # deprecated
 
 
 __all__ = [
     "action",
-    "retry",
-    "DotFlow",
     "Context",
     "Config",
+    "DotFlow",
     "Task"
 ]

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/abc/file.py

@@ -1,4 +1,4 @@
-"""File module"""
+"""File ABC"""
 
 from abc import ABC, abstractmethod
 

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/abc/http.py

@@ -1,4 +1,4 @@
-"""HTTP module"""
+"""HTTP ABC"""
 
 from abc import ABC, abstractmethod
 from typing import Callable

dotflow-0.10.0.dev1/dotflow/abc/storage.py

@@ -0,0 +1,25 @@
+"""Storage ABC"""
+
+from typing import Callable
+from abc import ABC, abstractmethod
+
+from dotflow.core.context import Context
+
+
+class Storage(ABC):
+    """Storage"""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+
+    @abstractmethod
+    def post(self, key: str, context: Context) -> None:
+        """Post context somewhere"""
+
+    @abstractmethod
+    def get(self, key: str) -> Context:
+        """Get context somewhere"""
+
+    @abstractmethod
+    def key(self, task: Callable):
+        """Function that returns a key to get and post storage"""

dotflow-0.10.0.dev1/dotflow/cli/commands/start.py

@@ -0,0 +1,35 @@
+"""Command start module"""
+
+from os import system
+
+from dotflow import DotFlow, Config
+from dotflow.providers import StorageInit, StorageFile
+from dotflow.core.types.execution import TypeExecution
+from dotflow.cli.command import Command
+
+
+class StartCommand(Command):
+
+    def setup(self):
+        workflow = DotFlow()
+
+        if self.params.storage:
+            storage = {"default": StorageInit, "file": StorageFile}
+
+            config = Config(
+                storage=storage.get(self.params.storage)(
+                    path=self.params.path,
+                )
+            )
+            workflow = DotFlow(config=config)
+
+        workflow.task.add(
+            step=self.params.step,
+            callback=self.params.callback,
+            initial_context=self.params.initial_context,
+        )
+
+        workflow.start(mode=self.params.mode)
+
+        if self.params.mode == TypeExecution.BACKGROUND:
+            system("/bin/bash")

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/cli/setup.py

@@ -10,7 +10,7 @@ from dotflow.core.types.execution import TypeExecution
 from dotflow.core.exception import (
     MissingActionDecorator,
     ExecutionModeNotExist,
-    ModuleNotFound,
+    ImportModuleError,
     MESSAGE_UNKNOWN_ERROR,
 )
 from dotflow.cli.commands import (
@@ -56,9 +56,7 @@ class Command:
         self.cmd_start.add_argument("-s", "--step", required=True)
         self.cmd_start.add_argument("-c", "--callback", default=basic_callback)
         self.cmd_start.add_argument("-i", "--initial-context")
-        self.cmd_start.add_argument(
-            "-o", "--output-context", default=False, action="store_true"
-        )
+        self.cmd_start.add_argument("-o", "--storage", choices=["default", "file"])
         self.cmd_start.add_argument("-p", "--path", default=settings.START_PATH)
         self.cmd_start.add_argument(
             "-m",
@@ -71,9 +69,7 @@ class Command:
 
     def setup_logs(self):
         self.cmd_logs = self.subparsers.add_parser("logs", help="Logs")
-        self.cmd_logs = self.cmd_logs.add_argument_group(
-            "Usage: dotflow log [OPTIONS]"
-        )
+        self.cmd_logs = self.cmd_logs.add_argument_group("Usage: dotflow log [OPTIONS]")
         self.cmd_logs.set_defaults(exec=LogCommand)
 
     def command(self):
@@ -89,7 +85,7 @@ class Command:
         except ExecutionModeNotExist as err:
             print(settings.WARNING_ALERT, err)
 
-        except ModuleNotFound as err:
+        except ImportModuleError as err:
             print(settings.WARNING_ALERT, err)
 
         except Exception as err:

dotflow-0.10.0.dev1/dotflow/core/action.py

@@ -0,0 +1,129 @@
+"""Action module"""
+
+from typing import Callable, Dict
+from types import FunctionType
+
+from dotflow.core.context import Context
+
+
+class Action(object):
+    """
+    Import:
+        You can import the **action** decorator directly from dotflow:
+
+            from dotflow import action
+
+    Example:
+        `class` dotflow.core.action.Action
+
+        Standard
+
+            @action
+            def my_task():
+                print("task")
+
+        With Retry
+
+            @action(retry=5)
+            def my_task():
+                print("task")
+
+    Args:
+        func (Callable):
+
+        task (Callable):
+
+        retry (int):
+            Integer-type argument referring to the number of retry attempts
+            the function will execute in case of failure.
+    """
+
+    def __init__(
+            self,
+            func: Callable = None,
+            task: Callable = None,
+            retry: int = 1
+    ) -> None:
+        self.func = func
+        self.task = task
+        self.retry = retry
+        self.params = []
+
+    def __call__(self, *args, **kwargs):
+        # With parameters
+        if self.func:
+            self._set_params()
+
+            task = self._get_task(kwargs=kwargs)
+            contexts = self._get_context(kwargs=kwargs)
+
+            if contexts:
+                return Context(
+                    storage=self._retry(*args, **contexts),
+                    task_id=task.task_id,
+                    workflow_id=task.workflow_id
+                )
+
+            return Context(
+                storage=self._retry(*args),
+                task_id=task.task_id,
+                workflow_id=task.workflow_id
+            )
+
+        # No parameters
+        def action(*_args, **_kwargs):
+            self.func = args[0]
+            self._set_params()
+
+            task = self._get_task(kwargs=_kwargs)
+            contexts = self._get_context(kwargs=_kwargs)
+
+            if contexts:
+                return Context(
+                    storage=self._retry(*_args, **contexts),
+                    task_id=task.task_id,
+                    workflow_id=task.workflow_id
+                )
+
+            return Context(
+                storage=self._retry(*_args),
+                task_id=task.task_id,
+                workflow_id=task.workflow_id
+            )
+
+        return action
+
+    def _retry(self, *args, **kwargs):
+        attempt = 0
+        exception = Exception()
+
+        while self.retry > attempt:
+            try:
+                return self.func(*args, **kwargs)
+            except Exception as error:
+                exception = error
+                attempt += 1
+
+        raise exception
+
+    def _set_params(self):
+        if isinstance(self.func, FunctionType):
+            self.params = [param for param in self.func.__code__.co_varnames]
+
+        if type(self.func) is type:
+            if hasattr(self.func, "__init__"):
+                if hasattr(self.func.__init__, "__code__"):
+                    self.params = [param for param in self.func.__init__.__code__.co_varnames]
+
+    def _get_context(self, kwargs: Dict):
+        context = {}
+        if "initial_context" in self.params:
+            context["initial_context"] = Context(kwargs.get("initial_context"))
+
+        if "previous_context" in self.params:
+            context["previous_context"] = Context(kwargs.get("previous_context"))
+
+        return context
+
+    def _get_task(self, kwargs: Dict):
+        return kwargs.get("task")

dotflow-0.10.0.dev1/dotflow/core/config.py

@@ -0,0 +1,27 @@
+"""Config module"""
+
+from dotflow.abc.storage import Storage
+from dotflow.providers.storage_init import StorageInit
+
+
+class Config:
+    """
+    Import:
+        You can import the **Config** class with:
+
+            from dotflow import Config, StorageInit
+
+    Example:
+        `class` dotflow.core.config.Config
+
+            config = Config(storage=StorageInit)
+
+    Args:
+        storage (Storage): Type of the storage.
+
+    Attributes:
+        storage (Storage):
+    """
+
+    def __init__(self, storage: Storage = StorageInit()) -> None:
+        self.storage = storage

dotflow-0.10.0.dev1/dotflow/core/context.py

@@ -0,0 +1,107 @@
+"""Context module"""
+
+from uuid import UUID
+
+from typing import Any
+from datetime import datetime
+
+
+class ContextInstance:
+    """
+    Import:
+        You can import the **ContextInstance** class with:
+
+            from dotflow.core.context import ContextInstance
+    """
+
+    def __init__(self, *args, **kwargs):
+        self._time = None
+        self._task_id = None
+        self._workflow_id = None
+        self._storage = None
+        self._current_key = None
+        self._previous_key = None
+
+
+class Context(ContextInstance):
+    """
+    Import:
+        You can import the Context class directly from dotflow:
+
+            from dotflow import Context
+
+    Example:
+        `class` dotflow.core.context.Context
+
+            Context(
+                storage={"data": [0, 1, 2, 3]}
+            )
+
+    Args:
+        storage (Any): Attribute where any type of Python object can be stored.
+
+        task_id (int): Task ID.
+
+        workflow_id (UUID): Workflow ID.
+    """
+
+    def __init__(
+            self,
+            storage: Any = None,
+            task_id: int = None,
+            workflow_id: UUID = None,
+    ) -> None:
+        super().__init__(
+            task_id,
+            storage,
+            task_id,
+            workflow_id
+        )
+        self.time = datetime.now()
+        self.task_id = task_id
+        self.workflow_id = workflow_id
+        self.storage = storage
+
+    @property
+    def time(self):
+        return self._time
+
+    @time.setter
+    def time(self, value: datetime):
+        self._time = value
+
+    @property
+    def task_id(self):
+        return self._task_id
+
+    @task_id.setter
+    def task_id(self, value: int):
+        if isinstance(value, int):
+            self._task_id = value
+
+        if not self.task_id:
+            self._task_id = value
+
+    @property
+    def workflow_id(self):
+        return self._workflow_id
+
+    @workflow_id.setter
+    def workflow_id(self, value: UUID):
+        if isinstance(value, UUID):
+            self._workflow_id = value
+
+    @property
+    def storage(self):
+        return self._storage
+
+    @storage.setter
+    def storage(self, value: Any):
+        if isinstance(value, Context):
+            self._storage = value.storage
+
+            self.time = value.time
+            self.task_id = value.task_id
+            self.workflow_id = value.workflow_id
+        else:
+            self._storage = value

dotflow-0.10.0.dev1/dotflow/core/decorators/__init__.py

@@ -0,0 +1,8 @@
+"""Decorators __init__ module."""
+
+from dotflow.core.decorators.time import time
+
+
+__all__ = [
+    "time"
+]

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/core/decorators/time.py

@@ -4,6 +4,7 @@ from datetime import datetime
 
 
 def time(func):
+    """"Time Decorator"""
     def inside(*args, **kwargs):
         start = datetime.now()
         task = func(*args, **kwargs)

dotflow-0.10.0.dev1/dotflow/core/dotflow.py

@@ -0,0 +1,75 @@
+"""DotFlow"""
+
+from uuid import uuid4
+from functools import partial
+
+from dotflow.core.config import Config
+from dotflow.core.workflow import Workflow
+from dotflow.core.task import TaskBuilder
+
+
+class DotFlow:
+    """
+    Import:
+        You can import the **Dotflow** class directly from dotflow:
+
+            from dotflow import DotFlow, Config
+            from dotflow.storage import StorageFile
+
+    Example:
+        `class` dotflow.core.dotflow.Dotflow
+
+            config = Config(
+                storage=StorageFile()
+            )
+
+            workflow = DotFlow(config=config)
+
+    Args:
+        config (Config): Configuration class.
+
+    Attributes:
+        workflow_id (UUID):
+
+        task (List[Task]):
+
+        start (Workflow):
+    """
+
+    def __init__(
+            self,
+            config: Config = Config()
+    ) -> None:
+        self.workflow_id = uuid4()
+
+        self.task = TaskBuilder(
+            config=config,
+            workflow_id=self.workflow_id
+        )
+
+        self.start = partial(
+            Workflow,
+            tasks=self.task.queu,
+            id=self.workflow_id
+        )
+
+    def result_task(self):
+        """
+        Returns:
+            list (List[Task]): Returns a list of Task class.
+        """
+        return self.task.queu
+
+    def result_context(self):
+        """
+        Returns:
+            list (List[Context]): Returns a list of Context class.
+        """
+        return [task.current_context for task in self.task.queu]
+
+    def result_storage(self):
+        """
+        Returns:
+            list (List[Any]): Returns a list of assorted objects.
+        """
+        return [task.current_context.storage for task in self.task.queu]

{dotflow-0.9.0.dev2 → dotflow-0.10.0.dev1}/dotflow/core/exception.py

@@ -4,8 +4,9 @@ MESSAGE_UNKNOWN_ERROR = "Unknown error, please check logs for more information."
 MESSAGE_MISSING_STEP_DECORATOR = "A step function necessarily needs an '@action' decorator to circulate in the workflow. For more implementation details, access the documentation: https://dotflow-io.github.io/dotflow/nav/getting-started/#3-task-function."
 MESSAGE_NOT_CALLABLE_OBJECT = "Problem validating the '{name}' object type; this is not a callable object"
 MESSAGE_EXECUTION_NOT_EXIST = "The execution mode does not exist. Allowed parameter is 'sequential' and 'background'."
-MESSAGE_MODULE_NOT_FOUND = "Problem importing the python module '{module}'."
+MESSAGE_IMPORT_MODULE_ERROR = "Error importing Python module '{module}'."
 MESSAGE_PROBLEM_ORDERING = "Problem with correctly ordering functions of the '{name}' class."
+MESSAGE_MODULE_NOT_FOUND = "Module '{module}' not found. Please install with 'pip install {library}'"
 
 class MissingActionDecorator(Exception):
 
@@ -23,11 +24,11 @@ class ExecutionModeNotExist(Exception):
         )
 
 
-class ModuleNotFound(Exception):
+class ImportModuleError(Exception):
 
     def __init__(self, module: str):
-        super(ModuleNotFound, self).__init__(
-            MESSAGE_MODULE_NOT_FOUND.format(
+        super(ImportModuleError, self).__init__(
+            MESSAGE_IMPORT_MODULE_ERROR.format(
                 module=module
             )
         )
@@ -50,4 +51,15 @@ class ProblemOrdering(Exception):
             MESSAGE_PROBLEM_ORDERING.format(
                 name=name
             )
-        )
+        )
+
+
+class ModuleNotFound(Exception):
+
+    def __init__(self, module: str, library: str):
+        super(ModuleNotFound, self).__init__(
+            MESSAGE_MODULE_NOT_FOUND.format(
+                module=module,
+                library=library
+            )
+        )