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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.63
+Version: 0.0.65
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -23,7 +23,7 @@ Requires-Python: >=3.9.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ddeutil[checksum]>=0.4.8
-Requires-Dist: ddeutil-io[toml,yaml]>=0.2.13
+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
@@ -221,33 +221,36 @@ value (This config can override by extra parameters with `registry_caller` key).
 > engine will auto use the `model_validate` method before run your caller function.
 
 ```python
-from ddeutil.workflow import Result, WorkflowSecret, tag
-from ddeutil.workflow.exceptions import StageException
+from ddeutil.workflow import Result, CallerSecret, tag
+from ddeutil.workflow.errors import StageError
 from pydantic import BaseModel
 
+
 class AwsCredential(BaseModel):
     path: str
     access_client_id: str
-    access_client_secret: WorkflowSecret
+    access_client_secret: CallerSecret
+
 
 class RestAuth(BaseModel):
     type: str
-    keys: WorkflowSecret
+    keys: CallerSecret
+
 
 @tag("requests", alias="get-api-with-oauth-to-s3")
 def get_api_with_oauth_to_s3(
-    method: str,
-    url: str,
-    body: dict[str, str],
-    auth: RestAuth,
-    writing_node: str,
-    aws: AwsCredential,
-    result: Result,
+        method: str,
+        url: str,
+        body: dict[str, str],
+        auth: RestAuth,
+        writing_node: str,
+        aws: AwsCredential,
+        result: Result,
 ) -> dict[str, int]:
     result.trace.info("[CALLER]: Start get data via RestAPI to S3.")
     result.trace.info(f"... {method}: {url}")
     if method != "post":
-       raise StageException(f"RestAPI does not support for {method} action.")
+        raise StageError(f"RestAPI does not support for {method} action.")
     # NOTE: If you want to use secret, you can use `auth.keys.get_secret_value()`.
     return {"records": 1000}
 ```
@@ -265,45 +268,6 @@ result: Result = workflow.execute(
 )
 ```
 
-> [!NOTE]
-> So, this package provide the `Schedule` template for this action, and you can
-> pass the parameters dynamically for changing align with that running time by
-> the `release` prefix.
->
-> ```yaml
-> schedule-run-local-wf:
->
->    # Validate model that use to parsing exists for template file
->    type: Schedule
->    workflows:
->
->       # Map existing workflow that want to deploy with scheduler application.
->       # It allows you to pass release parameter that dynamic change depend on the
->       # current context of this scheduler application releasing that time.
->       - name: run-py-local
->         params:
->           source-extract: "USD-THB"
->           run-date: "${{ release.logical_date }}"
-> ```
->
-> The main method of the `Schedule` model that use to running is `pending`. If you
-> do not pass the `stop` date on this method, it will use config with
-> `WORKFLOW_APP_STOP_BOUNDARY_DELTA` key for generate this stop date.
->
-> ```python
-> from ddeutil.workflow import Schedule
->
-> (
->    Schedule
->    .from_conf("schedule-run-local-wf")
->    .pending(stop=None)
-> )
-> ```
-
-> [!WARNING]
-> The scheduler feature is the expensive feature of this project. You should
-> avoid to use it and find a scheduler tool instead.
-
 ## :cookie: Configuration
 
 The main configuration that use to dynamic changing this workflow engine for your
@@ -321,7 +285,6 @@ it will use default value and do not raise any error to you.
 | **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    | `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.                                                   |
 | **MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                                                                                                                             |                                                                                                                    |
 | **MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                                                                                                                            |                                                                                                                    |
 | **GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                                                                                                                          | A flog that enable generating ID with `md5` algorithm.                                                             |
@@ -333,19 +296,6 @@ it will use default value and do not raise any error to you.
 | **TRACE_ENABLE_WRITE**       |    Log    | `false`                                                                                                                         |                                                                                                                    |
 | **AUDIT_PATH**               |    Log    | `./audits`                                                                                                                      |                                                                                                                    |
 | **AUDIT_ENABLE_WRITE**       |    Log    | `true`                                                                                                                          | A flag that enable logging object saving log to its destination.                                                   |
-| **MAX_PROCESS**              |    App    | `2`                                                                                                                             | The maximum process worker number that run in scheduler app module.                                                |
-| **MAX_SCHEDULE_PER_PROCESS** |    App    | `100`                                                                                                                           | A schedule per process that run parallel.                                                                          |
-| **STOP_BOUNDARY_DELTA**      |    App    | `'{"minutes": 5, "seconds": 20}'`                                                                                               | A time delta value that use to stop scheduler app in json string format.                                           |
-
-**API Application**:
-
-This config part use for the workflow application that build from the FastAPI
-only.
-
-| Environment                |  Component  | Default | Description                                                                        |
-|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
-| **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
-| **ENABLE_ROUTE_SCHEDULE**  |     API     | `true`  | A flag that enable run scheduler.                                                  |
 
 ## :rocket: Deployment
 

