ddeutil-workflow 0.0.8__py3-none-any.whl → 0.0.9__py3-none-any.whl

ddeutil/workflow/utils.py

@@ -9,6 +9,7 @@ import inspect
 import logging
 import os
 import stat
+import time
 from abc import ABC, abstractmethod
 from ast import Call, Constant, Expr, Module, Name, parse
 from collections.abc import Iterator
@@ -17,21 +18,29 @@ from functools import wraps
 from hashlib import md5
 from importlib import import_module
 from inspect import isfunction
-from itertools import product
+from itertools import chain, islice, product
 from pathlib import Path
+from random import randrange
 from typing import Any, Callable, Literal, Optional, Protocol, Union
 from zoneinfo import ZoneInfo
 
+try:
+    from typing import ParamSpec
+except ImportError:
+    from typing_extensions import ParamSpec
+
 from ddeutil.core import getdot, hasdot, hash_str, import_string, lazy, str2bool
 from ddeutil.io import PathData, search_env_replace
 from ddeutil.io.models.lineage import dt_now
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field, PrivateAttr
 from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
 from .__types import DictData, Matrix, Re
 from .exceptions import ParamValueException, UtilException
 
+P = ParamSpec("P")
+
 
 def get_diff_sec(dt: datetime, tz: ZoneInfo | None = None) -> int:
     """Return second value that come from diff of an input datetime and the
@@ -42,6 +51,13 @@ def get_diff_sec(dt: datetime, tz: ZoneInfo | None = None) -> int:
     )
 
 
+def delay() -> None:
+    """Delay time that use time.sleep with random second value between
+    0.00 - 0.99 seconds.
+    """
+    time.sleep(randrange(0, 99, step=10) / 100)
+
+
 class Engine(BaseModel):
     """Engine Model"""
 
@@ -257,7 +273,8 @@ class DefaultParam(BaseParam):
         )
 
     @model_validator(mode="after")
-    def check_default(self) -> Self:
+    def __check_default(self) -> Self:
+        """Check default value should pass when it set required."""
         if not self.required and self.default is None:
             raise ParamValueException(
                 "Default should set when this parameter does not required."
@@ -273,7 +290,13 @@ class DatetimeParam(DefaultParam):
     default: datetime = Field(default_factory=dt_now)
 
     def receive(self, value: str | datetime | date | None = None) -> datetime:
-        """Receive value that match with datetime."""
+        """Receive value that match with datetime. If a input value pass with
+        None, it will use default value instead.
+
+        :param value: A value that want to validate with datetime parameter
+            type.
+        :rtype: datetime
+        """
         if value is None:
             return self.default
 
@@ -295,7 +318,11 @@ class StrParam(DefaultParam):
     type: Literal["str"] = "str"
 
     def receive(self, value: Optional[str] = None) -> str | None:
-        """Receive value that match with str."""
+        """Receive value that match with str.
+
+        :param value: A value that want to validate with string parameter type.
+        :rtype: str | None
+        """
         if value is None:
             return self.default
         return str(value)
@@ -307,7 +334,11 @@ class IntParam(DefaultParam):
     type: Literal["int"] = "int"
 
     def receive(self, value: Optional[int] = None) -> int | None:
-        """Receive value that match with int."""
+        """Receive value that match with int.
+
+        :param value: A value that want to validate with integer parameter type.
+        :rtype: int | None
+        """
         if value is None:
             return self.default
         if not isinstance(value, int):
@@ -348,57 +379,57 @@ Param = Union[
 ]
 
 
-class Context(BaseModel):
-    """Context Pydantic Model"""
-
-    params: dict = Field(default_factory=dict)
-    jobs: dict = Field(default_factory=dict)
-    error: dict = Field(default_factory=dict)
-
-
 class Result(BaseModel):
     """Result Pydantic Model for passing parameter and receiving output from
     the pipeline execution.
     """
 
-    # TODO: Add running ID to this result dataclass.
-    # ---
-    # parent_run_id: str
-    # run_id: str
-    #
     status: int = Field(default=2)
     context: DictData = Field(default_factory=dict)
 
+    # NOTE: Ignore this field to compare another result model with __eq__.
+    _parent_run_id: Optional[str] = PrivateAttr(default=None)
+    _run_id: Optional[str] = PrivateAttr(default=None)
+
+    @model_validator(mode="after")
+    def __prepare_run_id(self):
+        if self._run_id is None:
+            self._run_id = gen_id("manual", unique=True)
+        return self
+
+    def set_run_id(self, running_id: str) -> Self:
+        self._run_id = running_id
+        return self
+
+    def set_parent_run_id(self, running_id: str) -> Self:
+        self._parent_run_id = running_id
+        return self
+
+    @property
+    def parent_run_id(self):
+        return self._parent_run_id
+
+    @property
+    def run_id(self):
+        return self._run_id
+
     def receive(self, result: Result) -> Result:
         self.__dict__["status"] = result.status
         self.__dict__["context"].update(result.context)
+        self._parent_run_id = result.parent_run_id
+        self._run_id = result.run_id
         return self
 
     def receive_jobs(self, result: Result) -> Result:
         self.__dict__["status"] = result.status
+
+        # NOTE: Check the context has jobs key.
         if "jobs" not in self.__dict__["context"]:
             self.__dict__["context"]["jobs"] = {}
-        self.__dict__["context"]["jobs"].update(result.context)
-        return self
-
 
-class ReResult(BaseModel):
-    """Result Pydantic Model for passing parameter and receiving output from
-    the pipeline execution.
-    """
-
-    # TODO: Add running ID to this result dataclass.
-    # ---
-    # parent_run_id: str
-    # run_id: str
-    #
-    status: int = Field(default=2)
-    context: Context = Field(default_factory=Context)
-
-    def receive(self, result: ReResult) -> ReResult:
-        self.__dict__["status"] = result.status
-        self.__dict__["context"].__dict__["jobs"].update(result.context.jobs)
-        self.__dict__["context"].__dict__["error"].update(result.context.error)
+        self.__dict__["context"]["jobs"].update(result.context)
+        self._parent_run_id = result.parent_run_id
+        self._run_id = result.run_id
         return self
 
 
@@ -426,7 +457,7 @@ class FilterFunc(Protocol):
     def __call__(self, *args, **kwargs): ...
 
 
-def custom_filter(name: str):
+def custom_filter(name: str) -> Callable[P, TagFunc]:
     """Custom filter decorator function that set function attributes, ``filter``
     for making filter registries variable.
 
