ddeutil-workflow 0.0.83__py3-none-any.whl → 0.0.85__py3-none-any.whl

ddeutil/workflow/workflow.py

@@ -41,6 +41,7 @@ from pydantic.functional_serializers import field_serializer
 from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
+from . import DRYRUN
 from .__types import DictData
 from .audits import NORMAL, RERUN, Audit, ReleaseType, get_audit
 from .conf import YamlParser, dynamic
@@ -66,7 +67,7 @@ from .utils import (
     extract_id,
     gen_id,
     get_dt_now,
-    remove_sys_extras,
+    pop_sys_extras,
 )
 
 
@@ -98,7 +99,10 @@ class Workflow(BaseModel):
         description="An extra parameters that want to override config values.",
     )
     name: str = Field(description="A workflow name.")
-    type: Literal["Workflow"] = Field(default="workflow")
+    type: Literal["Workflow"] = Field(
+        default="Workflow",
+        description="A type of this config data that will use by discriminator",
+    )
     desc: Optional[str] = Field(
         default=None,
         description=(
@@ -244,14 +248,12 @@ class Workflow(BaseModel):
                 f"{self.name!r}."
             )
 
-        # NOTE: Force update internal extras for handler circle execution.
-        self.extras.update({"__sys_break_circle_exec": self.name})
-
         return self
 
     @field_serializer("extras")
     def __serialize_extras(self, extras: DictData) -> DictData:
-        return remove_sys_extras(extras)
+        """Serialize extra parameter."""
+        return {k: extras[k] for k in extras if not k.startswith("__sys_")}
 
     def detail(self) -> DictData:  # pragma: no cov
         """Return the detail of this workflow for generate markdown."""
@@ -264,8 +266,10 @@ class Workflow(BaseModel):
             author (str | None, default None): An author name.
         """
 
-        def align_newline(value: str) -> str:
+        def align_newline(value: Optional[str]) -> str:
             space: str = " " * 16
+            if value is None:
+                return ""
             return value.rstrip("\n").replace("\n", f"\n{space}")
 
         info: str = (
@@ -452,7 +456,17 @@ class Workflow(BaseModel):
             extras=self.extras,
         )
 
-        if release_type == NORMAL and audit.is_pointed(data=audit_data):
+        if release_type == RERUN:
+            # TODO: It will load previous audit and use this data to run with
+            #   the `rerun` method.
+            raise NotImplementedError(
+                "Release does not support for rerun type yet. Please use the "
+                "`rerun` method instead."
+            )
+        elif release_type == DRYRUN:
+            self.extras.update({"__sys_release_dryrun_mode": True})
+            trace.debug("[RELEASE]: Mark dryrun mode to the extra params.")
+        elif release_type == NORMAL and audit.is_pointed(data=audit_data):
             trace.info("[RELEASE]: Skip this release because it already audit.")
             return Result(
                 run_id=run_id,
@@ -462,14 +476,6 @@ class Workflow(BaseModel):
                 extras=self.extras,
             )
 
-        if release_type == RERUN:
-            # TODO: It will load previous audit and use this data to run with
-            #   the `rerun` method.
-            raise NotImplementedError(
-                "Release does not support for rerun type yet. Please use the "
-                "`rerun` method instead."
-            )
-
         rs: Result = self.execute(
             params=values,
             run_id=parent_run_id,
@@ -478,27 +484,29 @@ class Workflow(BaseModel):
         catch(context, status=rs.status, updated=rs.context)
         trace.info(f"[RELEASE]: End {name!r} : {release:%Y-%m-%d %H:%M:%S}")
         trace.debug(f"[RELEASE]: Writing audit: {name!r}.")
-        (
-            audit.save(
-                data=audit_data
-                | {
-                    "context": context,
-                    "runs_metadata": (
-                        (runs_metadata or {})
-                        | rs.info
-                        | {
-                            "timeout": timeout,
-                            "original_name": self.name,
-                            "audit_excluded": audit_excluded,
-                        }
-                    ),
-                },
-                excluded=audit_excluded,
+        if release_type != DRYRUN:
+            (
+                audit.save(
+                    data=audit_data
+                    | {
+                        "context": context,
+                        "runs_metadata": (
+                            (runs_metadata or {})
+                            | rs.info
+                            | {
+                                "timeout": timeout,
+                                "original_name": self.name,
+                                "audit_excluded": audit_excluded,
+                            }
+                        ),
+                    },
+                    excluded=audit_excluded,
+                )
             )
-        )
-        return Result(
-            run_id=run_id,
-            parent_run_id=parent_run_id,
+
+        # NOTE: Pop system extra parameters.
+        pop_sys_extras(self.extras, scope="release")
+        return Result.from_trace(trace).catch(
             status=rs.status,
             context=catch(
                 context,
@@ -513,7 +521,6 @@ class Workflow(BaseModel):
                     **(context["errors"] if "errors" in context else {}),
                 },
             ),
-            extras=remove_sys_extras(self.extras),
         )
 
     def execute_job(
@@ -719,6 +726,8 @@ class Workflow(BaseModel):
                 extras=self.extras,
             )
 
+        # NOTE: Force update internal extras for handler circle execution.
+        self.extras.update({"__sys_exec_break_circle": self.name})
         with ThreadPoolExecutor(max_job_parallel, "wf") as executor:
             futures: list[Future] = []
 
@@ -747,6 +756,7 @@ class Workflow(BaseModel):
                 backoff_sleep = 0.01
 
                 if check == FAILED:  # pragma: no cov
+                    pop_sys_extras(self.extras)
                     return Result(
                         run_id=run_id,
                         parent_run_id=parent_run_id,
@@ -841,6 +851,7 @@ class Workflow(BaseModel):
                 for i, s in enumerate(sequence_statuses, start=0):
                     statuses[total + 1 + skip_count + i] = s
 
+                pop_sys_extras(self.extras)
                 st: Status = validate_statuses(statuses)
                 return Result(
                     run_id=run_id,
@@ -862,6 +873,7 @@ class Workflow(BaseModel):
 
             time.sleep(0.0025)
 
+        pop_sys_extras(self.extras)
         return Result(
             run_id=run_id,
             parent_run_id=parent_run_id,

{ddeutil_workflow-0.0.83.dist-info → ddeutil_workflow-0.0.85.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.83
+Version: 0.0.85
 Summary: Lightweight workflow orchestration with YAML template
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -303,21 +303,18 @@ it will use default value and do not raise any error to you.
 > The config value that you will set on the environment should combine with
 > prefix, component, and name which is `WORKFLOW_{component}_{name}` (Upper case).
 
-| Name                        | Component | Default                                                                                                                         | Description                                                                                      |
-|:----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
-| **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.                                            |
-| **STAGE_DEFAULT_ID**        |   CORE    | `false`                                                                                                                         | A flag that enable default stage ID that use for catch an execution output.                      |
-| **GENERATE_ID_SIMPLE_MODE** |   CORE    | `true`                                                                                                                          | A flog that enable generating ID with `md5` algorithm.                                           |
-| **DEBUG_MODE**              |    LOG    | `true`                                                                                                                          | A flag that enable logging with debug level mode.                                                |
-| **TIMEZONE**                |    LOG    | `Asia/Bangkok`                                                                                                                  | A Timezone string value that will pass to `ZoneInfo` object.                                     |
-| **FORMAT**                  |    LOG    | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format.                                                                  |
-| **FORMAT_FILE**             |    LOG    | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})`                                                   | A trace message format that use to write to target pointer.                                      |
-| **DATETIME_FORMAT**         |    LOG    | `%Y-%m-%d %H:%M:%S`                                                                                                             | A datetime format of the trace log.                                                              |
-| **TRACE_HANDLERS**          |    LOG    | `[{"type": "console"}]`                                                                                                         | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default.  |
-| **AUDIT_CONF**              |    LOG    | `{"type": "file", "path": "./audits"}`                                                                                          | A pointer URL of audit log that use to write audit metrix.                                       |
-| **AUDIT_ENABLE_WRITE**      |    LOG    | `true`                                                                                                                          | A flag that enable writing audit log after end execution in the workflow release step.           |
+| Name                        | Component | Default                                | Description                                                                            |
+|:----------------------------|:---------:|:---------------------------------------|:---------------------------------------------------------------------------------------|
+| **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.                                  |
+| **STAGE_DEFAULT_ID**        |   CORE    | `false`                                | A flag that enable default stage ID that use for catch an execution output.            |
+| **GENERATE_ID_SIMPLE_MODE** |   CORE    | `true`                                 | A flog that enable generating ID with `md5` algorithm.                                 |
+| **DEBUG_MODE**              |    LOG    | `true`                                 | A flag that enable logging with debug level mode.                                      |
+| **TIMEZONE**                |    LOG    | `Asia/Bangkok`                         | A Timezone string value that will pass to `ZoneInfo` object.                           |
+| **TRACE_HANDLERS**          |    LOG    | `[{"type": "console"}]`                | A Json string of list of trace handler config data that use to emit log message.       |
+| **AUDIT_CONF**              |    LOG    | `{"type": "file", "path": "./audits"}` | A Json string of audit config data that use to write audit metrix.                     |
+| **AUDIT_ENABLE_WRITE**      |    LOG    | `true`                                 | A flag that enable writing audit log after end execution in the workflow release step. |
 
 ## :rocket: Deployment
 

{ddeutil_workflow-0.0.83.dist-info → ddeutil_workflow-0.0.85.dist-info}/RECORD

@@ -1,20 +1,20 @@
-ddeutil/workflow/__about__.py,sha256=6n_dCde_BwTTJlP4Yu4HNgiRti7QydfShki703lt6Ro,60
+ddeutil/workflow/__about__.py,sha256=Txvkda5tF4nwp4Yt6KNhSDmJxbz--KaFp-CbDWuvGlY,60
 ddeutil/workflow/__cron.py,sha256=-1tqZG7GtUmusdl6NTy_Ck7nM_tGYTXYB7TB7tKeO60,29184
-ddeutil/workflow/__init__.py,sha256=Dvfjs7LpLerGCYGnbqKwznViTw7ire_6LR8obC1I4aM,3456
+ddeutil/workflow/__init__.py,sha256=p9BkDM0O3LpPchvpYCuUojsDOEEknM__tdAmpRHRQog,3454
 ddeutil/workflow/__main__.py,sha256=Nqk5aO-HsZVKV2BmuJYeJEufJluipvCD9R1k2kMoJ3Y,8581
 ddeutil/workflow/__types.py,sha256=IOKuJCxTUPHh8Z2JoLu_K7a85oq0VOcKBhpabiJ6qEE,5001
-ddeutil/workflow/audits.py,sha256=H8yuMzXs_QAAKNox-HXdojk9CcilHYYQtklJYetoZv8,26955
-ddeutil/workflow/conf.py,sha256=VfPmwaBYEgOj8bu4eim13ayZwJ4Liy7I702aQf7vS8g,17644
-ddeutil/workflow/errors.py,sha256=J4bEbtI7qtBX7eghod4djLf0y5i1r4mCz_uFU4roLhY,5713
+ddeutil/workflow/audits.py,sha256=R-EEQ84Xt_bFl1w00mSlr6jGHdyBTTciKJ3wrS39_7w,26940
+ddeutil/workflow/conf.py,sha256=pOqELGKvB7Pmu-iUNbQCc6R4dxC1YhpTP-RjNPiS7u0,17288
+ddeutil/workflow/errors.py,sha256=15GWARGs1rEnlH4JfIL_OQkCmASMRdanNMSGaARPsuc,6031
 ddeutil/workflow/event.py,sha256=OumcZBlOZD0_J53GS4V2XJEqQ9HEcIl3UicQrCyL46M,14684
-ddeutil/workflow/job.py,sha256=VVTpxVR2iVEkjvP8r0O0LRtAPnrbsguYbKzHpe2TAVo,48146
+ddeutil/workflow/job.py,sha256=Xcc4anoHJdUT9IaSj8HPHrKoa9qZJucphvGfFgWjmvw,51177
 ddeutil/workflow/params.py,sha256=y9f6DEIyae1j4awbj3Kbeq75-U2UPFlKv9K57Hdo_Go,17188
 ddeutil/workflow/result.py,sha256=0W3z5wAs3Dyr8r2vRMY5hl1MkvdsyXWJmQD4NmsDDOM,10194
 ddeutil/workflow/reusables.py,sha256=SBLJSxR8ELoWJErBfSMZS3Rr1O_93T-fFBpfn2AvxuA,25007
-ddeutil/workflow/stages.py,sha256=lWlzvpJ6YyhDf0ks5q_fzHjm4-o6UZfhiYp9CG-ffro,129661
-ddeutil/workflow/traces.py,sha256=pq1lOg2UMgDiSDmjHxXPoTaBHnfc7uzzlo1u2TCwN2Q,74733
-ddeutil/workflow/utils.py,sha256=XsH8DkcTiMmWt1e59b4bFQofsBdo7uW1-7gC2rghuW8,12128
-ddeutil/workflow/workflow.py,sha256=uc71PJh7e-Bjb3Xg7T83wlLrKTPGvmX7Qjsn6SJ1GDI,42544
+ddeutil/workflow/stages.py,sha256=PwL_VlK8dnNrWKT0y7TmsD8Zbp_D705a0FQ10SQHCoU,143580
+ddeutil/workflow/traces.py,sha256=quNko9OqB-ZHd4IcbfFKTeCA4Ccf1XZAVEHDYx05K34,70500
+ddeutil/workflow/utils.py,sha256=Hqdh6I3OD4N0Kuehn9qWVOg54pO3BG3rgIacCrN7jqk,12298
+ddeutil/workflow/workflow.py,sha256=yMlCG5f1GOsuVwzUwtOqyRcmsm2R_PPXz1uMJzBkv_c,43220
 ddeutil/workflow/api/__init__.py,sha256=5DzYL3ngceoRshh5HYCSVWChqNJSiP01E1bEd8XxPi0,4799
 ddeutil/workflow/api/log_conf.py,sha256=WfS3udDLSyrP-C80lWOvxxmhd_XWKvQPkwDqKblcH3E,1834
 ddeutil/workflow/api/routes/__init__.py,sha256=JRaJZB0D6mgR17MbZo8yLtdYDtD62AA8MdKlFqhG84M,420
@@ -24,12 +24,12 @@ ddeutil/workflow/api/routes/workflows.py,sha256=0pEZEsIrscRFBXG9gf6nttKw0aNbcdw7
 ddeutil/workflow/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ddeutil/workflow/plugins/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ddeutil/workflow/plugins/providers/aws.py,sha256=61uIFBEWt-_D5Sui24qUPier1Hiqlw_RP_eY-rXBCKc,31551
-ddeutil/workflow/plugins/providers/az.py,sha256=o3dh011lEtmr7-d7FPZJPgXdT0ytFzKfc5xnVxSyXGU,34867
+ddeutil/workflow/plugins/providers/az.py,sha256=86xuJh3rGvpGuDYD0c-inc7UcyiKQ28U_gMCUfgB5SQ,34879
 ddeutil/workflow/plugins/providers/container.py,sha256=DSN0RWxMjTJN5ANheeMauDaPa3X6Z2E1eGUcctYkENw,22134
 ddeutil/workflow/plugins/providers/gcs.py,sha256=KgAOdMBvdbMLTH_z_FwVriBFtZfKEYx8_34jzUOVjTY,27460
-ddeutil_workflow-0.0.83.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.83.dist-info/METADATA,sha256=pxD6FyTSV4ra5DujoPvWQnb2Z9WWHHqi97HBADqeeAo,16087
-ddeutil_workflow-0.0.83.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ddeutil_workflow-0.0.83.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
-ddeutil_workflow-0.0.83.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.83.dist-info/RECORD,,
+ddeutil_workflow-0.0.85.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.85.dist-info/METADATA,sha256=PjMSLS8IcDUCYS9SiovxEbuvUMAER_BkHA_t0oFIxNY,14080
+ddeutil_workflow-0.0.85.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ddeutil_workflow-0.0.85.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
+ddeutil_workflow-0.0.85.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.85.dist-info/RECORD,,