{ddeutil_workflow-0.0.63 → ddeutil_workflow-0.0.65}/README.md

@@ -170,33 +170,36 @@ value (This config can override by extra parameters with `registry_caller` key).
 > engine will auto use the `model_validate` method before run your caller function.
 
 ```python
-from ddeutil.workflow import Result, WorkflowSecret, tag
-from ddeutil.workflow.exceptions import StageException
+from ddeutil.workflow import Result, CallerSecret, tag
+from ddeutil.workflow.errors import StageError
 from pydantic import BaseModel
 
+
 class AwsCredential(BaseModel):
     path: str
     access_client_id: str
-    access_client_secret: WorkflowSecret
+    access_client_secret: CallerSecret
+
 
 class RestAuth(BaseModel):
     type: str
-    keys: WorkflowSecret
+    keys: CallerSecret
+
 
 @tag("requests", alias="get-api-with-oauth-to-s3")
 def get_api_with_oauth_to_s3(
-    method: str,
-    url: str,
-    body: dict[str, str],
-    auth: RestAuth,
-    writing_node: str,
-    aws: AwsCredential,
-    result: Result,
+        method: str,
+        url: str,
+        body: dict[str, str],
+        auth: RestAuth,
+        writing_node: str,
+        aws: AwsCredential,
+        result: Result,
 ) -> dict[str, int]:
     result.trace.info("[CALLER]: Start get data via RestAPI to S3.")
     result.trace.info(f"... {method}: {url}")
     if method != "post":
-       raise StageException(f"RestAPI does not support for {method} action.")
+        raise StageError(f"RestAPI does not support for {method} action.")
     # NOTE: If you want to use secret, you can use `auth.keys.get_secret_value()`.
     return {"records": 1000}
 ```
@@ -214,45 +217,6 @@ result: Result = workflow.execute(
 )
 ```
 
-> [!NOTE]
-> So, this package provide the `Schedule` template for this action, and you can
-> pass the parameters dynamically for changing align with that running time by
-> the `release` prefix.
->
-> ```yaml
-> schedule-run-local-wf:
->
->    # Validate model that use to parsing exists for template file
->    type: Schedule
->    workflows:
->
->       # Map existing workflow that want to deploy with scheduler application.
->       # It allows you to pass release parameter that dynamic change depend on the
->       # current context of this scheduler application releasing that time.
->       - name: run-py-local
->         params:
->           source-extract: "USD-THB"
->           run-date: "${{ release.logical_date }}"
-> ```
->
-> The main method of the `Schedule` model that use to running is `pending`. If you
-> do not pass the `stop` date on this method, it will use config with
-> `WORKFLOW_APP_STOP_BOUNDARY_DELTA` key for generate this stop date.
->
-> ```python
-> from ddeutil.workflow import Schedule
->
-> (
->    Schedule
->    .from_conf("schedule-run-local-wf")
->    .pending(stop=None)
-> )
-> ```
-
-> [!WARNING]
-> The scheduler feature is the expensive feature of this project. You should
-> avoid to use it and find a scheduler tool instead.
-
 ## :cookie: Configuration
 
 The main configuration that use to dynamic changing this workflow engine for your
@@ -270,7 +234,6 @@ it will use default value and do not raise any error to you.
 | **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    | `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.                                                   |
 | **MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                                                                                                                             |                                                                                                                    |
 | **MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                                                                                                                            |                                                                                                                    |
 | **GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                                                                                                                          | A flog that enable generating ID with `md5` algorithm.                                                             |
@@ -282,19 +245,6 @@ it will use default value and do not raise any error to you.
 | **TRACE_ENABLE_WRITE**       |    Log    | `false`                                                                                                                         |                                                                                                                    |
 | **AUDIT_PATH**               |    Log    | `./audits`                                                                                                                      |                                                                                                                    |
 | **AUDIT_ENABLE_WRITE**       |    Log    | `true`                                                                                                                          | A flag that enable logging object saving log to its destination.                                                   |
