ddeutil-workflow 0.0.30__tar.gz → 0.0.31__tar.gz

{ddeutil_workflow-0.0.30/src/ddeutil_workflow.egg-info → ddeutil_workflow-0.0.31}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ddeutil-workflow
-Version: 0.0.30
+Version: 0.0.31
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -192,6 +192,15 @@ The above workflow template is main executor pipeline that you want to do. If yo
 want to schedule this workflow, you want to dynamic its parameters change base on
 execution time such as `run-date` should change base on that workflow running date.
 
+```python
+from ddeutil.workflow import Workflow, Result
+
+workflow: Workflow = Workflow.from_loader('run-py-local')
+result: Result = workflow.execute(
+   params={"source-extract": "USD-THB", "asat-dt": "2024-01-01"}
+)
+```
+
 So, this package provide the `Schedule` template for this action.
 
 ```yaml

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/README.md

@@ -160,6 +160,15 @@ The above workflow template is main executor pipeline that you want to do. If yo
 want to schedule this workflow, you want to dynamic its parameters change base on
 execution time such as `run-date` should change base on that workflow running date.
 
+```python
+from ddeutil.workflow import Workflow, Result
+
+workflow: Workflow = Workflow.from_loader('run-py-local')
+result: Result = workflow.execute(
+   params={"source-extract": "USD-THB", "asat-dt": "2024-01-01"}
+)
+```
+
 So, this package provide the `Schedule` template for this action.
 
 ```yaml

ddeutil_workflow-0.0.31/src/ddeutil/workflow/__about__.py

@@ -0,0 +1 @@
+__version__: str = "0.0.31"

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/__cron.py

@@ -845,5 +845,6 @@ __all__ = (
     "CronJob",
     "CronJobYear",
     "CronRunner",
+    "Options",
     "WEEKDAYS",
 )

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/__init__.py

