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

ddeutil/workflow/__about__.py

@@ -1 +1 @@
-__version__: str = "0.0.33"
+__version__: str = "0.0.35"

ddeutil/workflow/__init__.py

@@ -9,6 +9,13 @@ from .audit import (
     Audit,
     get_audit,
 )
+from .caller import (
+    ReturnTagFunc,
+    TagFunc,
+    extract_call,
+    make_registry,
+    tag,
+)
 from .conf import (
     Config,
     Loader,
@@ -28,17 +35,15 @@ from .exceptions import (
     UtilException,
     WorkflowException,
 )
-from .hook import (
-    ReturnTagFunc,
-    TagFunc,
-    extract_hook,
-    make_registry,
-    tag,
-)
 from .job import (
     Job,
     Strategy,
 )
+from .logs import (
+    TraceLog,
+    get_dt_tznow,
+    get_trace,
+)
 from .params import (
     ChoiceParam,
     DatetimeParam,
@@ -46,7 +51,11 @@ from .params import (
     Param,
     StrParam,
 )
-from .result import Result
+from .result import (
+    Result,
+    Status,
+    default_gen_id,
+)
 from .scheduler import (
     Schedule,
     ScheduleWorkflow,
@@ -54,10 +63,10 @@ from .scheduler import (
     schedule_runner,
     schedule_task,
 )
-from .stage import (
+from .stages import (
     BashStage,
+    CallStage,
     EmptyStage,
-    HookStage,
     PyStage,
     Stage,
     TriggerStage,

ddeutil/workflow/api/api.py

@@ -20,6 +20,7 @@ from ..conf import config, get_logger
 from ..scheduler import ReleaseThread, ReleaseThreads
 from ..workflow import ReleaseQueue, WorkflowTask
 from .repeat import repeat_at
+from .routes import log
 
 load_dotenv()
 logger = get_logger("ddeutil.workflow")
@@ -77,22 +78,26 @@ async def health():
     return {"message": "Workflow API already start up"}
 
 
-# NOTE: Enable the workflow route.
+# NOTE Add the logs route by default.
+app.include_router(log, prefix=config.prefix_path)
+
+
+# NOTE: Enable the workflows route.
 if config.enable_route_workflow:
-    from .route import workflow_route
+    from .routes import workflow
 
-    app.include_router(workflow_route, prefix=config.prefix_path)
+    app.include_router(workflow, prefix=config.prefix_path)
 
 
-# NOTE: Enable the schedule route.
+# NOTE: Enable the schedules route.
 if config.enable_route_schedule:
     from ..audit import get_audit
     from ..scheduler import schedule_task
-    from .route import schedule_route
+    from .routes import schedule
 
-    app.include_router(schedule_route, prefix=config.prefix_path)
+    app.include_router(schedule, prefix=config.prefix_path)
 
-    @schedule_route.on_event("startup")
+    @schedule.on_event("startup")
     @repeat_at(cron="* * * * *", delay=2)
     def scheduler_listener():
         """Schedule broker every minute at 02 second."""
@@ -109,7 +114,7 @@ if config.enable_route_schedule:
                 log=get_audit(),
             )
 
-    @schedule_route.on_event("startup")
+    @schedule.on_event("startup")
     @repeat_at(cron="*/5 * * * *", delay=10)
     def monitoring():
         logger.debug("[MONITOR]: Start monitoring threading.")

ddeutil/workflow/api/routes/__init__.py

@@ -0,0 +1,8 @@
+# ------------------------------------------------------------------------------
+# Copyright (c) 2022 Korawich Anuttra. All rights reserved.
+# Licensed under the MIT License. See LICENSE in the project root for
+# license information.
+# ------------------------------------------------------------------------------
+from .logs import log_route as log
+from .schedules import schedule_route as schedule
+from .workflows import workflow_route as workflow

ddeutil/workflow/api/routes/logs.py

@@ -0,0 +1,36 @@
+# ------------------------------------------------------------------------------
+# 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
+
+from fastapi import APIRouter
+from fastapi.responses import UJSONResponse
+
+from ...conf import get_logger
+from ...logs import get_trace_obj
+
+logger = get_logger("ddeutil.workflow")
+
+
+# NOTE: Start create the schedule routes.
+#
+log_route = APIRouter(
+    prefix="/logs",
+    tags=["logs"],
+    default_response_class=UJSONResponse,
+)
+
+
+@log_route.get(path="/")
+async def get_logs():
+    return {
+        "message": "Getting logs",
+        "audits": list(get_trace_obj().find_logs()),
+    }
+
+
+@log_route.get(path="/{run_id}")
+async def get_log_with_run_id(run_id: str):
+    return get_trace_obj().find_log_with_id(run_id)

ddeutil/workflow/api/{route.py → routes/schedules.py}

@@ -6,30 +6,17 @@
 from __future__ import annotations
 
 import copy
-from dataclasses import asdict
 from datetime import datetime, timedelta
-from typing import Any
 
 from fastapi import APIRouter, HTTPException, Request
 from fastapi import status as st
 from fastapi.responses import UJSONResponse
-from pydantic import BaseModel
 
-from ..__types import DictData
-from ..audit import Audit, get_audit
-from ..conf import Loader, config, get_logger
-from ..result import Result
-from ..scheduler import Schedule
-from ..workflow import Workflow
+from ...conf import config, get_logger
+from ...scheduler import Schedule
 
 logger = get_logger("ddeutil.workflow")
 
-workflow_route = APIRouter(
-    prefix="/workflows",
-    tags=["workflows"],
-    default_response_class=UJSONResponse,
-)
-
 schedule_route = APIRouter(
     prefix="/schedules",
     tags=["schedules"],
@@ -37,122 +24,6 @@ schedule_route = APIRouter(
 )
 
 
-@workflow_route.get(path="/")
-async def get_workflows() -> DictData:
-    """Return all workflow workflows that exists in config path."""
-    workflows: DictData = dict(Loader.finds(Workflow))
-    return {
-        "message": f"Getting all workflows: {len(workflows)}",
-        "count": len(workflows),
-        "workflows": workflows,
-    }
-
-
-@workflow_route.get(path="/{name}")
-async def get_workflow_by_name(name: str) -> DictData:
-    """Return model of workflow that passing an input workflow name."""
-    try:
-        workflow: Workflow = Workflow.from_loader(name=name, externals={})
-    except ValueError as err:
-        logger.exception(err)
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Workflow workflow name: {name!r} does not found in /conf path"
-            ),
-        ) from None
-    return workflow.model_dump(
-        by_alias=True,
-        exclude_none=True,
-        exclude_unset=True,
-        exclude_defaults=True,
-    )
-
-
-class ExecutePayload(BaseModel):
-    params: dict[str, Any]
-
-
-@workflow_route.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
-async def execute_workflow(name: str, payload: ExecutePayload) -> DictData:
-    """Return model of workflow that passing an input workflow name."""
-    try:
-        workflow: Workflow = Workflow.from_loader(name=name, externals={})
-    except ValueError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Workflow workflow name: {name!r} does not found in /conf path"
-            ),
-        ) from None
-
-    # NOTE: Start execute manually
-    try:
-        result: Result = workflow.execute(params=payload.params)
-    except Exception as err:
-        raise HTTPException(
-            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
-            detail=f"{type(err)}: {err}",
-        ) from None
-
-    return asdict(result)
-
-
-@workflow_route.get(path="/{name}/logs")
-async def get_workflow_logs(name: str):
-    try:
-        return {
-            "message": f"Getting workflow {name!r} logs",
-            "logs": [
-                log.model_dump(
-                    by_alias=True,
-                    exclude_none=True,
-                    exclude_unset=True,
-                    exclude_defaults=True,
-                )
-                for log in get_audit().find_logs(name=name)
-            ],
-        }
-    except FileNotFoundError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=f"Does not found log for workflow {name!r}",
-        ) from None
-
-
-@workflow_route.get(path="/{name}/logs/{release}")
-async def get_workflow_release_log(name: str, release: str):
-    try:
-        log: Audit = get_audit().find_log_with_release(
-            name=name, release=datetime.strptime(release, "%Y%m%d%H%M%S")
-        )
-    except FileNotFoundError:
-        raise HTTPException(
-            status_code=st.HTTP_404_NOT_FOUND,
-            detail=(
-                f"Does not found log for workflow {name!r} "
-                f"with release {release!r}"
-            ),
-        ) from None
-    return {
-        "message": f"Getting workflow {name!r} log in release {release}",
-        "log": log.model_dump(
-            by_alias=True,
-            exclude_none=True,
-            exclude_unset=True,
-            exclude_defaults=True,
-        ),
-    }
-
-
-@workflow_route.delete(
-    path="/{name}/logs/{release}",
-    status_code=st.HTTP_204_NO_CONTENT,
-)
-async def del_workflow_release_log(name: str, release: str):
-    return {"message": f"Deleted workflow {name!r} log in release {release}"}
-
-
 @schedule_route.get(path="/{name}")
 async def get_schedules(name: str):
     try:

