ddeutil-workflow 0.0.65__py3-none-any.whl → 0.0.66__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.65"
+__version__: str = "0.0.66"

ddeutil/workflow/__main__.py

@@ -1,30 +1,4 @@
-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")
-
+from .cli import app
 
 if __name__ == "__main__":
     app()

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/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/errors.py

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

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/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/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/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/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.dist-info → ddeutil_workflow-0.0.66.dist-info}/METADATA

@@ -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.dist-info → ddeutil_workflow-0.0.66.dist-info}/RECORD

@@ -1,28 +1,29 @@
-ddeutil/workflow/__about__.py,sha256=HQ_82TqpLyt4QUTSUNDK94y4NkrRcrX9-AKR-fDwuWU,28
+ddeutil/workflow/__about__.py,sha256=nkpvuhIACvuey4B8paloyuDA6U0uRDZqZ83SUGdlIt4,28
 ddeutil/workflow/__cron.py,sha256=BOKQcreiex0SAigrK1gnLxpvOeF3aca_rQwyz9Kfve4,28751
 ddeutil/workflow/__init__.py,sha256=JfFZlPRDgR2J0rb0SRejt1OSrOrD3GGv9Um14z8MMfs,901
-ddeutil/workflow/__main__.py,sha256=x-sYedl4T8p6054aySk-EQX6vhytvPR0HvaBNYxMzp0,364
+ddeutil/workflow/__main__.py,sha256=Qd-f8z2Q2vpiEP2x6PBFsJrpACWDVxFKQk820MhFmHo,59
 ddeutil/workflow/__types.py,sha256=uNfoRbVmNK5O37UUMVnqcmoghD9oMS1q9fXC0APnjSI,4584
-ddeutil/workflow/conf.py,sha256=VKtnD-Duuf_tPOCUfM6oa86-CrqeCj8kiQbzPLPUXx0,14807
-ddeutil/workflow/errors.py,sha256=evZYwNrvAvY1jpCqqZFkBCdaZ7GN-JbYJMYL6tJmm-0,2980
+ddeutil/workflow/cli.py,sha256=__ydzTs_e9C1tHqhnyp__0iKelZJRUwZn8VsyVYw5yo,1458
+ddeutil/workflow/conf.py,sha256=w1WDWZDCvRVDSz2HnJxeqySzpYWSubJZjTVjXO9imK0,14669
+ddeutil/workflow/errors.py,sha256=vh_AbLegPbb61TvfwHmjSz0t2SH09RQuGHCKmoyNjn0,2934
 ddeutil/workflow/event.py,sha256=S2eJAZZx_V5TuQ0l417hFVCtjWXnfNPZBgSCICzxQ48,11041
-ddeutil/workflow/job.py,sha256=9toh8L9MlQqyy3U3WYierdA03ohf0LOhffaPIOY2IYU,39126
-ddeutil/workflow/logs.py,sha256=iVtyl8i69y7t07tAuWkihc54WlkHCcBy_Ur0WtzJ_lM,31367
+ddeutil/workflow/job.py,sha256=qcbKSOa39256nfJHL0vKJsHrelcRujX5KET2IEGS8dw,38995
+ddeutil/workflow/logs.py,sha256=4rL8TsRJsYVqyPfLjFW5bSoWtRwUgwmaRONu7nnVxQ8,31374
 ddeutil/workflow/params.py,sha256=Pco3DyjptC5Jkx53dhLL9xlIQdJvNAZs4FLzMUfXpbQ,12402
-ddeutil/workflow/result.py,sha256=aUMIXw2nYbCDfFZqj9ABr_b7ZLo1GftTaaW8ATh618g,7855
+ddeutil/workflow/result.py,sha256=CzSjK9EQtSS0a1z8b6oBW4gg8t0uVbZ_Ppx4Ckvcork,7786
 ddeutil/workflow/reusables.py,sha256=jPrOCbxagqRvRFGXJzIyDa1wKV5AZ4crZyJ10cldQP0,21620
-ddeutil/workflow/stages.py,sha256=rorKBjdyUAxALtelNJrvc5plJp1WCV35NMkii3XMw2A,102094
+ddeutil/workflow/stages.py,sha256=s6Jc4A6ApXT40JMrnVf7n7yHG_mmjfHJIOU_niMW5hI,102555
 ddeutil/workflow/utils.py,sha256=slhBbsBNl0yaSk9EOiCK6UL-o7smgHVsLT7svRqAWXU,10436
-ddeutil/workflow/workflow.py,sha256=YP1st2y3YCUscsuFpjf3fQgYMOnQbBhiY0s6PW1Lpng,27637
+ddeutil/workflow/workflow.py,sha256=AcSGqsH1N4LqWhYIcCPy9CoV_AGlXUrBgjpl-gniv6g,28267
 ddeutil/workflow/api/__init__.py,sha256=0UIilYwW29RL6HrCRHACSWvnATJVLSJzXiCMny0bHQk,2627
 ddeutil/workflow/api/logs.py,sha256=NMTnOnsBrDB5129329xF2myLdrb-z9k1MQrmrP7qXJw,1818
 ddeutil/workflow/api/routes/__init__.py,sha256=jC1pM7q4_eo45IyO3hQbbe6RnL9B8ibRq_K6aCMP6Ag,434
 ddeutil/workflow/api/routes/job.py,sha256=32TkNm7QY9gt6fxIqEPjDqPgc8XqDiMPjUb7disSrCw,2143
 ddeutil/workflow/api/routes/logs.py,sha256=QJH8IF102897WLfCJ29-1g15wl29M9Yq6omroZfbahs,5305
 ddeutil/workflow/api/routes/workflows.py,sha256=Gmg3e-K5rfi95pbRtWI_aIr5C089sIde_vefZVvh3U0,4420
-ddeutil_workflow-0.0.65.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.65.dist-info/METADATA,sha256=ujjqpMK3NkLSGMjPJdg30Cs3oGMJB8pBQd-eGWllYX4,16685
-ddeutil_workflow-0.0.65.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-ddeutil_workflow-0.0.65.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
-ddeutil_workflow-0.0.65.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.65.dist-info/RECORD,,
+ddeutil_workflow-0.0.66.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.66.dist-info/METADATA,sha256=LhCFhlwk3N5wbnylmi7zi3sAJqwxkRVlrRThlNB4Cj0,16676
+ddeutil_workflow-0.0.66.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+ddeutil_workflow-0.0.66.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
+ddeutil_workflow-0.0.66.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.66.dist-info/RECORD,,