ddeutil-workflow 0.0.48__py3-none-any.whl → 0.0.49__py3-none-any.whl

ddeutil/workflow/workflow.py

@@ -4,7 +4,9 @@
 # license information.
 # ------------------------------------------------------------------------------
 # [x] Use dynamic config
-"""A Workflow module that is the core model of this package."""
+"""A Workflow module that is the core module of this package. It keeps Release
+and Workflow Pydantic models.
+"""
 from __future__ import annotations
 
 import copy
@@ -98,8 +100,8 @@ class Release:
 
         :param dt: (datetime | str) A datetime object or string that want to
             construct to the Release object.
-        :param extras: An extra parameters that want to pass to override
-            config.
+        :param extras: (DictData) An extra parameters that want to pass to
+            override config values.
 
         :raise TypeError: If the type of the dt argument does not valid with
             datetime or str object.
@@ -159,7 +161,7 @@ class ReleaseQueue:
     complete: list[Release] = field(default_factory=list)
     extras: DictData = Field(
         default_factory=dict,
-        description="An extra override config values.",
+        description="An extra parameters that want to override config values.",
     )
 
     @classmethod
@@ -172,7 +174,8 @@ class ReleaseQueue:
         with list of datetime or list of Release.
 
         :param queue:
-        :param extras: An extra parameter that want to override core config.
+        :param extras: An extra parameter that want to override core config
+            values.
 
         :raise TypeError: If the type of input queue does not valid.
 
@@ -251,7 +254,7 @@ class ReleaseQueue:
         heappush(self.complete, value)
 
         # NOTE: Remove complete queue on workflow that keep more than the
-        #   maximum config.
+        #   maximum config value.
         num_complete_delete: int = len(self.complete) - dynamic(
             "max_queue_complete_hist", extras=self.extras
         )
@@ -262,6 +265,70 @@ class ReleaseQueue:
 
         return self
 
+    def gen(
+        self,
+        end_date: datetime,
+        audit: type[Audit],
+        runner: CronRunner,
+        name: str,
+        *,
+        offset: float = 0,
+        force_run: bool = False,
+        extras: Optional[DictData] = None,
+    ) -> Self:
+        """Generate Release model to queue.
+
+        Steps:
+            - Create Release object from the current date that not reach the end
+              date.
+            - Check this release do not store on the release queue object.
+              Generate the next date if it exists.
+            - Push this release to the release queue
+
+        :param end_date: (datetime) An end datetime object.
+        :param audit: (type[Audit]) An audit class that want to make audit
+            instance.
+        :param runner: (CronRunner) A CronRunner object.
+        :param name: (str) A target name that want to check at pointer of audit.
+        :param offset: (float) An offset in second unit for time travel.
+        :param force_run: A flag that allow to release workflow if the audit
+            with that release was pointed.
+        :param extras: An extra parameter that want to override core config.
+
+        :rtype: ReleaseQueue
+
+        """
+        if runner.date > end_date:
+            return self
+
+        workflow_release = Release(
+            date=runner.date,
+            offset=offset,
+            end_date=end_date,
+            runner=runner,
+            type=ReleaseType.POKE,
+        )
+
+        while self.check_queue(workflow_release) or (
+            audit.is_pointed(
+                name=name, release=workflow_release.date, extras=extras
+            )
+            and not force_run
+        ):
+            workflow_release = Release(
+                date=runner.next,
+                offset=offset,
+                end_date=end_date,
+                runner=runner,
+                type=ReleaseType.POKE,
+            )
+
+        if runner.date > end_date:
+            return self
+
+        heappush(self.queue, workflow_release)
+        return self
+
 
 class Workflow(BaseModel):
     """Workflow Pydantic model.
@@ -274,7 +341,7 @@ class Workflow(BaseModel):
 
     extras: DictData = Field(
         default_factory=dict,
-        description="An extra override config values.",
+        description="An extra parameters that want to override config values.",
     )
 
     name: str = Field(description="A workflow name.")
@@ -344,8 +411,8 @@ class Workflow(BaseModel):
 
         :param name: (str) A workflow name that want to pass to Loader object.
         :param path: (Path) A config path that want to search.
-        :param extras: An extra parameters that want to pass to Loader
-            object.
+        :param extras: (DictData) An extra parameters that want to override core
+            config values.
 
         :raise ValueError: If the type does not match with current object.
 
@@ -376,10 +443,10 @@ class Workflow(BaseModel):
     ) -> DictData:
         """Bypass the on data to loaded config data.
 
