ddeutil-workflow 0.0.46__py3-none-any.whl → 0.0.47__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.46"
+__version__: str = "0.0.47"

ddeutil/workflow/result.py

@@ -18,19 +18,10 @@ from pydantic.dataclasses import dataclass
 from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
-from .__types import DictData, TupleStr
+from .__types import DictData
 from .logs import TraceLog, get_dt_tznow, get_trace
 from .utils import default_gen_id, gen_id
 
-__all__: TupleStr = (
-    "SUCCESS",
-    "FAILED",
-    "WAIT",
-    "SKIP",
-    "Result",
-    "Status",
-)
-
 
 class Status(IntEnum):
     """Status Int Enum object that use for tracking execution status to the
@@ -62,6 +53,10 @@ class Result:
 
         For comparison property, this result will use ``status``, ``context``,
     and ``_run_id`` fields to comparing with other result instance.
+
+    Warning:
+        I use dataclass object instead of Pydantic model object because context
+    field that keep dict value change its ID when update new value to it.
     """
 
     status: Status = field(default=WAIT)
@@ -87,11 +82,11 @@ class Result:
         """Create the Result object or set parent running id if passing Result
         object.
 
-        :param result:
-        :param run_id:
-        :param parent_run_id:
-        :param id_logic:
-        :param extras:
+        :param result: A Result instance.
+        :param run_id: A running ID.
+        :param parent_run_id: A parent running ID.
+        :param id_logic: A logic function that use to generate a running ID.
+        :param extras: An extra parameter that want to override the core config.
 
         :rtype: Self
         """

ddeutil/workflow/reusables.py

@@ -10,7 +10,6 @@ from __future__ import annotations
 import inspect
 import logging
 from ast import Call, Constant, Expr, Module, Name, parse
-from dataclasses import dataclass
 from datetime import datetime
 from functools import wraps
 from importlib import import_module
@@ -23,6 +22,7 @@ except ImportError:
 
 from ddeutil.core import getdot, import_string, lazy
 from ddeutil.io import search_env_replace
+from pydantic.dataclasses import dataclass
 
 from .__types import DictData, Re
 from .conf import dynamic
