ddeutil-workflow 0.0.38__py3-none-any.whl → 0.0.40__py3-none-any.whl

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,10 +32,10 @@ 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
+from .job import Job, TriggerState
 from .params import Param
 from .result import Result, Status
 from .templates import has_template, param2template
@@ -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.
 
-        # NOTE: Prepare `on` data
-        cls.__bypass_on__(loader_data, externals=externals)
+        :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.
+
+        :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
                 )
@@ -882,8 +921,6 @@ class Workflow(BaseModel):
                 f"workflow."
             )
 
-        result.trace.info(f"[WORKFLOW]: Start execute job: {job_id!r}")
-
         if event and event.is_set():  # pragma: no cov
             raise WorkflowException(
                 "Workflow job was canceled from event that had set before "
@@ -898,15 +935,20 @@ class Workflow(BaseModel):
         #
         try:
             job: Job = self.jobs[job_id]
-            job.set_outputs(
-                job.execute(
-                    params=params,
-                    run_id=result.run_id,
-                    parent_run_id=result.parent_run_id,
-                    event=event,
-                ).context,
-                to=params,
-            )
+            if job.is_skipped(params=params):
+                result.trace.info(f"[JOB]: Skip job: {job_id!r}")
+                job.set_outputs(output={"SKIP": {"skipped": True}}, to=params)
+            else:
+                result.trace.info(f"[JOB]: Start execute job: {job_id!r}")
+                job.set_outputs(
+                    job.execute(
+                        params=params,
+                        run_id=result.run_id,
+                        parent_run_id=result.parent_run_id,
+                        event=event,
+                    ).context,
+                    to=params,
+                )
         except JobException as err:
             result.trace.error(f"[WORKFLOW]: {err.__class__.__name__}: {err}")
             if raise_error:
@@ -1054,11 +1096,20 @@ class Workflow(BaseModel):
                 job_id: str = job_queue.get()
                 job: Job = self.jobs[job_id]
 
-                if not job.check_needs(context["jobs"]):
+                if (check := job.check_needs(context["jobs"])).is_waiting():
                     job_queue.task_done()
                     job_queue.put(job_id)
                     time.sleep(0.15)
                     continue
+                elif check == TriggerState.failed:  # pragma: no cov
+                    raise WorkflowException(
+                        "Check job trigger rule was failed."
+                    )
+                elif check == TriggerState.skipped:  # pragma: no cov
+                    result.trace.info(f"[JOB]: Skip job: {job_id!r}")
+                    job.set_outputs({"SKIP": {"skipped": True}}, to=context)
+                    job_queue.task_done()
+                    continue
 
                 # NOTE: Start workflow job execution with deep copy context data
                 #   before release.
@@ -1149,11 +1200,18 @@ class Workflow(BaseModel):
             job: Job = self.jobs[job_id]
 
             # NOTE: Waiting dependency job run successful before release.
-            if not job.check_needs(context["jobs"]):
+            if (check := job.check_needs(context["jobs"])).is_waiting():
                 job_queue.task_done()
                 job_queue.put(job_id)
                 time.sleep(0.075)
                 continue
+            elif check == TriggerState.failed:  # pragma: no cov
+                raise WorkflowException("Check job trigger rule was failed.")
+            elif check == TriggerState.skipped:  # pragma: no cov
+                result.trace.info(f"[JOB]: Skip job: {job_id!r}")
+                job.set_outputs({"SKIP": {"skipped": True}}, to=context)
+                job_queue.task_done()
+                continue
 
             # NOTE: Start workflow job execution with deep copy context data
             #   before release. This job execution process will run until

{ddeutil_workflow-0.0.38.dist-info → ddeutil_workflow-0.0.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.38
+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"
@@ -130,7 +130,7 @@ flowchart LR
 > - [Google **Workflows**](https://cloud.google.com/workflows)
 > - [AWS **Step Functions**](https://aws.amazon.com/step-functions/)
 
-## :round_pushpin: Installation
+## 📦 Installation
 
 This project need `ddeutil` and `ddeutil-io` extension namespace packages.
 If you want to install this package with application add-ons, you should add

{ddeutil_workflow-0.0.38.dist-info → ddeutil_workflow-0.0.40.dist-info}/RECORD

@@ -1,22 +1,22 @@
-ddeutil/workflow/__about__.py,sha256=nUvuf0abbrBoZoHVyqcyvfYEilSx2oTLDwA7Az8m5UU,28
-ddeutil/workflow/__cron.py,sha256=3i-wmjTlh0ADCzN9pLKaWHzJkXzC72aIBmVEQSbyCCE,26895
+ddeutil/workflow/__about__.py,sha256=4_L4aAteV6ecIgxXQuBmMHF6LoFXtYgCVakxe2GlHjk,28
+ddeutil/workflow/__cron.py,sha256=h8rLeIUAAEB2SdZ4Jhch7LU1Yl3bbJ-iNNJ3tQ0eYVM,28095
 ddeutil/workflow/__init__.py,sha256=hIM2Ha-7F3YF3aLsu4IY3N-UvD_EE1ai6DO6WL2mILg,1908
-ddeutil/workflow/__types.py,sha256=CK1jfzyHP9P-MB0ElhpJZ59ZFGJC9MkQuAop5739_9k,4304
-ddeutil/workflow/audit.py,sha256=wx70RKRdHj1d2431ilpt9OPTInMByjqXkYff7l5pvF4,8230
-ddeutil/workflow/caller.py,sha256=oFjB9zpG93aeVd-T_4QMz5kk64lo-iyxaPmCo_1_AzU,5693
-ddeutil/workflow/conf.py,sha256=MHzBeLZukFeIQ-YhxOz5uKCnGYqbhYdpwAEh9A9h_OM,12216
-ddeutil/workflow/context.py,sha256=fdGUuQnsjDCDGibPHKMWc5PA3pArHpfv6Aff2nVvZ0U,1618
+ddeutil/workflow/__types.py,sha256=8jBdbfb3aZSetjz0mvNrpGHwwxJff7mK8_4v41cLqlc,4316
+ddeutil/workflow/audit.py,sha256=BpzLI6ZKXi6xQO8C2sAHxSi8RAfF31dMPdjn3DbYlw8,8364
+ddeutil/workflow/caller.py,sha256=M7_nan1DbRUAHEIQoQc1qIX4AHgI5fKFNx0KDbzhDMk,5736
+ddeutil/workflow/conf.py,sha256=USYzITPwBS5Q_pl3DTTdFK8OxeL9GQu4GUXqi8nKpJo,11819
+ddeutil/workflow/context.py,sha256=vsk4JQL7t3KsnKPfshw3O7YrPFo2h4rnnNd3B-G9Kj4,1700
 ddeutil/workflow/cron.py,sha256=j8EeoHst70toRfnD_frix41vrI-eLYVJkZ9yeJtpfnI,8871
 ddeutil/workflow/exceptions.py,sha256=fO37f9p7lOjIJgVOpKE_1X44yJTwBepyukZV9a7NNm4,1241
-ddeutil/workflow/job.py,sha256=3oDY-THXYMvmW0kKkHN2VMJyq0u0_4s9H0eX40Iiw6E,24267
+ddeutil/workflow/job.py,sha256=LCQf_3gyTmnj6aAQ0ksz4lJxU10-F5MfVFHczkWt_VE,28669
 ddeutil/workflow/logs.py,sha256=mAKQjNri-oourd3dBLLG3Fqoo4QG27U9IO2h6IqCOU0,10196
 ddeutil/workflow/params.py,sha256=qw9XJyjh2ocf9pf6h_XiYHLOvQN4R5TMqPElmItKnRM,8019
 ddeutil/workflow/result.py,sha256=cDkItrhpzZfMS1Oj8IZX8O-KBD4KZYDi43XJZvvC3Gc,4318
-ddeutil/workflow/scheduler.py,sha256=YMebYpNjqg6RWaE17sicwM3uthupeBGSGCnDGy4aKd8,26286
-ddeutil/workflow/stages.py,sha256=aHMPOPxRiSo2jBFqQOlua01sQ18RMvjaKk2Dotnu7v4,36480
-ddeutil/workflow/templates.py,sha256=A0JgZFGkBv-AX-EskZj656nG5zFd3j1PpLpyXihf6Xg,10967
+ddeutil/workflow/scheduler.py,sha256=daNdcTp8dQN0gXuK3cg7K7idspOcqKNmfOLTWirNEUM,27652
+ddeutil/workflow/stages.py,sha256=ONBR7GjgLEbA21wNioBrhOucwqj6M1v2ht5JhipoWSg,36994
+ddeutil/workflow/templates.py,sha256=yA2xgrSXcxfBxNT2hc6v06HkVY_0RKsc1UwdJRip9EE,11554
 ddeutil/workflow/utils.py,sha256=Fz5y-LK_JfikDfvMKcFaxad_VvCnr7UC2C9KFCbzPNA,7105
-ddeutil/workflow/workflow.py,sha256=v6LTbXZ34yWmddZquBxpahxCW1PFb3177q1T3Ssf5C0,46636
+ddeutil/workflow/workflow.py,sha256=8ForojeLboLL6dHmV5-NjtU9o4mIL7NtY2F2NFxdqZY,49400
 ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
 ddeutil/workflow/api/api.py,sha256=gGQtqkzyJNaJIfka_w2M1lrCS3Ep46re2Dznsk9RxYQ,5191
 ddeutil/workflow/api/log.py,sha256=NMTnOnsBrDB5129329xF2myLdrb-z9k1MQrmrP7qXJw,1818
@@ -26,8 +26,8 @@ ddeutil/workflow/api/routes/job.py,sha256=YVta083i8vU8-o4WdKFwDpfdC9vN1dZ6goZSmN
 ddeutil/workflow/api/routes/logs.py,sha256=uEQ6k5PwRg-k0eSiSFArXfyeDq5xzepxILrRnwgAe1I,5373
 ddeutil/workflow/api/routes/schedules.py,sha256=uWYDOwlV8w56hKQmfkQFwdZ6t2gZSJeCdBIzMmJenAQ,4824
 ddeutil/workflow/api/routes/workflows.py,sha256=KVywA7vD9b4QrfmWBdSFF5chj34yJe1zNCzl6iBMeGI,4538
-ddeutil_workflow-0.0.38.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.38.dist-info/METADATA,sha256=haHYX6Ui8EXTi2qJA5x_SOWSmVqmXRKsHLdgyMp7Two,19511
-ddeutil_workflow-0.0.38.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
-ddeutil_workflow-0.0.38.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.38.dist-info/RECORD,,
+ddeutil_workflow-0.0.40.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.40.dist-info/METADATA,sha256=AdIiZTWsPhfcVba7x2OrWw5CN3y0OQB-dRdBb9RQh2o,19501
+ddeutil_workflow-0.0.40.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ddeutil_workflow-0.0.40.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.40.dist-info/RECORD,,

{ddeutil_workflow-0.0.38.dist-info → ddeutil_workflow-0.0.40.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (77.0.3)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any