-| **MAX_PROCESS**              |    App    | `2`                                                                                                                             | The maximum process worker number that run in scheduler app module.                                                |
-| **MAX_SCHEDULE_PER_PROCESS** |    App    | `100`                                                                                                                           | A schedule per process that run parallel.                                                                          |
-| **STOP_BOUNDARY_DELTA**      |    App    | `'{"minutes": 5, "seconds": 20}'`                                                                                               | A time delta value that use to stop scheduler app in json string format.                                           |
-
-**API Application**:
-
-This config part use for the workflow application that build from the FastAPI
-only.
-
-| Environment                |  Component  | Default | Description                                                                        |
-|:---------------------------|:-----------:|---------|------------------------------------------------------------------------------------|
-| **ENABLE_ROUTE_WORKFLOW**  |     API     | `true`  | A flag that enable workflow route to manage execute manually and workflow logging. |
-| **ENABLE_ROUTE_SCHEDULE**  |     API     | `true`  | A flag that enable run scheduler.                                                  |
 
 ## :rocket: Deployment
 

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

@@ -26,7 +26,7 @@ classifiers = [
 requires-python = ">=3.9.13"
 dependencies = [
     "ddeutil[checksum]>=0.4.8",
-    "ddeutil-io[yaml,toml]>=0.2.13",
+    "ddeutil-io[yaml,toml]>=0.2.14",
     "pydantic==2.11.4",
     "pydantic-extra-types==2.10.4",
     "python-dotenv==1.1.0",
@@ -121,6 +121,8 @@ console_output_style = "count"
 addopts = [
     "--strict-config",
     "--strict-markers",
+#    "-p no:launch",
+#    "-p no:launch_ros",
 ]
 filterwarnings = [
     "error",

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

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

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

@@ -6,8 +6,8 @@
 from .__cron import CronJob, CronRunner
 from .__types import DictData, DictStr, Matrix, Re, TupleStr
 from .conf import *
+from .errors import *
 from .event import *
-from .exceptions import *
 from .job import *
 from .logs import (
     Audit,
@@ -33,13 +33,6 @@ from .result import (
     Status,
 )
 from .reusables import *
-from .scheduler import (
-    Schedule,
-    ScheduleWorkflow,
-    schedule_control,
-    schedule_runner,
-    schedule_task,
-)
 from .stages import *
 from .utils import *
 from .workflow import *

ddeutil_workflow-0.0.65/src/ddeutil/workflow/api/__init__.py

@@ -0,0 +1,91 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from __future__ import annotations
+
+import contextlib
+from collections.abc import AsyncIterator
+
+from dotenv import load_dotenv
+from fastapi import FastAPI, Request
+from fastapi import status as st
+from fastapi.encoders import jsonable_encoder
+from fastapi.exceptions import RequestValidationError
+from fastapi.middleware.cors import CORSMiddleware
+from fastapi.middleware.gzip import GZipMiddleware
+from fastapi.responses import UJSONResponse
+
+from ..__about__ import __version__
+from ..conf import api_config
+from ..logs import get_logger
+from .routes import job, log, workflow
+
+load_dotenv()
+logger = get_logger("uvicorn.error")
+
+
+@contextlib.asynccontextmanager
+async def lifespan(_: FastAPI) -> AsyncIterator[dict[str, list]]:
+    """Lifespan function for the FastAPI application."""
+    yield {}
+
+
+app = FastAPI(
+    titile="Workflow",
+    description=(
+        "This is a workflow FastAPI application that use to manage manual "
+        "execute, logging, and schedule workflow via RestAPI."
+    ),
+    version=__version__,
+    lifespan=lifespan,
+    default_response_class=UJSONResponse,
+)
+app.add_middleware(GZipMiddleware, minimum_size=1000)
+origins: list[str] = [
+    "http://localhost",
+    "http://localhost:88",
+    "http://localhost:80",
+]
+app.add_middleware(
+    CORSMiddleware,
+    allow_origins=origins,
+    allow_credentials=True,
+    allow_methods=["*"],
+    allow_headers=["*"],
+)
+
+
+@app.get(path="/", response_class=UJSONResponse)
+async def health():
+    """Index view that not return any template without json status."""
+    return {"message": "Workflow already start up with healthy status."}
+
+
+# NOTE Add the jobs and logs routes by default.
+app.include_router(job, prefix=api_config.prefix_path)
+app.include_router(log, prefix=api_config.prefix_path)
+app.include_router(workflow, prefix=api_config.prefix_path)
+
+
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(
+    request: Request, exc: RequestValidationError
+):
+    _ = request
+    return UJSONResponse(
+        status_code=st.HTTP_422_UNPROCESSABLE_ENTITY,
+        content=jsonable_encoder({"detail": exc.errors(), "body": exc.body}),
+    )
+
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(
+        app,
+        host="0.0.0.0",
+        port=80,
+        log_level="DEBUG",
+    )

{ddeutil_workflow-0.0.63 → ddeutil_workflow-0.0.65}/src/ddeutil/workflow/api/routes/__init__.py

@@ -5,5 +5,4 @@
 # ------------------------------------------------------------------------------
 from .job import job_route as job
 from .logs import log_route as log
-from .schedules import schedule_route as schedule
 from .workflows import workflow_route as workflow

{ddeutil_workflow-0.0.63 → ddeutil_workflow-0.0.65}/src/ddeutil/workflow/api/routes/job.py

@@ -12,7 +12,7 @@ from fastapi.responses import UJSONResponse
 from pydantic import BaseModel, Field
 
 from ...__types import DictData
-from ...exceptions import JobException
+from ...errors import JobError
 from ...job import Job
 from ...logs import get_logger
 from ...result import Result
@@ -59,7 +59,7 @@ async def job_execute(
             ).context,
             to=context,
         )
-    except JobException as err:
+    except JobError as err:
         rs.trace.error(f"[JOB]: {err.__class__.__name__}: {err}")
 
     return {
@@ -69,7 +69,6 @@ async def job_execute(
             by_alias=True,
             exclude_none=False,
             exclude_unset=True,
-            exclude_defaults=True,
         ),
         "params": params,
         "context": context,

{ddeutil_workflow-0.0.63 → ddeutil_workflow-0.0.65}/src/ddeutil/workflow/api/routes/logs.py

@@ -44,7 +44,6 @@ async def get_traces(
                 by_alias=True,
                 exclude_none=True,
                 exclude_unset=True,
-                exclude_defaults=True,
             )
             for trace in result.trace.find_traces()
         ],
@@ -73,7 +72,6 @@ async def get_trace_with_id(run_id: str):
                 by_alias=True,
                 exclude_none=True,
                 exclude_unset=True,
-                exclude_defaults=True,
             )
         ),
     }