@@ -437,6 +437,7 @@ Registry = dict[str, Callable[[], TagFunc]]
 
 def make_registry(
     submodule: str,
+    *,
     registries: Optional[list[str]] = None,
 ) -> dict[str, Registry]:
     """Return registries of all functions that able to called with task.
@@ -539,13 +540,13 @@ def extract_call(
 
     if call.func not in rgt:
         raise NotImplementedError(
-            f"`REGISTER-MODULES.{call.path}.registries` not implement "
+            f"`REGISTERS.{call.path}.registries` not implement "
             f"registry: {call.func!r}."
         )
 
     if call.tag not in rgt[call.func]:
         raise NotImplementedError(
             f"tag: {call.tag!r} not found on registry func: "
-            f"`REGISTER-MODULES.{call.path}.registries.{call.func}`"
+            f"`REGISTER.{call.path}.registries.{call.func}`"
         )
     return rgt[call.func][call.tag]

ddeutil/workflow/stages.py

@@ -38,12 +38,13 @@ from concurrent.futures import (
     ThreadPoolExecutor,
     as_completed,
 )
+from dataclasses import is_dataclass
 from inspect import Parameter
 from pathlib import Path
 from subprocess import CompletedProcess
 from textwrap import dedent
 from threading import Event
-from typing import Annotated, Optional, Union
+from typing import Annotated, Any, Optional, Union, get_type_hints
 
 from pydantic import BaseModel, Field
 from pydantic.functional_validators import model_validator
@@ -814,9 +815,8 @@ class CallStage(BaseStage):
                 run_id=gen_id(self.name + (self.id or ""), unique=True)
             )
 
-        print("Extras in CallStage", self.extras)
-
-        t_func: TagFunc = extract_call(
+        has_keyword: bool = False
+        call_func: TagFunc = extract_call(
             param2template(self.uses, params, extras=self.extras),
             registries=self.extras.get("regis_call"),
         )()
@@ -826,55 +826,92 @@ class CallStage(BaseStage):
         args: DictData = {"result": result} | param2template(
             self.args, params, extras=self.extras
         )
-        ips = inspect.signature(t_func)
-        necessary_params: list[str] = [
-            k
-            for k in ips.parameters
+        ips = inspect.signature(call_func)
+        necessary_params: list[str] = []
+        for k in ips.parameters:
             if (
-                (v := ips.parameters[k]).default == Parameter.empty
-                and (
-                    v.kind != Parameter.VAR_KEYWORD
-                    or v.kind != Parameter.VAR_POSITIONAL
-                )
-            )
-        ]
+                v := ips.parameters[k]
+            ).default == Parameter.empty and v.kind not in (
+                Parameter.VAR_KEYWORD,
+                Parameter.VAR_POSITIONAL,
+            ):
+                necessary_params.append(k)
+            elif v.kind == Parameter.VAR_KEYWORD:
+                has_keyword = True
+
         if any(
             (k.removeprefix("_") not in args and k not in args)
             for k in necessary_params
         ):
             raise ValueError(
                 f"Necessary params, ({', '.join(necessary_params)}, ), "
-                f"does not set to args"
+                f"does not set to args, {list(args.keys())}."
             )
 
-        # NOTE: add '_' prefix if it wants to use.
-        for k in ips.parameters:
-            if k.removeprefix("_") in args:
-                args[k] = args.pop(k.removeprefix("_"))
-
-        if "result" not in ips.parameters:
+        if "result" not in ips.parameters and not has_keyword:
             args.pop("result")
 
-        result.trace.info(f"[STAGE]: Call-Execute: {t_func.name}@{t_func.tag}")
-        if inspect.iscoroutinefunction(t_func):  # pragma: no cov
+        result.trace.info(
+            f"[STAGE]: Call-Execute: {call_func.name}@{call_func.tag}"
+        )
+
+        args = self.parse_model_args(call_func, args, result)
+        if inspect.iscoroutinefunction(call_func):
             loop = asyncio.get_event_loop()
             rs: DictData = loop.run_until_complete(
-                t_func(**param2template(args, params, extras=self.extras))
+                call_func(**param2template(args, params, extras=self.extras))
             )
         else:
-            rs: DictData = t_func(
+            rs: DictData = call_func(
                 **param2template(args, params, extras=self.extras)
             )
 
         # VALIDATE:
         #   Check the result type from call function, it should be dict.
-        if not isinstance(rs, dict):
+        if isinstance(rs, BaseModel):
+            rs: DictData = rs.model_dump()
+        elif not isinstance(rs, dict):
             raise TypeError(
-                f"Return type: '{t_func.name}@{t_func.tag}' does not serialize "
-                f"to result model, you change return type to `dict`."
+                f"Return type: '{call_func.name}@{call_func.tag}' does not "
+                f"serialize to result model, you change return type to `dict`."
             )
         return result.catch(status=SUCCESS, context=rs)
 
+    @staticmethod
+    def parse_model_args(
+        func: TagFunc,
+        args: DictData,
+        result: Result,
+    ) -> DictData:
+        """Parse Pydantic model from any dict data before parsing to target
+        caller function.
+        """
+        try:
+            type_hints: dict[str, Any] = get_type_hints(func)
+        except TypeError as e:
+            result.trace.warning(
+                f"[STAGE]: Get type hint raise TypeError: {e}, so, it skip "
+                f"parsing model args process."
+            )
+            return args
+
+        for arg in type_hints:
+
+            if arg == "return":
+                continue
+
+            if arg.removeprefix("_") in args:
+                args[arg] = args.pop(arg.removeprefix("_"))
+
+            t: Any = type_hints[arg]
+            if is_dataclass(t) and t.__name__ == "Result" and arg not in args:
+                args[arg] = result
+
+            if issubclass(t, BaseModel) and arg in args:
+                args[arg] = t.model_validate(obj=args[arg])
+
+        return args
+
 
 class TriggerStage(BaseStage):
     """Trigger Workflow execution stage that execute another workflow. This

