ddeutil-workflow 0.0.80__py3-none-any.whl → 0.0.81__py3-none-any.whl

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.80"
+__version__: str = "0.0.81"

ddeutil/workflow/cli.py

@@ -54,29 +54,30 @@ def init() -> None:
         dedent(
             """
         # Example workflow template.
-        wf-example:
-          type: Workflow
-          desc: |
-            An example workflow template that provide the demo of workflow.
-          params:
-            name:
-                type: str
-                default: "World"
-          jobs:
-            first-job:
-              stages:
-
-                - name: "Hello Stage"
-                  echo: "Start say hi to the console"
-
-                - name: "Call tasks"
-                  uses: tasks/say-hello-func@example
-                  with:
-                    name: ${{ params.name }}
-            second-job:
-
-                - name: "Hello Env"
-                  echo: "Start say hi with ${ WORKFLOW_DEMO_HELLO }"
+        name: wf-example:
+        type: Workflow
+        desc: |
+          An example workflow template that provide the demo of workflow.
+        params:
+          name:
+              type: str
+              default: "World"
+        jobs:
+          first-job:
+            stages:
+
+              - name: "Hello Stage"
+                echo: "Start say hi to the console"
+
+              - name: "Call tasks"
+                uses: tasks/say-hello-func@example
+                with:
+                  name: ${{ params.name }}
+
+          second-job:
+
+              - name: "Hello Env"
+                echo: "Start say hi with ${ WORKFLOW_DEMO_HELLO }"
         """
         ).lstrip("\n")
     )
@@ -89,12 +90,20 @@ def init() -> None:
         dummy_tasks_path.write_text(
             dedent(
                 """
+            from typing import Any, Optional
+
             from ddeutil.workflow import Result, tag
 
             @tag(name="example", alias="say-hello-func")
-            def hello_world_task(name: str, rs: Result) -> dict[str, str]:
+            def hello_world_task(name: str, rs: Result, extras: Optional[dict[str, Any]] = None) -> dict[str, str]:
                 \"\"\"Logging hello task function\"\"\"
-                rs.trace.info(f"Hello, {name}")
+                _extras = extras or {}
+                # NOTE: I will use custom newline logging if you pass `||`.
+                rs.trace.info(
+                    f"Hello, {name}||"
+                    f"> running ID: {rs.run_id}"
+                    f"> extras: {_extras}"
+                )
                 return {"name": name}
             """
             ).lstrip("\n")
@@ -106,18 +115,19 @@ def init() -> None:
     dotenv_file = Path(".env")
     mode: str = "a" if dotenv_file.exists() else "w"
     with dotenv_file.open(mode=mode) as f:
-        f.write("\n# Workflow env vars\n")
+        f.write("\n# Workflow Environment Variables\n")
         f.write(
             "WORKFLOW_DEMO_HELLO=foo\n"
             "WORKFLOW_CORE_DEBUG_MODE=true\n"
             "WORKFLOW_LOG_TIMEZONE=Asia/Bangkok\n"
-            "WORKFLOW_LOG_TRACE_ENABLE_WRITE=false\n"
+            'WORKFLOW_LOG_TRACE_HANDLERS=\'[{"type": "console"}]\'\n'
+            'WORKFLOW_LOG_AUDIT_CONF=\'{"type": "file", "path": "./audits"}\''
             "WORKFLOW_LOG_AUDIT_ENABLE_WRITE=true\n"
         )
 
     typer.echo("Starter command:")
     typer.echo(
-        "> `source .env && workflow-cli workflows execute --name=wf-example`"
+        ">>> `source .env && workflow-cli workflows execute --name=wf-example`"
     )
 
 
@@ -163,7 +173,7 @@ def api(
     debug: Annotated[bool, typer.Option(help="A debug mode flag")] = True,
     workers: Annotated[int, typer.Option(help="A worker number")] = None,
     reload: Annotated[bool, typer.Option(help="A reload flag")] = False,
-):
+) -> None:
     """
     Provision API application from the FastAPI.
     """

ddeutil/workflow/conf.py

@@ -22,19 +22,6 @@ Functions:
     pass_env: Process environment variable substitution
     api_config: Get API-specific configuration settings
 
-Example:
-    ```python
-    from ddeutil.workflow.conf import Config, YamlParser
-
-    # Load workflow configuration
-    parser = YamlParser("my-workflow")
-    workflow_config = parser.data
-
-    # Access dynamic configuration
-    from ddeutil.workflow.conf import dynamic
-    log_level = dynamic("log_level", default="INFO")
-    ```
-
 Note:
     Configuration files support environment variable substitution using
     ${VAR_NAME} syntax and provide extensive validation capabilities.
