ddeutil-workflow 0.0.57__py3-none-any.whl → 0.0.59__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.57"
+__version__: str = "0.0.59"

ddeutil/workflow/__cron.py

@@ -699,9 +699,9 @@ class CronJob:
 
     def schedule(
         self,
-        date: datetime | None = None,
+        date: Optional[datetime] = None,
         *,
-        tz: str | None = None,
+        tz: Optional[str] = None,
     ) -> CronRunner:
         """Returns CronRunner instance that be datetime runner with this
         cronjob. It can use `next`, `prev`, or `reset` methods to generate
@@ -766,7 +766,7 @@ class CronRunner:
     def __init__(
         self,
         cron: CronJob | CronJobYear,
-        date: datetime | None = None,
+        date: Optional[datetime] = None,
         *,
         tz: str | ZoneInfo | None = None,
     ) -> None:

ddeutil/workflow/conf.py

@@ -5,6 +5,7 @@
 # ------------------------------------------------------------------------------
 from __future__ import annotations
 
+import copy
 import json
 import os
 from abc import ABC, abstractmethod
@@ -26,13 +27,13 @@ T = TypeVar("T")
 PREFIX: Final[str] = "WORKFLOW"
 
 
-def env(var: str, default: str | None = None) -> str | None:
+def env(var: str, default: Optional[str] = None) -> Optional[str]:
     """Get environment variable with uppercase and adding prefix string.
 
     :param var: (str) A env variable name.
-    :param default: (str | None) A default value if an env var does not set.
+    :param default: (Optional[str]) A default value if an env var does not set.
 
-    :rtype: str | None
+    :rtype: Optional[str]
     """
     return os.getenv(f"{PREFIX}_{var.upper().replace(' ', '_')}", default)
 
@@ -218,7 +219,7 @@ class BaseLoad(ABC):  # pragma: no cov
 
 class FileLoad(BaseLoad):
     """Base Load object that use to search config data by given some identity
-    value like name of `Workflow` or `On` templates.
+    value like name of `Workflow` or `Crontab` templates.
 
     :param name: (str) A name of key of config data that read with YAML
         Environment object.
@@ -298,6 +299,7 @@ class FileLoad(BaseLoad):
                 f"Multi-config paths does not support for type: {type(paths)}"
             )
         else:
+            paths: list[Path] = copy.deepcopy(paths)
             paths.append(path)
 
         all_data: list[tuple[float, DictData]] = []
@@ -398,7 +400,7 @@ class FileLoad(BaseLoad):
         return is_ignored(file, read_ignore(path / ignore_filename))
 
     @classmethod
-    def filter_yaml(cls, file: Path, name: str | None = None) -> DictData:
+    def filter_yaml(cls, file: Path, name: Optional[str] = None) -> DictData:
         """Read a YAML file context from an input file path and specific name.
 
         :param file: (Path) A file path that want to extract YAML context.

ddeutil/workflow/event.py

@@ -3,14 +3,14 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
-"""Event module that store all event object. Now, it has only `On` and `OnYear`
-model these are schedule with crontab event.
+"""Event module that store all event object. Now, it has only `Crontab` and
+`CrontabYear` model these are schedule with crontab event.
 """
 from __future__ import annotations
 
 from dataclasses import fields
 from datetime import datetime
-from typing import Annotated, Any, Literal, Union
+from typing import Annotated, Any, Literal, Optional, Union
 from zoneinfo import ZoneInfo, ZoneInfoNotFoundError
 
 from pydantic import BaseModel, ConfigDict, Field, ValidationInfo
@@ -28,7 +28,7 @@ Interval = Literal["daily", "weekly", "monthly"]
 def interval2crontab(
     interval: Interval,
     *,
-    day: str | None = None,
+    day: Optional[str] = None,
     time: str = "00:00",
 ) -> str:
     """Return the crontab string that was generated from specific values.
@@ -63,9 +63,9 @@ def interval2crontab(
     return f"{h} {m} {'1' if interval == 'monthly' else '*'} * {d}"
 
 
-class On(BaseModel):
-    """On model (Warped crontab object by Pydantic model) to keep crontab value
-    and generate CronRunner object from this crontab value.
+class Crontab(BaseModel):
+    """Cron event model (Warped the CronJob object by Pydantic model) to keep
+    crontab value and generate CronRunner object from this crontab value.
 
     Methods:
         - generate: is the main use-case of this schedule object.
@@ -128,7 +128,7 @@ class On(BaseModel):
         extras: DictData | None = None,
     ) -> Self:
         """Constructor from the name of config loader that will use loader