@@ -47,8 +47,10 @@ from .params import (
 from .result import Result
 from .scheduler import (
     Schedule,
-    WorkflowSchedule,
+    ScheduleWorkflow,
+    schedule_control,
     schedule_runner,
+    schedule_task,
 )
 from .stage import (
     BashStage,
@@ -83,6 +85,8 @@ from .utils import (
     make_exec,
 )
 from .workflow import (
+    Release,
+    ReleaseQueue,
     Workflow,
     WorkflowTask,
 )

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/conf.py

@@ -582,6 +582,10 @@ Log = Union[
 
 
 def get_log() -> type[Log]:  # pragma: no cov
+    """Get logging class that dynamic base on the config log path value.
+
+    :rtype: type[Log]
+    """
     if config.log_path.is_file():
         return SQLiteLog
     return FileLog

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/cron.py

@@ -5,16 +5,17 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+from dataclasses import fields
 from datetime import datetime
-from typing import Annotated, Literal
+from typing import Annotated, Literal, Union
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, ValidationInfo
 from pydantic.functional_serializers import field_serializer
 from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
-from .__cron import WEEKDAYS, CronJob, CronJobYear, CronRunner
+from .__cron import WEEKDAYS, CronJob, CronJobYear, CronRunner, Options
 from .__types import DictData, DictStr, TupleStr
 from .conf import Loader
 
@@ -47,6 +48,8 @@ def interval2crontab(
         '0 0 1 * *'
         >>> interval2crontab(interval='monthly', day='tuesday', time='12:00')
         '12 0 1 * 2'
+
+    :rtype: str
     """
     d: str = "*"
     if interval == "weekly":
@@ -64,12 +67,19 @@ class On(BaseModel):
     """On Pydantic model (Warped crontab object by model).
 
     See Also:
-        * ``generate()`` is the main usecase of this schedule object.
+        * ``generate()`` is the main use-case of this schedule object.
     """
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
     # NOTE: This is fields of the base schedule.
+    extras: Annotated[
+        DictData,
+        Field(
+            default_factory=dict,
+            description="An extras mapping parameters",
+        ),
+    ]
     cronjob: Annotated[
         CronJob,
         Field(description="Cron job of this schedule"),
@@ -81,13 +91,6 @@ class On(BaseModel):
             alias="timezone",
         ),
     ] = "Etc/UTC"
-    extras: Annotated[
-        DictData,
-        Field(
-            default_factory=dict,
-            description="An extras mapping parameters",
-        ),
-    ]
 
     @classmethod
     def from_value(cls, value: DictStr, externals: DictData) -> Self:
@@ -153,6 +156,7 @@ class On(BaseModel):
 
     @model_validator(mode="before")
     def __prepare_values(cls, values: DictData) -> DictData:
+        """Extract tz key from value and change name to timezone key."""
         if tz := values.pop("tz", None):
             values["timezone"] = tz
         return values
@@ -160,24 +164,55 @@ class On(BaseModel):
     @field_validator("tz")
     def __validate_tz(cls, value: str) -> str:
         """Validate timezone value that able to initialize with ZoneInfo after
-        it passing to this model in before mode."""
+        it passing to this model in before mode.
+
+        :rtype: str
+        """
         try:
             _ = ZoneInfo(value)
             return value
         except ZoneInfoNotFoundError as err:
             raise ValueError(f"Invalid timezone: {value}") from err
 
-    @field_validator("cronjob", mode="before")
-    def __prepare_cronjob(cls, value: str | CronJob) -> CronJob:
-        """Prepare crontab value that able to receive with string type."""
-        return CronJob(value) if isinstance(value, str) else value
+    @field_validator(
+        "cronjob", mode="before", json_schema_input_type=Union[CronJob, str]
+    )
+    def __prepare_cronjob(
+        cls, value: str | CronJob, info: ValidationInfo
+    ) -> CronJob:
+        """Prepare crontab value that able to receive with string type.
+        This step will get options kwargs from extras and pass to the
+        CronJob object.
+
+        :rtype: CronJob
+        """
+        extras: DictData = info.data.get("extras", {})
+        return (
+            CronJob(
+                value,
+                option={
+                    name: extras[name]
+                    for name in (f.name for f in fields(Options))
+                    if name in extras
+                },
+            )
+            if isinstance(value, str)
+            else value
+        )
 
     @field_serializer("cronjob")
     def __serialize_cronjob(self, value: CronJob) -> str:
+        """Serialize the cronjob field that store with CronJob object.
+
+        :rtype: str
+        """
         return str(value)
 
     def generate(self, start: str | datetime) -> CronRunner:
-        """Return Cron runner object."""
+        """Return Cron runner object.
+
+        :rtype: CronRunner
+        """
         if isinstance(start, str):
             start: datetime = datetime.fromisoformat(start)
         elif not isinstance(start, datetime):
@@ -187,6 +222,8 @@ class On(BaseModel):
     def next(self, start: str | datetime) -> CronRunner:
         """Return a next datetime from Cron runner object that start with any
         date that given from input.
+
+        :rtype: CronRunner
         """
         runner: CronRunner = self.generate(start=start)
 
@@ -209,7 +246,26 @@ class YearOn(On):
         Field(description="Cron job of this schedule"),
     ]
 
-    @field_validator("cronjob", mode="before")
-    def __prepare_cronjob(cls, value: str | CronJobYear) -> CronJobYear:
-        """Prepare crontab value that able to receive with string type."""
-        return CronJobYear(value) if isinstance(value, str) else value
+    @field_validator(
+        "cronjob", mode="before", json_schema_input_type=Union[CronJob, str]
+    )
+    def __prepare_cronjob(
+        cls, value: str | CronJobYear, info: ValidationInfo
+    ) -> CronJobYear:
+        """Prepare crontab value that able to receive with string type.
+
+        :rtype: CronJobYear
+        """
+        extras: DictData = info.data.get("extras", {})
+        return (
+            CronJobYear(
+                value,
+                option={
+                    name: extras[name]
+                    for name in (f.name for f in fields(Options))
+                    if name in extras
+                },
+            )
+            if isinstance(value, str)
+            else value
+        )

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/exceptions.py

@@ -29,3 +29,6 @@ class WorkflowFailException(WorkflowException): ...
 
 
 class ParamValueException(WorkflowException): ...
+
+
+class ScheduleException(BaseWorkflowException): ...

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/params.py

@@ -5,6 +5,7 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+import decimal
 import logging
 from abc import ABC, abstractmethod
 from datetime import date, datetime
@@ -49,7 +50,7 @@ class BaseParam(BaseModel, ABC):
 
 class DefaultParam(BaseParam):
     """Default Parameter that will check default if it required. This model do
-    not implement the receive method.
+    not implement the `receive` method.
     """
 
     required: bool = Field(
@@ -68,6 +69,15 @@ class DefaultParam(BaseParam):
         )
 
 
+# TODO: Not implement this parameter yet
+class DateParam(DefaultParam):
+    """Date parameter."""
+
+    type: Literal["date"] = "date"
+
+    def receive(self, value: Optional[str | date] = None) -> date: ...
+
+
 class DatetimeParam(DefaultParam):
     """Datetime parameter."""
 
@@ -145,6 +155,13 @@ class IntParam(DefaultParam):
         return value
 
 
+# TODO: Not implement this parameter yet
+class DecimalParam(DefaultParam):
+    type: Literal["decimal"] = "decimal"
+
+    def receive(self, value: float | None = None) -> decimal.Decimal: ...
+
+
 class ChoiceParam(BaseParam):
     """Choice parameter."""
 

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/result.py

@@ -94,6 +94,7 @@ class Result:
         # NOTE: Check the context has jobs key.
         if "jobs" not in self.__dict__["context"]:
             self.__dict__["context"]["jobs"] = {}
+
         self.__dict__["context"]["jobs"].update(result.context)
 
         # NOTE: Update running ID from an incoming result.

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/scheduler.py

@@ -33,7 +33,7 @@ from functools import wraps
 from heapq import heappop, heappush
 from textwrap import dedent
 from threading import Thread
-from typing import Callable, Optional, TypedDict
+from typing import Callable, Optional, TypedDict, Union
 
 from pydantic import BaseModel, Field
 from pydantic.functional_validators import field_validator, model_validator
@@ -41,7 +41,7 @@ from typing_extensions import Self
 
 try:
     from typing import ParamSpec
-except ImportError:
+except ImportError:  # pragma: no cov
     from typing_extensions import ParamSpec
 
 try:
@@ -53,11 +53,9 @@ from .__cron import CronRunner
 from .__types import DictData, TupleStr
 from .conf import Loader, Log, config, get_log, get_logger
 from .cron import On
-from .exceptions import WorkflowException
-from .utils import (
-    batch,
-    delay,
-)
+from .exceptions import ScheduleException, WorkflowException
+from .result import Result
+from .utils import batch, delay
 from .workflow import Release, ReleaseQueue, Workflow, WorkflowTask
 
 P = ParamSpec("P")
@@ -69,7 +67,7 @@ logging.getLogger("schedule").setLevel(logging.INFO)
 
 __all__: TupleStr = (
     "Schedule",
-    "WorkflowSchedule",
+    "ScheduleWorkflow",
     "schedule_task",
     "monitor",
     "schedule_control",
@@ -79,8 +77,8 @@ __all__: TupleStr = (
 )
 
 
-class WorkflowSchedule(BaseModel):
-    """Workflow Schedule Pydantic model that use to keep workflow model for
+class ScheduleWorkflow(BaseModel):
+    """Schedule Workflow Pydantic model that use to keep workflow model for
     the Schedule model. it should not use Workflow model directly because on the
     schedule config it can adjust crontab value that different from the Workflow
     model.
@@ -233,9 +231,9 @@ class Schedule(BaseModel):
             "A schedule description that can be string of markdown content."
         ),
     )
-    workflows: list[WorkflowSchedule] = Field(
+    workflows: list[ScheduleWorkflow] = Field(
         default_factory=list,
-        description="A list of WorkflowSchedule models.",
+        description="A list of ScheduleWorkflow models.",
     )
 
     @field_validator("desc", mode="after")
@@ -258,7 +256,7 @@ class Schedule(BaseModel):
         an input schedule name. The loader object will use this schedule name to
         searching configuration data of this schedule model in conf path.
 
-        :param name: A schedule name that want to pass to Loader object.
+        :param name: (str) A schedule name that want to pass to Loader object.
         :param externals: An external parameters that want to pass to Loader
             object.
 
@@ -277,6 +275,37 @@ class Schedule(BaseModel):
 
         return cls.model_validate(obj=loader_data)
 
+    @classmethod
+    def extract_tasks(
+        cls,
+        schedules: list[str],
+        start_date: datetime,
+        queue: dict[str, ReleaseQueue],
+        externals: DictData | None = None,
+    ) -> list[WorkflowTask]:
+        """Return the list of WorkflowTask object from all schedule object that
+        include in an input schedules argument.
+
+        :param schedules: A list of schedule name that will use `from_loader`
+            method.
+        :param start_date: A start date that get from the workflow schedule.
+        :param queue: A mapping of name and list of datetime for queue.
+        :param externals: An external parameters that pass to the Loader object.
+
+        :rtype: list[WorkflowTask]
+        """
+        tasks: list[WorkflowTask] = []
+        for name in schedules:
+            schedule: Schedule = Schedule.from_loader(name, externals=externals)
+            tasks.extend(
+                schedule.tasks(
+                    start_date,
+                    queue=queue,
+                    externals=externals,
+                ),
+            )
+        return tasks
+
     def tasks(
         self,
         start_date: datetime,
@@ -311,7 +340,8 @@ class Schedule(BaseModel):
         return workflow_tasks
 
 
-ReturnCancelJob = Callable[P, Optional[CancelJob]]
+ResultOrCancelJob = Union[type[CancelJob], Result]
+ReturnCancelJob = Callable[P, ResultOrCancelJob]
 DecoratorCancelJob = Callable[[ReturnCancelJob], ReturnCancelJob]
 
 
@@ -326,24 +356,25 @@ def catch_exceptions(cancel_on_failure: bool = False) -> DecoratorCancelJob:
     """
 
     def decorator(func: ReturnCancelJob) -> ReturnCancelJob:  # pragma: no cov
-        try:
 
-            @wraps(func)
-            def wrapper(*args, **kwargs):
+        @wraps(func)
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> ResultOrCancelJob:
+            try:
                 return func(*args, **kwargs)
+            except Exception as err:
+                logger.exception(err)
+                if cancel_on_failure:
+                    return CancelJob
+                raise err
 
-            return wrapper
-
-        except Exception as err:
-            logger.exception(err)
-            if cancel_on_failure:
-                return CancelJob
-            raise err
+        return wrapper
 
     return decorator
 
 
 class ReleaseThread(TypedDict):
+    """TypeDict for the release thread."""
+
     thread: Thread
     start_date: datetime
 
@@ -358,11 +389,13 @@ def schedule_task(
     queue: dict[str, ReleaseQueue],
     threads: ReleaseThreads,
     log: type[Log],
-) -> CancelJob | None:
-    """Workflow task generator that create release pair of workflow and on to
-    the threading in background.
+) -> type[CancelJob] | None:
+    """Schedule task function that generate thread of workflow task release
+    method in background. This function do the same logic as the workflow poke
+    method, but it runs with map of schedules and the on values.
 
-        This workflow task will start every minute at ':02' second.
+        This schedule task start runs every minute at ':02' second and it does
+    not allow you to run with offset time.
 
     :param tasks: A list of WorkflowTask object.
     :param stop: A stop datetime object that force stop running scheduler.
@@ -370,7 +403,7 @@ def schedule_task(
     :param threads: A mapping of alias name and Thread object.
     :param log: A log class that want to make log object.
 
-    :rtype: CancelJob | None
+    :rtype: type[CancelJob] | None
     """
     current_date: datetime = datetime.now(tz=config.tz)
     if current_date > stop.replace(tzinfo=config.tz):
@@ -410,12 +443,17 @@ def schedule_task(
         current_release: datetime = current_date.replace(
             second=0, microsecond=0
         )
-        if (first_date := q.first_queue.date) != current_release:
+        if (first_date := q.first_queue.date) > current_release:
             logger.debug(
                 f"[WORKFLOW]: Skip schedule "
                 f"{first_date:%Y-%m-%d %H:%M:%S} for : {task.alias!r}"
             )
             continue
+        elif first_date < current_release:  # pragma: no cov
+            raise ScheduleException(
+                "The first release date from queue should not less than current"
+                "release date."
+            )
 
         # NOTE: Pop the latest release and push it to running.
         release: Release = heappop(q.queue)
@@ -445,7 +483,7 @@ def schedule_task(
 
         delay()
 
-    logger.debug(f"[SCHEDULE]: End schedule release {'=' * 80}")
+    logger.debug(f"[SCHEDULE]: End schedule task {'=' * 80}")
 
 
 def monitor(threads: ReleaseThreads) -> None:  # pragma: no cov
@@ -455,9 +493,7 @@ def monitor(threads: ReleaseThreads) -> None:  # pragma: no cov
     :param threads: A mapping of Thread object and its name.
     :type threads: ReleaseThreads
     """
-    logger.debug(
-        "[MONITOR]: Start checking long running workflow release task."
-    )
+    logger.debug("[MONITOR]: Start checking long running schedule task.")
 
     snapshot_threads: list[str] = list(threads.keys())
     for t_name in snapshot_threads:
@@ -476,12 +512,15 @@ def schedule_control(
     *,
     log: type[Log] | None = None,
 ) -> list[str]:  # pragma: no cov
-    """Scheduler control function that running every minute.
+    """Scheduler control function that run the chuck of schedules every minute
+    and this function release monitoring thread for tracking undead thread in
+    the background.
 
     :param schedules: A list of workflow names that want to schedule running.
     :param stop: A datetime value that use to stop running schedule.
     :param externals: An external parameters that pass to Loader.
-    :param log:
+    :param log: A log class that use on the workflow task release for writing
+        its release log context.
 
     :rtype: list[str]
     """
@@ -493,8 +532,11 @@ def schedule_control(
             "Should install schedule package before use this module."
         ) from None
 
+    # NOTE: Get default logging.
     log: type[Log] = log or get_log()
     scheduler: Scheduler = Scheduler()
+
+    # NOTE: Create the start and stop datetime.
     start_date: datetime = datetime.now(tz=config.tz)
     stop_date: datetime = stop or (start_date + config.stop_boundary_delta)
 
@@ -506,25 +548,15 @@ def schedule_control(
         second=0, microsecond=0
     ) + timedelta(minutes=1)
 
-    # NOTE: Start create workflow tasks from list of schedule name.
-    tasks: list[WorkflowTask] = []
-    for name in schedules:
-        schedule: Schedule = Schedule.from_loader(name, externals=externals)
-        tasks.extend(
-            schedule.tasks(
-                start_date_waiting,
-                queue=queue,
-                externals=externals,
-            ),
-        )
-
     # NOTE: This schedule job will start every minute at :02 seconds.
     (
         scheduler.every(1)
         .minutes.at(":02")
         .do(
             schedule_task,
-            tasks=tasks,
+            tasks=Schedule.extract_tasks(
+                schedules, start_date_waiting, queue, externals=externals
+            ),
             stop=stop_date,
             queue=queue,
             threads=threads,
@@ -533,7 +565,8 @@ def schedule_control(
         .tag("control")
     )
 
-    # NOTE: Checking zombie task with schedule job will start every 5 minute.
+    # NOTE: Checking zombie task with schedule job will start every 5 minute at
+    #   :10 seconds.
     (
         scheduler.every(5)
         .minutes.at(":10")
@@ -579,16 +612,15 @@ def schedule_runner(
     externals: DictData | None = None,
     excluded: list[str] | None = None,
 ) -> list[str]:  # pragma: no cov
-    """Schedule runner function for start submit the ``schedule_control`` func
-    in multiprocessing pool with chunk of schedule config that exists in config
-    path by ``WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS``.
+    """Schedule runner function it the multiprocess controller function for
+    split the setting schedule to the `schedule_control` function on the
+    process pool. It chunks schedule configs that exists in config
+    path by `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` value.
 
     :param stop: A stop datetime object that force stop running scheduler.
     :param externals:
     :param excluded: A list of schedule name that want to exclude from finding.
 
-    :rtype: list[str]
-
         This function will get all workflows that include on value that was
     created in config path and chuck it with application config variable
     ``WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS`` env var to multiprocess executor
@@ -600,7 +632,9 @@ def schedule_runner(
                                         --> thread of release task 01 02
                             ==> schedule --> thread of release task 02 01
                                         --> thread of release task 02 02
-            ==> process 02
+            ==> process 02  ==> ...
+
+    :rtype: list[str]
     """
     results: list[str] = []
 

{ddeutil_workflow-0.0.30 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/stage.py

@@ -328,7 +328,7 @@ class BashStage(BaseStage):
     If your current OS is Windows, it will run on the bash in the WSL.
 
         I get some limitation when I run shell statement with the built-in
-    supprocess package. It does not good enough to use multiline statement.
+    subprocess package. It does not good enough to use multiline statement.
     Thus, I add writing ``.sh`` file before execution process for fix this
     issue.
 
@@ -665,3 +665,15 @@ Stage = Union[
     TriggerStage,
     EmptyStage,
 ]
+
+
+# TODO: Not implement this stages yet
+class ParallelStage(BaseModel):
+    parallel: list[Stage]
+    max_parallel_core: int = Field(default=2)
+
+
+# TODO: Not implement this stages yet
+class ForEachStage(BaseModel):
+    foreach: list[str]
+    stages: list[Stage]