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

{ddeutil_workflow-0.0.29/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.29
+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
@@ -212,9 +221,9 @@ schedule-run-local-wf:
 
 ## :cookie: Configuration
 
-The main configuration that use to dynamic changing with your objective of this
-application. If any configuration values do not set yet, it will use default value
-and do not raise any error to you.
+The main configuration that use to dynamic changing this workflow engine for your
+objective use environment variable only. If any configuration values do not set yet,
+it will use default value and do not raise any error to you.
 
 > [!IMPORTANT]
 > The config value that you will set on the environment should combine with
@@ -246,6 +255,9 @@ and do not raise any error to you.
 
 **API Application**:
 
+This config part use for the workflow application that build from the FastAPI
+only.
+
 | Environment                |  Component  | Default | Description                                                                        |
 |:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
 | **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
@@ -272,16 +284,9 @@ like crontab job but via Python API.
 
 ### Docker Container
 
-Create Docker image;
-
 ```shell
 $ docker build -t ddeutil-workflow:latest -f .container/Dockerfile .
-```
-
-Run the above Docker image;
-
-```shell
-$ docker run -i ddeutil-workflow:latest
+$ docker run -i ddeutil-workflow:latest ddeutil-workflow
 ```
 
 ## :speech_balloon: Contribute

{ddeutil_workflow-0.0.29 → 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
@@ -180,9 +189,9 @@ schedule-run-local-wf:
 
 ## :cookie: Configuration
 
-The main configuration that use to dynamic changing with your objective of this
-application. If any configuration values do not set yet, it will use default value
-and do not raise any error to you.
+The main configuration that use to dynamic changing this workflow engine for your
+objective use environment variable only. If any configuration values do not set yet,
+it will use default value and do not raise any error to you.
 
 > [!IMPORTANT]
 > The config value that you will set on the environment should combine with
@@ -214,6 +223,9 @@ and do not raise any error to you.
 
 **API Application**:
 
+This config part use for the workflow application that build from the FastAPI
+only.
+
 | Environment                |  Component  | Default | Description                                                                        |
 |:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
 | **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
@@ -240,16 +252,9 @@ like crontab job but via Python API.
 
 ### Docker Container
 
-Create Docker image;
-
 ```shell
 $ docker build -t ddeutil-workflow:latest -f .container/Dockerfile .
-```
-
-Run the above Docker image;
-
-```shell
-$ docker run -i ddeutil-workflow:latest
+$ docker run -i ddeutil-workflow:latest ddeutil-workflow
 ```
 
 ## :speech_balloon: Contribute

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

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

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

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

{ddeutil_workflow-0.0.29 → 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.29 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/api/api.py

@@ -18,7 +18,7 @@ from fastapi.responses import UJSONResponse
 from ..__about__ import __version__
 from ..conf import config, get_logger
 from ..scheduler import ReleaseThread, ReleaseThreads
-from ..workflow import WorkflowQueue, WorkflowTask
+from ..workflow import ReleaseQueue, WorkflowTask
 from .repeat import repeat_at
 
 load_dotenv()
@@ -31,7 +31,7 @@ class State(TypedDict):
     scheduler: list[str]
     workflow_threads: ReleaseThreads
     workflow_tasks: list[WorkflowTask]
-    workflow_queue: dict[str, WorkflowQueue]
+    workflow_queue: dict[str, ReleaseQueue]
 
 
 @contextlib.asynccontextmanager

{ddeutil_workflow-0.0.29 → 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.29 → 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.29 → 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.29 → ddeutil_workflow-0.0.31}/src/ddeutil/workflow/hook.py

@@ -79,7 +79,9 @@ def make_registry(submodule: str) -> dict[str, Registry]:
     :rtype: dict[str, Registry]
     """
     rs: dict[str, Registry] = {}
-    for module in config.regis_hook | ["ddeutil.vendors"]:
+    regis_hooks: list[str] = config.regis_hook
+    regis_hooks.extend(["ddeutil.vendors"])
+    for module in regis_hooks:
         # NOTE: try to sequential import task functions
         try:
             importer = import_module(f"{module}.{submodule}")

{ddeutil_workflow-0.0.29 → 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.29 → 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.