ddeutil-workflow 0.0.65__tar.gz → 0.0.66__tar.gz

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.65
+Version: 0.0.66
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -27,7 +27,7 @@ Requires-Dist: ddeutil-io[toml,yaml]>=0.2.14
 Requires-Dist: pydantic==2.11.4
 Requires-Dist: pydantic-extra-types==2.10.4
 Requires-Dist: python-dotenv==1.1.0
-Requires-Dist: schedule<2.0.0,==1.2.2
+Requires-Dist: typer==0.15.4
 Provides-Extra: all
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "all"
 Requires-Dist: uvicorn; extra == "all"

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/pyproject.toml

@@ -30,7 +30,8 @@ dependencies = [
     "pydantic==2.11.4",
     "pydantic-extra-types==2.10.4",
     "python-dotenv==1.1.0",
-    "schedule==1.2.2,<2.0.0",
+#    "schedule==1.2.2,<2.0.0",
+    "typer==0.15.4",
 ]
 dynamic = ["version"]
 
@@ -90,15 +91,13 @@ omit = [
     "src/ddeutil/workflow/__about__.py",
     "src/ddeutil/workflow/__cron.py",
     "src/ddeutil/workflow/__main__.py",
+    "src/ddeutil/workflow/cli.py",
     "src/ddeutil/workflow/api/__init__.py",
     "src/ddeutil/workflow/api/logs.py",
-    "src/ddeutil/workflow/api/utils.py",
     "src/ddeutil/workflow/api/routes/__init__.py",
     "src/ddeutil/workflow/api/routes/job.py",
     "src/ddeutil/workflow/api/routes/logs.py",
-    "src/ddeutil/workflow/api/routes/schedules.py",
     "src/ddeutil/workflow/api/routes/workflows.py",
-    "app.py",
 ]
 
 [tool.coverage.report]

ddeutil_workflow-0.0.66/src/ddeutil/workflow/__about__.py

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

ddeutil_workflow-0.0.66/src/ddeutil/workflow/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+if __name__ == "__main__":
+    app()

ddeutil_workflow-0.0.66/src/ddeutil/workflow/cli.py

@@ -0,0 +1,66 @@
+import json
+from typing import Annotated, Any
+
+import typer
+import uvicorn
+
+from .__about__ import __version__
+from .api import app as fastapp
+from .api.logs import LOGGING_CONFIG
+
+app = typer.Typer(
+    pretty_exceptions_enable=True,
+)
+
+
+@app.callback()
+def callback():
+    """
+    Awesome Portal Gun
+    """
+    typer.echo("Start call from callback function")
+
+
+@app.command()
+def version():
+    """Get the ddeutil-workflow package version."""
+    typer.echo(__version__)
+
+
+@app.command()
+def job(
+    params: Annotated[str, typer.Option(help="A job execute parameters")],
+):
+    """Job execution on the local.
+
+    Example:
+        ... workflow-cli job --params "{\"test\": 1}"
+    """
+    try:
+        params_dict: dict[str, Any] = json.loads(params)
+    except json.JSONDecodeError as e:
+        raise ValueError(f"params does not support format: {params!r}.") from e
+    typer.echo(f"Job params: {params_dict}")
+
+
+@app.command()
+def api(
+    host: Annotated[str, typer.Option(help="A host url.")] = "0.0.0.0",
+    port: Annotated[int, typer.Option(help="A port url.")] = 80,
+    debug: Annotated[bool, typer.Option(help="A debug mode flag")] = True,
+):
+    """
+    Provision API application from the FastAPI.
+    """
+
+    uvicorn.run(
+        fastapp,
+        host=host,
+        port=port,
+        log_config=uvicorn.config.LOGGING_CONFIG | LOGGING_CONFIG,
+        log_level=("DEBUG" if debug else "INFO"),
+    )
+
+
+if __name__ == "__main__":
+    app()

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/conf.py

@@ -18,7 +18,7 @@ from zoneinfo import ZoneInfo
 from ddeutil.core import str2bool
 from ddeutil.io import YamlFlResolve, search_env_replace
 from ddeutil.io.paths import glob_files, is_ignored, read_ignore
-from pydantic import SecretStr, TypeAdapter
+from pydantic import SecretStr
 
 from .__types import DictData
 