-        object for getting the `On` data.
+        object for getting the `Crontab` data.
 
         :param name: (str) A name of config that will get from loader.
         :param extras: (DictData) An extra parameter that use to override core
@@ -172,7 +172,7 @@ class On(BaseModel):
     def __prepare_values(cls, data: Any) -> Any:
         """Extract tz key from value and change name to timezone key.
 
-        :param data: (DictData) A data that want to pass for create an On
+        :param data: (DictData) A data that want to pass for create an Crontab
             model.
 
         :rtype: DictData
@@ -265,9 +265,9 @@ class On(BaseModel):
         return runner
 
 
-class YearOn(On):
-    """On with enhance Year Pydantic model for limit year matrix that use by
-    some data schedule tools like AWS Glue.
+class CrontabYear(Crontab):
+    """Cron event with enhance Year Pydantic model for limit year matrix that
+    use by some data schedule tools like AWS Glue.
     """
 
     model_config = ConfigDict(arbitrary_types_allowed=True)

ddeutil/workflow/exceptions.py

@@ -9,7 +9,7 @@ annotate for handle error only.
 """
 from __future__ import annotations
 
-from typing import Literal, TypedDict, overload
+from typing import Literal, Optional, TypedDict, overload
 
 
 class ErrorData(TypedDict):
@@ -39,9 +39,9 @@ class BaseWorkflowException(Exception):
     making an error context to the result context.
     """
 
-    def __init__(self, message: str, *, refs: str | None = None):
+    def __init__(self, message: str, *, refs: Optional[str] = None):
         super().__init__(message)