@@ -155,7 +142,7 @@ class Config:  # pragma: no cov
         )
 
     @property
-    def audit_conf(self) -> str:
+    def audit_conf(self) -> dict[str, Any]:
         return json.loads(
             env("LOG_AUDIT_URL", '{"type": "file", "path": "./audits"}')
         )
@@ -288,9 +275,12 @@ class YamlParser:
                     continue
 
                 if data := cls.filter_yaml(file, name=name):
+
+                    # NOTE: Start adding file metadata.
                     file_stat: os.stat_result = file.lstat()
                     data["created_at"] = file_stat.st_ctime
                     data["updated_at"] = file_stat.st_mtime
+
                     if not obj_type:
                         all_data.append((file_stat.st_mtime, data))
                     elif (t := data.get("type")) and t == obj_type:
@@ -324,9 +314,8 @@ class YamlParser:
             extras: (DictData) An extra parameter that use to override core
                 config values.
             ignore_filename: (str) An ignore filename. Default is
-            ``.confignore`` filename.
-            tags: (list[str])
-                A list of tag that want to filter.
+                ``.confignore`` filename.
+            tags (list[str]): A list of tag that want to filter.
 
         :rtype: Iterator[tuple[str, DictData]]
         """
@@ -365,6 +354,8 @@ class YamlParser:
                         continue
 
                     if (t := data.get("type")) and t == obj_type:
+
+                        # NOTE: Start adding file metadata.
                         file_stat: os.stat_result = file.lstat()
                         data["created_at"] = file_stat.st_ctime
                         data["updated_at"] = file_stat.st_mtime
@@ -372,6 +363,7 @@ class YamlParser:
                             file.lstat().st_mtime,
                             data,
                         )
+
                         if key in all_data:
                             all_data[key].append(marking)
                         else:
@@ -405,15 +397,23 @@ class YamlParser:
     def filter_yaml(cls, file: Path, name: Optional[str] = None) -> DictData:
         """Read a YAML file context from an input file path and specific name.
 
-        :param file: (Path) A file path that want to extract YAML context.
-        :param name: (str) A key name that search on a YAML context.
+        Args:
+            file (Path): A file path that want to extract YAML context.
+            name (str): A key name that search on a YAML context.
 
-        :rtype: DictData
+        Returns:
+            DictData: A data that read from this file if it is YAML format.
         """
         if any(file.suffix.endswith(s) for s in (".yml", ".yaml")):
             values: DictData = YamlFlResolve(file).read()
             if values is not None:
-                return values.get(name, {}) if name else values
+                if name:
+                    if "name" in values and values.get("name") == name:
+                        return values
+                    return (
+                        values[name] | {"name": name} if name in values else {}
+                    )
+                return values
         return {}
 
     @cached_property

ddeutil/workflow/errors.py

@@ -135,11 +135,12 @@ class BaseError(Exception):
 
         Example:
             >>> error = BaseError("Something failed", refs="stage-1")
-            >>> # Simple format
+
+            Simple format
             >>> error.to_dict()
             >>> # Returns: {"name": "BaseError", "message": "Something failed"}
 
-            >>> # With reference mapping
+            With reference mapping
             >>> error.to_dict(with_refs=True)
             >>> # Returns: {"stage-1": {"name": "BaseError", "message": "Something failed"}}
             ```

ddeutil/workflow/reusables.py

@@ -25,22 +25,20 @@ Functions:
     create_model_from_caller: Generate Pydantic models from function signatures
 
 Example:
-    ```python
-    from ddeutil.workflow.reusables import tag
-
-    @tag("data-processing", alias="process-csv")
-    def process_csv_file(input_path: str, output_path: str) -> dict:
-        # Custom processing logic
-        return {"status": "completed", "rows_processed": 1000}
-
-    # Use in workflow YAML:
-    # stages:
-    #   - name: "Process data"
-    #     uses: "data-processing/process-csv@latest"
-    #     args:
-    #       input_path: "/data/input.csv"
-    #       output_path: "/data/output.csv"
-    ```
+
+    >>> from ddeutil.workflow.reusables import tag
+    >>>
+    >>> @tag("data-processing", alias="process-csv")
+    >>> def process_csv_file(input_path: str, output_path: str) -> dict:
+    >>>     return {"status": "completed", "rows_processed": 1000}
+
+    >>> # Use in workflow YAML:
+    >>> # stages:
+    >>> #   - name: "Process data"
+    >>> #     uses: "data-processing/process-csv@latest"
+    >>> #     args:
+    >>> #       input_path: "/data/input.csv"
+    >>> #       output_path: "/data/output.csv"
 
 Note:
     The registry system supports versioning and aliasing for better function
@@ -64,6 +62,7 @@ from typing import (
     Protocol,
     TypeVar,
     Union,
+    cast,
     get_type_hints,
 )
 
@@ -201,7 +200,7 @@ def get_args_const(
             f"Post-filter: {expr} does not valid because it raise syntax error."
         ) from None
 
-    body: list[Expr] = mod.body
+    body: list[Expr] = cast(list[Expr], mod.body)
     if len(body) > 1:
         raise UtilError(
             "Post-filter function should be only one calling per workflow."

ddeutil/workflow/utils.py

@@ -28,17 +28,6 @@ Functions:
     cut_id: Cut running ID to specified length
     dump_all: Serialize nested BaseModel objects to dictionaries
     obj_name: Get object name or class name
-
-Example:
-    ```python
-    from ddeutil.workflow.utils import gen_id, get_dt_now
-
-    # Generate unique ID
-    run_id = gen_id("workflow")
-
-    # Get current datetime
-    now = get_dt_now()
-    ```
 """
 from __future__ import annotations
 