ddeutil/workflow/api/routes/workflows.py

@@ -0,0 +1,137 @@
+# ------------------------------------------------------------------------------
+# 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
+
+from dataclasses import asdict
+from datetime import datetime
+from typing import Any
+
+from fastapi import APIRouter, HTTPException
+from fastapi import status as st
+from fastapi.responses import UJSONResponse
+from pydantic import BaseModel
+
+from ...__types import DictData
+from ...audit import Audit, get_audit
+from ...conf import Loader, get_logger
+from ...result import Result
+from ...workflow import Workflow
+
+logger = get_logger("ddeutil.workflow")
+
+workflow_route = APIRouter(
+    prefix="/workflows",
+    tags=["workflows"],
+    default_response_class=UJSONResponse,
+)
+
+
+@workflow_route.get(path="/")
+async def get_workflows() -> DictData:
+    """Return all workflow workflows that exists in config path."""
+    workflows: DictData = dict(Loader.finds(Workflow))
+    return {
+        "message": f"Getting all workflows: {len(workflows)}",
+        "count": len(workflows),
+        "workflows": workflows,
+    }
+
+
+@workflow_route.get(path="/{name}")
+async def get_workflow_by_name(name: str) -> DictData:
+    """Return model of workflow that passing an input workflow name."""
+    try:
+        workflow: Workflow = Workflow.from_loader(name=name, externals={})
+    except ValueError as err:
+        logger.exception(err)
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Workflow workflow name: {name!r} does not found in /conf path"
+            ),
+        ) from None
+    return workflow.model_dump(
+        by_alias=True,
+        exclude_none=True,
+        exclude_unset=True,
+        exclude_defaults=True,
+    )
+
+
+class ExecutePayload(BaseModel):
+    params: dict[str, Any]
+
+
+@workflow_route.post(path="/{name}/execute", status_code=st.HTTP_202_ACCEPTED)
+async def execute_workflow(name: str, payload: ExecutePayload) -> DictData:
+    """Return model of workflow that passing an input workflow name."""
+    try:
+        workflow: Workflow = Workflow.from_loader(name=name, externals={})
+    except ValueError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Workflow workflow name: {name!r} does not found in /conf path"
+            ),
+        ) from None
+
+    # NOTE: Start execute manually
+    try:
+        result: Result = workflow.execute(params=payload.params)
+    except Exception as err:
+        raise HTTPException(
+            status_code=st.HTTP_500_INTERNAL_SERVER_ERROR,
+            detail=f"{type(err)}: {err}",
+        ) from None
+
+    return asdict(result)
+
+
+@workflow_route.get(path="/{name}/audits")
+async def get_workflow_audits(name: str):
+    try:
+        return {
+            "message": f"Getting workflow {name!r} audits",
+            "audits": [
+                audit.model_dump(
+                    by_alias=True,
+                    exclude_none=True,
+                    exclude_unset=True,
+                    exclude_defaults=True,
+                )
+                for audit in get_audit().find_audits(name=name)
+            ],
+        }
+    except FileNotFoundError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=f"Does not found audit for workflow {name!r}",
+        ) from None
+
+
+@workflow_route.get(path="/{name}/audits/{release}")
+async def get_workflow_release_audit(name: str, release: str):
+    try:
+        audit: Audit = get_audit().find_audit_with_release(
+            name=name, release=datetime.strptime(release, "%Y%m%d%H%M%S")
+        )
+    except FileNotFoundError:
+        raise HTTPException(
+            status_code=st.HTTP_404_NOT_FOUND,
+            detail=(
+                f"Does not found audit for workflow {name!r} "
+                f"with release {release!r}"
+            ),
+        ) from None
+    return {
+        "message": f"Getting workflow {name!r} audit in release {release}",
+        "audit": audit.model_dump(
+            by_alias=True,
+            exclude_none=True,
+            exclude_unset=True,
+            exclude_defaults=True,
+        ),
+    }