@@ -470,7 +470,3 @@ class CallerSecret(SecretStr):  # pragma: no cov
         :rtype: str
         """
         return pass_env(super().get_secret_value())
-
-
-# NOTE: Define the caller secret type for use it directly in the caller func.
-CallerSecretType = TypeAdapter(CallerSecret)

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/errors.py

@@ -114,9 +114,6 @@ class WorkflowError(BaseError): ...
 class WorkflowCancelError(WorkflowError): ...
 
 
-class WorkflowSkipError(WorkflowError): ...
-
-
 class WorkflowTimeoutError(WorkflowError): ...
 
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/job.py

@@ -39,7 +39,6 @@ from pydantic import BaseModel, Discriminator, Field, SecretStr, Tag
 from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
-from . import JobSkipError
 from .__types import DictData, DictStr, Matrix, StrOrNone
 from .errors import JobCancelError, JobError, to_dict
 from .result import (
@@ -774,7 +773,7 @@ def local_execute_strategy(
     *,
     result: Optional[Result] = None,
     event: Optional[Event] = None,
-) -> Result:
+) -> tuple[Status, Result]:
     """Local strategy execution with passing dynamic parameters from the
     job execution and strategy matrix.
 
@@ -799,7 +798,7 @@ def local_execute_strategy(
     :raise JobError: If stage execution raise any error as `StageError`.
     :raise JobError: If the result from execution has `FAILED` status.
 
-    :rtype: Result
+    :rtype: tuple[Status, Result]
     """
     result: Result = result or Result(
         run_id=gen_id(job.id or "EMPTY", unique=True),
@@ -899,9 +898,7 @@ def local_execute_strategy(
             },
         },
     )
-    if status == SKIP:
-        raise JobSkipError("All stage was skipped.")
-    return result
+    return status, result
 
 
 def local_execute(
@@ -1017,14 +1014,13 @@ def local_execute(
 
         for i, future in enumerate(done, start=0):
             try:
-                statuses[i] = future.result().status
+                statuses[i], _ = future.result()
             except JobError as e:
                 statuses[i] = get_status_from_error(e)
                 result.trace.error(
-                    f"[JOB]: {ls} Error Handler:||{e.__class__.__name__}: {e}"
+                    f"[JOB]: {ls} Handler:||{e.__class__.__name__}: {e}"
                 )
-                if not isinstance(e, JobSkipError):
-                    mark_errors(context, e)
+                mark_errors(context, e)
             except CancelledError:
                 pass
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/logs.py

@@ -848,7 +848,7 @@ class FileAudit(BaseAudit):
             "audit_path", extras=self.extras
         ) / self.filename_fmt.format(name=self.name, release=self.release)
 
-    def save(self, excluded: Optional[list[str]]) -> Self:
+    def save(self, excluded: Optional[list[str]] = None) -> Self:
         """Save logging data that receive a context data from a workflow
         execution result.
 

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/result.py

@@ -28,7 +28,6 @@ from . import (
     StageSkipError,
     WorkflowCancelError,
     WorkflowError,
-    WorkflowSkipError,
 )
 from .__types import DictData
 from .conf import dynamic
@@ -106,13 +105,12 @@ def get_status_from_error(
         JobSkipError,
         WorkflowError,
         WorkflowCancelError,
-        WorkflowSkipError,
         Exception,
         BaseException,
     ]
 ) -> Status:
     """Get the Status from the error object."""
-    if isinstance(error, (StageSkipError, JobSkipError, WorkflowSkipError)):
+    if isinstance(error, (StageSkipError, JobSkipError)):
         return SKIP
     elif isinstance(
         error, (StageCancelError, JobCancelError, WorkflowCancelError)

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/stages.py

@@ -1610,6 +1610,9 @@ class ParallelStage(BaseNestedStage):
             (Default is None)
 
         :raise StageCancelError: If event was set.
+        :raise StageCancelError: If result from a nested-stage return canceled
+            status.
+        :raise StageError: If result from a nested-stage return failed status.
 
         :rtype: tuple[Status, Result]
         """
@@ -1854,9 +1857,11 @@ class ForEachStage(BaseNestedStage):
         result.trace.debug(f"[STAGE]: Execute Item: {item!r}")
         key: StrOrInt = index if self.use_index_as_key else item
 
+        # NOTE: Create nested-context data from the passing context.
         context: DictData = copy.deepcopy(params)
         context.update({"item": item, "loop": index})
         nestet_context: DictData = {"item": item, "stages": {}}
+
         total_stage: int = len(self.stages)
         skips: list[bool] = [False] * total_stage
         for i, stage in enumerate(self.stages, start=0):
@@ -1959,6 +1964,10 @@ class ForEachStage(BaseNestedStage):
     ) -> Result:
         """Execute the stages that pass each item form the foreach field.
 
+            This stage will use fail-fast strategy if it was set concurrency
+        value more than 1. It will cancel all nested-stage execution when it has
+        any item loop raise failed or canceled error.
+
         :param params: (DictData) A parameter data.
         :param result: (Result) A Result instance for return context and status.
         :param event: (Event) An Event manager instance that use to cancel this

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil/workflow/workflow.py

@@ -379,6 +379,7 @@ class Workflow(BaseModel):
         override_log_name: Optional[str] = None,
         result: Optional[Result] = None,
         timeout: int = 600,
+        excluded: Optional[list[str]] = None,
     ) -> Result:
         """Release the workflow which is executes workflow with writing audit
         log tracking. The method is overriding parameter with the release
@@ -405,6 +406,8 @@ class Workflow(BaseModel):
         :param result: (Result) A result object for keeping context and status
             data.
         :param timeout: (int) A workflow execution time out in second unit.
+        :param excluded: (list[str]) A list of key that want to exclude from
+            audit data.
 
         :rtype: Result
         """
