ddeutil-workflow 0.0.48__tar.gz → 0.0.49__tar.gz

{ddeutil_workflow-0.0.48 → ddeutil_workflow-0.0.49}/PKG-INFO

@@ -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.48 → ddeutil_workflow-0.0.49}/README.md

@@ -219,14 +219,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/src/ddeutil/workflow/__about__.py

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

{ddeutil_workflow-0.0.48 → ddeutil_workflow-0.0.49}/src/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,

{ddeutil_workflow-0.0.48 → ddeutil_workflow-0.0.49}/src/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-0.0.48 → ddeutil_workflow-0.0.49}/src/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)
@@ -51,22 +54,13 @@ class Config:  # pragma: no cov
     """
 
     # 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 +72,12 @@ 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:
         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 +87,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.
 
@@ -106,7 +100,7 @@ class Config:  # pragma: no cov
 
     # NOTE: Log
     @property
-    def log_path(self) -> Path:
+    def trace_path(self) -> Path:
         return Path(env("LOG_TRACE_PATH", "./logs"))
 
     @property
@@ -165,11 +159,7 @@ class Config:  # pragma: no cov
         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-0.0.48 → ddeutil_workflow-0.0.49}/src/ddeutil/workflow/job.py

@@ -483,7 +483,13 @@ class Job(BaseModel):
         except Exception as err:
             raise JobException(f"{err.__class__.__name__}: {err}") from err
 
-    def set_outputs(self, output: DictData, to: DictData) -> DictData:
+    def set_outputs(
+        self,
+        output: DictData,
+        to: DictData,
+        *,
+        job_id: Optional[None] = None,
+    ) -> DictData:
         """Set an outputs from execution process to the received context. The
         result from execution will pass to value of `strategies` key.
 
@@ -511,22 +517,21 @@ class Job(BaseModel):
 
         :param output: An output context.
         :param to: A context data that want to add output result.
+        :param job_id: A job ID if the id field does not set.
 
         :rtype: DictData
         """
         if "jobs" not in to:
             to["jobs"] = {}
 
-        if self.id is None and not dynamic(
-            "job_default_id", extras=self.extras
-        ):
+        if self.id is None and job_id is None:
             raise JobException(
                 "This job do not set the ID before setting execution output."
             )
 
         # NOTE: If the job ID did not set, it will use index of jobs key
         #   instead.
-        _id: str = self.id or str(len(to["jobs"]) + 1)
+        _id: str = self.id or job_id
 
         errors: DictData = (
             {"errors": output.pop("errors", {})} if "errors" in output else {}