📌 ISSUE-#23: Code improvement

Author: FernandoCelmer

.flake8

@@ -0,0 +1,11 @@
+[flake8]
+extend-ignore = E501,E501
+exclude =
+    __pycache__,
+    docs,
+    dotflow/core/exception.py,
+    setup.py,
+    old,
+    build,
+    dist
+max-complexity = 10

.github/workflows/python-app-code-quality.yml

@@ -23,5 +23,4 @@ jobs:
         pip install flake8
     - name: 📝️ Code Scan
       run: |
-        flake8 dotflow/ --count --show-source --statistics --ignore=E501
-        flake8 tests/ --count --show-source --statistics --ignore=E501
+        flake8

dotflow/__init__.py

@@ -4,8 +4,8 @@
 
 from .core.action import Action as action
 from .core.context import Context
-from .core.decorators import retry  # deprecated
 from .core.workflow import DotFlow
+from .core.decorators import retry  # deprecated
 
 
 __all__ = [

dotflow/core/action.py

@@ -19,14 +19,14 @@ def __call__(self, *args, **kwargs):
             else:
                 return Context(storage=self._retry(*args))
 
-        def wrapper(*_args, **_kwargs):
+        def action(*_args, **_kwargs):
             self.func = args[0]
             if self._has_context():
                 context = _kwargs.get("previous_context") or Context()
                 return Context(storage=self._retry(*_args, previous_context=context))
             else:
                 return Context(storage=self._retry(*_args))
-        return wrapper
+        return action
 
     def _retry(self, *args, **kwargs):
         attempt = 0

dotflow/core/controller.py

@@ -6,7 +6,8 @@
 from typing import Callable, List
 
 from dotflow.core.context import Context
-from dotflow.core.status.workflow import WorkflowStatus
+from dotflow.core.exception import ExecutionModeNotExist
+from dotflow.core.models import Execution, Status
 from dotflow.core.task import Task
 from dotflow.core.utils import exec
 from dotflow.core.decorators import time
@@ -19,7 +20,7 @@ def __init__(self,
                  success: Callable = exec,
                  failure: Callable = exec,
                  keep_going: bool = False,
-                 mode: str = "sequential"):
+                 mode: Execution = Execution.SEQUENTIAL):
         self.workflow_id = uuid4()
         self.tasks = tasks
         self.success = success
@@ -28,28 +29,28 @@ def __init__(self,
         try:
             getattr(self, mode)(keep_going=keep_going)
         except AttributeError:
-            raise Exception("Execution mode does not exist.") from AttributeError
+            raise ExecutionModeNotExist()
 
     def _callback_workflow(self, result: Task):
         final_status = [flow.status for flow in result]
-        if WorkflowStatus.FAILED in final_status:
+        if Status.FAILED in final_status:
             self.failure(content=result)
         else:
             self.success(content=result)
 
     @time
     def _excution(self, task: Task, previous_context: Context):
         task.workflow_id = self.workflow_id
-        task.set_status(WorkflowStatus.IN_PROGRESS)
+        task.set_status(Status.IN_PROGRESS)
         task.set_previous_context(previous_context)
 
         try:
             current_context = task.step(previous_context=previous_context)
-            task.set_status(WorkflowStatus.COMPLETED)
+            task.set_status(Status.COMPLETED)
             task.set_current_context(current_context)
 
         except Exception as error:
-            task.set_status(WorkflowStatus.FAILED)
+            task.set_status(Status.FAILED)
             task.error.append(error)
 
         task.callback(content=task)
@@ -66,7 +67,7 @@ def sequential(self, keep_going: bool = False):
             previous_context = task.current_context
 
             if not keep_going:
-                if task.status == WorkflowStatus.FAILED:
+                if task.status == Status.FAILED:
                     break
 
         self._callback_workflow(result=self.tasks)

dotflow/core/decorators/retry.py

@@ -4,7 +4,11 @@
 
 
 def retry(max_retry: int):
-    warn("The 'retry' decorator is deprecated", DeprecationWarning, stacklevel=2)
+    warn(
+        message="The 'retry' decorator is deprecated",
+        category=DeprecationWarning,
+        stacklevel=2
+    )
 
     def inside(func):
 

dotflow/core/decorators/time.py

@@ -5,8 +5,8 @@
 
 def time(func):
     def inside(*args, **kwargs):
-            start = datetime.now()
-            task = func(*args, **kwargs)
-            task.set_duration((datetime.now() - start).total_seconds())
-            return task
+        start = datetime.now()
+        task = func(*args, **kwargs)
+        task.set_duration((datetime.now() - start).total_seconds())
+        return task
     return inside

dotflow/core/exception.py

@@ -0,0 +1,16 @@
+"""Exception module"""
+
+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_EXECUTION_NOT_EXIST = "The execution mode does not exist. Allowed parameter is 'sequential' and 'background'."
+
+
+class MissingStepDecorator(Exception):
+
+    def __init__(self):
+        super(MissingStepDecorator, self).__init__(MESSAGE_MISSING_STEP_DECORATOR)
+
+
+class ExecutionModeNotExist(Exception):
+
+    def __init__(self):
+        super(ExecutionModeNotExist, self).__init__(MESSAGE_EXECUTION_NOT_EXIST)

dotflow/core/models/__init__.py

@@ -0,0 +1,10 @@
+"""Types __init__ module."""
+
+from dotflow.core.models.execution import Execution
+from dotflow.core.models.status import Status
+
+
+__all__ = [
+    "Execution",
+    "Status"
+]

dotflow/core/models/execution.py

@@ -0,0 +1,9 @@
+"""Execution mode module"""
+
+
+class Execution:
+
+    SEQUENTIAL = "sequential"
+    BACKGROUND = "background"
+    PARALLEL = "parallel"
+    DATA_STORE = "data_store"