ddeutil-workflow 0.0.16__py3-none-any.whl → 0.0.18__py3-none-any.whl

ddeutil/workflow/stage.py

@@ -13,8 +13,8 @@ handle stage error on this stage model. I think stage model should have a lot of
 usecase and it does not worry when I want to create a new one.
 
     Execution   --> Ok      --> Result with 0
-                --> Error   --> Raise StageException
-                            --> Result with 1 (if env var was set)
+                --> Error   --> Result with 1 (if env var was set)
+                            --> Raise StageException
 
     On the context I/O that pass to a stage object at execute process. The
 execute method receives a `params={"params": {...}}` value for mapping to
@@ -48,9 +48,8 @@ from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
 from .__types import DictData, DictStr, Re, TupleStr
-from .conf import config
+from .conf import config, get_logger
 from .exceptions import StageException
-from .log import get_logger
 from .utils import (
     Registry,
     Result,
@@ -94,12 +93,12 @@ def handler_result(message: str | None = None) -> DecoratorResult:
                                         status: 0
                                         context:
                                             outputs: ...
-                    --> Error   --> Raise StageException
-                                --> Result (if env var was set)
+                    --> Error   --> Result (if env var was set)
                                         status: 1
                                         context:
                                             error: ...
                                             error_message: ...
+                    --> Error   --> Raise StageException
 
         On the last step, it will set the running ID on a return result object
     from current stage ID before release the final result.
@@ -190,6 +189,9 @@ class BaseStage(BaseModel, ABC):
         method will validate name and id fields should not contain any template
         parameter (exclude matrix template).
 
+        :raise ValueError: When the ID and name fields include matrix parameter
+            template with the 'matrix.' string value.
+
         :rtype: Self
         """
         if self.run_id is None:
@@ -199,7 +201,7 @@ class BaseStage(BaseModel, ABC):
         #   template. (allow only matrix)
         if not_in_template(self.id) or not_in_template(self.name):
             raise ValueError(
-                "Stage name and ID should only template with matrix."
+                "Stage name and ID should only template with 'matrix.'"
             )
 
         return self
@@ -236,10 +238,10 @@ class BaseStage(BaseModel, ABC):
         The result of the `to` variable will be;
 
             ... (iii) to: {
-                            'stages': {
-                                '<stage-id>': {'outputs': {'foo': 'bar'}}
-                            }
+                        'stages': {
+                            '<stage-id>': {'outputs': {'foo': 'bar'}}
                         }
+                    }
 
         :param output: A output data that want to extract to an output key.
         :param to: A context data that want to add output result.
@@ -273,6 +275,11 @@ class BaseStage(BaseModel, ABC):
         """Return true if condition of this stage do not correct. This process
         use build-in eval function to execute the if-condition.
 
+        :raise StageException: When it has any error raise from the eval
+            condition statement.
+        :raise StageException: When return type of the eval condition statement
+            does not return with boolean type.
+
         :param params: A parameters that want to pass to condition template.
         :rtype: bool
         """
@@ -460,6 +467,15 @@ class PyStage(BaseStage):
         ),
     )
 
+    @staticmethod
+    def pick_keys_from_locals(values: DictData) -> Iterator[str]:
+        from inspect import ismodule
+
+        for value in values:
+            if value == "__annotations__" or ismodule(values[value]):
+                continue
+            yield value
+
     def set_outputs(self, output: DictData, to: DictData) -> DictData:
         """Override set an outputs method for the Python execution process that
         extract output from all the locals values.
@@ -469,15 +485,19 @@ class PyStage(BaseStage):
         :rtype: DictData
         """
         # NOTE: The output will fileter unnecessary keys from locals.
-        _locals: DictData = output["locals"]
+        lc: DictData = output.get("locals", {})
         super().set_outputs(
-            {k: _locals[k] for k in _locals if k != "__annotations__"}, to=to
+            (
+                {k: lc[k] for k in self.pick_keys_from_locals(lc)}
+                | {k: output[k] for k in output if k.startswith("error")}
+            ),
+            to=to,
         )
 
-        # NOTE:
-        #   Override value that changing from the globals that pass via exec.
-        _globals: DictData = output["globals"]
-        to.update({k: _globals[k] for k in to if k in _globals})
+        # NOTE: Override value that changing from the globals that pass via the
+        #   exec function.
+        gb: DictData = output.get("globals", {})
+        to.update({k: gb[k] for k in to if k in gb})
         return to
 
     @handler_result()
@@ -495,15 +515,15 @@ class PyStage(BaseStage):
         _globals: DictData = (
             globals() | params | param2template(self.vars, params)
         )
-        _locals: DictData = {}
+        lc: DictData = {}
 
         # NOTE: Start exec the run statement.
         logger.info(f"({self.run_id}) [STAGE]: Py-Execute: {self.name}")
-        exec(run, _globals, _locals)
+        exec(run, _globals, lc)
 
         return Result(
             status=0,
-            context={"locals": _locals, "globals": _globals},
+            context={"locals": lc, "globals": _globals},
         )
 
 
@@ -522,6 +542,11 @@ def extract_hook(hook: str) -> Callable[[], TagFunc]:
     """Extract Hook function from string value to hook partial function that
     does run it at runtime.
 
+    :raise NotImplementedError: When the searching hook's function result does
+        not exist in the registry.
+    :raise NotImplementedError: When the searching hook's tag result does not
+        exists in the registry with its function key.
+
     :param hook: A hook value that able to match with Task regex.
     :rtype: Callable[[], TagFunc]
     """
@@ -581,6 +606,11 @@ class HookStage(BaseStage):
     def execute(self, params: DictData) -> Result:
         """Execute the Hook function that already in the hook registry.
 
+        :raise ValueError: When the necessary arguments of hook function do not
+            set from the input params argument.
+        :raise TypeError: When the return type of hook function does not be
+            dict type.
+
         :param params: A parameter that want to pass before run any statement.
         :type params: DictData
         :rtype: Result

ddeutil/workflow/utils.py

@@ -37,9 +37,10 @@ from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
 from .__types import DictData, Matrix, Re
-from .conf import config, load_config
+from .conf import config
 from .exceptions import ParamValueException, UtilException
 
+T = TypeVar("T")
 P = ParamSpec("P")
 AnyModel = TypeVar("AnyModel", bound=BaseModel)
 AnyModelType = type[AnyModel]
@@ -99,7 +100,7 @@ def gen_id(
     if not isinstance(value, str):
         value: str = str(value)
 
-    if config.workflow_id_simple_mode:
+    if config.gen_id_simple_mode:
         return hash_str(f"{(value if sensitive else value.lower())}", n=10) + (
             f"{datetime.now(tz=config.tz):%Y%m%d%H%M%S%f}" if unique else ""
         )
@@ -160,7 +161,7 @@ def make_registry(submodule: str) -> dict[str, Registry]:
     :rtype: dict[str, Registry]
     """
     rs: dict[str, Registry] = {}
-    for module in load_config().engine.registry:
+    for module in config.regis_hook:
         # NOTE: try to sequential import task functions
         try:
             importer = import_module(f"{module}.{submodule}")
@@ -228,15 +229,6 @@ class DefaultParam(BaseParam):
             "Receive value and validate typing before return valid value."
         )
 
-    @model_validator(mode="after")
-    def __check_default(self) -> Self:
-        """Check default value should pass when it set required."""
-        if self.required and self.default is None:
-            raise ParamValueException(
-                "Default should be set when this parameter was required."
-            )
-        return self
-
 
 class DatetimeParam(DefaultParam):
     """Datetime parameter."""
@@ -497,7 +489,7 @@ def make_filter_registry() -> dict[str, FilterRegistry]:
     :rtype: dict[str, Registry]
     """
     rs: dict[str, Registry] = {}
-    for module in load_config().engine.registry_filter:
+    for module in config.regis_filter:
         # NOTE: try to sequential import task functions
         try:
             importer = import_module(module)
@@ -529,11 +521,11 @@ def get_args_const(
         raise UtilException(
             f"Post-filter: {expr} does not valid because it raise syntax error."
         ) from None
-    body: list[Expr] = mod.body
 
+    body: list[Expr] = mod.body
     if len(body) > 1:
         raise UtilException(
-            "Post-filter function should be only one calling per wf"
+            "Post-filter function should be only one calling per workflow."
         )
 
     caller: Union[Name, Call]
@@ -549,12 +541,15 @@ def get_args_const(
     keywords: dict[str, Constant] = {k.arg: k.value for k in caller.keywords}
 
     if any(not isinstance(i, Constant) for i in args):
-        raise UtilException("Argument should be constant.")
+        raise UtilException(f"Argument of {expr} should be constant.")
+
+    if any(not isinstance(i, Constant) for i in keywords.values()):
+        raise UtilException(f"Keyword argument of {expr} should be constant.")
 
     return name.id, args, keywords
 
 
-@custom_filter("fmt")
+@custom_filter("fmt")  # pragma: no cov
 def datetime_format(value: datetime, fmt: str = "%Y-%m-%d %H:%M:%S") -> str:
     """Format datetime object to string with the format."""
     if isinstance(value, datetime):
@@ -565,16 +560,18 @@ def datetime_format(value: datetime, fmt: str = "%Y-%m-%d %H:%M:%S") -> str:
 
 
 def map_post_filter(
-    value: Any,
+    value: T,
     post_filter: list[str],
     filters: dict[str, FilterRegistry],
-) -> Any:
+) -> T:
     """Mapping post-filter to value with sequence list of filter function name
     that will get from the filter registry.
 
     :param value: A string value that want to mapped with filter function.
     :param post_filter: A list of post-filter function name.
     :param filters: A filter registry.
+
+    :rtype: T
     """
     for _filter in post_filter:
         func_name, _args, _kwargs = get_args_const(_filter)
@@ -597,6 +594,8 @@ def map_post_filter(
                     value: Any = func(value)
             else:
                 value: Any = f_func(value, *args, **kwargs)
+        except UtilException:
+            raise
         except Exception as err:
             logger.warning(str(err))
             raise UtilException(
@@ -609,8 +608,8 @@ def map_post_filter(
 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:
+    :param value: A value that want to find parameter template prefix.
+    :param not_in: The not in string that use in the `.startswith` function.
     :rtype: bool
     """
     if isinstance(value, dict):
@@ -628,7 +627,7 @@ def not_in_template(value: Any, *, not_in: str = "matrix.") -> bool:
 def has_template(value: Any) -> bool:
     """Check value include templating string.
 
-    :param value:
+    :param value: A value that want to find parameter template.
     :rtype: bool
     """
     if isinstance(value, dict):
@@ -784,6 +783,7 @@ def batch(iterable: Iterator[Any], n: int) -> Iterator[Any]:
     """
     if n < 1:
         raise ValueError("n must be at least one")
+
     it: Iterator[Any] = iter(iterable)
     while True:
         chunk_it = islice(it, n)

{ddeutil_workflow-0.0.16.dist-info → ddeutil_workflow-0.0.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ddeutil-workflow
-Version: 0.0.16
+Version: 0.0.18
 Summary: Lightweight workflow orchestration with less dependencies
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -23,7 +23,8 @@ Requires-Python: >=3.9.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: ddeutil >=0.4.3
-Requires-Dist: ddeutil-io[yaml] >=0.2.3
+Requires-Dist: ddeutil-io[toml,yaml] >=0.2.3
+Requires-Dist: pydantic ==2.9.2
 Requires-Dist: python-dotenv ==1.0.1
 Requires-Dist: typer <1.0.0,==0.12.5
 Requires-Dist: schedule <2.0.0,==1.2.2
@@ -33,6 +34,7 @@ Requires-Dist: fastapi <1.0.0,>=0.115.0 ; extra == 'api'
 # 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)
+[![codecov](https://codecov.io/gh/ddeutils/ddeutil-workflow/graph/badge.svg?token=3NDPN2I0H9)](https://codecov.io/gh/ddeutils/ddeutil-workflow)
 [![pypi version](https://img.shields.io/pypi/v/ddeutil-workflow)](https://pypi.org/project/ddeutil-workflow/)
 [![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)
@@ -74,8 +76,9 @@ configuration. It called **Metadata Driven Data Workflow**.
 
 ## :round_pushpin: 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;
+This project need `ddeutil` and `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            |
 |-------------------|------------------------------------------|--------------------|
@@ -181,29 +184,30 @@ and do not raise any error to you.
 
 | Environment                             | Component | Default                          | Description                                                                                                        | Remark |
 |:----------------------------------------|-----------|----------------------------------|--------------------------------------------------------------------------------------------------------------------|--------|
-| `WORKFLOW_ROOT_PATH`                    | Core      | .                                | The root path of the workflow application                                                                          |        |
-| `WORKFLOW_CORE_REGISTRY`                | Core      | src.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      | false                            | A flag that all stage raise StageException from stage execution                                                    |        |
+| `WORKFLOW_ROOT_PATH`                    | Core      | .                                | The root path of the workflow application.                                                                         |        |
+| `WORKFLOW_CORE_REGISTRY`                | Core      | src.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      | false                            | A flag that all stage raise StageException from stage execution.                                                   |        |
 | `WORKFLOW_CORE_JOB_DEFAULT_ID`          | Core      | false                            | A flag that enable default job ID that use for catch an execution output. The ID that use will be sequence number. |        |
-| `WORKFLOW_CORE_MAX_NUM_POKING`          | Core      | 4                                |                                                                                                                    |        |
-| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        | Core      | 2                                | The maximum job number that able to run parallel in workflow executor                                              |        |
-| `WORKFLOW_CORE_WORKFLOW_ID_SIMPLE_MODE` | Core      | true                             |                                                                                                                    |        |
-| `WORKFLOW_LOG_DEBUG_MODE`               | Log       | true                             | A flag that enable logging with debug level mode                                                                   |        |
-| `WORKFLOW_LOG_ENABLE_WRITE`             | Log       | true                             | A flag that enable logging object saving log to its destination                                                    |        |
-| `WORKFLOW_APP_MAX_PROCESS`              | Schedule  | 2                                | The maximum process worker number that run in scheduler app module                                                 |        |
-| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` | Schedule  | 100                              | A schedule per process that run parallel                                                                           |        |
-| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      | Schedule  | '{"minutes": 5, "seconds": 20}'  | A time delta value that use to stop scheduler app in json string format                                            |        |
+| `WORKFLOW_CORE_JOB_RAISE_ERROR`         | Core      | true                             | A flag that all job raise JobException from job strategy execution.                                                |        |
+| `WORKFLOW_CORE_MAX_NUM_POKING`          | Core      | 4                                | .                                                                                                                  |        |
+| `WORKFLOW_CORE_MAX_JOB_PARALLEL`        | Core      | 2                                | The maximum job number that able to run parallel in workflow executor.                                             |        |
+| `WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE` | Core      | true                             | A flog that enable generating ID with `md5` algorithm.                                                             |        |
+| `WORKFLOW_LOG_DEBUG_MODE`               | Log       | true                             | A flag that enable logging with debug level mode.                                                                  |        |
+| `WORKFLOW_LOG_ENABLE_WRITE`             | Log       | true                             | A flag that enable logging object saving log to its destination.                                                   |        |
+| `WORKFLOW_APP_MAX_PROCESS`              | Schedule  | 2                                | The maximum process worker number that run in scheduler app module.                                                |        |
+| `WORKFLOW_APP_MAX_SCHEDULE_PER_PROCESS` | Schedule  | 100                              | A schedule per process that run parallel.                                                                          |        |
+| `WORKFLOW_APP_STOP_BOUNDARY_DELTA`      | Schedule  | '{"minutes": 5, "seconds": 20}'  | A time delta value that use to stop scheduler app in json string format.                                           |        |
 
 **API Application**:
 
-| Environment                           | Component | Default | Description                                                                       | Remark |
-|:--------------------------------------|-----------|---------|-----------------------------------------------------------------------------------|--------|
-| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  | API       | true    | A flag that enable workflow route to manage execute manually and workflow logging |        |
-| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  | API       | true    | A flag that enable run scheduler                                                  |        |
+| Environment                           | Component | Default | Description                                                                        | Remark |
+|:--------------------------------------|-----------|---------|------------------------------------------------------------------------------------|--------|
+| `WORKFLOW_API_ENABLE_ROUTE_WORKFLOW`  | API       | true    | A flag that enable workflow route to manage execute manually and workflow logging. |        |
+| `WORKFLOW_API_ENABLE_ROUTE_SCHEDULE`  | API       | true    | A flag that enable run scheduler.                                                  |        |
 
 ## :rocket: Deployment
 

ddeutil_workflow-0.0.18.dist-info/RECORD

@@ -0,0 +1,21 @@
+ddeutil/workflow/__about__.py,sha256=b5h9QJ6GhQ-EDPZTcMYoeJZy8blWgeG9xjpFBHrVLPg,28
+ddeutil/workflow/__cron.py,sha256=ZiuV4ASkXvAyFJYxEb9PKiAFNYnUt4AJozu_kH3pI4U,25777
+ddeutil/workflow/__init__.py,sha256=HA0tjGBXJItNPsAqvhnFUXU0fP0K6iMMfMtJ37tRwcw,1385
+ddeutil/workflow/__types.py,sha256=yizLXzjQpBt_WPaof2pIyncitJvYeksw4Q1zYJeuCLA,3707
+ddeutil/workflow/api.py,sha256=vUT2RVS9sF3hvY-IrzAEnahxwq4ZFYP0G3xfctHbNsw,4701
+ddeutil/workflow/cli.py,sha256=baHhvtI8snbHYHeThoX401Cd6SMB2boyyCbCtTrIl3E,3278
+ddeutil/workflow/conf.py,sha256=4j7m2blvCPlz_me4SBHf_exViUK3ZLLBCwldPztHJKo,15390
+ddeutil/workflow/exceptions.py,sha256=Uf1-Tn8rAzj0aiVHSqo4fBqO80W0za7UFZgKv24E-tg,706
+ddeutil/workflow/job.py,sha256=kSllDDiSnDpyFnIT9-Sum6OHQ16Pn5h2t5_-XljHbgk,23979
+ddeutil/workflow/on.py,sha256=rneZB5HyFWTBWriGef999bovA3glQIK6LTgC996q9Gc,7334
+ddeutil/workflow/repeat.py,sha256=s0azh-f5JQeow7kpxM8GKlqgAmKL7oU6St3L4Ggx4cY,4925
+ddeutil/workflow/route.py,sha256=JALwOH6xKu5rnII7DgA1Lbp_E5ehCoBbOW_eKqB_Olk,6753
+ddeutil/workflow/scheduler.py,sha256=baCYbv5f8HiQgV36fUvkkUpSiIRhrznuwKefsgKjHv4,47546
+ddeutil/workflow/stage.py,sha256=6Ng3RiCSrnQ-FUsRRcuG2ClMD6ifiQlgyBFi6tohfxI,25455
+ddeutil/workflow/utils.py,sha256=ouuQ3mqjKVzuchCcvVelo8Hh8c6UJ4_lHPqejcxNDRA,25147
+ddeutil_workflow-0.0.18.dist-info/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.18.dist-info/METADATA,sha256=VLZchB_AWG5kMf7RYFTyKI3zkxWdj7k942f_XZpBxyQ,13606
+ddeutil_workflow-0.0.18.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+ddeutil_workflow-0.0.18.dist-info/entry_points.txt,sha256=0BVOgO3LdUdXVZ-CiHHDKxzEk2c8J30jEwHeKn2YCWI,62
+ddeutil_workflow-0.0.18.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.18.dist-info/RECORD,,

ddeutil/workflow/log.py

@@ -1,195 +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 json
-import logging
-from abc import ABC, abstractmethod
-from datetime import datetime
-from functools import lru_cache
-from pathlib import Path
-from typing import ClassVar, Optional, Union
-
-from pydantic import BaseModel, Field
-from pydantic.functional_validators import model_validator
-from typing_extensions import Self
-
-from .__types import DictData
-from .conf import config, load_config
-
-
-@lru_cache
-def get_logger(name: str):
-    """Return logger object with an input module name.
-
-    :param name: A module name that want to log.
-    """
-    logger = logging.getLogger(name)
-    formatter = logging.Formatter(
-        fmt=(
-            "%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d, "
-            "%(thread)-5d) [%(levelname)-7s] %(message)-120s "
-            "(%(filename)s:%(lineno)s)"
-        ),
-        datefmt="%Y-%m-%d %H:%M:%S",
-    )
-    stream = logging.StreamHandler()
-    stream.setFormatter(formatter)
-    logger.addHandler(stream)
-
-    logger.setLevel(logging.DEBUG if config.debug else logging.INFO)
-    return logger
-
-
-class BaseLog(BaseModel, ABC):
-    """Base Log Pydantic Model with abstraction class property that implement
-    only model fields. This model should to use with inherit to logging
-    sub-class like file, sqlite, etc.
-    """
-
-    name: str = Field(description="A workflow name.")
-    on: str = Field(description="A cronjob string of this piepline schedule.")
-    release: datetime = Field(description="A release datetime.")
-    context: DictData = Field(
-        default_factory=dict,
-        description=(
-            "A context data that receive from a workflow execution result.",
-        ),
-    )
-    parent_run_id: Optional[str] = Field(default=None)
-    run_id: str
-    update: datetime = Field(default_factory=datetime.now)
-
-    @model_validator(mode="after")
-    def __model_action(self) -> Self:
-        """Do before the Log action with WORKFLOW_LOG_ENABLE_WRITE env variable.
-
-        :rtype: Self
-        """
-        if config.enable_write_log:
-            self.do_before()
-        return self
-
-    def do_before(self) -> None:
-        """To something before end up of initial log model."""
-
-    @abstractmethod
-    def save(self, excluded: list[str] | None) -> None:
-        """Save this model logging to target logging store."""
-        raise NotImplementedError("Log should implement ``save`` method.")
-
-
-class FileLog(BaseLog):
-    """File Log Pydantic Model that use to saving log data from result of
-    workflow execution. It inherit from BaseLog model that implement the
-    ``self.save`` method for file.
-    """
-
-    filename: ClassVar[str] = (
-        "./logs/workflow={name}/release={release:%Y%m%d%H%M%S}"
-    )
-
-    def do_before(self) -> None:
-        """Create directory of release before saving log file."""
-        self.pointer().mkdir(parents=True, exist_ok=True)
-
-    @classmethod
-    def find_logs(cls, name: str):
-        pointer: Path = (
-            load_config().engine.paths.root / f"./logs/workflow={name}"
-        )
-        for file in pointer.glob("./release=*/*.log"):
-            with file.open(mode="r", encoding="utf-8") as f:
-                yield json.load(f)
-
-    @classmethod
-    def find_log(cls, name: str, release: datetime | None = None):
-        if release is not None:
-            pointer: Path = (
-                load_config().engine.paths.root
-                / f"./logs/workflow={name}/release={release:%Y%m%d%H%M%S}"
-            )
-            if not pointer.exists():
-                raise FileNotFoundError(
-                    f"Pointer: ./logs/workflow={name}/"
-                    f"release={release:%Y%m%d%H%M%S} does not found."
-                )
-            return cls.model_validate(
-                obj=json.loads(pointer.read_text(encoding="utf-8"))
-            )
-        raise NotImplementedError("Find latest log does not implement yet.")
-
-    @classmethod
-    def is_pointed(
-        cls,
-        name: str,
-        release: datetime,
-        *,
-        queue: list[datetime] | None = None,
-    ) -> bool:
-        """Check this log already point in the destination.
-
-        :param name: A workflow name.
-        :param release: A release datetime.
-        :param queue: A list of queue of datetime that already run in the
-            future.
-        """
-        # NOTE: Check environ variable was set for real writing.
-        if not config.enable_write_log:
-            return False
-
-        # NOTE: create pointer path that use the same logic of pointer method.
-        pointer: Path = load_config().engine.paths.root / cls.filename.format(
-            name=name, release=release
-        )
-
-        if not queue:
-            return pointer.exists()
-        return pointer.exists() or (release in queue)
-
-    def pointer(self) -> Path:
-        """Return release directory path that was generated from model data.
-
-        :rtype: Path
-        """
-        return load_config().engine.paths.root / self.filename.format(
-            name=self.name, release=self.release
-        )
-
-    def save(self, excluded: list[str] | None) -> Self:
-        """Save logging data that receive a context data from a workflow
-        execution result.
-
-        :param excluded: An excluded list of key name that want to pass in the
-            model_dump method.
-        :rtype: Self
-        """
-        # NOTE: Check environ variable was set for real writing.
-        if not config.enable_write_log:
-            return self
-
-        log_file: Path = self.pointer() / f"{self.run_id}.log"
-        log_file.write_text(
-            json.dumps(
-                self.model_dump(exclude=excluded),
-                default=str,
-                indent=2,
-            ),
-            encoding="utf-8",
-        )
-        return self
-
-
-class SQLiteLog(BaseLog):
-
-    def save(self, excluded: list[str] | None) -> None:
-        raise NotImplementedError("SQLiteLog does not implement yet.")
-
-
-Log = Union[
-    FileLog,
-    SQLiteLog,
-]

ddeutil_workflow-0.0.16.dist-info/RECORD

@@ -1,22 +0,0 @@
-ddeutil/workflow/__about__.py,sha256=J3F-a05BmGpnyxPdhYxOJtDuTmXUjC0rvelcqfmfPRQ,28
-ddeutil/workflow/__init__.py,sha256=-DIy8SGFsD7_wqp-V-K8v8jTxacmqrcyj_SFx1WS6qg,687
-ddeutil/workflow/__types.py,sha256=yizLXzjQpBt_WPaof2pIyncitJvYeksw4Q1zYJeuCLA,3707
-ddeutil/workflow/api.py,sha256=7LQeR9w2Mq_vFTjqEK3dPiI1de-ENC_eyozr_UG8JMA,4717
-ddeutil/workflow/cli.py,sha256=GgVWPrSrG8ZTUGMTmHHngBi5LK0w5sAIMepciE5G_kc,3294
-ddeutil/workflow/conf.py,sha256=Pzw2LGaKtOUgEvczp9_PRhzO2HBigQx5XUEdrlNQFm4,10244
-ddeutil/workflow/cron.py,sha256=naWefHc3EnVo41Yf1zQeXOzF27YlTlnfj0XnQ6_HO-U,25514
-ddeutil/workflow/exceptions.py,sha256=Uf1-Tn8rAzj0aiVHSqo4fBqO80W0za7UFZgKv24E-tg,706
-ddeutil/workflow/job.py,sha256=8198kktH8WqMR2H6VWx2Pq6TFc2gmBdH3qZvVERRJx0,22668
-ddeutil/workflow/log.py,sha256=uxnxzeYTG7bu2ShchYehRnyr9YAdQyiMsUEhm8RbDDQ,6285
-ddeutil/workflow/on.py,sha256=2Kt0GIgrp_na1lA-TdJz1Wwo_mdcgxhTZdQ5BU2rj0E,7236
-ddeutil/workflow/repeat.py,sha256=mAj2BUDdcCe828gG-1NNxaz57mHebra5aC2VbjEzVJE,4939
-ddeutil/workflow/route.py,sha256=HveQ2c5MDVYW5YdMsF6g30DX2liR6vNt3_20NirMGQ8,6769
-ddeutil/workflow/scheduler.py,sha256=u1r5JhI7HSZzJ9__yruQen3mmo6Pd3slvEMtFfRFeOc,46995
-ddeutil/workflow/stage.py,sha256=I5bGASI-UUCcS-figIHdrV_LycDu_2mwjt4eZBR3Z_E,24268
-ddeutil/workflow/utils.py,sha256=PgPvcLoRYFobUUS56rSUFuN-zTyejgJ-gl36nNqQuWM,25117
-ddeutil_workflow-0.0.16.dist-info/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.16.dist-info/METADATA,sha256=_1jCgcqLcSKB2EHZcotmCtZec2KPKAYCidy28ZqQTe8,13190
-ddeutil_workflow-0.0.16.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
-ddeutil_workflow-0.0.16.dist-info/entry_points.txt,sha256=0BVOgO3LdUdXVZ-CiHHDKxzEk2c8J30jEwHeKn2YCWI,62
-ddeutil_workflow-0.0.16.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.16.dist-info/RECORD,,