-        self.refs: str | None = refs
+        self.refs: Optional[str] = refs
 
     @overload
     def to_dict(

ddeutil/workflow/job.py

@@ -19,6 +19,7 @@ from __future__ import annotations
 
 import copy
 import time
+from collections.abc import Iterator
 from concurrent.futures import (
     FIRST_EXCEPTION,
     CancelledError,
@@ -67,8 +68,8 @@ def make(
 
     :param matrix: (Matrix) A matrix values that want to cross product to
         possible parallelism values.
-    :param include: (A list of additional matrix that want to adds-in.
-    :param exclude: (A list of exclude matrix that want to filter-out.
+    :param include: A list of additional matrix that want to adds-in.
+    :param exclude: A list of exclude matrix that want to filter-out.
 
     :rtype: list[DictStr]
     """
@@ -191,22 +192,22 @@ class Strategy(BaseModel):
 class Rule(str, Enum):
     """Rule enum object for assign trigger option."""
 
-    ALL_SUCCESS: str = "all_success"
-    ALL_FAILED: str = "all_failed"
-    ALL_DONE: str = "all_done"
-    ONE_FAILED: str = "one_failed"
-    ONE_SUCCESS: str = "one_success"
-    NONE_FAILED: str = "none_failed"
-    NONE_SKIPPED: str = "none_skipped"
+    ALL_SUCCESS = "all_success"
+    ALL_FAILED = "all_failed"
+    ALL_DONE = "all_done"
+    ONE_FAILED = "one_failed"
+    ONE_SUCCESS = "one_success"
+    NONE_FAILED = "none_failed"
+    NONE_SKIPPED = "none_skipped"
 
 
 class RunsOn(str, Enum):
     """Runs-On enum object."""
 
-    LOCAL: str = "local"
-    SELF_HOSTED: str = "self_hosted"
-    AZ_BATCH: str = "azure_batch"
-    DOCKER: str = "docker"
+    LOCAL = "local"
+    SELF_HOSTED = "self_hosted"
+    AZ_BATCH = "azure_batch"
+    DOCKER = "docker"
 
 
 class BaseRunsOn(BaseModel):  # pragma: no cov
@@ -566,7 +567,7 @@ class Job(BaseModel):
         :param output: (DictData) A result data context that want to extract
             and transfer to the `strategies` key in receive context.
         :param to: (DictData) A received context data.
-        :param job_id: (str | None) A job ID if the `id` field does not set.
+        :param job_id: (Optional[str]) A job ID if the `id` field does not set.
 
         :rtype: DictData
         """
@@ -606,9 +607,9 @@ class Job(BaseModel):
         self,
         params: DictData,
         *,
-        run_id: str | None = None,
-        parent_run_id: str | None = None,
-        event: Event | None = None,
+        run_id: Optional[str] = None,
+        parent_run_id: Optional[str] = None,
+        event: Optional[Event] = None,
     ) -> Result:
         """Job execution with passing dynamic parameters from the workflow
         execution. It will generate matrix values at the first step and run
@@ -676,8 +677,8 @@ def local_execute_strategy(
     strategy: DictData,
     params: DictData,
     *,
-    result: Result | None = None,
-    event: Event | None = None,
+    result: Optional[Result] = None,
+    event: Optional[Event] = None,
 ) -> Result:
     """Local strategy execution with passing dynamic parameters from the
     job execution and strategy matrix.
@@ -799,9 +800,9 @@ def local_execute(
     job: Job,
     params: DictData,
     *,
-    run_id: str | None = None,
-    parent_run_id: str | None = None,
-    event: Event | None = None,
+    run_id: Optional[str] = None,
+    parent_run_id: Optional[str] = None,
+    event: Optional[Event] = None,
 ) -> Result:
     """Local job execution with passing dynamic parameters from the workflow
     execution or directly. It will generate matrix values at the first
@@ -839,7 +840,7 @@ def local_execute(
     ls: str = "Fail-Fast" if fail_fast_flag else "All-Completed"
     workers: int = job.strategy.max_parallel
     result.trace.info(
-        f"[JOB]: Execute {ls}: {job.id} with {workers} "
+        f"[JOB]: Execute {ls}: {job.id!r} with {workers} "
         f"worker{'s' if workers > 1 else ''}."
     )
 
@@ -874,10 +875,10 @@ def local_execute(
         status: Status = SUCCESS
 
         if not fail_fast_flag:
-            done: list[Future] = as_completed(futures)
+            done: Iterator[Future] = as_completed(futures)
         else:
             done, not_done = wait(futures, return_when=FIRST_EXCEPTION)
-            if len(done) != len(futures):
+            if len(list(done)) != len(futures):
                 result.trace.warning(
                     "[JOB]: Handler Fail-Fast: Got exception and set event."
                 )
@@ -886,9 +887,16 @@ def local_execute(
                     future.cancel()
                 time.sleep(0.075)
 
-            nd: str = f", strategies not run: {not_done}" if not_done else ""
+            nd: str = (
+                (
+                    f", {len(not_done)} strateg"
+                    f"{'ies' if len(not_done) > 1 else 'y'} not run!!!"
+                )
+                if not_done
+                else ""
+            )
             result.trace.debug(f"[JOB]: ... Job was set Fail-Fast{nd}")
-            done: list[Future] = as_completed(futures)
+            done: Iterator[Future] = as_completed(futures)
 
         for future in done:
             try:
@@ -911,9 +919,9 @@ def self_hosted_execute(
     job: Job,
     params: DictData,
     *,
-    run_id: str | None = None,
-    parent_run_id: str | None = None,
-    event: Event | None = None,
+    run_id: Optional[str] = None,
+    parent_run_id: Optional[str] = None,
+    event: Optional[Event] = None,
 ) -> Result:  # pragma: no cov
     """Self-Hosted job execution with passing dynamic parameters from the
     workflow execution or itself execution. It will make request to the
@@ -974,9 +982,9 @@ def azure_batch_execute(
     job: Job,
     params: DictData,
     *,
-    run_id: str | None = None,
-    parent_run_id: str | None = None,
-    event: Event | None = None,
+    run_id: Optional[str] = None,
+    parent_run_id: Optional[str] = None,
+    event: Optional[Event] = None,
 ) -> Result:  # pragma: no cov
     """Azure Batch job execution that will run all job's stages on the Azure
     Batch Node and extract the result file to be returning context result.
@@ -1028,9 +1036,9 @@ def docker_execution(
     job: Job,
     params: DictData,
     *,
-    run_id: str | None = None,
-    parent_run_id: str | None = None,
-    event: Event | None = None,
+    run_id: Optional[str] = None,
+    parent_run_id: Optional[str] = None,
+    event: Optional[Event] = None,
 ):  # pragma: no cov
     """Docker job execution.