ddeutil-workflow 0.0.35__py3-none-any.whl → 0.0.37__py3-none-any.whl

ddeutil/workflow/stages.py

@@ -14,8 +14,8 @@ use-case, and it does not worry when I want to create a new one.
 
     Execution   --> Ok      --> Result with 0
 
-                --> Error   --> Result with 1 (if env var was set)
-                            --> Raise StageException(...)
+                --> 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
@@ -733,6 +733,26 @@ Stage = Union[
 
 # TODO: Not implement this stages yet
 class ParallelStage(BaseStage):  # pragma: no cov
+    """Parallel execution stage that execute child stages with parallel.
+
+    Data Validate:
+        >>> stage = {
+        ...     "name": "Parallel stage execution.",
+        ...     "parallel": [
+        ...         {
+        ...             "name": "Echo first stage",
+        ...             "echo": "Start run with branch 1",
+        ...             "sleep": 3,
+        ...         },
+        ...         {
+        ...             "name": "Echo second stage",
+        ...             "echo": "Start run with branch 2",
+        ...             "sleep": 1,
+        ...         },
+        ...     ]
+        ... }
+    """
+
     parallel: list[Stage]
     max_parallel_core: int = Field(default=2)
 
@@ -743,6 +763,22 @@ class ParallelStage(BaseStage):  # pragma: no cov
 
 # TODO: Not implement this stages yet
 class ForEachStage(BaseStage):  # pragma: no cov
+    """For-Each execution stage that execute child stages with an item in list of
+    item values.
+
+    Data Validate:
+        >>> stage = {
+        ...     "name": "For-each stage execution",
+        ...     "foreach": [1, 2, 3]
+        ...     "stages": [
+        ...         {
+        ...             "name": "Echo stage",
+        ...             "echo": "Start run with item {{ item }}"
+        ...         },
+        ...     ],
+        ... }
+    """
+
     foreach: list[str]
     stages: list[Stage]
 
@@ -753,9 +789,34 @@ class ForEachStage(BaseStage):  # pragma: no cov
 
 # TODO: Not implement this stages yet
 class HookStage(BaseStage):  # pragma: no cov
-    foreach: list[str]
-    stages: list[Stage]
+    hook: str
+    args: DictData
+    callback: str
 
     def execute(
         self, params: DictData, *, result: Result | None = None
     ) -> Result: ...
+
+
+# TODO: Not implement this stages yet
+class DockerStage(BaseStage):  # pragma: no cov
+    """Docker container stage execution."""
+
+    image: str
+    env: DictData = Field(default_factory=dict)
+    volume: DictData = Field(default_factory=dict)
+    auth: DictData = Field(default_factory=dict)
+
+    def execute(
+        self, params: DictData, *, result: Result | None = None
+    ) -> Result: ...
+
+
+# TODO: Not implement this stages yet
+class VirtualPyStage(PyStage):  # pragma: no cov
+    """Python Virtual Environment stage execution."""
+
+    run: str
+    vars: DictData
+
+    def create_py_file(self, py: str, run_id: str | None): ...

ddeutil/workflow/utils.py

@@ -9,7 +9,7 @@ import logging
 import stat
 import time
 from collections.abc import Iterator, Mapping
-from datetime import datetime, timedelta
+from datetime import date, datetime, timedelta
 from hashlib import md5
 from inspect import isfunction
 from itertools import chain, islice, product
@@ -32,13 +32,29 @@ def get_dt_now(
 ) -> datetime:  # pragma: no cov
     """Return the current datetime object.
 
-    :param tz:
-    :param offset:
+    :param tz: A ZoneInfo object for replace timezone of return datetime object.
+    :param offset: An offset second value.
+
+    :rtype: datetime
     :return: The current datetime object that use an input timezone or UTC.
     """
     return datetime.now(tz=(tz or UTC)) - timedelta(seconds=offset)
 
 
+def get_d_now(
+    tz: ZoneInfo | None = None, offset: float = 0.0
+) -> date:  # pragma: no cov
+    """Return the current date object.
+
+    :param tz: A ZoneInfo object for replace timezone of return date object.
+    :param offset: An offset second value.
+
+    :rtype: date
+    :return: The current date object that use an input timezone or UTC.
+    """
+    return (datetime.now(tz=(tz or UTC)) - timedelta(seconds=offset)).date()
+
+
 def get_diff_sec(
     dt: datetime, tz: ZoneInfo | None = None, offset: float = 0.0
 ) -> int:  # pragma: no cov
@@ -46,8 +62,10 @@ def get_diff_sec(
     current datetime with specific timezone.
 
     :param dt:
-    :param tz:
-    :param offset:
+    :param tz: A ZoneInfo object for replace timezone of return datetime object.
+    :param offset: An offset second value.
+
+    :rtype: int
     """
     return round(
         (
@@ -61,6 +79,10 @@ def reach_next_minute(
 ) -> bool:
     """Check this datetime object is not in range of minute level on the current
     datetime.
+
+    :param dt:
+    :param tz: A ZoneInfo object for replace timezone of return datetime object.
+    :param offset: An offset second value.
     """
     diff: float = (
         dt.replace(second=0, microsecond=0)
@@ -122,13 +144,14 @@ def gen_id(
         value: str = str(value)
 
     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 ""
-        )
+        return (
+            f"{datetime.now(tz=config.tz):%Y%m%d%H%M%S%f}T" if unique else ""
+        ) + hash_str(f"{(value if sensitive else value.lower())}", n=10)
+
     return md5(
         (
-            f"{(value if sensitive else value.lower())}"
-            + (f"{datetime.now(tz=config.tz):%Y%m%d%H%M%S%f}" if unique else "")
+            (f"{datetime.now(tz=config.tz):%Y%m%d%H%M%S%f}T" if unique else "")
+            + f"{(value if sensitive else value.lower())}"
         ).encode()
     ).hexdigest()
 
@@ -173,9 +196,13 @@ def dash2underscore(
 ) -> DictData:
     """Change key name that has dash to underscore.
 
-    :param key
-    :param values
-    :param fixed
+    :param key:
+    :param values:
+    :param fixed:
+
+    Examples:
+        >>> dash2underscore('foo-bar', {"foo-bar": "demo"})
+        {'foo_bar': 'demo'}
 
     :rtype: DictData
     """

ddeutil/workflow/workflow.py

@@ -3,21 +3,7 @@
 # Licensed under the MIT License. See LICENSE in the project root for
 # license information.
 # ------------------------------------------------------------------------------
-"""The main schedule running is `workflow_runner` function that trigger the
-multiprocess of `workflow_control` function for listing schedules on the
-config by `Loader.finds(Schedule)`.
-
-    The `workflow_control` is the scheduler function that release 2 schedule
-functions; `workflow_task`, and ``workflow_monitor``.
-
-    ``workflow_control`` --- Every minute at :02 --> ``workflow_task``
-
-                         --- Every 5 minutes     --> ``workflow_monitor``
-
-    The ``workflow_task`` will run ``task.release`` method in threading object
-for multithreading strategy. This ``release`` method will run only one crontab
-value with the on field.
-"""
+"""A Workflow module."""
 from __future__ import annotations
 
 import copy

{ddeutil_workflow-0.0.35.dist-info → ddeutil_workflow-0.0.37.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: ddeutil-workflow
-Version: 0.0.35
+Version: 0.0.37
 Summary: Lightweight workflow orchestration
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -29,6 +29,8 @@ Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: schedule<2.0.0,==1.2.2
 Provides-Extra: api
 Requires-Dist: fastapi<1.0.0,>=0.115.0; extra == "api"
+Requires-Dist: httpx; extra == "api"
+Requires-Dist: ujson; extra == "api"
 
 # Workflow Orchestration
 
@@ -59,10 +61,10 @@ configuration. It called **Metadata Driven Data Workflow**.
 
 **:pushpin: <u>Rules of This Workflow engine</u>**:
 
-1. The Minimum frequency unit of scheduling is **1 minute** :warning:
-2. Can not re-run only failed stage and its pending downstream :rotating_light:
-3. All parallel tasks inside workflow engine use Multi-Threading
-   (🐍 Python 3.13 unlock GIL :unlock:)
+1. The Minimum frequency unit of scheduling is **1 Minute** 🕘
+2. **Can not** re-run only failed stage and its pending downstream ↩️
+3. All parallel tasks inside workflow engine use **Multi-Threading**
+   (Python 3.13 unlock GIL 🐍🔓)
 
 ---
 
@@ -78,12 +80,12 @@ flowchart LR
 
     subgraph Docker Container
         direction TB
-        G@{ shape: rounded, label: "Observe<br>Application" }
+        G@{ shape: rounded, label: "📡Observe<br>Application" }
     end
 
     subgraph Docker Container
         direction TB
-        B@{ shape: rounded, label: "Workflow<br>Application" }
+        B@{ shape: rounded, label: "🏃Workflow<br>Application" }
     end
 
     A <-->|action &<br>response| B
@@ -95,7 +97,7 @@ flowchart LR
         E@{ shape: lin-cyl, label: "Audit<br>Logs" }
     end
 
-    subgraph Git Context
+    subgraph Config Context
         F@{ shape: tag-rect, label: "YAML<br>files" }
     end
 
@@ -130,10 +132,10 @@ 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;
 
-| Use-case       | Install Optional         | Support            |
-|----------------|--------------------------|--------------------|
-| Python         | `ddeutil-workflow`       | :heavy_check_mark: |
-| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark: |
+| Use-case       | Install Optional         |       Support       |
+|----------------|--------------------------|:-------------------:|
+| Python         | `ddeutil-workflow`       | :heavy_check_mark:  |
+| FastAPI Server | `ddeutil-workflow[api]`  | :heavy_check_mark:  |
 
 ## :beers: Usage
 
@@ -295,7 +297,7 @@ like crontab job but via Python API.
 ### API Server
 
 ```shell
-(venv) $ uvicorn src.ddeutil.workflow.api:app \
+(venv) $ uvicorn ddeutil.workflow.api:app \
   --host 127.0.0.1 \
   --port 80 \
   --no-access-log

ddeutil_workflow-0.0.37.dist-info/RECORD

@@ -0,0 +1,32 @@
+ddeutil/workflow/__about__.py,sha256=UJZ9dzvQ9h4mY_1tAZ0imJIZbhNW3TD-wWNEVs22HwA,28
+ddeutil/workflow/__cron.py,sha256=3i-wmjTlh0ADCzN9pLKaWHzJkXzC72aIBmVEQSbyCCE,26895
+ddeutil/workflow/__init__.py,sha256=d643WDkk93MjCt9ujD46hX07Mb7yc9eTzKV3QwnEZQg,1845
+ddeutil/workflow/__types.py,sha256=CK1jfzyHP9P-MB0ElhpJZ59ZFGJC9MkQuAop5739_9k,4304
+ddeutil/workflow/audit.py,sha256=wx70RKRdHj1d2431ilpt9OPTInMByjqXkYff7l5pvF4,8230
+ddeutil/workflow/caller.py,sha256=pmZ9a5m1JlBTzR_xePOWZa98zyFE7jgJUlAXCx874Fs,5521
+ddeutil/workflow/conf.py,sha256=MHzBeLZukFeIQ-YhxOz5uKCnGYqbhYdpwAEh9A9h_OM,12216
+ddeutil/workflow/cron.py,sha256=j8EeoHst70toRfnD_frix41vrI-eLYVJkZ9yeJtpfnI,8871
+ddeutil/workflow/exceptions.py,sha256=5ghT443VLq0IeU87loHNEqqrrrctklP7YfxwJ51ImWU,949
+ddeutil/workflow/job.py,sha256=WnNkk_XhZytmLPzN6Kb41_BdfvBdtYhbn0SnDJ5ZgEw,25417
+ddeutil/workflow/logs.py,sha256=EJDb9Xt3XWjTGE8CeEvw0eDU8kyaeStALQNAtTl5HQw,10027
+ddeutil/workflow/params.py,sha256=qw9XJyjh2ocf9pf6h_XiYHLOvQN4R5TMqPElmItKnRM,8019
+ddeutil/workflow/result.py,sha256=fbM2An3VyweMjAy4Iw7h8H-KkoQsDrZe_KjGztXAFkE,4319
+ddeutil/workflow/scheduler.py,sha256=YMebYpNjqg6RWaE17sicwM3uthupeBGSGCnDGy4aKd8,26286
+ddeutil/workflow/stages.py,sha256=SJD7T7BdIhxoPSaDf8s5I8U6sv7wJsG2BynG-_aZ004,28165
+ddeutil/workflow/templates.py,sha256=A0JgZFGkBv-AX-EskZj656nG5zFd3j1PpLpyXihf6Xg,10967
+ddeutil/workflow/utils.py,sha256=JppsS2c545hPqog0GWjpQnTVMnzjqnhx4K8GkMV_CP0,8132
+ddeutil/workflow/workflow.py,sha256=_LYfs15AcXWVpM8CaO4oH6SWoJnqzF5FU08QTDoHT5w,44529
+ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
+ddeutil/workflow/api/api.py,sha256=gGQtqkzyJNaJIfka_w2M1lrCS3Ep46re2Dznsk9RxYQ,5191
+ddeutil/workflow/api/log.py,sha256=NMTnOnsBrDB5129329xF2myLdrb-z9k1MQrmrP7qXJw,1818
+ddeutil/workflow/api/repeat.py,sha256=cycd1-91j-4v6uY1SkrZHd9l95e-YgVC4UCSNNFuGJ8,5277
+ddeutil/workflow/api/routes/__init__.py,sha256=qoGtOMyVgQ5nTUc8J8wH27A8isaxl3IFCX8qoyibeCY,484
+ddeutil/workflow/api/routes/job.py,sha256=vCUTtsoCOtubVqjgk6MYUcGYim_l5Vh_NdtnQGx1SYM,1898
+ddeutil/workflow/api/routes/logs.py,sha256=7xPKu814PGxaMsij8zB3MLeXBfTC7NKT7GlTOJ-PV2U,5173
+ddeutil/workflow/api/routes/schedules.py,sha256=uWYDOwlV8w56hKQmfkQFwdZ6t2gZSJeCdBIzMmJenAQ,4824
+ddeutil/workflow/api/routes/workflows.py,sha256=KVywA7vD9b4QrfmWBdSFF5chj34yJe1zNCzl6iBMeGI,4538
+ddeutil_workflow-0.0.37.dist-info/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
+ddeutil_workflow-0.0.37.dist-info/METADATA,sha256=lazCqQyB5Cm-UWkYN9bGz3RnJpv_XhT0JOcmMf-7i5Y,19342
+ddeutil_workflow-0.0.37.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+ddeutil_workflow-0.0.37.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
+ddeutil_workflow-0.0.37.dist-info/RECORD,,

{ddeutil_workflow-0.0.35.dist-info → ddeutil_workflow-0.0.37.dist-info}/WHEEL

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

ddeutil_workflow-0.0.35.dist-info/RECORD

@@ -1,30 +0,0 @@
-ddeutil/workflow/__about__.py,sha256=nntH3Ja8ABeB5HcYg4Fy7-Z6jDBj67mjILrr2_dJHiw,28
-ddeutil/workflow/__cron.py,sha256=3i-wmjTlh0ADCzN9pLKaWHzJkXzC72aIBmVEQSbyCCE,26895
-ddeutil/workflow/__init__.py,sha256=SX48GHuEMoxJiKKXbBWT8IxcIk9AnibB-T8cUj1Dx1k,1818
-ddeutil/workflow/__types.py,sha256=CK1jfzyHP9P-MB0ElhpJZ59ZFGJC9MkQuAop5739_9k,4304
-ddeutil/workflow/audit.py,sha256=kWymGFEy4WBUXDez1QLRU3FvqLMYQhKJHAzAvIms_Vk,8077
-ddeutil/workflow/caller.py,sha256=qNfrr0B2ykLm6Y8JfhU1rnf5XGmp-usXrPmXM5uGRnM,5473
-ddeutil/workflow/conf.py,sha256=cFc2cd_SGXg9PMrkvCT7WWE85a5UN-DdH53_JIbFyzs,14031
-ddeutil/workflow/cron.py,sha256=j8EeoHst70toRfnD_frix41vrI-eLYVJkZ9yeJtpfnI,8871
-ddeutil/workflow/exceptions.py,sha256=5ghT443VLq0IeU87loHNEqqrrrctklP7YfxwJ51ImWU,949
-ddeutil/workflow/job.py,sha256=iUrmNbpBCpxMJyK_hAxpnyLBtrVhyDCoua4X12CH_BI,24702
-ddeutil/workflow/logs.py,sha256=fmtZl7lQYhKre_auADN64jqD2cqN4aMkNUZdMdhKioM,6398
-ddeutil/workflow/params.py,sha256=bqFDOcfAGcZ-HYa2n_5tO31uw3KXc66wHpUZ5cgpsTk,6702
-ddeutil/workflow/result.py,sha256=iuMvKv5OAzKWDbQf3yfrMHNEse6VdqvsKjv-DXKk-aQ,4349
-ddeutil/workflow/scheduler.py,sha256=DTD5HbCB8oQaxvAQ51-hvpec-NmDIYpyAXsMTODWuoc,25401
-ddeutil/workflow/stages.py,sha256=4SJcseBw4hv9WahJIXfaPdgn9-1Rbti_awMxO-AiP8s,26438
-ddeutil/workflow/templates.py,sha256=A0JgZFGkBv-AX-EskZj656nG5zFd3j1PpLpyXihf6Xg,10967
-ddeutil/workflow/utils.py,sha256=MctJmvklTYtiqZ-nZ7fazQeDoe77UvU0YUEqQZSlbCs,7225
-ddeutil/workflow/workflow.py,sha256=-n-8C0P-SY0BRc1ak6YhP_J2tT924O6ZkCnDJQFu-z8,45156
-ddeutil/workflow/api/__init__.py,sha256=F53NMBWtb9IKaDWkPU5KvybGGfKAcbehgn6TLBwHuuM,21
-ddeutil/workflow/api/api.py,sha256=q7wE0CDPCzpwmhnqKO5qSVO2Mjl1folqwF5E4W-l_UE,4042
-ddeutil/workflow/api/repeat.py,sha256=zyvsrXKk-3-_N8ZRZSki0Mueshugum2jtqctEOp9QSc,4927
-ddeutil/workflow/api/routes/__init__.py,sha256=HRUg4yB3023Iml8FQKuY0X6u9FavJe-HqEl6V8N_4hs,450
-ddeutil/workflow/api/routes/logs.py,sha256=uC8daeCrH_vpVJ-9Um5dMGfHR8JVtwwrDH5I1-Vp6Sw,971
-ddeutil/workflow/api/routes/schedules.py,sha256=9Q4cPYQWOyiZ1lnanpwtIaLWQtLRX1Vwx7uE30cd_1w,4644
-ddeutil/workflow/api/routes/workflows.py,sha256=LQiLlB3tESUtOZWcuLUKIHKvnit_yX3fKzYB4FqhavI,4354
-ddeutil_workflow-0.0.35.dist-info/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.35.dist-info/METADATA,sha256=FGRFLyia45WdWsiJin8fuTmLoD5-MqKDO63tflCJCzI,19269
-ddeutil_workflow-0.0.35.dist-info/WHEEL,sha256=nn6H5-ilmfVryoAQl3ZQ2l8SH5imPWFpm1A5FgEuFV4,91
-ddeutil_workflow-0.0.35.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.35.dist-info/RECORD,,