ddeutil-workflow 0.0.26.post1__tar.gz → 0.0.27__tar.gz

{ddeutil_workflow-0.0.26.post1/src/ddeutil_workflow.egg-info → ddeutil_workflow-0.0.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ddeutil-workflow
-Version: 0.0.26.post1
+Version: 0.0.27
 Summary: Lightweight workflow orchestration with less dependencies
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -168,29 +168,29 @@ The main configuration that use to dynamic changing with your propose of this
 application. If any configuration values do not set yet, it will use default value
 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,src.ddeutil.workflow,tests,tests.utils`         | List of importable string for the hook stage.                                                                      |        |
-| **WORKFLOW_CORE_REGISTRY_FILTER**          |   Core    | `src.ddeutil.workflow.utils,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_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_MAX_JOB_EXEC_TIMEOUT**     |   Core    | `600`                                                |                                                                                                                    |        |
-| **WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                                                  |                                                                                                                    |        |
-| **WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                                                 |                                                                                                                    |        |
-| **WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                                               | A flog that enable generating ID with `md5` algorithm.                                                             |        |
-| **WORKFLOW_LOG_PATH**                      |    Log    | `./logs`                                             | The log path of the workflow saving log.                                                                           |        |
-| **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.                                           |        |
+| Environment                                | Component | Default                           | Description                                                                                                        | Remark |
+|:-------------------------------------------|:---------:|:----------------------------------|:-------------------------------------------------------------------------------------------------------------------|--------|
+| **WORKFLOW_ROOT_PATH**                     |   Core    | `.`                               | The root path of the workflow application.                                                                         |        |
+| **WORKFLOW_CORE_REGISTRY**                 |   Core    | `src`                             | 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_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_MAX_JOB_EXEC_TIMEOUT**     |   Core    | `600`                             |                                                                                                                    |        |
+| **WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                               |                                                                                                                    |        |
+| **WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                              |                                                                                                                    |        |
+| **WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                            | A flog that enable generating ID with `md5` algorithm.                                                             |        |
+| **WORKFLOW_LOG_PATH**                      |    Log    | `./logs`                          | The log path of the workflow saving log.                                                                           |        |
+| **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**:
 

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/README.md

@@ -136,29 +136,29 @@ The main configuration that use to dynamic changing with your propose of this
 application. If any configuration values do not set yet, it will use default value
 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,src.ddeutil.workflow,tests,tests.utils`         | List of importable string for the hook stage.                                                                      |        |
-| **WORKFLOW_CORE_REGISTRY_FILTER**          |   Core    | `src.ddeutil.workflow.utils,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_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_MAX_JOB_EXEC_TIMEOUT**     |   Core    | `600`                                                |                                                                                                                    |        |
-| **WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                                                  |                                                                                                                    |        |
-| **WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                                                 |                                                                                                                    |        |
-| **WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                                               | A flog that enable generating ID with `md5` algorithm.                                                             |        |
-| **WORKFLOW_LOG_PATH**                      |    Log    | `./logs`                                             | The log path of the workflow saving log.                                                                           |        |
-| **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.                                           |        |
+| Environment                                | Component | Default                           | Description                                                                                                        | Remark |
+|:-------------------------------------------|:---------:|:----------------------------------|:-------------------------------------------------------------------------------------------------------------------|--------|
+| **WORKFLOW_ROOT_PATH**                     |   Core    | `.`                               | The root path of the workflow application.                                                                         |        |
+| **WORKFLOW_CORE_REGISTRY**                 |   Core    | `src`                             | 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_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_MAX_JOB_EXEC_TIMEOUT**     |   Core    | `600`                             |                                                                                                                    |        |
+| **WORKFLOW_CORE_MAX_CRON_PER_WORKFLOW**    |   Core    | `5`                               |                                                                                                                    |        |
+| **WORKFLOW_CORE_MAX_QUEUE_COMPLETE_HIST**  |   Core    | `16`                              |                                                                                                                    |        |
+| **WORKFLOW_CORE_GENERATE_ID_SIMPLE_MODE**  |   Core    | `true`                            | A flog that enable generating ID with `md5` algorithm.                                                             |        |
+| **WORKFLOW_LOG_PATH**                      |    Log    | `./logs`                          | The log path of the workflow saving log.                                                                           |        |
+| **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**:
 

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

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

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/src/ddeutil/workflow/__init__.py

@@ -8,6 +8,7 @@ from .conf import (
     Config,
     Loader,
     Log,
+    config,
     env,
     get_log,
     get_logger,
@@ -24,6 +25,13 @@ from .exceptions import (
     UtilException,
     WorkflowException,
 )
+from .hook import (
+    ReturnTagFunc,
+    TagFunc,
+    extract_hook,
+    make_registry,
+    tag,
+)
 from .job import (
     Job,
     Strategy,
@@ -48,33 +56,30 @@ from .stage import (
     PyStage,
     Stage,
     TriggerStage,
-    extract_hook,
 )
-from .utils import (
+from .templates import (
     FILTERS,
     FilterFunc,
     FilterRegistry,
-    ReturnTagFunc,
-    TagFunc,
+    custom_filter,
+    get_args_const,
+    has_template,
+    make_filter_registry,
+    map_post_filter,
+    not_in_template,
+    param2template,
+    str2template,
+)
+from .utils import (
     batch,
     cross_product,
-    custom_filter,
     dash2underscore,
     delay,
     filter_func,
     gen_id,
-    get_args_const,
     get_diff_sec,
     get_dt_now,
-    has_template,
     make_exec,
-    make_filter_registry,
-    make_registry,
-    map_post_filter,
-    not_in_template,
-    param2template,
-    str2template,
-    tag,
 )
 from .workflow import (
     Workflow,

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/src/ddeutil/workflow/conf.py

@@ -108,15 +108,13 @@ class Config:  # pragma: no cov
     # NOTE: Register
     @property
     def regis_hook(self) -> list[str]:
-        regis_hook_str: str = env(
-            "CORE_REGISTRY", "src,src.ddeutil.workflow,tests,tests.utils"
-        )
+        regis_hook_str: str = env("CORE_REGISTRY", "src")
         return [r.strip() for r in regis_hook_str.split(",")]
 
     @property
     def regis_filter(self) -> list[str]:
         regis_filter_str: str = env(
-            "CORE_REGISTRY_FILTER", "ddeutil.workflow.utils"
+            "CORE_REGISTRY_FILTER", "ddeutil.workflow.templates"
         )
         return [r.strip() for r in regis_filter_str.split(",")]
 
@@ -312,6 +310,10 @@ class SimLoad:
         )
 
 
+config = Config()
+logger = get_logger("ddeutil.workflow")
+
+
 class Loader(SimLoad):
     """Loader Object that get the config `yaml` file from current path.
 
@@ -337,15 +339,11 @@ class Loader(SimLoad):
         :rtype: Iterator[tuple[str, DictData]]
         """
         return super().finds(
-            obj=obj, conf=Config(), included=included, excluded=excluded
+            obj=obj, conf=config, included=included, excluded=excluded
         )
 
     def __init__(self, name: str, externals: DictData) -> None:
-        super().__init__(name, conf=Config(), externals=externals)
-
-
-config = Config()
-logger = get_logger("ddeutil.workflow")
+        super().__init__(name, conf=config, externals=externals)
 
 
 class BaseLog(BaseModel, ABC):
@@ -427,8 +425,8 @@ class FileLog(BaseLog):
         workflow name and release values. If a release does not pass to an input
         argument, it will return the latest release from the current log path.
 
-        :param name:
-        :param release:
+        :param name: A workflow name that want to search log.
+        :param release: A release datetime that want to search log.
 
         :raise FileNotFoundError:
         :raise NotImplementedError:
@@ -492,8 +490,14 @@ class FileLog(BaseLog):
 
         :rtype: Self
         """
+        from .utils import cut_id
+
         # NOTE: Check environ variable was set for real writing.
         if not config.enable_write_log:
+            logger.debug(
+                f"({cut_id(self.run_id)}) [LOG]: Skip writing log cause "
+                f"config was set"
+            )
             return self
 
         log_file: Path = self.pointer() / f"{self.run_id}.log"
@@ -523,6 +527,19 @@ class SQLiteLog(BaseLog):  # pragma: no cov
         """
 
     def save(self, excluded: list[str] | None) -> None:
+        """Save logging data that receive a context data from a workflow
+        execution result.
+        """
+        from .utils import cut_id
+
+        # NOTE: Check environ variable was set for real writing.
+        if not config.enable_write_log:
+            logger.debug(
+                f"({cut_id(self.run_id)}) [LOG]: Skip writing log cause "
+                f"config was set"
+            )
+            return self
+
         raise NotImplementedError("SQLiteLog does not implement yet.")
 
 

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/src/ddeutil/workflow/exceptions.py

@@ -29,6 +29,3 @@ class WorkflowFailException(WorkflowException): ...
 
 
 class ParamValueException(WorkflowException): ...
-
-
-class CliException(BaseWorkflowException): ...

ddeutil_workflow-0.0.27/src/ddeutil/workflow/hook.py

@@ -0,0 +1,153 @@
+# ------------------------------------------------------------------------------
+# 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 inspect
+import logging
+from dataclasses import dataclass
+from functools import wraps
+from importlib import import_module
+from typing import Any, Callable, Protocol, TypeVar
+
+try:
+    from typing import ParamSpec
+except ImportError:
+    from typing_extensions import ParamSpec
+
+from ddeutil.core import lazy
+
+from .__types import Re
+from .conf import config
+
+T = TypeVar("T")
+P = ParamSpec("P")
+
+logger = logging.getLogger("ddeutil.workflow")
+
+
+class TagFunc(Protocol):
+    """Tag Function Protocol"""
+
+    name: str
+    tag: str
+
+    def __call__(self, *args, **kwargs): ...  # pragma: no cov
+
+
+ReturnTagFunc = Callable[P, TagFunc]
+DecoratorTagFunc = Callable[[Callable[[...], Any]], ReturnTagFunc]
+
+
+def tag(
+    name: str, alias: str | None = None
+) -> DecoratorTagFunc:  # pragma: no cov
+    """Tag decorator function that set function attributes, ``tag`` and ``name``
+    for making registries variable.
+
+    :param: name: A tag name for make different use-case of a function.
+    :param: alias: A alias function name that keeping in registries. If this
+        value does not supply, it will use original function name from __name__.
+    :rtype: Callable[P, TagFunc]
+    """
+
+    def func_internal(func: Callable[[...], Any]) -> ReturnTagFunc:
+        func.tag = name
+        func.name = alias or func.__name__.replace("_", "-")
+
+        @wraps(func)
+        def wrapped(*args, **kwargs):
+            # NOTE: Able to do anything before calling hook function.
+            return func(*args, **kwargs)
+
+        return wrapped
+
+    return func_internal
+
+
+Registry = dict[str, Callable[[], TagFunc]]
+
+
+def make_registry(submodule: str) -> dict[str, Registry]:
+    """Return registries of all functions that able to called with task.
+
+    :param submodule: A module prefix that want to import registry.
+    :rtype: dict[str, Registry]
+    """
+    rs: dict[str, Registry] = {}
+    for module in config.regis_hook:
+        # NOTE: try to sequential import task functions
+        try:
+            importer = import_module(f"{module}.{submodule}")
+        except ModuleNotFoundError:
+            continue
+
+        for fstr, func in inspect.getmembers(importer, inspect.isfunction):
+            # NOTE: check function attribute that already set tag by
+            #   ``utils.tag`` decorator.
+            if not hasattr(func, "tag"):
+                continue
+
+            # NOTE: Create new register name if it not exists
+            if func.name not in rs:
+                rs[func.name] = {func.tag: lazy(f"{module}.{submodule}.{fstr}")}
+                continue
+
+            if func.tag in rs[func.name]:
+                raise ValueError(
+                    f"The tag {func.tag!r} already exists on "
+                    f"{module}.{submodule}, you should change this tag name or "
+                    f"change it func name."
+                )
+            rs[func.name][func.tag] = lazy(f"{module}.{submodule}.{fstr}")
+
+    return rs
+
+
+@dataclass(frozen=True)
+class HookSearchData:
+    """Hook Search dataclass that use for receive regular expression grouping
+    dict from searching hook string value.
+    """
+
+    path: str
+    func: str
+    tag: str
+
+
+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]
+    """
+    if not (found := Re.RE_TASK_FMT.search(hook)):
+        raise ValueError(
+            f"Hook {hook!r} does not match with hook format regex."
+        )
+
+    # NOTE: Pass the searching hook string to `path`, `func`, and `tag`.
+    hook: HookSearchData = HookSearchData(**found.groupdict())
+
+    # NOTE: Registry object should implement on this package only.
+    rgt: dict[str, Registry] = make_registry(f"{hook.path}")
+    if hook.func not in rgt:
+        raise NotImplementedError(
+            f"``REGISTER-MODULES.{hook.path}.registries`` does not "
+            f"implement registry: {hook.func!r}."
+        )
+
+    if hook.tag not in rgt[hook.func]:
+        raise NotImplementedError(
+            f"tag: {hook.tag!r} does not found on registry func: "
+            f"``REGISTER-MODULES.{hook.path}.registries.{hook.func}``"
+        )
+    return rgt[hook.func][hook.tag]

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/src/ddeutil/workflow/job.py

@@ -38,13 +38,13 @@ from .exceptions import (
 )
 from .result import Result
 from .stage import Stage
+from .templates import has_template
 from .utils import (
     cross_product,
     cut_id,
     dash2underscore,
     filter_func,
     gen_id,
-    has_template,
 )
 
 logger = get_logger("ddeutil.workflow")

{ddeutil_workflow-0.0.26.post1 → ddeutil_workflow-0.0.27}/src/ddeutil/workflow/stage.py

@@ -31,7 +31,6 @@ import time
 import uuid
 from abc import ABC, abstractmethod
 from collections.abc import Iterator
-from dataclasses import dataclass
 from functools import wraps
 from inspect import Parameter
 from pathlib import Path
@@ -48,19 +47,16 @@ from pydantic import BaseModel, Field
 from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
-from .__types import DictData, DictStr, Re, TupleStr
+from .__types import DictData, DictStr, TupleStr
 from .conf import config, get_logger
 from .exceptions import StageException
+from .hook import TagFunc, extract_hook
 from .result import Result
+from .templates import not_in_template, param2template
 from .utils import (
-    Registry,
-    TagFunc,
     cut_id,
     gen_id,
     make_exec,
-    make_registry,
-    not_in_template,
-    param2template,
 )
 
 P = ParamSpec("P")
@@ -76,7 +72,6 @@ __all__: TupleStr = (
     "HookStage",
     "TriggerStage",
     "Stage",
-    "extract_hook",
 )
 
 
@@ -558,53 +553,6 @@ class PyStage(BaseStage):
         )
 
 
-@dataclass(frozen=True)
-class HookSearchData:
-    """Hook Search dataclass that use for receive regular expression grouping
-    dict from searching hook string value.
-    """
-
-    path: str
-    func: str
-    tag: str
-
-
-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]
-    """
-    if not (found := Re.RE_TASK_FMT.search(hook)):
-        raise ValueError(
-            f"Hook {hook!r} does not match with hook format regex."
-        )
-
-    # NOTE: Pass the searching hook string to `path`, `func`, and `tag`.
-    hook: HookSearchData = HookSearchData(**found.groupdict())
-
-    # NOTE: Registry object should implement on this package only.
-    rgt: dict[str, Registry] = make_registry(f"{hook.path}")
-    if hook.func not in rgt:
-        raise NotImplementedError(
-            f"``REGISTER-MODULES.{hook.path}.registries`` does not "
-            f"implement registry: {hook.func!r}."
-        )
-
-    if hook.tag not in rgt[hook.func]:
-        raise NotImplementedError(
-            f"tag: {hook.tag!r} does not found on registry func: "
-            f"``REGISTER-MODULES.{hook.path}.registries.{hook.func}``"
-        )
-    return rgt[hook.func][hook.tag]
-
-
 class HookStage(BaseStage):
     """Hook executor that hook the Python function from registry with tag
     decorator function in ``utils`` module and run it with input arguments.