-        :param data: A data to construct to this Workflow model.
-        :param path: A config path.
-        :param extras: An extra parameters that want to pass to SimLoad
-            object.
+        :param data: (DictData) A data to construct to this Workflow model.
+        :param path: (Path) A config path.
+        :param extras: (DictData) An extra parameters that want to override core
+            config values.
 
         :rtype: DictData
         """
@@ -456,7 +523,7 @@ class Workflow(BaseModel):
 
         extras: Optional[DictData] = info.data.get("extras")
         if len(set_ons) > (
-            conf := dynamic("max_on_per_workflow", extras=extras)
+            conf := dynamic("max_cron_per_workflow", extras=extras)
         ):
             raise ValueError(
                 f"The number of the on should not more than {conf} crontabs."
@@ -494,8 +561,9 @@ class Workflow(BaseModel):
         return self
 
     def job(self, name: str) -> Job:
-        """Return the workflow's job model that searching with an input job's
-        name or job's ID.
+        """Return the workflow's Job model that getting by an input job's name
+        or job's ID. This method will pass an extra parameter from this model
+        to the returned Job model.
 
         :param name: (str) A job name or ID that want to get from a mapping of
             job models.
@@ -712,14 +780,6 @@ class Workflow(BaseModel):
         """Generate Release from all on values from the on field and store them
         to the ReleaseQueue object.
 
-        Steps:
-            - For-loop all the on value in the on field.
-            - Create Release object from the current date that not reach the end
-              date.
-            - Check this release do not store on the release queue object.
-              Generate the next date if it exists.
-            - Push this release to the release queue
-
         :param offset: An offset in second unit for time travel.
         :param end_date: An end datetime object.
         :param queue: A workflow queue object.
@@ -731,40 +791,19 @@ class Workflow(BaseModel):
         """
         for on in self.on:
 
-            runner: CronRunner = on.next(
-                get_dt_now(
-                    tz=dynamic("tz", extras=self.extras), offset=offset
-                ).replace(microsecond=0)
-            )
-
-            if runner.date > end_date:
-                continue
-
-            workflow_release = Release(
-                date=runner.date,
+            queue.gen(
+                end_date,
+                audit,
+                on.next(
+                    get_dt_now(
+                        tz=dynamic("tz", extras=self.extras), offset=offset
+                    ).replace(microsecond=0)
+                ),
+                self.name,
                 offset=offset,
-                end_date=end_date,
-                runner=runner,
-                type=ReleaseType.POKE,
+                force_run=force_run,
             )
 
-            while queue.check_queue(workflow_release) or (
-                audit.is_pointed(name=self.name, release=workflow_release.date)
-                and not force_run
-            ):
-                workflow_release = Release(
-                    date=runner.next,
-                    offset=offset,
-                    end_date=end_date,
-                    runner=runner,
-                    type=ReleaseType.POKE,
-                )
-
-            if runner.date > end_date:
-                continue
-
-            heappush(queue.queue, workflow_release)
-
         return queue
 
     def poke(
@@ -803,7 +842,7 @@ class Workflow(BaseModel):
         :rtype: Result
         :return: A list of all results that return from `self.release` method.
         """
-        audit: type[Audit] = audit or get_audit()
+        audit: type[Audit] = audit or get_audit(extras=self.extras)
         result: Result = Result(
             run_id=(run_id or gen_id(self.name, unique=True))
         )
@@ -1315,10 +1354,11 @@ class WorkflowTask:
     arguments before passing to the parent release method.
     """
 
-    alias: str = field()
-    workflow: Workflow = field()
-    runner: CronRunner = field()
+    alias: str
+    workflow: Workflow
+    runner: CronRunner
     values: DictData = field(default_factory=dict)
+    extras: DictData = field(default_factory=dict)
 
     def release(
         self,
@@ -1345,7 +1385,7 @@ class WorkflowTask:
 
         :rtype: Result
         """