@@ -453,7 +456,7 @@ class Workflow(BaseModel):
                 run_id=result.run_id,
                 execution_time=result.alive_time(),
                 extras=self.extras,
-            ).save(excluded=None)
+            ).save(excluded=excluded)
         )
         return result.catch(
             status=rs.status,
@@ -586,6 +589,19 @@ class Workflow(BaseModel):
                                                 |-name: ...
                                                 ╰-message: ...
 
+                        --> Ok      --> Result
+                                        |-status: FAILED
+                                        ╰-context:
+                                            ╰-errors:
+                                                |-name: ...
+                                                ╰-message: ...
+
+                        --> Ok      --> Result
+                                        ╰-status: SKIP
+
+                        --> Ok      --> Result
+                                        ╰-status: SUCCESS
+
         :param params: A parameter data that will parameterize before execution.
         :param run_id: (Optional[str]) A workflow running ID.
         :param parent_run_id: (Optional[str]) A parent workflow running ID.
@@ -725,25 +741,23 @@ class Workflow(BaseModel):
 
             if not_timeout_flag:
                 job_queue.join()
-                total_future: int = 0
-                for i, future in enumerate(as_completed(futures), start=0):
+                for total, future in enumerate(as_completed(futures), start=0):
                     try:
-                        statuses[i], _ = future.result()
+                        statuses[total], _ = future.result()
                     except WorkflowError as e:
-                        statuses[i] = get_status_from_error(e)
-                    total_future += 1
+                        statuses[total] = get_status_from_error(e)
 
                 # NOTE: Update skipped status from the job trigger.
                 for i in range(skip_count):
-                    statuses[total_future + i] = SKIP
+                    statuses[total + 1 + i] = SKIP
 
                 # NOTE: Update status from none-parallel job execution.
                 for i, s in enumerate(sequence_statuses, start=0):
-                    statuses[total_future + skip_count + i] = s
+                    statuses[total + 1 + skip_count + i] = s
 
-                status: Status = validate_statuses(statuses)
-
-                return result.catch(status=status, context=context)
+                return result.catch(
+                    status=validate_statuses(statuses), context=context
+                )
 
             event.set()
             for future in futures:

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil_workflow.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.65
+Version: 0.0.66
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -27,7 +27,7 @@ Requires-Dist: ddeutil-io[toml,yaml]>=0.2.14
 Requires-Dist: pydantic==2.11.4
 Requires-Dist: pydantic-extra-types==2.10.4
 Requires-Dist: python-dotenv==1.1.0
-Requires-Dist: schedule<2.0.0,==1.2.2
+Requires-Dist: typer==0.15.4
 Provides-Extra: all
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "all"
 Requires-Dist: uvicorn; extra == "all"

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil_workflow.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ src/ddeutil/workflow/__cron.py
 src/ddeutil/workflow/__init__.py
 src/ddeutil/workflow/__main__.py
 src/ddeutil/workflow/__types.py
+src/ddeutil/workflow/cli.py
 src/ddeutil/workflow/conf.py
 src/ddeutil/workflow/errors.py
 src/ddeutil/workflow/event.py

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/src/ddeutil_workflow.egg-info/requires.txt

@@ -3,7 +3,7 @@ ddeutil-io[toml,yaml]>=0.2.14
 pydantic==2.11.4
 pydantic-extra-types==2.10.4
 python-dotenv==1.1.0
-schedule<2.0.0,==1.2.2
+typer==0.15.4
 
 [all]
 fastapi<1.0.0,>=0.115.0

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/tests/test_conf.py

@@ -9,7 +9,6 @@ import pytest
 import rtoml
 import yaml
 from ddeutil.workflow.conf import (
-    CallerSecretType,
     Config,
     FileLoad,
     config,
@@ -171,8 +170,3 @@ def test_dynamic():
 
     conf = dynamic("max_job_exec_timeout", f=0, extras={})
     assert conf == 0
-
-
-def test_workflow_secret_model():
-    data = CallerSecretType.validate_python("${WORKFLOW_CORE_TIMEZONE}")
-    assert data.get_secret_value() == "Asia/Bangkok"

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/tests/test_job_exec_strategy.py

@@ -11,7 +11,8 @@ def test_job_exec_strategy():
     job: Job = Workflow.from_conf(name="wf-run-python-raise-for-job").job(
         "job-complete"
     )
-    rs = local_execute_strategy(job, {"sleep": "0.1"}, {})
+    st, rs = local_execute_strategy(job, {"sleep": "0.1"}, {})
+    assert st == SUCCESS
     assert rs.status == SUCCESS
     assert rs.context == {
         "status": SUCCESS,
@@ -29,7 +30,8 @@ def test_job_exec_strategy_skipped_stage():
     job: Job = Workflow.from_conf(name="wf-run-python-raise-for-job").job(
         "job-stage-condition"
     )
-    rs = local_execute_strategy(job, {"sleep": "1"}, {})
+    st, rs = local_execute_strategy(job, {"sleep": "1"}, {})
+    assert st == SUCCESS
     assert rs.status == SUCCESS
     assert rs.context == {
         "status": SUCCESS,

{ddeutil_workflow-0.0.65 → ddeutil_workflow-0.0.66}/tests/test_workflow_release.py

@@ -1,5 +1,7 @@
 from datetime import datetime
 
+import pytest
+from ddeutil.workflow import WorkflowError
 from ddeutil.workflow.conf import config
 from ddeutil.workflow.result import SUCCESS, Result
 from ddeutil.workflow.workflow import (
@@ -8,6 +10,56 @@ from ddeutil.workflow.workflow import (
 )
 
 
+def test_workflow_validate_release():
+    workflow: Workflow = Workflow.model_validate(
+        {"name": "wf-common-not-set-event"}
+    )
+    assert workflow.validate_release(datetime.now())
+    assert workflow.validate_release(datetime(2025, 5, 1, 12, 1))
+    assert workflow.validate_release(datetime(2025, 5, 1, 11, 12))
+    assert workflow.validate_release(datetime(2025, 5, 1, 10, 25, 59, 150))
+
+    workflow: Workflow = Workflow.model_validate(
+        {
+            "name": "wf-common-validate",
+            "on": [
+                {
+                    "cronjob": "*/3 * * * *",
+                    "timezone": "Asia/Bangkok",
+                }
+            ],
+        }
+    )
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 9))
+
+    with pytest.raises(WorkflowError):
+        workflow.validate_release(datetime(2025, 5, 1, 1, 10))
+
+    with pytest.raises(WorkflowError):
+        workflow.validate_release(datetime(2025, 5, 1, 1, 1))
+
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 3))
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 3, 10, 100))
+
+    workflow: Workflow = Workflow.model_validate(
+        {
+            "name": "wf-common-validate",
+            "on": [
+                {
+                    "cronjob": "* * * * *",
+                    "timezone": "Asia/Bangkok",
+                }
+            ],
+        }
+    )
+
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 9))
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 10))
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 1))
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 3))
+    assert workflow.validate_release(datetime(2025, 5, 1, 1, 3, 10, 100))
+
+
 def test_workflow_release():
     workflow: Workflow = Workflow.model_validate(
         obj={

ddeutil_workflow-0.0.65/src/ddeutil/workflow/__about__.py

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

ddeutil_workflow-0.0.65/src/ddeutil/workflow/__main__.py

@@ -1,30 +0,0 @@
-import typer
-
-app = typer.Typer()
-
-
-@app.callback()
-def callback():
-    """
-    Awesome Portal Gun
-    """
-
-
-@app.command()
-def provision():
-    """
-    Shoot the portal gun
-    """
-    typer.echo("Shooting portal gun")
-
-
-@app.command()
-def job():
-    """
-    Load the portal gun
-    """
-    typer.echo("Loading portal gun")
-
-
-if __name__ == "__main__":
-    app()