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

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.48"
+__version__: str = "0.0.50"

ddeutil/workflow/__init__.py

@@ -32,8 +32,11 @@ from .job import (
 )
 from .logs import (
     Audit,
+    AuditModel,
+    Trace,
     TraceData,
-    TraceLog,
+    TraceMeta,
+    TraceModel,
     get_audit,
     get_dt_tznow,
     get_trace,
@@ -46,6 +49,7 @@ from .params import (
     StrParam,
 )
 from .result import (
+    CANCEL,
     FAILED,
     SKIP,
     SUCCESS,
@@ -98,6 +102,9 @@ from .utils import (
     get_diff_sec,
     get_dt_now,
     make_exec,
+    reach_next_minute,
+    replace_sec,
+    wait_to_next_minute,
 )
 from .workflow import (
     Release,

ddeutil/workflow/api/routes/logs.py

@@ -10,7 +10,8 @@ from fastapi import APIRouter, Path, Query
 from fastapi import status as st
 from fastapi.responses import UJSONResponse
 
-from ...logs import get_audit, get_trace_obj
+from ...logs import get_audit
+from ...result import Result
 
 log_route = APIRouter(
     prefix="/logs",
@@ -33,6 +34,7 @@ async def get_traces(
     """Return all trace logs from the current trace log path that config with
     `WORKFLOW_LOG_PATH` environment variable name.
     """
+    result = Result()
     return {
         "message": (
             f"Getting trace logs with offset: {offset} and limit: {limit}"
@@ -44,7 +46,7 @@ async def get_traces(
                 exclude_unset=True,
                 exclude_defaults=True,
             )
-            for trace in get_trace_obj().find_logs()
+            for trace in result.trace.find_traces()
         ],
     }
 
@@ -63,12 +65,11 @@ async def get_trace_with_id(run_id: str):
     - **run_id**: A running ID that want to search a trace log from the log
         path.
     """
+    result = Result()
     return {
         "message": f"Getting trace log with specific running ID: {run_id}",
         "trace": (
-            get_trace_obj()
-            .find_log_with_id(run_id)
-            .model_dump(
+            result.trace.find_trace_with_id(run_id).model_dump(
                 by_alias=True,
                 exclude_none=True,
                 exclude_unset=True,

ddeutil/workflow/conf.py

@@ -11,7 +11,7 @@ from collections.abc import Iterator
 from datetime import timedelta
 from functools import cached_property
 from pathlib import Path
-from typing import Optional, TypeVar
+from typing import Final, Optional, TypeVar
 from zoneinfo import ZoneInfo
 
 from ddeutil.core import str2bool
@@ -21,12 +21,15 @@ from ddeutil.io.paths import glob_files, is_ignored, read_ignore
 from .__types import DictData, TupleStr
 
 T = TypeVar("T")
-PREFIX: str = "WORKFLOW"
+PREFIX: Final[str] = "WORKFLOW"
 
 
 def env(var: str, default: str | None = None) -> str | None:  # pragma: no cov
     """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.
+
     :rtype: str | None
     """
     return os.getenv(f"{PREFIX}_{var.upper().replace(' ', '_')}", default)
@@ -50,23 +53,13 @@ class Config:  # pragma: no cov
         The config value can change when you call that config property again.
     """
 
-    # NOTE: Core
-    @property
-    def root_path(self) -> Path:
-        """Root path or the project path for this workflow engine that use for
-        combine with `conf_path` value.
-
-        :rtype: Path
-        """
-        return Path(env("CORE_ROOT_PATH", "."))
-
     @property
     def conf_path(self) -> Path:
         """Config path that keep all workflow template YAML files.
 
         :rtype: Path
         """
-        return self.root_path / env("CORE_CONF_PATH", "conf")
+        return Path(env("CORE_CONF_PATH", "./conf"))
 
     @property
     def tz(self) -> ZoneInfo:
@@ -78,12 +71,16 @@ class Config:  # pragma: no cov
         return ZoneInfo(env("CORE_TIMEZONE", "UTC"))
 
     @property
-    def gen_id_simple_mode(self) -> bool:
+    def generate_id_simple_mode(self) -> bool:
+        """Flag for generate running ID with simple mode. That does not use
+        `md5` function after generate simple mode.
+
+        :rtype: bool
+        """
         return str2bool(env("CORE_GENERATE_ID_SIMPLE_MODE", "true"))
 
-    # NOTE: Register
     @property
-    def regis_call(self) -> list[str]:
+    def registry_caller(self) -> list[str]:
         """Register Caller that is a list of importable string for the call
         stage model can get.
 
@@ -93,7 +90,7 @@ class Config:  # pragma: no cov
         return [r.strip() for r in regis_call_str.split(",")]
 
     @property
-    def regis_filter(self) -> list[str]:
+    def registry_filter(self) -> list[str]:
         """Register Filter that is a list of importable string for the filter
         template.
 
@@ -104,13 +101,16 @@ class Config:  # pragma: no cov
         )
         return [r.strip() for r in regis_filter_str.split(",")]
 
-    # NOTE: Log
     @property
-    def log_path(self) -> Path:
+    def trace_path(self) -> Path:
         return Path(env("LOG_TRACE_PATH", "./logs"))
 
     @property
     def debug(self) -> bool:
+        """Debug flag for echo log that use DEBUG mode.
+
+        :rtype: bool
+        """
         return str2bool(env("LOG_DEBUG_MODE", "true"))
 
     @property
@@ -150,7 +150,6 @@ class Config:  # pragma: no cov
     def log_datetime_format(self) -> str:
         return env("LOG_DATETIME_FORMAT", "%Y-%m-%d %H:%M:%S")
 
-    # NOTE: Stage
     @property
     def stage_raise_error(self) -> bool:
         return str2bool(env("CORE_STAGE_RAISE_ERROR", "false"))
@@ -159,17 +158,8 @@ class Config:  # pragma: no cov
     def stage_default_id(self) -> bool:
         return str2bool(env("CORE_STAGE_DEFAULT_ID", "false"))
 
-    # NOTE: Job
-    @property
-    def job_raise_error(self) -> bool:
-        return str2bool(env("CORE_JOB_RAISE_ERROR", "true"))
-
     @property
-    def job_default_id(self) -> bool:
-        return str2bool(env("CORE_JOB_DEFAULT_ID", "false"))
-
-    @property
-    def max_on_per_workflow(self) -> int:
+    def max_cron_per_workflow(self) -> int:
         """The maximum on value that store in workflow model.
 
         :rtype: int
@@ -305,23 +295,31 @@ class SimLoad:
                     )
 
     @classmethod
-    def is_ignore(cls, file: Path, conf_path: Path) -> bool:
+    def is_ignore(
+        cls,
+        file: Path,
+        conf_path: Path,
+        *,
+        ignore_filename: Optional[str] = None,
+    ) -> bool:
         """Check this file was ignored.
 
         :param file: (Path) A file path that want to check.
         :param conf_path: (Path) A config path that want to read the config
             ignore file.
+        :param ignore_filename: (str) An ignore filename.
 
         :rtype: bool
         """
-        return is_ignored(file, read_ignore(conf_path / ".confignore"))
+        ignore_filename: str = ignore_filename or ".confignore"
+        return is_ignored(file, read_ignore(conf_path / ignore_filename))
 
     @classmethod
     def filter_yaml(cls, file: Path, name: str | None = None) -> DictData:
         """Read a YAML file context from an input file path and specific name.
 
-        :param file: (Path)
-        :param name: (str)
+        :param file: (Path) A file path that want to extract YAML context.
+        :param name: (str) A key name that search on a YAML context.
 
         :rtype: DictData
         """
@@ -374,8 +372,8 @@ def dynamic(
 class Loader(SimLoad):
     """Loader Object that get the config `yaml` file from current path.
 
-    :param name: A name of config data that will read by Yaml Loader object.
-    :param externals: An external parameters
+    :param name: (str) A name of config data that will read by Yaml Loader object.
+    :param externals: (DictData) An external parameters
     """
 
     @classmethod
@@ -383,17 +381,19 @@ class Loader(SimLoad):
         cls,
         obj: object,
         *,
+        path: Path | None = None,
         included: list[str] | None = None,
         excluded: list[str] | None = None,
-        path: Path | None = None,
         **kwargs,
     ) -> Iterator[tuple[str, DictData]]:
         """Override the find class method from the Simple Loader object.
 
         :param obj: An object that want to validate matching before return.
-        :param included:
-        :param excluded:
-        :param path:
+        :param path: (Path) A override config path.
+        :param included: An excluded list of data key that want to reject this
+            data if any key exist.
+        :param excluded: An included list of data key that want to filter from
+            data.
 
         :rtype: Iterator[tuple[str, DictData]]
         """

ddeutil/workflow/exceptions.py

@@ -39,6 +39,9 @@ class BaseWorkflowException(Exception):
 class UtilException(BaseWorkflowException): ...
 
 
+class ResultException(UtilException): ...
+
+
 class StageException(BaseWorkflowException): ...
 
 
@@ -48,9 +51,6 @@ class JobException(BaseWorkflowException): ...
 class WorkflowException(BaseWorkflowException): ...
 
 
-class WorkflowFailException(WorkflowException): ...
-
-
 class ParamValueException(WorkflowException): ...