ddeutil/workflow/audit.py

@@ -12,16 +12,15 @@ from abc import ABC, abstractmethod
 from collections.abc import Iterator
 from datetime import datetime
 from pathlib import Path
-from typing import Any, ClassVar, Optional, Union
+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, TupleStr
-from .conf import config, get_logger
-
-logger = get_logger("ddeutil.workflow")
+from .conf import config
+from .logs import TraceLog, get_trace
 
 __all__: TupleStr = (
     "get_audit",
@@ -55,7 +54,7 @@ class BaseAudit(BaseModel, ABC):
 
         :rtype: Self
         """
-        if config.enable_write_log:
+        if config.enable_write_audit:
             self.do_before()
         return self
 
@@ -83,8 +82,8 @@ class FileAudit(BaseAudit):
         self.pointer().mkdir(parents=True, exist_ok=True)
 
     @classmethod
-    def find_logs(cls, name: str) -> Iterator[Self]:
-        """Generate the logging data that found from logs path with specific a
+    def find_audits(cls, name: str) -> Iterator[Self]:
+        """Generate the audit data that found from logs path with specific a
         workflow name.
 
         :param name: A workflow name that want to search release logging data.
@@ -100,12 +99,12 @@ class FileAudit(BaseAudit):
                 yield cls.model_validate(obj=json.load(f))
 
     @classmethod
-    def find_log_with_release(
+    def find_audit_with_release(
         cls,
         name: str,
         release: datetime | None = None,
     ) -> Self:
-        """Return the logging data that found from logs path with specific
+        """Return the audit data that found from logs path with specific
         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.
 
@@ -147,7 +146,7 @@ class FileAudit(BaseAudit):
         :return: Return False if the release log was not pointed or created.
         """
         # NOTE: Return False if enable writing log flag does not set.
-        if not config.enable_write_log:
+        if not config.enable_write_audit:
             return False
 
         # NOTE: create pointer path that use the same logic of pointer method.
@@ -175,14 +174,11 @@ class FileAudit(BaseAudit):
 
         :rtype: Self
         """
-        from .utils import cut_id
+        trace: TraceLog = get_trace(self.run_id, self.parent_run_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"
-            )
+        if not config.enable_write_audit:
+            trace.debug("[LOG]: Skip writing log cause config was set")
             return self
 
         log_file: Path = self.pointer() / f"{self.run_id}.log"
@@ -200,34 +196,29 @@ class FileAudit(BaseAudit):
 class SQLiteAudit(BaseAudit):  # pragma: no cov
     """SQLite Audit Pydantic Model."""
 
-    @staticmethod
-    def meta() -> dict[str, Any]:
-        return {
-            "table": "workflow_log",
-            "ddl": """
-                workflow        str,
-                release         int,
-                type            str,
-                context         json,
-                parent_run_id   int,
-                run_id          int,
-                update          datetime
-                primary key ( run_id )
-                """,
-        }
+    table_name: ClassVar[str] = "workflow_log"
+    schemas: ClassVar[
+        str
+    ] = """
+        workflow        str,
+        release         int,
+        type            str,
+        context         json,
+        parent_run_id   int,
+        run_id          int,
+        update          datetime
+        primary key ( run_id )
+        """
 
     def save(self, excluded: list[str] | None) -> SQLiteAudit:
         """Save logging data that receive a context data from a workflow
         execution result.
         """
-        from .utils import cut_id
+        trace: TraceLog = get_trace(self.run_id, self.parent_run_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"
-            )
+        if not config.enable_write_audit:
+            trace.debug("[LOG]: Skip writing log cause config was set")
             return self
 
         raise NotImplementedError("SQLiteAudit does not implement yet.")