{ddeutil_workflow-0.0.63 → ddeutil_workflow-0.0.65}/src/ddeutil/workflow/api/routes/workflows.py

@@ -56,7 +56,6 @@ async def get_workflow_by_name(name: str) -> DictData:
         by_alias=True,
         exclude_none=False,
         exclude_unset=True,
-        exclude_defaults=True,
     )
 
 
@@ -99,7 +98,6 @@ async def get_workflow_audits(name: str):
                     by_alias=True,
                     exclude_none=False,
                     exclude_unset=True,
-                    exclude_defaults=True,
                 )
                 for audit in get_audit().find_audits(name=name)
             ],
@@ -133,6 +131,5 @@ async def get_workflow_release_audit(name: str, release: str):
             by_alias=True,
             exclude_none=False,
             exclude_unset=True,
-            exclude_defaults=True,
         ),
     }

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

@@ -6,11 +6,9 @@
 from __future__ import annotations
 
 import copy
-import json
 import os
 from abc import ABC, abstractmethod
 from collections.abc import Iterator
-from datetime import timedelta
 from functools import cached_property
 from inspect import isclass
 from pathlib import Path
@@ -20,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
+from pydantic import SecretStr, TypeAdapter
 
 from .__types import DictData
 
@@ -143,10 +141,6 @@ class Config:  # pragma: no cov
     def log_datetime_format(self) -> str:
         return env("LOG_DATETIME_FORMAT", "%Y-%m-%d %H:%M:%S")
 
-    @property
-    def stage_raise_error(self) -> bool:
-        return str2bool(env("CORE_STAGE_RAISE_ERROR", "false"))
-
     @property
     def stage_default_id(self) -> bool:
         return str2bool(env("CORE_STAGE_DEFAULT_ID", "false"))
@@ -163,28 +157,6 @@ class Config:  # pragma: no cov
     def max_queue_complete_hist(self) -> int:
         return int(env("CORE_MAX_QUEUE_COMPLETE_HIST", "16"))
 
-    # NOTE: App
-    @property
-    def max_schedule_process(self) -> int:
-        return int(env("APP_MAX_PROCESS", "2"))
-
-    @property
-    def max_schedule_per_process(self) -> int:
-        return int(env("APP_MAX_SCHEDULE_PER_PROCESS", "100"))
-
-    @property
-    def stop_boundary_delta(self) -> timedelta:
-        stop_boundary_delta_str: str = env(
-            "APP_STOP_BOUNDARY_DELTA", '{"minutes": 5, "seconds": 20}'
-        )
-        try:
-            return timedelta(**json.loads(stop_boundary_delta_str))
-        except Exception as err:
-            raise ValueError(
-                "Config `WORKFLOW_APP_STOP_BOUNDARY_DELTA` can not parsing to"
-                f"timedelta with {stop_boundary_delta_str}."
-            ) from err
-
 
 class APIConfig:
     """API Config object."""