ddeutil/workflow/workflow.py

@@ -198,17 +198,15 @@ class Workflow(BaseModel):
             FileNotFoundError: If workflow configuration file not found
 
         Example:
-            ```python
-            # Load from default config path
-            workflow = Workflow.from_conf('data-pipeline')
-
-            # Load with custom path and extras
-            workflow = Workflow.from_conf(
-                'data-pipeline',
-                path=Path('./custom-configs'),
-                extras={'environment': 'production'}
-            )
-            ```
+            >>> # Load from default config path
+            >>> workflow = Workflow.from_conf('data-pipeline')
+
+            >>> # Load with custom path and extras
+            >>> workflow = Workflow.from_conf(
+            ...     'data-pipeline',
+            ...     path=Path('./custom-configs'),
+            ...     extras={'env': 'prod'}
+            ... )
         """
         load: YamlParser = YamlParser(name, path=path, extras=extras, obj=cls)
         data: DictData = copy.deepcopy(load.data)

{ddeutil_workflow-0.0.80.dist-info → ddeutil_workflow-0.0.81.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.80
+Version: 0.0.81
 Summary: Lightweight workflow orchestration with YAML template
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT

{ddeutil_workflow-0.0.80.dist-info → ddeutil_workflow-0.0.81.dist-info}/RECORD

@@ -1,21 +1,21 @@
-ddeutil/workflow/__about__.py,sha256=0fYC3KyobGtx1NtfXlGCbR9mrpL_yrH0UY_kp0NWaN8,28
+ddeutil/workflow/__about__.py,sha256=OgSQucXlwEL1i2ZuW-rDgctTF1ybVDYwWSf4fhzgOx4,28
 ddeutil/workflow/__cron.py,sha256=avOagaHl9xXOmizeRWm13cOrty9Tw0vRjFq-xoEgpAY,29167
 ddeutil/workflow/__init__.py,sha256=pRnUNCrwnKGrEQNSmdU9Ybf1tEQKg4LfsCpyj1Y3mhg,3241
 ddeutil/workflow/__main__.py,sha256=Qd-f8z2Q2vpiEP2x6PBFsJrpACWDVxFKQk820MhFmHo,59
 ddeutil/workflow/__types.py,sha256=tA2vsr6mzTSzbWB1sb62c5GgxODlfVRz6FvgLNJtQao,4788
 ddeutil/workflow/audits.py,sha256=h7WVHe3z_FqtmLRvAxhnSqae8fFtZPN0tICrVr39wP4,25456
-ddeutil/workflow/cli.py,sha256=aNFOZ3Re_QJBBP6vkT9Lsjrg8wLxrw_LKrl-1SIvSOg,8152
-ddeutil/workflow/conf.py,sha256=4bFl1ufX7-p6ely7tJnanpTZ0wJoik81yTcmBrbcyxY,16661
-ddeutil/workflow/errors.py,sha256=UpUIqoyqkvzqjuxtUQ9535l1HeAsyh-plEG0PgDVR2w,5541
+ddeutil/workflow/cli.py,sha256=qEfqno3RoHLCKBdaA3IGYXcH40EUk9sSSOxN7iocWNQ,8573
+ddeutil/workflow/conf.py,sha256=mvouKL6MroSCBNiRgPMb9T7_OI26JKHMGiGfYchLkF0,16756
+ddeutil/workflow/errors.py,sha256=U2OHGY46zgcr6POmdJKryTVnCkjrswA7cNqjWiV_kMI,5530
 ddeutil/workflow/event.py,sha256=qm7QHw-Pozm6oIUzAIxpDkPzzVZVtHgJIUlIle0vEfQ,13943
 ddeutil/workflow/job.py,sha256=lSmOgh4l3_gBJXrTEWULhSSol648h6zPe6zKzz8jDHQ,46597
 ddeutil/workflow/params.py,sha256=y9f6DEIyae1j4awbj3Kbeq75-U2UPFlKv9K57Hdo_Go,17188
 ddeutil/workflow/result.py,sha256=BOk3DZMtmdE7xzQYeEYTGFlIkzJQ4Ed3fYzf0zF8Jo8,8963
-ddeutil/workflow/reusables.py,sha256=g_Cac3yHy0H5ffl4Bb8_eGl284ELxOuX4LI8GYPMZgw,24983
+ddeutil/workflow/reusables.py,sha256=SBLJSxR8ELoWJErBfSMZS3Rr1O_93T-fFBpfn2AvxuA,25007
 ddeutil/workflow/stages.py,sha256=QufIa2b7A_ngOndVoGzyxKm_o5ZrauNeqxAC4vBkKFM,122678
 ddeutil/workflow/traces.py,sha256=e12_rDnwVo-XR6Ca1KLwCjo3tAwbJP7yXc1YU62YOt8,73415
-ddeutil/workflow/utils.py,sha256=-E-Z5hN_UTFuWDk-NpfKhNj0QtLfJSvZNDI5NzJsd5E,12122
-ddeutil/workflow/workflow.py,sha256=Uojf7k7l91sqOlsPMeSPwQmbrB5pgbWEmx9QgKYngmI,42924
+ddeutil/workflow/utils.py,sha256=zj4o10Iq3qgNobTQAkTaQzQ5EBBf3uhbqhcOyCo1suo,11923
+ddeutil/workflow/workflow.py,sha256=9oxbJBOtr2jvv1k2BVwAs4xh20yTSqd3EpaKhC9mLlU,42904
 ddeutil/workflow/api/__init__.py,sha256=5DzYL3ngceoRshh5HYCSVWChqNJSiP01E1bEd8XxPi0,4799
 ddeutil/workflow/api/log_conf.py,sha256=WfS3udDLSyrP-C80lWOvxxmhd_XWKvQPkwDqKblcH3E,1834
 ddeutil/workflow/api/routes/__init__.py,sha256=JRaJZB0D6mgR17MbZo8yLtdYDtD62AA8MdKlFqhG84M,420
@@ -28,9 +28,9 @@ ddeutil/workflow/plugins/providers/aws.py,sha256=61uIFBEWt-_D5Sui24qUPier1Hiqlw_
 ddeutil/workflow/plugins/providers/az.py,sha256=o3dh011lEtmr7-d7FPZJPgXdT0ytFzKfc5xnVxSyXGU,34867
 ddeutil/workflow/plugins/providers/container.py,sha256=DSN0RWxMjTJN5ANheeMauDaPa3X6Z2E1eGUcctYkENw,22134
 ddeutil/workflow/plugins/providers/gcs.py,sha256=KgAOdMBvdbMLTH_z_FwVriBFtZfKEYx8_34jzUOVjTY,27460
-ddeutil_workflow-0.0.80.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.80.dist-info/METADATA,sha256=g43RJsjquJoYyQUl_d5Wfuxdoh00tukjjjgW-lL7Hdw,16087
-ddeutil_workflow-0.0.80.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ddeutil_workflow-0.0.80.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
-ddeutil_workflow-0.0.80.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.80.dist-info/RECORD,,
+ddeutil_workflow-0.0.81.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.81.dist-info/METADATA,sha256=KfQDz9_yjBxdfDMUhbO1kBrwNWS2C6cEiMyWn5b0wws,16087
+ddeutil_workflow-0.0.81.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ddeutil_workflow-0.0.81.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
+ddeutil_workflow-0.0.81.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.81.dist-info/RECORD,,