-        audit: type[Audit] = audit or get_audit()
+        audit: type[Audit] = audit or get_audit(extras=self.extras)
 
         if release is None:
 
@@ -1395,35 +1435,15 @@ class WorkflowTask:
 
         :rtype: ReleaseQueue
         """
-        if self.runner.date > end_date:
-            return queue
-
-        workflow_release = Release(
-            date=self.runner.date,
-            offset=0,
-            end_date=end_date,
-            runner=self.runner,
-            type=ReleaseType.TASK,
+        return queue.gen(
+            end_date,
+            audit,
+            self.runner,
+            self.alias,
+            force_run=force_run,
+            extras=self.extras,
         )
 
-        while queue.check_queue(workflow_release) or (
-            audit.is_pointed(name=self.alias, release=workflow_release.date)
-            and not force_run
-        ):
-            workflow_release = Release(
-                date=self.runner.next,
-                offset=0,
-                end_date=end_date,
-                runner=self.runner,
-                type=ReleaseType.TASK,
-            )
-
-        if self.runner.date > end_date:
-            return queue
-
-        heappush(queue.queue, workflow_release)
-        return queue
-
     def __repr__(self) -> str:
         """Override the `__repr__` method.
 

{ddeutil_workflow-0.0.48.dist-info → ddeutil_workflow-0.0.49.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.48
+Version: 0.0.49
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -262,14 +262,12 @@ it will use default value and do not raise any error to you.
 
 | Name                         | Component | Default                                                                                                                         | Description                                                                                                        |
 |:-----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------|
-| **ROOT_PATH**                |   Core    | `.`                                                                                                                             | Root path or the project path for this workflow engine.                                                            |
 | **REGISTRY_CALLER**          |   Core    | `.`                                                                                                                             | List of importable string for the call stage.                                                                      |
 | **REGISTRY_FILTER**          |   Core    | `ddeutil.workflow.templates`                                                                                                    | List of importable string for the filter template.                                                                 |
-| **CONF_PATH**                |   Core    | `conf`                                                                                                                          | The config path that keep all template `.yaml` files.                                                              |
+| **CONF_PATH**                |   Core    | `./conf`                                                                                                                        | The config path that keep all template `.yaml` files.                                                              |
 | **TIMEZONE**                 |   Core    | `Asia/Bangkok`                                                                                                                  | A Timezone string value that will pass to `ZoneInfo` object.                                                       |
-| **STAGE_DEFAULT_ID**         |   Core    | `true`                                                                                                                          | A flag that enable default stage ID that use for catch an execution output.                                        |
+| **STAGE_DEFAULT_ID**         |   Core    | `false`                                                                                                                         | A flag that enable default stage ID that use for catch an execution output.                                        |
 | **STAGE_RAISE_ERROR**        |   Core    | `false`                                                                                                                         | A flag that all stage raise StageException from stage execution.                                                   |
-| **JOB_DEFAULT_ID**           |   Core    | `false`                                                                                                                         | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |
 | **JOB_RAISE_ERROR**          |   Core    | `true`                                                                                                                          | A flag that all job raise JobException from job strategy execution.                                                |
 | **MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                                                                                                                             |                                                                                                                    |
 | **MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                                                                                                                            |                                                                                                                    |

ddeutil_workflow-0.0.49.dist-info/RECORD

@@ -0,0 +1,31 @@
+ddeutil/workflow/__about__.py,sha256=8c8KBEXeEOskazR5AlLYEjCpyi54xsoTaaqRY8pXUJY,28
+ddeutil/workflow/__cron.py,sha256=h8rLeIUAAEB2SdZ4Jhch7LU1Yl3bbJ-iNNJ3tQ0eYVM,28095
+ddeutil/workflow/__init__.py,sha256=EpqROKwAX76Wea-37hi0R_oVQ2jm2cc9ML9USxRAsak,1971
+ddeutil/workflow/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ddeutil/workflow/__types.py,sha256=8jBdbfb3aZSetjz0mvNrpGHwwxJff7mK8_4v41cLqlc,4316
+ddeutil/workflow/conf.py,sha256=lviP7bFsOCJtD8S1VyJK6aaSL9Nj_vfC2Kkpe1z2Zec,12444
+ddeutil/workflow/cron.py,sha256=80SijzMdDOBxTWRsiF-Fmuz7Ym7leY0XT2lzRAPGdXc,8781
+ddeutil/workflow/exceptions.py,sha256=uLNxzav3HRcr4vaZnvbUIF_eTR6UXXZNaxroMWFOUL4,1418
+ddeutil/workflow/job.py,sha256=y2q_md2nUp1jfgjaQdjDZqrHR541ENrWB__S1-Eoyss,30830
+ddeutil/workflow/logs.py,sha256=JghQawGd16ysf-5y7ZFtSGFY82uwgb9oMKNYy9eGI-o,26468
+ddeutil/workflow/params.py,sha256=xCtFEh0-G-G-f8y_SXxyf31bU6Ox5p5Z-WbBFXrjy8M,9960
+ddeutil/workflow/result.py,sha256=kizTEP6DY9ewDQQR17YgfrtMXRW-wF8vRzG26wzAqUM,5439
+ddeutil/workflow/reusables.py,sha256=hIpehea6J4OWeXX55kjYzo-c9-_Cc0YRwLRRbcaUkZs,17539
+ddeutil/workflow/scheduler.py,sha256=F783QaJfPg8tvYyvJvkwl8Sa42vsJzj6BzzROZFvm9I,28153
+ddeutil/workflow/stages.py,sha256=2vO5pdUgKHeGsS762fdYrBkWfvby_Q3Z71ptHajEp8k,55904
+ddeutil/workflow/utils.py,sha256=CtFUrP_4m6xaJooc9RbE4ulTBE-OkICg-MPHqzCuJ0I,7392
+ddeutil/workflow/workflow.py,sha256=mCpsAY0Su-pMJ_xZ-qF6lDEXn-Ih7myUODZ0ZEuyVew,50804
+ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
+ddeutil/workflow/api/api.py,sha256=CWtPLgOv2Jus9E7nzG5mG2Z32ZEkUK3JWQ2htZyMRpA,5244
+ddeutil/workflow/api/log.py,sha256=NMTnOnsBrDB5129329xF2myLdrb-z9k1MQrmrP7qXJw,1818
+ddeutil/workflow/api/repeat.py,sha256=uTtUFVLpiYYahXvCVx8sueRQ03K2Xw1id_gW3IMmX1U,5295
+ddeutil/workflow/api/routes/__init__.py,sha256=qoGtOMyVgQ5nTUc8J8wH27A8isaxl3IFCX8qoyibeCY,484
+ddeutil/workflow/api/routes/job.py,sha256=oPwBVP0Mxwxv-bGPlfmxQQ9PcVl0ev9HoPzndpYDCCQ,1954
+ddeutil/workflow/api/routes/logs.py,sha256=U6vOni3wd-ZTOwd3yVdSOpgyRmNdcgfngU5KlLM3Cww,5383
+ddeutil/workflow/api/routes/schedules.py,sha256=EgUjyRGhsm6UNaMj5luh6TcY6l571sCHcla-BL1iOfY,4829
+ddeutil/workflow/api/routes/workflows.py,sha256=JcDOrn1deK8ztFRcMTNATQejG6KMA7JxZLVc4QeBsP4,4527
+ddeutil_workflow-0.0.49.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.49.dist-info/METADATA,sha256=U847vy3oZ6ZEvngEe-9W3wA1vkKGr15UQa73v9Dsy7k,18257
+ddeutil_workflow-0.0.49.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ddeutil_workflow-0.0.49.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.49.dist-info/RECORD,,

ddeutil_workflow-0.0.48.dist-info/RECORD

@@ -1,31 +0,0 @@
-ddeutil/workflow/__about__.py,sha256=OFynARvYDKZ4fFNVea1bykjJJKDpblDyUNtdv9rywxE,28
-ddeutil/workflow/__cron.py,sha256=h8rLeIUAAEB2SdZ4Jhch7LU1Yl3bbJ-iNNJ3tQ0eYVM,28095
-ddeutil/workflow/__init__.py,sha256=t7AaJ3gY7E8i2WeL3_8dYz-F5mzskUxsSAx7-Ny4Fhw,1927
-ddeutil/workflow/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ddeutil/workflow/__types.py,sha256=8jBdbfb3aZSetjz0mvNrpGHwwxJff7mK8_4v41cLqlc,4316
-ddeutil/workflow/conf.py,sha256=sXN7epudr90I1gUAjwJqvWTQV39mhO6cJhuuOuoYCw0,12153
-ddeutil/workflow/cron.py,sha256=80SijzMdDOBxTWRsiF-Fmuz7Ym7leY0XT2lzRAPGdXc,8781
-ddeutil/workflow/exceptions.py,sha256=uLNxzav3HRcr4vaZnvbUIF_eTR6UXXZNaxroMWFOUL4,1418
-ddeutil/workflow/job.py,sha256=nvcSH1vxQrq8tGDrOs-8wHifaOLrfZdTAUk1vD-QtRA,30762
-ddeutil/workflow/logs.py,sha256=o_EziK1MgP-7fJIl6bwE58BZHt8FBTrsmrEBhu1XGTo,24670
-ddeutil/workflow/params.py,sha256=xCtFEh0-G-G-f8y_SXxyf31bU6Ox5p5Z-WbBFXrjy8M,9960
-ddeutil/workflow/result.py,sha256=6yqWXFE__xMr8VY8xchBhBd3lyU-XX1nHOpx_2V5VGU,5390
-ddeutil/workflow/reusables.py,sha256=7uamdx0nnBnDHcc0xXqwucItFYHUXI4_O-SHdFHIZCo,17528
-ddeutil/workflow/scheduler.py,sha256=jyTLML8ppwdCrcuVw9ZMcZ1JwJ1SW6wDrJg5soHDFAw,27681
-ddeutil/workflow/stages.py,sha256=mnP07SLvGRfggOV1i9bZ7_j5K_ksHlorCYb2crU1pus,49170
-ddeutil/workflow/utils.py,sha256=sblje9qOtejCHVt8EVrbC0KY98vKqvxccaR5HIkRiTA,7363
-ddeutil/workflow/workflow.py,sha256=V8uJw16gtjTd8T5aCpvSUr9z_oGQrV-ycybvUjA8NHI,50073
-ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
-ddeutil/workflow/api/api.py,sha256=CWtPLgOv2Jus9E7nzG5mG2Z32ZEkUK3JWQ2htZyMRpA,5244
-ddeutil/workflow/api/log.py,sha256=NMTnOnsBrDB5129329xF2myLdrb-z9k1MQrmrP7qXJw,1818
-ddeutil/workflow/api/repeat.py,sha256=uTtUFVLpiYYahXvCVx8sueRQ03K2Xw1id_gW3IMmX1U,5295
-ddeutil/workflow/api/routes/__init__.py,sha256=qoGtOMyVgQ5nTUc8J8wH27A8isaxl3IFCX8qoyibeCY,484
-ddeutil/workflow/api/routes/job.py,sha256=oPwBVP0Mxwxv-bGPlfmxQQ9PcVl0ev9HoPzndpYDCCQ,1954
-ddeutil/workflow/api/routes/logs.py,sha256=TeRDrEelbKS2Hu_EovgLh0bOdmSv9mfnrIZsrE7uPD4,5353
-ddeutil/workflow/api/routes/schedules.py,sha256=EgUjyRGhsm6UNaMj5luh6TcY6l571sCHcla-BL1iOfY,4829
-ddeutil/workflow/api/routes/workflows.py,sha256=JcDOrn1deK8ztFRcMTNATQejG6KMA7JxZLVc4QeBsP4,4527
-ddeutil_workflow-0.0.48.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.48.dist-info/METADATA,sha256=wv_dQPbCSS_1TuKmZ2jl1cWTRu0sM2eGtV3pBHHdWmQ,18841
-ddeutil_workflow-0.0.48.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-ddeutil_workflow-0.0.48.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.48.dist-info/RECORD,,