@@ -193,14 +165,6 @@ class APIConfig:
     def prefix_path(self) -> str:
         return env("API_PREFIX_PATH", "/api/v1")
 
-    @property
-    def enable_route_workflow(self) -> bool:
-        return str2bool(env("API_ENABLE_ROUTE_WORKFLOW", "true"))
-
-    @property
-    def enable_route_schedule(self) -> bool:
-        return str2bool(env("API_ENABLE_ROUTE_SCHEDULE", "true"))
-
 
 class BaseLoad(ABC):  # pragma: no cov
     """Base Load object is the abstraction object for any Load object that
@@ -496,7 +460,7 @@ def pass_env(value: T) -> T:  # pragma: no cov
     return None if rs == "null" else rs
 
 
-class WorkflowSecret(SecretStr):  # pragma: no cov
+class CallerSecret(SecretStr):  # pragma: no cov
     """Workflow Secret String model."""
 
     def get_secret_value(self) -> str:
@@ -506,3 +470,7 @@ class WorkflowSecret(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.63/src/ddeutil/workflow/exceptions.py → ddeutil_workflow-0.0.65/src/ddeutil/workflow/errors.py

@@ -11,6 +11,8 @@ from __future__ import annotations
 
 from typing import Literal, Optional, TypedDict, Union, overload
 
+from .__types import DictData, StrOrInt
+
 
 class ErrorData(TypedDict):
     """Error data type dict for typing necessary keys of return of to_dict func
@@ -21,7 +23,7 @@ class ErrorData(TypedDict):
     message: str
 
 
-def to_dict(exception: Exception) -> ErrorData:  # pragma: no cov
+def to_dict(exception: Exception, **kwargs) -> ErrorData:  # pragma: no cov
     """Create dict data from exception instance.
 
     :param exception: An exception object.
@@ -31,17 +33,27 @@ def to_dict(exception: Exception) -> ErrorData:  # pragma: no cov
     return {
         "name": exception.__class__.__name__,
         "message": str(exception),
+        **kwargs,
     }
 
 
-class BaseWorkflowException(Exception):
+class BaseError(Exception):
     """Base Workflow exception class will implement the `refs` argument for
     making an error context to the result context.
     """
 
-    def __init__(self, message: str, *, refs: Optional[str] = None):
+    def __init__(
+        self,
+        message: str,
+        *,
+        refs: Optional[StrOrInt] = None,
+        context: Optional[DictData] = None,
+        params: Optional[DictData] = None,
+    ) -> None:
         super().__init__(message)
         self.refs: Optional[str] = refs
+        self.context: DictData = context or {}
+        self.params: DictData = params or {}
 
     @overload
     def to_dict(
@@ -54,7 +66,9 @@ class BaseWorkflowException(Exception):
     ) -> ErrorData: ...  # pragma: no cov
 
     def to_dict(
-        self, with_refs: bool = False
+        self,
+        with_refs: bool = False,
+        **kwargs,
     ) -> Union[ErrorData, dict[str, ErrorData]]:
         """Return ErrorData data from the current exception object. If with_refs
         flag was set, it will return mapping of refs and itself data.
@@ -64,25 +78,46 @@ class BaseWorkflowException(Exception):
         data: ErrorData = to_dict(self)
         if with_refs and (self.refs is not None and self.refs != "EMPTY"):
             return {self.refs: data}
-        return data
+        return data | kwargs
+
+
+class UtilError(BaseError): ...
+
+
+class ResultError(UtilError): ...
+
+
+class StageError(BaseError): ...
+
+
+class StageRetryError(StageError): ...
+
+
+class StageCancelError(StageError): ...
+
+
+class StageSkipError(StageError): ...
+
+
+class JobError(BaseError): ...
 
 
-class UtilException(BaseWorkflowException): ...
+class JobCancelError(JobError): ...
 
 
-class ResultException(UtilException): ...
+class JobSkipError(JobError): ...
 
 
-class StageException(BaseWorkflowException): ...
+class WorkflowError(BaseError): ...
 
 
-class JobException(BaseWorkflowException): ...
+class WorkflowCancelError(WorkflowError): ...
 
 
-class WorkflowException(BaseWorkflowException): ...
+class WorkflowSkipError(WorkflowError): ...
 
 
-class ParamValueException(WorkflowException): ...
+class WorkflowTimeoutError(WorkflowError): ...
 
 
-class ScheduleException(BaseWorkflowException): ...
+class ParamError(WorkflowError): ...