ddeutil-workflow 0.0.39__tar.gz → 0.0.40__tar.gz

{ddeutil_workflow-0.0.39/src/ddeutil_workflow.egg-info → ddeutil_workflow-0.0.40}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.39
+Version: 0.0.40
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -23,9 +23,9 @@ Requires-Python: >=3.9.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ddeutil>=0.4.6
-Requires-Dist: ddeutil-io[toml,yaml]>=0.2.3
-Requires-Dist: pydantic==2.10.6
-Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: ddeutil-io[toml,yaml]>=0.2.10
+Requires-Dist: pydantic==2.11.1
+Requires-Dist: python-dotenv==1.1.0
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/pyproject.toml

@@ -27,9 +27,9 @@ classifiers = [
 requires-python = ">=3.9.13"
 dependencies = [
     "ddeutil>=0.4.6",
-    "ddeutil-io[yaml,toml]>=0.2.3",
-    "pydantic==2.10.6",
-    "python-dotenv==1.0.1",
+    "ddeutil-io[yaml,toml]>=0.2.10",
+    "pydantic==2.11.1",
+    "python-dotenv==1.1.0",
     "schedule==1.2.2,<2.0.0",
 ]
 dynamic = ["version"]

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

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

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/src/ddeutil/workflow/__cron.py

@@ -37,7 +37,7 @@ class CronYearLimit(Exception): ...
 def str2cron(value: str) -> str:  # pragma: no cov
     """Convert Special String with the @ prefix to Crontab value.
 
-    :param value: A string value that want to convert to cron value.
+    :param value: (str) A string value that want to convert to cron value.
     :rtype: str
 
     Table:
@@ -82,6 +82,9 @@ class Unit:
         )
 
 
+Units = tuple[Unit, ...]
+
+
 @dataclass
 class Options:
     """Options dataclass for config CronPart object."""
@@ -91,7 +94,7 @@ class Options:
     output_hashes: bool = False
 
 
-CRON_UNITS: tuple[Unit, ...] = (
+CRON_UNITS: Units = (
     Unit(
         name="minute",
         range=partial(range, 0, 60),
@@ -147,7 +150,7 @@ CRON_UNITS: tuple[Unit, ...] = (
     ),
 )
 
-CRON_UNITS_YEAR: tuple[Unit, ...] = CRON_UNITS + (
+CRON_UNITS_YEAR: Units = CRON_UNITS + (
     Unit(
         name="year",
         range=partial(range, 1990, 2101),
@@ -220,18 +223,21 @@ class CronPart:
         return ",".join(cron_range_strings) if cron_range_strings else "?"
 
     def __repr__(self) -> str:
+        """Override __repr__ method."""
         return (
             f"{self.__class__.__name__}"
             f"(unit={self.unit}, values={self.__str__()!r})"
         )
 
     def __lt__(self, other) -> bool:
+        """Override __lt__ method."""
         if isinstance(other, CronPart):
             return self.values < other.values
         elif isinstance(other, list):
             return self.values < other
 
     def __eq__(self, other) -> bool:
+        """Override __eq__ method."""
         if isinstance(other, CronPart):
             return self.values == other.values
         elif isinstance(other, list):
@@ -239,18 +245,26 @@ class CronPart:
 
     @property
     def min(self) -> int:
-        """Returns the smallest value in the range."""
+        """Returns the smallest value in the range.
+
+        :rtype: int
+        """
         return self.values[0]
 
     @property
     def max(self) -> int:
-        """Returns the largest value in the range."""
+        """Returns the largest value in the range.
+
+        :rtype: int
+        """
         return self.values[-1]
 
     @property
     def step(self) -> Optional[int]:
         """Returns the difference between first and second elements in the
         range.
+
+        :rtype: Optional[int]
         """
         if (
             len(self.values) > 2
@@ -260,15 +274,17 @@ class CronPart:
 
     @property
     def is_full(self) -> bool:
-        """Returns true if range has all the values of the unit."""
+        """Returns true if range has all the values of the unit.
+
+        :rtype: bool
+        """
         return len(self.values) == (self.unit.max - self.unit.min + 1)
 
     def from_str(self, value: str) -> tuple[int, ...]:
         """Parses a string as a range of positive integers. The string should
         include only `-` and `,` special strings.
 
-        :param value: A string value that want to parse
-        :type value: str
+        :param value: (str) A string value that want to parse
 
         TODO: support for `L`, `W`, and `#`
         ---
@@ -351,6 +367,8 @@ class CronPart:
             For example if value == 'JAN,AUG' it will replace to '1,8'.
 
         :param value: A string value that want to replace alternative to int.
+
+        :rtype: str
         """
         for i, alt in enumerate(self.unit.alt):
             if alt in value:
@@ -361,6 +379,7 @@ class CronPart:
         """Replaces all 7 with 0 as Sunday can be represented by both.
 
         :param values: list or iter of int that want to mode by 7
+
         :rtype: list[int]
         """
         if self.unit.name == "weekday":
@@ -388,7 +407,13 @@ class CronPart:
         return values
 
     def _parse_range(self, value: str) -> list[int]:
-        """Parses a range string."""
+        """Parses a range string from a cron-part.
+
+        :param value: (str) A cron-part string value that want to parse.
+
+        :rtype: list[int]
+        :return: A list of parse range.
+        """
         if value == "*":
             return list(self.unit.range())
         elif value.count("-") > 1:
@@ -410,7 +435,13 @@ class CronPart:
         values: list[int],
         step: int | None = None,
     ) -> list[int]:
-        """Applies an interval step to a collection of values."""
+        """Applies an interval step to a collection of values.
+
+        :param values:
+        :param step:
+
+        :rtype: list[int]
+        """
         if not step:
             return values
         elif (_step := int(step)) < 1:
@@ -427,7 +458,10 @@ class CronPart:
 
     @property
     def is_interval(self) -> bool:
-        """Returns true if the range can be represented as an interval."""
+        """Returns true if the range can be represented as an interval.
+
+        :rtype: bool
+        """
         if not (step := self.step):
             return False
         for idx, value in enumerate(self.values):
@@ -439,7 +473,10 @@ class CronPart:
 
     @property
     def is_full_interval(self) -> bool:
-        """Returns true if the range contains all the interval values."""
+        """Returns true if the range contains all the interval values.
+
+        :rtype: bool
+        """
         if step := self.step:
             return (
                 self.min == self.unit.min
@@ -482,8 +519,7 @@ class CronPart:
         """Formats weekday and month names as string when the relevant options
         are set.
 
-        :param value: a int value
-        :type value: int
+        :param value: (int) An int value that want to get from the unit.
 
         :rtype: int | str
         """
@@ -538,8 +574,8 @@ class CronJob:
             monitor-data-warehouse-schedule.html
     """
 
-    cron_length: int = 5
-    cron_units: tuple[Unit, ...] = CRON_UNITS
+    cron_length: ClassVar[int] = 5
+    cron_units: ClassVar[Units] = CRON_UNITS
 
     def __init__(
         self,
@@ -600,38 +636,64 @@ class CronJob:
 
     @property
     def parts_order(self) -> Iterator[CronPart]:
+        """Return iterator of CronPart instance.
+
+        :rtype: Iterator[CronPart]
+        """
         return reversed(self.parts[:3] + [self.parts[4], self.parts[3]])
 
     @property
     def minute(self) -> CronPart:
-        """Return part of minute."""
+        """Return part of minute with the CronPart instance.
+
+        :rtype: CronPart
+        """
         return self.parts[0]
 
     @property
     def hour(self) -> CronPart:
-        """Return part of hour."""
+        """Return part of hour with the CronPart instance.
+
+        :rtype: CronPart
+        """
         return self.parts[1]
 
     @property
     def day(self) -> CronPart:
-        """Return part of day."""
+        """Return part of day with the CronPart instance.
+
+        :rtype: CronPart
+        """
         return self.parts[2]
 
     @property
     def month(self) -> CronPart:
-        """Return part of month."""
+        """Return part of month with the CronPart instance.
+
+        :rtype: CronPart
+        """
         return self.parts[3]
 
     @property
     def dow(self) -> CronPart:
-        """Return part of day of month."""
+        """Return part of day of month with the CronPart instance.
+
+        :rtype: CronPart
+        """
         return self.parts[4]
 
     def to_list(self) -> list[list[int]]:
-        """Returns the cron schedule as a 2-dimensional list of integers."""
+        """Returns the cron schedule as a 2-dimensional list of integers.
+
+        :rtype: list[list[int]]
+        """
         return [part.values for part in self.parts]
 
     def check(self, date: datetime, mode: str) -> bool:
+        """Check the date value with the mode.
+
+        :rtype: bool
+        """
         assert mode in ("year", "month", "day", "hour", "minute")
         return getattr(date, mode) in getattr(self, mode).values
 
@@ -667,12 +729,14 @@ class CronJobYear(CronJob):
         (vi)    year (1990 - 2100)
     """
 
-    cron_length = 6
-    cron_units = CRON_UNITS_YEAR
+    cron_length: ClassVar[int] = 6
+    cron_units: ClassVar[Units] = CRON_UNITS_YEAR
 
     @property
     def year(self) -> CronPart:
-        """Return part of year."""
+        """Return part of year with the CronPart instance.
+
+        :rtype: CronPart"""
         return self.parts[5]
 
 

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/src/ddeutil/workflow/conf.py

@@ -16,6 +16,7 @@ from zoneinfo import ZoneInfo
 
 from ddeutil.core import str2bool
 from ddeutil.io import YamlFlResolve
+from ddeutil.io.paths import glob_files, is_ignored, read_ignore
 
 from .__types import DictData, TupleStr
 
@@ -26,10 +27,6 @@ def env(var: str, default: str | None = None) -> str | None:  # pragma: no cov
     return os.getenv(f"{PREFIX}_{var.upper().replace(' ', '_')}", default)
 
 
-def glob_files(path: Path) -> Iterator[Path]:  # pragma: no cov
-    yield from (file for file in path.rglob("*") if file.is_file())
-
-
 __all__: TupleStr = (
     "env",
     "get_logger",
@@ -37,7 +34,6 @@ __all__: TupleStr = (
     "SimLoad",
     "Loader",
     "config",
-    "glob_files",
 )
 
 
@@ -273,7 +269,7 @@ class SimLoad:
             if self.is_ignore(file, conf_path):
                 continue
 
-            if data := self.filter_suffix(file, name=name):
+            if data := self.filter_yaml(file, name=name):
                 self.data = data
 
         # VALIDATE: check the data that reading should not empty.
@@ -307,15 +303,15 @@ class SimLoad:
         exclude: list[str] = excluded or []
         for file in glob_files(conf_path):
 
-            for key, data in cls.filter_suffix(file).items():
+            if cls.is_ignore(file, conf_path):
+                continue
 
-                if cls.is_ignore(file, conf_path):
-                    continue
+            for key, data in cls.filter_yaml(file).items():
 
                 if key in exclude:
                     continue
 
-                if data["type"] == obj.__name__:
+                if data.get("type", "") == obj.__name__:
                     yield key, (
                         {k: data[k] for k in data if k in included}
                         if included
@@ -324,24 +320,13 @@ class SimLoad:
 
     @classmethod
     def is_ignore(cls, file: Path, conf_path: Path) -> bool:
-        ignore_file: Path = conf_path / ".confignore"
-        ignore: list[str] = []
-        if ignore_file.exists():
-            ignore = ignore_file.read_text(encoding="utf-8").splitlines()
-
-        if any(
-            (file.match(f"**/{pattern}/*") or file.match(f"**/{pattern}*"))
-            for pattern in ignore
-        ):
-            return True
-        return False
+        return is_ignored(file, read_ignore(conf_path / ".confignore"))
 
     @classmethod
-    def filter_suffix(cls, file: Path, name: str | None = None) -> DictData:
+    def filter_yaml(cls, file: Path, name: str | None = None) -> DictData:
         if any(file.suffix.endswith(s) for s in (".yml", ".yaml")):
             values: DictData = YamlFlResolve(file).read()
             return values.get(name, {}) if name else values
-
         return {}
 
     @cached_property

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/src/ddeutil/workflow/scheduler.py

@@ -31,6 +31,7 @@ from concurrent.futures import (
 from datetime import datetime, timedelta
 from functools import wraps
 from heapq import heappop, heappush
+from pathlib import Path
 from textwrap import dedent
 from threading import Thread
 from typing import Callable, Optional, TypedDict, Union
@@ -52,7 +53,7 @@ except ImportError:  # pragma: no cov
 from .__cron import CronRunner
 from .__types import DictData, TupleStr
 from .audit import Audit, get_audit
-from .conf import Loader, config, get_logger
+from .conf import Loader, SimLoad, config, get_logger
 from .cron import On
 from .exceptions import ScheduleException, WorkflowException
 from .result import Result, Status
@@ -266,6 +267,8 @@ class Schedule(BaseModel):
         :param externals: An external parameters that want to pass to Loader
             object.
 
+        :raise ValueError: If the type does not match with current object.
+
         :rtype: Self
         """
         loader: Loader = Loader(name, externals=(externals or {}))
@@ -281,6 +284,42 @@ class Schedule(BaseModel):
 
         return cls.model_validate(obj=loader_data)
 
+    @classmethod
+    def from_path(
+        cls,
+        name: str,
+        path: Path,
+        externals: DictData | None = None,
+    ) -> Self:
+        """Create Schedule instance from the SimLoad object that receive an
+        input schedule name and conf path. The loader object will use this
+        schedule name to searching configuration data of this schedule model
+        in conf path.
+
+        :param name: (str) A schedule name that want to pass to Loader object.
+        :param path: (Path) A config path that want to search.
+        :param externals: An external parameters that want to pass to Loader
+            object.
+
+        :raise ValueError: If the type does not match with current object.
+
+        :rtype: Self
+        """
+        loader: SimLoad = SimLoad(
+            name, conf_path=path, externals=(externals or {})
+        )
+
+        # NOTE: Validate the config type match with current connection model
+        if loader.type != cls.__name__:
+            raise ValueError(f"Type {loader.type} does not match with {cls}")
+
+        loader_data: DictData = copy.deepcopy(loader.data)
+
+        # NOTE: Add name to loader data
+        loader_data["name"] = name.replace(" ", "_")
+
+        return cls.model_validate(obj=loader_data)
+
     def tasks(
         self,
         start_date: datetime,

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/src/ddeutil/workflow/workflow.py

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
-"""A Workflow module."""
+"""A Workflow module that is the core model of this package."""
 from __future__ import annotations
 
 import copy
@@ -18,6 +18,7 @@ from datetime import datetime, timedelta
 from enum import Enum
 from functools import partial, total_ordering
 from heapq import heappop, heappush
+from pathlib import Path
 from queue import Queue
 from textwrap import dedent
 from threading import Event
@@ -31,7 +32,7 @@ from typing_extensions import Self
 from .__cron import CronJob, CronRunner
 from .__types import DictData, TupleStr
 from .audit import Audit, get_audit
-from .conf import Loader, config, get_logger
+from .conf import Loader, SimLoad, config, get_logger
 from .cron import On
 from .exceptions import JobException, WorkflowException
 from .job import Job, TriggerState
@@ -299,33 +300,71 @@ class Workflow(BaseModel):
 
         # NOTE: Add name to loader data
         loader_data["name"] = name.replace(" ", "_")
+        cls.__bypass_on__(
+            loader_data, path=loader.conf_path, externals=externals
+        )
+        return cls.model_validate(obj=loader_data)
+
+    @classmethod
+    def from_path(
+        cls,
+        name: str,
+        path: Path,
+        externals: DictData | None = None,
+    ) -> Self:
+        """Create Workflow instance from the specific path. The loader object
+        will use this workflow name and path to searching configuration data of
+        this workflow model.
+
+        :param name: (str) A workflow name that want to pass to Loader object.
+        :param path: (Path) A config path that want to search.
+        :param externals: An external parameters that want to pass to Loader
+            object.
+
+        :raise ValueError: If the type does not match with current object.
 
-        # NOTE: Prepare `on` data
-        cls.__bypass_on__(loader_data, externals=externals)
+        :rtype: Self
+        """
+        loader: SimLoad = SimLoad(
+            name, conf_path=path, externals=(externals or {})
+        )
+        # NOTE: Validate the config type match with current connection model
+        if loader.type != cls.__name__:
+            raise ValueError(f"Type {loader.type} does not match with {cls}")
+
+        loader_data: DictData = copy.deepcopy(loader.data)
+
+        # NOTE: Add name to loader data
+        loader_data["name"] = name.replace(" ", "_")
+        cls.__bypass_on__(loader_data, path=path, externals=externals)
         return cls.model_validate(obj=loader_data)
 
     @classmethod
     def __bypass_on__(
         cls,
         data: DictData,
+        path: Path,
         externals: DictData | None = None,
     ) -> DictData:
         """Bypass the on data to loaded config data.
 
-        :param data:
-        :param externals:
+        :param data: A data to construct to this Workflow model.
+        :param path: A config path.
+        :param externals: An external parameters that want to pass to SimLoad
+            object.
         :rtype: DictData
         """
         if on := data.pop("on", []):
             if isinstance(on, str):
-                on = [on]
+                on: list[str] = [on]
             if any(not isinstance(i, (dict, str)) for i in on):
                 raise TypeError("The ``on`` key should be list of str or dict")
 
-            # NOTE: Pass on value to Loader and keep on model object to on field
+            # NOTE: Pass on value to SimLoad and keep on model object to the on
+            #   field.
             data["on"] = [
                 (
-                    Loader(n, externals=(externals or {})).data
+                    SimLoad(n, conf_path=path, externals=(externals or {})).data
                     if isinstance(n, str)
                     else n
                 )

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40/src/ddeutil_workflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.39
+Version: 0.0.40
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -23,9 +23,9 @@ Requires-Python: >=3.9.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ddeutil>=0.4.6
-Requires-Dist: ddeutil-io[toml,yaml]>=0.2.3
-Requires-Dist: pydantic==2.10.6
-Requires-Dist: python-dotenv==1.0.1
+Requires-Dist: ddeutil-io[toml,yaml]>=0.2.10
+Requires-Dist: pydantic==2.11.1
+Requires-Dist: python-dotenv==1.1.0
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/src/ddeutil_workflow.egg-info/requires.txt

@@ -1,7 +1,7 @@
 ddeutil>=0.4.6
-ddeutil-io[toml,yaml]>=0.2.3
-pydantic==2.10.6
-python-dotenv==1.0.1
+ddeutil-io[toml,yaml]>=0.2.10
+pydantic==2.11.1
+python-dotenv==1.1.0
 schedule<2.0.0,==1.2.2
 
 [api]

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/tests/test_schedule.py

@@ -47,6 +47,9 @@ def test_schedule_from_loader_raise(test_path):
     with pytest.raises(ValueError):
         Schedule.from_loader("schedule-raise-wf")
 
+    with pytest.raises(ValueError):
+        Schedule.from_path("schedule-raise-wf", path=test_path / "conf")
+
     with test_file.open(mode="w") as f:
         yaml.dump(
             {
@@ -69,6 +72,9 @@ def test_schedule_from_loader_raise(test_path):
     with pytest.raises(TypeError):
         Schedule.from_loader("schedule-raise-wf")
 
+    with pytest.raises(TypeError):
+        Schedule.from_path("schedule-raise-wf", path=test_path / "conf")
+
     with test_file.open(mode="w") as f:
         yaml.dump(
             {
@@ -91,6 +97,9 @@ def test_schedule_from_loader_raise(test_path):
     with pytest.raises(ValidationError):
         Schedule.from_loader("schedule-raise-wf")
 
+    with pytest.raises(ValidationError):
+        Schedule.from_path("schedule-raise-wf", path=test_path / "conf")
+
     test_file.unlink(missing_ok=True)
 
 
@@ -110,6 +119,12 @@ def test_schedule_default_on(test_path):
         for sch_wf in schedule.workflows:
             assert sch_wf.on == []
 
+        schedule = Schedule.from_path(
+            "tmp-schedule-default-wf", path=test_path / "conf"
+        )
+        for sch_wf in schedule.workflows:
+            assert sch_wf.on == []
+
 
 def test_schedule_remove_workflow_task():
     pipeline_tasks: list[WorkflowTask] = []

{ddeutil_workflow-0.0.39 → ddeutil_workflow-0.0.40}/tests/test_workflow.py

@@ -114,6 +114,19 @@ def test_workflow_desc():
 
 def test_workflow_from_loader_without_job():
     workflow = Workflow.from_loader(name="wf-without-jobs")
+    assert workflow.name == "wf-without-jobs"
+
+    rs = workflow.execute({})
+    assert rs.context == {}
+
+
+def test_workflow_from_path(test_path):
+    workflow = Workflow.from_path(
+        name="wf-without-jobs",
+        path=test_path / "conf",
+    )
+    assert workflow.name == "wf-without-jobs"
+
     rs = workflow.execute({})
     assert rs.context == {}
 
@@ -139,6 +152,12 @@ def test_workflow_from_loader_raise(test_path):
     with pytest.raises(ValueError):
         Workflow.from_loader(name="wf-run-from-loader-raise")
 
+    with pytest.raises(ValueError):
+        Workflow.from_path(
+            name="wf-run-from-loader-raise",
+            path=test_path / "conf",
+        )
+
     # NOTE: Raise if type of the on field does not valid with str or dict.
     dump_yaml(
         test_file,
@@ -161,7 +180,13 @@ def test_workflow_from_loader_raise(test_path):
     with pytest.raises(TypeError):
         Workflow.from_loader(name="wf-run-from-loader-raise")
 
-    # NOTE: Raise if value of the on field does not parsing to the CronJob obj.
+    with pytest.raises(TypeError):
+        Workflow.from_path(
+            name="wf-run-from-loader-raise",
+            path=test_path / "conf",
+        )
+
+    # NOTE: Raise if value of the on field does not parse to the CronJob obj.
     dump_yaml(
         test_file,
         data={
@@ -182,6 +207,12 @@ def test_workflow_from_loader_raise(test_path):
     with pytest.raises(WorkflowException):
         Workflow.from_loader(name="wf-run-from-loader-raise")
 
+    with pytest.raises(WorkflowException):
+        Workflow.from_path(
+            name="wf-run-from-loader-raise",
+            path=test_path / "conf",
+        )
+
     # NOTE: Remove the testing file on the demo path.
     test_file.unlink(missing_ok=True)
 

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

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