ddeutil-workflow 0.0.13__tar.gz → 0.0.15__tar.gz

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ddeutil-workflow
-Version: 0.0.13
+Version: 0.0.15
 Summary: Lightweight workflow orchestration with less dependencies
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -22,12 +22,13 @@ Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.9.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: ddeutil-io>=0.1.12
+Requires-Dist: ddeutil>=0.4.0
+Requires-Dist: ddeutil-io>=0.1.13
 Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: typer<1.0.0,==0.12.5
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
-Requires-Dist: fastapi<1.0.0,>=0.114.1; extra == "api"
+Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"
 
 # Workflow
 
@@ -62,7 +63,7 @@ configuration. It called **Metadata Driven Data Workflow**.
 
 > [!NOTE]
 > _Disclaimer_: I inspire the dynamic statement from the [**GitHub Action**](https://github.com/features/actions)
-> `.yml` files and all of config file from several data orchestration framework
+> with `.yml` files and all of config file from several data orchestration framework
 > tools from my experience on Data Engineer. :grimacing:
 >
 > Other workflow that I interest on them and pick some interested feature to this
@@ -92,6 +93,7 @@ this package with application add-ons, you should add `app` in installation;
 > | ddeutil-workflow:python3.10 | `3.10`         | :x:     |
 > | ddeutil-workflow:python3.11 | `3.11`         | :x:     |
 > | ddeutil-workflow:python3.12 | `3.12`         | :x:     |
+> | ddeutil-workflow:python3.12 | `3.13`         | :x:     |
 
 ## :beers: Usage
 

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/README.md

@@ -31,7 +31,7 @@ configuration. It called **Metadata Driven Data Workflow**.
 
 > [!NOTE]
 > _Disclaimer_: I inspire the dynamic statement from the [**GitHub Action**](https://github.com/features/actions)
-> `.yml` files and all of config file from several data orchestration framework
+> with `.yml` files and all of config file from several data orchestration framework
 > tools from my experience on Data Engineer. :grimacing:
 >
 > Other workflow that I interest on them and pick some interested feature to this
@@ -61,6 +61,7 @@ this package with application add-ons, you should add `app` in installation;
 > | ddeutil-workflow:python3.10 | `3.10`         | :x:     |
 > | ddeutil-workflow:python3.11 | `3.11`         | :x:     |
 > | ddeutil-workflow:python3.12 | `3.12`         | :x:     |
+> | ddeutil-workflow:python3.12 | `3.13`         | :x:     |
 
 ## :beers: Usage
 

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/pyproject.toml

@@ -26,7 +26,8 @@ classifiers = [
 ]
 requires-python = ">=3.9.13"
 dependencies = [
-    "ddeutil-io>=0.1.12",
+    "ddeutil>=0.4.0",
+    "ddeutil-io>=0.1.13",
     "python-dotenv==1.0.1",
     "typer==0.12.5,<1.0.0",
     "schedule==1.2.2,<2.0.0",
@@ -35,7 +36,7 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 api = [
-    "fastapi>=0.114.1,<1.0.0",
+    "fastapi>=0.115.0,<1.0.0",
 ]
 
 [project.urls]
@@ -62,7 +63,6 @@ concurrency = ["thread", "multiprocessing"]
 source = ["ddeutil.workflow", "tests"]
 omit = [
     "src/ddeutil/workflow/__about__.py",
-    "scripts/",
     # Omit this files because it does not ready to production.
     "src/ddeutil/workflow/api.py",
     "src/ddeutil/workflow/cli.py",

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

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

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/src/ddeutil/workflow/__init__.py

@@ -12,7 +12,10 @@ from .exceptions import (
 )
 from .job import Job, Strategy
 from .on import On, interval2crontab
-from .scheduler import Workflow
+from .scheduler import (
+    Schedule,
+    Workflow,
+)
 from .stage import Stage, handler_result
 from .utils import (
     Param,

ddeutil_workflow-0.0.15/src/ddeutil/workflow/__types.py

@@ -0,0 +1,113 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+import re
+from collections.abc import Iterator
+from dataclasses import dataclass
+from re import (
+    IGNORECASE,
+    MULTILINE,
+    UNICODE,
+    VERBOSE,
+    Match,
+    Pattern,
+)
+from typing import Any, Optional, Union
+
+from typing_extensions import Self
+
+TupleStr = tuple[str, ...]
+DictData = dict[str, Any]
+DictStr = dict[str, str]
+Matrix = dict[str, Union[list[str], list[int]]]
+MatrixInclude = list[dict[str, Union[str, int]]]
+MatrixExclude = list[dict[str, Union[str, int]]]
+
+
+@dataclass(frozen=True)
+class CallerRe:
+    """Caller dataclass that catching result from the matching regex with the
+    Re.RE_CALLER value.
+    """
+
+    full: str
+    caller: str
+    caller_prefix: Optional[str]
+    caller_last: str
+    post_filters: str
+
+    @classmethod
+    def from_regex(cls, match: Match[str]) -> Self:
+        """Class construct from matching result.
+
+        :rtype: Self
+        """
+        return cls(full=match.group(0), **match.groupdict())
+
+
+class Re:
+    """Regular expression config for this package."""
+
+    # NOTE:
+    #   Regular expression:
+    #       - Version 1:
+    #         \${{\s*(?P<caller>[a-zA-Z0-9_.\s'\"\[\]\(\)\-\{}]+?)\s*(?P<post_filters>(?:\|\s*(?:[a-zA-Z0-9_]{3,}[a-zA-Z0-9_.,-\\%\s'\"[\]()\{}]+)\s*)*)}}
+    #       - Version 2 (2024-09-30):
+    #         \${{\s*(?P<caller>(?P<caller_prefix>(?:[a-zA-Z_-]+\.)*)(?P<caller_last>[a-zA-Z0-9_\-.'\"(\)[\]{}]+))\s*(?P<post_filters>(?:\|\s*(?:[a-zA-Z0-9_]{3,}[a-zA-Z0-9_.,-\\%\s'\"[\]()\{}]+)\s*)*)}}
+    #
+    #   Examples:
+    #       - ${{ params.data_dt }}
+    #       - ${{ params.source.table }}
+    #
+    __re_caller: str = r"""
+        \$
+        {{
+            \s*
+            (?P<caller>
+                (?P<caller_prefix>(?:[a-zA-Z_-]+\.)*)
+                (?P<caller_last>[a-zA-Z0-9_\-.'\"(\)[\]{}]+)
+            )
+            \s*
+            (?P<post_filters>
+                (?:
+                    \|\s*
+                    (?:
+                        [a-zA-Z0-9_]{3,}
+                        [a-zA-Z0-9_.,-\\%\s'\"[\]()\{}]*
+                    )\s*
+                )*
+            )
+        }}
+    """
+    RE_CALLER: Pattern = re.compile(
+        __re_caller, MULTILINE | IGNORECASE | UNICODE | VERBOSE
+    )
+
+    # NOTE:
+    #   Regular expression:
+    #       - Version 1:
+    #         ^(?P<path>[^/@]+)/(?P<func>[^@]+)@(?P<tag>.+)$
+    #
+    #   Examples:
+    #       - tasks/function@dummy
+    __re_task_fmt: str = r"""
+        ^
+            (?P<path>[^/@]+)
+            /
+            (?P<func>[^@]+)
+            @
+            (?P<tag>.+)
+        $
+    """
+    RE_TASK_FMT: Pattern = re.compile(
+        __re_task_fmt, MULTILINE | IGNORECASE | UNICODE | VERBOSE
+    )
+
+    @classmethod
+    def finditer_caller(cls, value) -> Iterator[CallerRe]:
+        for found in cls.RE_CALLER.finditer(value):
+            yield CallerRe.from_regex(found)

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/src/ddeutil/workflow/api.py

@@ -25,7 +25,7 @@ from pydantic import BaseModel
 from .__about__ import __version__
 from .log import get_logger
 from .repeat import repeat_at, repeat_every
-from .scheduler import WorkflowTask
+from .scheduler import WorkflowTaskData
 
 load_dotenv()
 logger = get_logger("ddeutil.workflow")
@@ -36,7 +36,7 @@ class State(TypedDict):
     upper_result: dict[str, str]
     scheduler: list[str]
     workflow_threads: dict[str, Thread]
-    workflow_tasks: list[WorkflowTask]
+    workflow_tasks: list[WorkflowTaskData]
     workflow_queue: dict[str, list[datetime]]
     workflow_running: dict[str, list[datetime]]
 

ddeutil_workflow-0.0.15/src/ddeutil/workflow/conf.py

@@ -0,0 +1,45 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+import os
+from zoneinfo import ZoneInfo
+
+from ddeutil.core import str2bool
+from dotenv import load_dotenv
+
+load_dotenv()
+env = os.getenv
+
+
+class Config:
+    """Config object for keeping application configuration on current session
+    without changing when if the application still running.
+    """
+
+    # NOTE: Core
+    tz: ZoneInfo = ZoneInfo(env("WORKFLOW_CORE_TIMEZONE", "UTC"))
+
+    # NOTE: Stage
+    stage_raise_error: bool = str2bool(
+        env("WORKFLOW_CORE_STAGE_RAISE_ERROR", "true")
+    )
+    stage_default_id: bool = str2bool(
+        env("WORKFLOW_CORE_STAGE_DEFAULT_ID", "false")
+    )
+
+    # NOTE: Workflow
+    max_job_parallel: int = int(env("WORKFLOW_CORE_MAX_JOB_PARALLEL", "2"))
+
+    def __init__(self):
+        if self.max_job_parallel < 0:
+            raise ValueError(
+                f"MAX_JOB_PARALLEL should more than 0 but got "
+                f"{self.max_job_parallel}."
+            )
+
+
+config = Config()

{ddeutil_workflow-0.0.13 → ddeutil_workflow-0.0.15}/src/ddeutil/workflow/cron.py

@@ -14,7 +14,7 @@ from typing import ClassVar, Optional, Union
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 from ddeutil.core import (
-    is_int,
+    checker,
     isinstance_check,
     must_split,
 )
@@ -38,16 +38,21 @@ class CronYearLimit(Exception): ...
 
 
 def str2cron(value: str) -> str:
-    """Convert Special String to Crontab.
-
-    @reboot 	Run once, at system startup
-    @yearly 	Run once every year, "0 0 1 1 *"
-    @annually   (same as @yearly)
-    @monthly    Run once every month, "0 0 1 * *"
-    @weekly 	Run once every week, "0 0 * * 0"
-    @daily  	Run once each day, "0 0 * * *"
-    @midnight   (same as @daily)
-    @hourly 	Run once an hour, "0 * * * *"
+    """Convert Special String with the @ prefix to Crontab value.
+
+    :param value: A string value that want to convert to cron value.
+    :rtype: str
+
+    Table:
+
+        @reboot 	Run once, at system startup
+        @yearly 	Run once every year, "0 0 1 1 *"
+        @annually   (same as @yearly)
+        @monthly    Run once every month, "0 0 1 * *"
+        @weekly 	Run once every week, "0 0 * * 0"
+        @daily  	Run once each day, "0 0 * * *"
+        @midnight   (same as @daily)
+        @hourly 	Run once an hour, "0 * * * *"
     """
     mapping_spacial_str = {
         "@reboot": "",
@@ -321,7 +326,9 @@ class CronPart:
                 self._parse_range(value_range)
             )
 
-            if (value_step and not is_int(value_step)) or value_step == "":
+            if (
+                value_step and not checker.is_int(value_step)
+            ) or value_step == "":
                 raise ValueError(
                     f"Invalid interval step value {value_step!r} for "
                     f"{self.unit.name!r}"