{ddeutil_workflow-0.0.46.dist-info → ddeutil_workflow-0.0.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.46
+Version: 0.0.47
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -9,7 +9,7 @@ Project-URL: Source Code, https://github.com/ddeutils/ddeutil-workflow/
 Keywords: orchestration,workflow
 Classifier: Topic :: Utilities
 Classifier: Natural Language :: English
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python

{ddeutil_workflow-0.0.46.dist-info → ddeutil_workflow-0.0.47.dist-info}/RECORD

@@ -1,4 +1,4 @@
-ddeutil/workflow/__about__.py,sha256=yDFXJ7qonVJ1xTa_rhZ4F9WS1AblaopGDHPdNrytYtM,28
+ddeutil/workflow/__about__.py,sha256=6qZfpuPCbzNW572qdp7t-HFsC1JN75TQi_50aMab9kk,28
 ddeutil/workflow/__cron.py,sha256=h8rLeIUAAEB2SdZ4Jhch7LU1Yl3bbJ-iNNJ3tQ0eYVM,28095
 ddeutil/workflow/__init__.py,sha256=m7ZTCuUOarcTKJuXOyuaXd5WTIO7NTkqCeCrNX3d5i8,1943
 ddeutil/workflow/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -9,10 +9,10 @@ ddeutil/workflow/exceptions.py,sha256=uLNxzav3HRcr4vaZnvbUIF_eTR6UXXZNaxroMWFOUL
 ddeutil/workflow/job.py,sha256=uDT_lxAmtWDk6OYm6E4_rz_ngMdS5S03YF4D3WZMP8k,30676
 ddeutil/workflow/logs.py,sha256=Ki1t6HkThwimzAe1OSxPPc7OQ4r-kXAc1kB63x2DsOg,21160
 ddeutil/workflow/params.py,sha256=xCtFEh0-G-G-f8y_SXxyf31bU6Ox5p5Z-WbBFXrjy8M,9960
-ddeutil/workflow/result.py,sha256=9tbCmP0Sjy7h9GKWyD5e1bjAzNOWZcnvBFuC6to_f-8,4929
-ddeutil/workflow/reusables.py,sha256=ZE8WfD0WyQUKRV5aujJpGG6g6ODJz-wtgwHbQiCrN-E,17536
+ddeutil/workflow/result.py,sha256=bysM6A194LPcivzmCrNNZsT8MphzhYAvqhjEYD6zryo,5145
+ddeutil/workflow/reusables.py,sha256=vUsbh1dw5Cpojv98QTZarwBLHjvTMvR05H7XV76zUKQ,17537
 ddeutil/workflow/scheduler.py,sha256=_MDsEHbBVOeF-381U8DfIMDyca_nG3XNXmgX4229_EU,27437
-ddeutil/workflow/stages.py,sha256=G9TtXx2_HzcvgOetcncW0-GzMapqho6VmxENFyoYmt0,47829
+ddeutil/workflow/stages.py,sha256=oYEGWD-3kodtKSZ6JPAqAT5_za-sZI3GAKMJxeYUD8o,49009
 ddeutil/workflow/utils.py,sha256=sblje9qOtejCHVt8EVrbC0KY98vKqvxccaR5HIkRiTA,7363
 ddeutil/workflow/workflow.py,sha256=kEbPr2Wi9n5fDaCi5R26f4SHw7083_TdcIkZw-w7cEA,49716
 ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
@@ -24,8 +24,8 @@ ddeutil/workflow/api/routes/job.py,sha256=YVta083i8vU8-o4WdKFwDpfdC9vN1dZ6goZSmN
 ddeutil/workflow/api/routes/logs.py,sha256=TeRDrEelbKS2Hu_EovgLh0bOdmSv9mfnrIZsrE7uPD4,5353
 ddeutil/workflow/api/routes/schedules.py,sha256=rUWBm5RgLS1PNBHSWwWXJ0l-c5mYWfl9os0BA9_OTEw,4810
 ddeutil/workflow/api/routes/workflows.py,sha256=ctgQGxXfpIV6bHFDM9IQ1_qaQHT6n5-HjJ1-D4GKWpc,4527
-ddeutil_workflow-0.0.46.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.46.dist-info/METADATA,sha256=_HZpnC_wIzRdBFhLXDVsJpfPBevg5YXKDYll6KGg4pE,19129
-ddeutil_workflow-0.0.46.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-ddeutil_workflow-0.0.46.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.46.dist-info/RECORD,,
+ddeutil_workflow-0.0.47.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.47.dist-info/METADATA,sha256=EngsQlJUAaJf_8irHXLk04p6F71UjQnBifd84g1GhNw,19116
+ddeutil_workflow-0.0.47.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+ddeutil_workflow-0.0.47.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.47.dist-info/RECORD,,