@@ -511,7 +542,11 @@ def get_args_const(
 
 @custom_filter("fmt")
 def datetime_format(value: datetime, fmt: str = "%Y-%m-%d %H:%M:%S") -> str:
-    return value.strftime(fmt)
+    if isinstance(value, datetime):
+        return value.strftime(fmt)
+    raise UtilException(
+        "This custom function should pass input value with datetime type."
+    )
 
 
 def map_post_filter(
@@ -556,6 +591,40 @@ def map_post_filter(
     return value
 
 
+def not_in_template(value: Any, *, not_in: str = "matrix.") -> bool:
+    """Check value should not pass template with not_in value prefix.
+
+    :param value:
+    :param not_in:
+    :rtype: bool
+    """
+    if isinstance(value, dict):
+        return any(not_in_template(value[k], not_in=not_in) for k in value)
+    elif isinstance(value, (list, tuple, set)):
+        return any(not_in_template(i, not_in=not_in) for i in value)
+    elif not isinstance(value, str):
+        return False
+    return any(
+        (not found.group("caller").strip().startswith(not_in))
+        for found in Re.RE_CALLER.finditer(value.strip())
+    )
+
+
+def has_template(value: Any) -> bool:
+    """Check value include templating string.
+
+    :param value:
+    :rtype: bool
+    """
+    if isinstance(value, dict):
+        return any(has_template(value[k]) for k in value)
+    elif isinstance(value, (list, tuple, set)):
+        return any(has_template(i) for i in value)
+    elif not isinstance(value, str):
+        return False
+    return bool(Re.RE_CALLER.findall(value.strip()))
+
+
 def str2template(
     value: str,
     params: DictData,
@@ -639,7 +708,7 @@ def param2template(
     return str2template(value, params, filters=filters)
 
 
-def filter_func(value: Any):
+def filter_func(value: Any) -> Any:
     """Filter own created function out of any value with replace it to its
     function name. If it is built-in function, it does not have any changing.
     """
@@ -678,3 +747,25 @@ def cross_product(matrix: Matrix) -> Iterator[DictData]:
             *[[{k: v} for v in vs] for k, vs in matrix.items()]
         )
     )
+
+
+def batch(iterable: Iterator[Any], n: int) -> Iterator[Any]:
+    """Batch data into iterators of length n. The last batch may be shorter.
+
+    Example:
+        >>> for b in batch('ABCDEFG', 3):
+        ...     print(list(b))
+        ['A', 'B', 'C']
+        ['D', 'E', 'F']
+        ['G']
+    """
+    if n < 1:
+        raise ValueError("n must be at least one")
+    it = iter(iterable)
+    while True:
+        chunk_it = islice(it, n)
+        try:
+            first_el = next(chunk_it)
+        except StopIteration:
+            return
+        yield chain((first_el,), chunk_it)

ddeutil_workflow-0.0.9.dist-info/METADATA

@@ -0,0 +1,273 @@
+Metadata-Version: 2.1
+Name: ddeutil-workflow
+Version: 0.0.9
+Summary: Lightweight workflow orchestration with less dependencies
+Author-email: ddeutils <korawich.anu@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ddeutils/ddeutil-workflow/
+Project-URL: Source Code, https://github.com/ddeutils/ddeutil-workflow/
+Keywords: orchestration,workflow
+Classifier: Topic :: Utilities
+Classifier: Natural Language :: English
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: fmtutil
+Requires-Dist: ddeutil-io
+Requires-Dist: python-dotenv ==1.0.1
+Requires-Dist: typer ==0.12.4
+Provides-Extra: api
+Requires-Dist: fastapi[standard] ==0.112.1 ; extra == 'api'
+Requires-Dist: croniter ==3.0.3 ; extra == 'api'
+Provides-Extra: schedule
+Requires-Dist: schedule <2.0.0,==1.2.2 ; extra == 'schedule'
+
+# Workflow
+
+[![test](https://github.com/ddeutils/ddeutil-workflow/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/ddeutils/ddeutil-workflow/actions/workflows/tests.yml)
+[![python support version](https://img.shields.io/pypi/pyversions/ddeutil-workflow)](https://pypi.org/project/ddeutil-workflow/)
+[![size](https://img.shields.io/github/languages/code-size/ddeutils/ddeutil-workflow)](https://github.com/ddeutils/ddeutil-workflow)
+[![gh license](https://img.shields.io/github/license/ddeutils/ddeutil-workflow)](https://github.com/ddeutils/ddeutil-workflow/blob/main/LICENSE)
+[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+**Table of Contents**:
+
+- [Installation](#installation)
+- [Getting Started](#getting-started)
+  - [On](#on)
+  - [Pipeline](#pipeline)
+- [Usage](#usage)
+- [Configuration](#configuration)
+- [Future](#future)
+- [Deployment](#deployment)
+
+The **Lightweight workflow orchestration** with less dependencies the was created
+for easy to make a simple metadata driven for data pipeline orchestration.
+It can to use for data operator by a `.yaml` template.
+
+> [!WARNING]
+> This package provide only orchestration workload. That mean you should not use
+> workflow stage to process any large data which use lot of compute usecase.
+
+In my opinion, I think it should not create duplicate pipeline codes if I can
+write with dynamic input parameters on the one template pipeline that just change
+the input parameters per use-case instead.
+This way I can handle a lot of logical pipelines in our orgs with only metadata
+configuration. It called **Metadata Driven Data Pipeline**.
+
+Next, we should get some monitoring tools for manage logging that return from
+pipeline running. Because it not show us what is a use-case that running data
+pipeline.
+
+> [!NOTE]
+> _Disclaimer_: I inspire the dynamic statement from the GitHub Action `.yml` files
+> and all of config file from several data orchestration framework tools from my
+> experience on Data Engineer.
+
+**Rules of This Workflow engine**:
+
+1. Minimum unit of scheduling is 1 minute
+2. Cannot re-run only failed stage and its pending downstream
+3. All parallel tasks inside workflow engine use Threading
+   (Because Python 3.13 unlock GIL)
+
+## Installation
+
+This project need `ddeutil-io` extension namespace packages. If you want to install
+this package with application add-ons, you should add `app` in installation;
+
+| Usecase           | Install Optional                         | Support            |
+|-------------------|------------------------------------------|--------------------|
+| Python & CLI      | `pip install ddeutil-workflow`           | :heavy_check_mark: |
+| Scheduler Service | `pip install ddeutil-workflow[schedule]` | :x:                |
+| FastAPI Server    | `pip install ddeutil-workflow[api]`      | :x:                |
+
+
+> I added this feature to the main milestone.
+>
+> **Docker Images** supported:
+>
+> | Docker Image                | Python Version | Support |
+> |-----------------------------|----------------|---------|
+> | ddeutil-workflow:latest     | `3.9`          | :x:     |
+> | ddeutil-workflow:python3.10 | `3.10`         | :x:     |
+> | ddeutil-workflow:python3.11 | `3.11`         | :x:     |
+> | ddeutil-workflow:python3.12 | `3.12`         | :x:     |
+
+## Getting Started
+
+The main feature of this project is the `Pipeline` object that can call any
+registries function. The pipeline can handle everything that you want to do, it
+will passing parameters and catching the output for re-use it to next step.
+
+### On
+
+The **On** is schedule object that receive crontab value and able to generate
+datetime value with next or previous with any start point of an input datetime.
+
+```yaml
+# This file should keep under this path: `./root-path/conf-path/*`
+on_every_5_min:
+  type: on.On
+  cron: "*/5 * * * *"
+```
+
+```python
+from ddeutil.workflow.on import On
+
+# NOTE: Start load the on data from `.yaml` template file with this key.
+schedule = On.from_loader(name='on_every_5_min', externals={})
+
+assert '*/5 * * * *' == str(schedule.cronjob)
+
+cron_iter = schedule.generate('2022-01-01 00:00:00')
+
+assert "2022-01-01 00:05:00" f"{cron_iter.next:%Y-%m-%d %H:%M:%S}"
+assert "2022-01-01 00:10:00" f"{cron_iter.next:%Y-%m-%d %H:%M:%S}"
+assert "2022-01-01 00:15:00" f"{cron_iter.next:%Y-%m-%d %H:%M:%S}"
+```
+
+### Pipeline
+
+The **Pipeline** object that is the core feature of this project.
+
+```yaml
+# This file should keep under this path: `./root-path/conf-path/*`
+pipeline-name:
+  type: ddeutil.workflow.pipeline.Pipeline
+  on: 'on_every_5_min'
+  params:
+    author-run:
+      type: str
+    run-date:
+      type: datetime
+  jobs:
+    first-job:
+      stages:
+        - name: "Empty stage do logging to console only!!"
+```
+
+```python
+from ddeutil.workflow.pipeline import Pipeline
+
+pipe = Pipeline.from_loader(name='pipeline-name', externals={})
+pipe.execute(params={'author-run': 'Local Workflow', 'run-date': '2024-01-01'})
+```
+
+> [!NOTE]
+> The above parameter can use short declarative statement. You can pass a parameter
+> type to the key of a parameter name but it does not handler default value if you
+> run this pipeline workflow with schedule.
+>
+> ```yaml
+> ...
+> params:
+>   author-run: str
+>   run-date: datetime
+> ...
+> ```
+>
+> And for the type, you can remove `ddeutil.workflow` prefix because we can find
+> it by looping search from `WORKFLOW_CORE_REGISTRY` value.
+
+## Usage
+
+This is examples that use workflow file for running common Data Engineering
+use-case.
+
+> [!IMPORTANT]
+> I recommend you to use the `hook` stage for all actions that you want to do
+> with pipeline activity that you want to orchestrate. Because it able to dynamic
+> an input argument with the same hook function that make you use less time to
+> maintenance your data pipelines.
+
+```yaml
+run_py_local:
+  type: pipeline.Pipeline
+  on:
+    - cronjob: '*/5 * * * *'
+      timezone: "Asia/Bangkok"
+  params:
+    author-run: str
+    run-date: datetime
+  jobs:
+    getting-api-data:
+      stages:
+        - name: "Retrieve API Data"
+          id: retrieve-api
+          uses: tasks/get-api-with-oauth-to-s3@requests
+          with:
+            url: https://open-data/
+            auth: ${API_ACCESS_REFRESH_TOKEN}
+            aws_s3_path: my-data/open-data/
+            # This Authentication code should implement with your custom hook function
+            aws_access_client_id: ${AWS_ACCESS_CLIENT_ID}
+            aws_access_client_secret: ${AWS_ACCESS_CLIENT_SECRET}
+```
+
+## Configuration
+
+| Environment                         | Component | Default                      | Description                                                                |
+|-------------------------------------|-----------|------------------------------|----------------------------------------------------------------------------|
+| `WORKFLOW_ROOT_PATH`                | Core      | .                            | The root path of the workflow application                                  |
+| `WORKFLOW_CORE_REGISTRY`            | Core      | ddeutil.workflow,tests.utils | List of importable string for the hook stage                               |
+| `WORKFLOW_CORE_REGISTRY_FILTER`     | Core      | ddeutil.workflow.utils       | List of importable string for the filter template                          |
+| `WORKFLOW_CORE_PATH_CONF`           | Core      | conf                         | The config path that keep all template `.yaml` files                       |
+| `WORKFLOW_CORE_TIMEZONE`            | Core      | Asia/Bangkok                 | A Timezone string value that will pass to `ZoneInfo` object                |
+| `WORKFLOW_CORE_STAGE_DEFAULT_ID`    | Core      | true                         | A flag that enable default stage ID that use for catch an execution output |
+| `WORKFLOW_CORE_STAGE_RAISE_ERROR`   | Core      | true                         | A flag that all stage raise StageException from stage execution            |
+| `WORKFLOW_CORE_MAX_PIPELINE_POKING` | Core      | 4                            |                                                                            |
+| `WORKFLOW_CORE_MAX_JOB_PARALLEL`    | Core      | 2                            | The maximum job number that able to run parallel in pipeline executor      |
+| `WORKFLOW_LOG_ENABLE_WRITE`         | Log       | true                         | A flag that enable logging object saving log to its destination            |
+
+
+**Application**:
+
+| Environment                         | Default | Description |
+|-------------------------------------|---------|-------------|
+| `WORKFLOW_APP_PROCESS_WORKER`       | 2       |             |
+| `WORKFLOW_APP_PIPELINE_PER_PROCESS` | 100     |             |
+
+**API server**:
+
+| Environment           | Default                                                | Description                                                        |
+|-----------------------|--------------------------------------------------------|--------------------------------------------------------------------|
+| `WORKFLOW_API_DB_URL` | postgresql+asyncpg://user:pass@localhost:5432/schedule | A Database URL that will pass to SQLAlchemy create_engine function |
+
+## Future
+
+The current milestone that will develop and necessary features that should to
+implement on this project.
+
+- ...
+
+## Deployment
+
+This package able to run as a application service for receive manual trigger
+from the master node via RestAPI or use to be Scheduler background service
+like crontab job but via Python API.
+
+### Schedule Service
+
+```shell
+(venv) $ python src.ddeutil.workflow.app
+```
+
+### API Server
+
+```shell
+(venv) $ uvicorn src.ddeutil.workflow.api:app --host 0.0.0.0 --port 80 --reload
+```
+
+> [!NOTE]
+> If this package already deploy, it able to use
+> `uvicorn ddeutil.workflow.api:app --host 0.0.0.0 --port 80`

ddeutil_workflow-0.0.9.dist-info/RECORD

@@ -0,0 +1,22 @@
+ddeutil/workflow/__about__.py,sha256=gh9CIut-EzZx1bHdgqILjssQNzzmuo1z_7iXAotDuKk,27
+ddeutil/workflow/__init__.py,sha256=oGvg_BpKKb_FG76DlMvXTKD7BsYhqF9wB1r4x5Q_lQI,647
+ddeutil/workflow/__types.py,sha256=SYMoxbENQX8uPsiCZkjtpHAqqHOh8rUrarAFicAJd0E,1773
+ddeutil/workflow/api.py,sha256=GxjGTLnohbsLsQbcJ0CL00d2LHpuw6J7PN6NqJ3oyRw,2502
+ddeutil/workflow/cli.py,sha256=RsP7evb3HCkzzO89ODjX6VEemQsSv9I-XOdWUJsiLfg,1180
+ddeutil/workflow/cron.py,sha256=FqmkvWCqwJ4eRf8aDn5Ce4FcNWqmcvu2aTTfL34lfgs,22184
+ddeutil/workflow/exceptions.py,sha256=zuCcsfJ1hFivubXz6lXCpGYXk07d_PkRaUD5ew3_LC0,632
+ddeutil/workflow/loader.py,sha256=uMMDc7hzPHqcmIoX2tF91KF1R9AerSC-TScrWmKLlNU,4490
+ddeutil/workflow/log.py,sha256=MxRZMnpq_p0khgZQXffJ7mlGPeVPeY6ABYBBauxUapc,5192
+ddeutil/workflow/on.py,sha256=6E8P4Cbc5y-nywF7xk0KDCJFEG8GhUVGnbjAQnQN2Dg,6892
+ddeutil/workflow/pipeline.py,sha256=uSX5qtDvBXjTDZheQPPafb704R9C0upFPCNIDnoIFOE,39219
+ddeutil/workflow/repeat.py,sha256=e127Z-Fl5Ft2CZSQwLOhInU21IBio0XAyk00B2TLQmU,4730
+ddeutil/workflow/route.py,sha256=w095eB4zMQsqszVgll-M15ky1mxmLKCbwfcTXc9xOPE,1933
+ddeutil/workflow/scheduler.py,sha256=06p0BAHehdP-23rUfrswZi1mF7Kgolqf4OLMtFVsVX4,14875
+ddeutil/workflow/stage.py,sha256=4Xtjl0GQUceqe8VGV8DsqmvfuX6lq8C0ne-Ls9qtLMs,20589
+ddeutil/workflow/utils.py,sha256=HY3tEARQHJrm4WTQX9jmeHUBwQaFmJFIrtzttYvaCRA,23963
+ddeutil_workflow-0.0.9.dist-info/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.9.dist-info/METADATA,sha256=VSDq5YFeEJ6Ni0e-I32B4M9Anwh18Pd7q2CCp_igTMY,11148
+ddeutil_workflow-0.0.9.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+ddeutil_workflow-0.0.9.dist-info/entry_points.txt,sha256=gLS1mgLig424zJql6CYYz4TxjKzoOwsS_Ez_NkEw0DA,54
+ddeutil_workflow-0.0.9.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.9.dist-info/RECORD,,

{ddeutil_workflow-0.0.8.dist-info → ddeutil_workflow-0.0.9.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.2.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

ddeutil_workflow-0.0.9.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+workflow = ddeutil.workflow.cli:app

ddeutil/workflow/app.py

@@ -1,45 +0,0 @@
-# ------------------------------------------------------------------------------
-# 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 functools
-import time
-
-import schedule
-
-
-def catch_exceptions(cancel_on_failure=False):
-    """Catch exception error from scheduler job."""
-
-    def catch_exceptions_decorator(job_func):
-        @functools.wraps(job_func)
-        def wrapper(*args, **kwargs):
-            try:
-                return job_func(*args, **kwargs)
-            except Exception as err:
-                print(err)
-
-                if cancel_on_failure:
-                    return schedule.CancelJob
-
-        return wrapper
-
-    return catch_exceptions_decorator
-
-
-@catch_exceptions(cancel_on_failure=True)
-def bad_task():
-    return 1 / 0
-
-
-schedule.every(5).seconds.do(bad_task)
-
-if __name__ == "__main__":
-    while True:
-        schedule.run_pending()
-        time.sleep(1)
-        if not schedule.get_jobs():
-            break