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

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.40"
+__version__: str = "0.0.41"

ddeutil/workflow/__init__.py

@@ -5,17 +5,6 @@
 # ------------------------------------------------------------------------------
 from .__cron import CronJob, CronRunner
 from .__types import Re
-from .audit import (
-    Audit,
-    get_audit,
-)
-from .caller import (
-    ReturnTagFunc,
-    TagFunc,
-    extract_call,
-    make_registry,
-    tag,
-)
 from .conf import (
     Config,
     Loader,
@@ -43,8 +32,10 @@ from .job import (
     local_execute_strategy,
 )
 from .logs import (
+    Audit,
     TraceData,
     TraceLog,
+    get_audit,
     get_dt_tznow,
     get_trace,
 )
@@ -58,7 +49,24 @@ from .params import (
 from .result import (
     Result,
     Status,
-    default_gen_id,
+)
+from .reusables import (
+    FILTERS,
+    FilterFunc,
+    FilterRegistry,
+    ReturnTagFunc,
+    TagFunc,
+    custom_filter,
+    extract_call,
+    get_args_const,
+    has_template,
+    make_filter_registry,
+    make_registry,
+    map_post_filter,
+    not_in_template,
+    param2template,
+    str2template,
+    tag,
 )
 from .scheduler import (
     Schedule,
@@ -77,22 +85,10 @@ from .stages import (
     Stage,
     TriggerStage,
 )
-from .templates import (
-    FILTERS,
-    FilterFunc,
-    FilterRegistry,
-    custom_filter,
-    get_args_const,
-    has_template,
-    make_filter_registry,
-    map_post_filter,
-    not_in_template,
-    param2template,
-    str2template,
-)
 from .utils import (
     batch,
     cross_product,
+    default_gen_id,
     delay,
     filter_func,
     gen_id,

ddeutil/workflow/api/api.py

@@ -109,7 +109,7 @@ if config.enable_route_workflow:
 
 # NOTE: Enable the schedules route.
 if config.enable_route_schedule:
-    from ..audit import get_audit
+    from ..logs import get_audit
     from ..scheduler import schedule_task
     from .routes import schedule
 

ddeutil/workflow/api/routes/logs.py

@@ -10,8 +10,7 @@ from fastapi import APIRouter, Path, Query
 from fastapi import status as st
 from fastapi.responses import UJSONResponse
 
-from ...audit import get_audit
-from ...logs import get_trace_obj
+from ...logs import get_audit, get_trace_obj
 
 log_route = APIRouter(
     prefix="/logs",

ddeutil/workflow/api/routes/workflows.py

@@ -15,8 +15,8 @@ from fastapi.responses import UJSONResponse
 from pydantic import BaseModel
 
 from ...__types import DictData
-from ...audit import Audit, get_audit
 from ...conf import Loader, get_logger
+from ...logs import Audit, get_audit
 from ...result import Result
 from ...workflow import Workflow
 

ddeutil/workflow/conf.py

@@ -24,6 +24,7 @@ PREFIX: str = "WORKFLOW"
 
 
 def env(var: str, default: str | None = None) -> str | None:  # pragma: no cov
+    """Get environment variable with uppercase and adding prefix string."""
     return os.getenv(f"{PREFIX}_{var.upper().replace(' ', '_')}", default)
 
 
@@ -94,11 +95,19 @@ class Config(BaseConfig):  # pragma: no cov
     # NOTE: Register
     @property
     def regis_call(self) -> list[str]:
+        """Register Caller module importer str.
+
+        :rtype: list[str]
+        """
         regis_call_str: str = env("CORE_REGISTRY", ".")
         return [r.strip() for r in regis_call_str.split(",")]
 
     @property
     def regis_filter(self) -> list[str]:
+        """Register Filter module.
+
+        :rtype: list[str]
+        """
         regis_filter_str: str = env(
             "CORE_REGISTRY_FILTER", "ddeutil.workflow.templates"
         )
@@ -326,7 +335,8 @@ class SimLoad:
     def filter_yaml(cls, file: Path, name: str | None = None) -> DictData:
         if any(file.suffix.endswith(s) for s in (".yml", ".yaml")):
             values: DictData = YamlFlResolve(file).read()
-            return values.get(name, {}) if name else values
+            if values is not None:
+                return values.get(name, {}) if name else values
         return {}
 
     @cached_property

ddeutil/workflow/job.py

@@ -39,8 +39,8 @@ from .exceptions import (
     UtilException,
 )
 from .result import Result, Status
+from .reusables import has_template, param2template
 from .stages import Stage
-from .templates import has_template, param2template
 from .utils import cross_product, filter_func, gen_id
 
 MatrixFilter = list[dict[str, Union[str, int]]]
@@ -344,6 +344,10 @@ class Job(BaseModel):
         default_factory=Strategy,
         description="A strategy matrix that want to generate.",
     )
+    extras: DictData = Field(
+        default_factory=dict,
+        description="An extra override values.",
+    )
 
     @field_validator("desc", mode="after")
     def ___prepare_desc__(cls, value: str) -> str:
@@ -394,6 +398,8 @@ class Job(BaseModel):
         """
         for stage in self.stages:
             if stage_id == (stage.id or ""):
+                if self.extras:
+                    stage.extras = self.extras
                 return stage
         raise ValueError(f"Stage ID {stage_id} does not exists")
 
@@ -596,7 +602,7 @@ def local_execute_strategy(
     *,
     result: Result | None = None,
     event: Event | None = None,
-    raise_error: bool = False,
+    raise_error: bool | None = None,
 ) -> Result:
     """Local job strategy execution with passing dynamic parameters from the
     workflow execution to strategy matrix.
@@ -694,12 +700,16 @@ def local_execute_strategy(
                     params=context,
                     run_id=result.run_id,
                     parent_run_id=result.parent_run_id,
+                    event=event,
                 ).context,
                 to=context,
             )
         except (StageException, UtilException) as err:
             result.trace.error(f"[JOB]: {err.__class__.__name__}: {err}")
-            if raise_error or config.job_raise_error:
+            do_raise: bool = (
+                config.job_raise_error if raise_error is None else raise_error
+            )
+            if do_raise:
                 raise JobException(
                     f"Stage execution error: {err.__class__.__name__}: "
                     f"{err}"
@@ -735,7 +745,7 @@ def local_execute(
     parent_run_id: str | None = None,
     result: Result | None = None,
     event: Event | None = None,
-    raise_error: bool = False,
+    raise_error: bool | None = None,
 ) -> Result:
     """Local job execution with passing dynamic parameters from the workflow
     execution. It will generate matrix values at the first step and run
@@ -865,3 +875,44 @@ def local_execute(
                 context.update({"errors": err.to_dict()})
 
     return result.catch(status=status, context=context)
+
+
+def self_hosted_execute(
+    job: Job,
+    params: DictData,
+    *,
+    run_id: str | None = None,
+    parent_run_id: str | None = None,
+    result: Result | None = None,
+    event: Event | None = None,
+    raise_error: bool | None = None,
+) -> Result:  # pragma: no cov
+    result: Result = Result.construct_with_rs_or_id(
+        result,
+        run_id=run_id,
+        parent_run_id=parent_run_id,
+        id_logic=(job.id or "not-set"),
+    )
+
+    if event and event.is_set():
+        return result.catch(status=Status.FAILED)
+
+    import requests
+
+    resp = requests.post(
+        job.runs_on.args.host,
+        data={"job": job.model_dump(), "params": params},
+    )
+
+    if resp.status_code != 200:
+        do_raise: bool = (
+            config.job_raise_error if raise_error is None else raise_error
+        )
+        if do_raise:
+            raise JobException(
+                f"Job execution error from request to self-hosted: "
+                f"{job.runs_on.args.host!r}"
+            )
+
+        return result.catch(status=Status.FAILED)
+    return result.catch(status=Status.SUCCESS)