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

ddeutil/workflow/__about__.py

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

ddeutil/workflow/__init__.py

@@ -52,7 +52,7 @@ from .__types import DictData, DictStr, Matrix, Re, TupleStr
 from .audits import (
     Audit,
     FileAudit,
-    get_audit_model,
+    get_audit,
 )
 from .conf import *
 from .errors import (

ddeutil/workflow/api/routes/logs.py

@@ -10,7 +10,7 @@ from fastapi import APIRouter, Path, Query
 from fastapi import status as st
 from fastapi.responses import UJSONResponse
 
-from ...audits import get_audit_model
+from ...audits import get_audit
 from ...result import Result
 
 router = APIRouter(
@@ -90,7 +90,7 @@ async def get_audits():
     """
     return {
         "message": "Getting audit logs",
-        "audits": list(get_audit_model().find_audits(name="demo")),
+        "audits": list(get_audit().find_audits(name="demo")),
     }
 
 
@@ -109,7 +109,7 @@ async def get_audit_with_workflow(workflow: str):
     """
     return {
         "message": f"Getting audit logs with workflow name {workflow}",
-        "audits": list(get_audit_model().find_audits(name="demo")),
+        "audits": list(get_audit().find_audits(name="demo")),
     }
 
 
@@ -136,7 +136,7 @@ async def get_audit_with_workflow_release(
             f"Getting audit logs with workflow name {workflow} and release "
             f"{release}"
         ),
-        "audits": list(get_audit_model().find_audits(name="demo")),
+        "audits": list(get_audit().find_audits(name="demo")),
     }
 
 
@@ -167,5 +167,5 @@ async def get_audit_with_workflow_release_run_id(
             f"Getting audit logs with workflow name {workflow}, release "
             f"{release}, and running ID {run_id}"
         ),
-        "audits": list(get_audit_model().find_audits(name="demo")),
+        "audits": list(get_audit().find_audits(name="demo")),
     }

ddeutil/workflow/api/routes/workflows.py

@@ -16,7 +16,7 @@ from fastapi.responses import UJSONResponse
 from pydantic import BaseModel
 
 from ...__types import DictData
-from ...audits import Audit, get_audit_model
+from ...audits import Audit, get_audit
 from ...conf import YamlParser
 from ...result import Result
 from ...workflow import Workflow
@@ -100,7 +100,7 @@ async def get_workflow_audits(name: str):
                     exclude_none=False,
                     exclude_unset=True,
                 )
-                for audit in get_audit_model().find_audits(name=name)
+                for audit in get_audit().find_audits(name=name)
             ],
         }
     except FileNotFoundError:
@@ -114,7 +114,7 @@ async def get_workflow_audits(name: str):
 async def get_workflow_release_audit(name: str, release: str):
     """Get Workflow audit log with an input release value."""
     try:
-        audit: Audit = get_audit_model().find_audit_with_release(
+        audit: Audit = get_audit().find_audit_with_release(
             name=name,
             release=datetime.strptime(release, "%Y%m%d%H%M%S"),
         )

ddeutil/workflow/audits.py

@@ -32,10 +32,8 @@ Functions:
 
 Example:
 
-    >>> from ddeutil.workflow.audits import get_audit_model
-    >>> audit = get_audit_model(run_id="run-123")
-    >>> audit.info("Workflow execution started")
-    >>> audit.success("Workflow completed successfully")
+    >>> from ddeutil.workflow.audits import get_audit
+    >>> audit = get_audit(run_id="run-123")
 
 Note:
     Audit instances are automatically configured based on the workflow
@@ -52,11 +50,10 @@ from abc import ABC, abstractmethod
 from collections.abc import Iterator
 from datetime import datetime, timedelta
 from pathlib import Path
-from typing import Any, ClassVar, Optional, TypeVar, Union
+from typing import Annotated, Any, ClassVar, Literal, Optional, Union
 from urllib.parse import ParseResult, urlparse
 
-from pydantic import BaseModel, Field
-from pydantic.functional_serializers import field_serializer
+from pydantic import BaseModel, Field, TypeAdapter
 from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
@@ -67,17 +64,7 @@ from .traces import TraceManager, get_trace, set_logging
 logger = logging.getLogger("ddeutil.workflow")
 
 
-class BaseAudit(BaseModel, ABC):
-    """Base Audit Pydantic Model with abstraction class property.
-
-    This model implements only model fields and should be used as a base class
-    for logging subclasses like file, sqlite, etc.
-    """
-
-    extras: DictData = Field(
-        default_factory=dict,
-        description="An extras parameter that want to override core config",
-    )
+class AuditData(BaseModel):
     name: str = Field(description="A workflow name.")
     release: datetime = Field(description="A release datetime.")
     type: str = Field(description="A running type before logging.")
@@ -94,6 +81,20 @@ class BaseAudit(BaseModel, ABC):
         description="A runs metadata that will use to tracking this audit log.",
     )
 
+
+class BaseAudit(BaseModel, ABC):
+    """Base Audit Pydantic Model with abstraction class property.
+
+    This model implements only model fields and should be used as a base class
+    for logging subclasses like file, sqlite, etc.
+    """
+
+    type: str
+    extras: DictData = Field(
+        default_factory=dict,
+        description="An extras parameter that want to override core config",
+    )
+
     @field_validator("extras", mode="before")
     def validate_extras(cls, v: Any) -> DictData:
         """Validate extras field to ensure it's a dictionary."""
@@ -118,20 +119,17 @@ class BaseAudit(BaseModel, ABC):
         set_logging("ddeutil.workflow")
         return self
 
-    @classmethod
     @abstractmethod
     def is_pointed(
-        cls,
-        name: str,
-        release: datetime,
+        self,
+        data: AuditData,
         *,
         extras: Optional[DictData] = None,
     ) -> bool:
         """Check if audit data exists for the given workflow and release.
 
         Args:
-            name: The workflow name to check.
-            release: The release datetime to check.
+            data:
             extras: Optional extra parameters to override core config.
 
         Returns:
@@ -144,10 +142,9 @@ class BaseAudit(BaseModel, ABC):
             "Audit should implement `is_pointed` class-method"
         )
 
-    @classmethod
     @abstractmethod
     def find_audits(
-        cls,
+        self,
         name: str,
         *,
         extras: Optional[DictData] = None,
@@ -168,10 +165,9 @@ class BaseAudit(BaseModel, ABC):
             "Audit should implement `find_audits` class-method"
         )
 
-    @classmethod
     @abstractmethod
     def find_audit_with_release(
-        cls,
+        self,
         name: str,
         release: Optional[datetime] = None,
         *,
@@ -203,11 +199,12 @@ class BaseAudit(BaseModel, ABC):
 
     @abstractmethod
     def save(
-        self, excluded: Optional[list[str]] = None
+        self, data: Any, excluded: Optional[list[str]] = None
     ) -> Self:  # pragma: no cov
         """Save this model logging to target logging store.
 
         Args:
+            data:
             excluded: Optional list of field names to exclude from saving.
 
         Returns:
@@ -234,20 +231,11 @@ class FileAudit(BaseAudit):
         "workflow={name}/release={release:%Y%m%d%H%M%S}"
     )
 
-    @field_serializer("extras")
-    def __serialize_extras(self, value: DictData) -> DictData:
-        """Serialize extras field, converting ParseResult objects to URLs.
-
-        Args:
-            value: The extras dictionary to serialize.
-
-        Returns:
-            DictData: Serialized extras with ParseResult objects converted to URLs.
-        """
-        return {
-            k: (v.geturl() if isinstance(v, ParseResult) else v)
-            for k, v in value.items()
-        }
+    type: Literal["file"] = "file"
+    path: str = Field(
+        default="./audits",
+        description="A file path that use to manage audit logs.",
+    )
 
     def do_before(self) -> None:
         """Create directory of release before saving log file.
@@ -255,12 +243,11 @@ class FileAudit(BaseAudit):
         This method ensures the target directory exists before attempting
         to save audit log files.
         """
-        self.pointer().mkdir(parents=True, exist_ok=True)
+        Path(self.path).mkdir(parents=True, exist_ok=True)
 
-    @classmethod
     def find_audits(
-        cls, name: str, *, extras: Optional[DictData] = None
-    ) -> Iterator[Self]:
+        self, name: str, *, extras: Optional[DictData] = None
+    ) -> Iterator[AuditData]:
         """Generate audit data found from logs path for a specific workflow name.
 
         Args:
@@ -273,27 +260,21 @@ class FileAudit(BaseAudit):
         Raises:
             FileNotFoundError: If the workflow directory does not exist.
         """
-        audit_url = dynamic("audit_url", extras=extras)
-        if audit_url is None:
-            raise ValueError("audit_url configuration is not set")
-
-        audit_url_parse: ParseResult = urlparse(audit_url)
-        pointer: Path = Path(audit_url_parse.path) / f"workflow={name}"
+        pointer: Path = Path(self.path) / f"workflow={name}"
         if not pointer.exists():
             raise FileNotFoundError(f"Pointer: {pointer.absolute()}.")
 
         for file in pointer.glob("./release=*/*.log"):
             with file.open(mode="r", encoding="utf-8") as f:
-                yield cls.model_validate(obj=json.load(f))
+                yield AuditData.model_validate(obj=json.load(f))
 
-    @classmethod
     def find_audit_with_release(
-        cls,
+        self,
         name: str,
         release: Optional[datetime] = None,
         *,
         extras: Optional[DictData] = None,
-    ) -> Self:
+    ) -> AuditData:
         """Return audit data found from logs path for specific workflow and release.
 
         If a release is not provided, it will return the latest release from
@@ -305,20 +286,14 @@ class FileAudit(BaseAudit):
             extras: Optional extra parameters to override core config.
 
         Returns:
-            Self: The audit instance for the specified workflow and release.
+            AuditData: The audit instance for the specified workflow and release.
 
         Raises:
             FileNotFoundError: If the specified workflow/release directory does not exist.
             ValueError: If no releases found when release is None.
         """
         if release is None:
-            # Find the latest release
-            audit_url = dynamic("audit_url", extras=extras)
-            if audit_url is None:
-                raise ValueError("audit_url configuration is not set")
-
-            audit_url_parse: ParseResult = urlparse(audit_url)
-            pointer: Path = Path(audit_url_parse.path) / f"workflow={name}"
+            pointer: Path = Path(self.path) / f"workflow={name}"
             if not pointer.exists():
                 raise FileNotFoundError(f"Pointer: {pointer.absolute()}.")
 
@@ -332,13 +307,8 @@ class FileAudit(BaseAudit):
                 pointer.glob("./release=*"), key=os.path.getctime
             )
         else:
-            audit_url = dynamic("audit_url", extras=extras)
-            if audit_url is None:
-                raise ValueError("audit_url configuration is not set")
-
-            audit_url_parse: ParseResult = urlparse(audit_url)
             release_pointer: Path = (
-                Path(audit_url_parse.path)
+                Path(self.path)
                 / f"workflow={name}/release={release:%Y%m%d%H%M%S}"
             )
             if not release_pointer.exists():
@@ -355,21 +325,15 @@ class FileAudit(BaseAudit):
             release_pointer.glob("./*.log"), key=os.path.getctime
         )
         with latest_file.open(mode="r", encoding="utf-8") as f:
-            return cls.model_validate(obj=json.load(f))
+            return AuditData.model_validate(obj=json.load(f))
 
-    @classmethod
     def is_pointed(
-        cls,
-        name: str,
-        release: datetime,
-        *,
-        extras: Optional[DictData] = None,
+        self, data: AuditData, *, extras: Optional[DictData] = None
     ) -> bool:
         """Check if the release log already exists at the destination log path.
 
         Args:
-            name: The workflow name.
-            release: The release datetime.
+            data: The workflow name.
             extras: Optional extra parameters to override core config.
 
         Returns:
@@ -378,46 +342,32 @@ class FileAudit(BaseAudit):
         # NOTE: Return False if enable writing log flag does not set.
         if not dynamic("enable_write_audit", extras=extras):
             return False
+        return self.pointer(data).exists()
 
-        # NOTE: create pointer path that use the same logic of pointer method.
-        audit_url: Optional[str] = dynamic("audit_url", extras=extras)
-        if audit_url is None:
-            return False
-
-        audit_url_parse: ParseResult = urlparse(audit_url)
-        pointer: Path = Path(audit_url_parse.path) / cls.filename_fmt.format(
-            name=name, release=release
-        )
-
-        return pointer.exists()
-
-    def pointer(self) -> Path:
+    def pointer(self, data: AuditData) -> Path:
         """Return release directory path generated from model data.
 
         Returns:
             Path: The directory path for the current workflow and release.
         """
-        audit_url = dynamic("audit_url", extras=self.extras)
-        if audit_url is None:
-            raise ValueError("audit_url configuration is not set")
-
-        audit_url_parse: ParseResult = urlparse(audit_url)
-        return Path(audit_url_parse.path) / self.filename_fmt.format(
-            name=self.name, release=self.release
+        return Path(self.path) / self.filename_fmt.format(
+            name=data.name, release=data.release
         )
 
-    def save(self, excluded: Optional[list[str]] = None) -> Self:
+    def save(self, data: Any, excluded: Optional[list[str]] = None) -> Self:
         """Save logging data received from workflow execution result.
 
         Args:
+            data:
             excluded: Optional list of field names to exclude from saving.
 
         Returns:
             Self: The audit instance after saving.
         """
+        audit = AuditData.model_validate(data)
         trace: TraceManager = get_trace(
-            self.run_id,
-            parent_run_id=self.parent_run_id,
+            audit.run_id,
+            parent_run_id=audit.parent_run_id,
             extras=self.extras,
         )
 
@@ -426,19 +376,21 @@ class FileAudit(BaseAudit):
             trace.debug("[AUDIT]: Skip writing audit log cause config was set.")
             return self
 
-        log_file: Path = (
-            self.pointer() / f"{self.parent_run_id or self.run_id}.log"
-        )
+        pointer: Path = self.pointer(data=audit)
+        if not pointer.exists():
+            pointer.mkdir(parents=True)
+
+        log_file: Path = pointer / f"{audit.parent_run_id or audit.run_id}.log"
 
         # NOTE: Convert excluded list to set for pydantic compatibility
         exclude_set = set(excluded) if excluded else None
         trace.info(
             f"[AUDIT]: Start writing audit log with "
-            f"release: {self.release:%Y%m%d%H%M%S}"
+            f"release: {audit.release:%Y%m%d%H%M%S}"
         )
         log_file.write_text(
             json.dumps(
-                self.model_dump(exclude=exclude_set),
+                audit.model_dump(exclude=exclude_set),
                 default=str,
                 indent=2,
             ),
@@ -504,6 +456,9 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
         )
         """
 
+    type: Literal["sqlite"] = "sqlite"
+    path: str
+
     def _ensure_table_exists(self) -> None:
         """Ensure the audit table exists in the database."""
         audit_url = dynamic("audit_url", extras=self.extras)
@@ -520,19 +475,16 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
             conn.execute(self.schemas)
             conn.commit()
 
-    @classmethod
     def is_pointed(
-        cls,
-        name: str,
-        release: datetime,
+        self,
+        data: AuditData,
         *,
         extras: Optional[DictData] = None,
     ) -> bool:
         """Check if audit data exists for the given workflow and release.
 
         Args:
-            name: The workflow name to check.
-            release: The release datetime to check.
+            data:
             extras: Optional extra parameters to override core config.
 
         Returns:
@@ -553,7 +505,7 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
         with sqlite3.connect(db_path) as conn:
             cursor = conn.execute(
                 "SELECT COUNT(*) FROM audits WHERE workflow = ? AND release = ?",
-                (name, release.isoformat()),
+                (data.name, data.release.isoformat()),
             )
             return cursor.fetchone()[0] > 0
 
@@ -592,7 +544,7 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
                 context = json.loads(cls._decompress_data(row[3]))
                 metadata = json.loads(cls._decompress_data(row[6]))
 
-                yield cls(
+                yield AuditData(
                     name=row[0],
                     release=datetime.fromisoformat(row[1]),
                     type=row[2],
@@ -600,7 +552,6 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
                     parent_run_id=row[4],
                     run_id=row[5],
                     runs_metadata=metadata,
-                    extras=extras or {},
                 )
 
     @classmethod
@@ -610,7 +561,7 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
         release: Optional[datetime] = None,
         *,
         extras: Optional[DictData] = None,
-    ) -> Self:
+    ) -> AuditData:
         """Find audit data for a specific workflow and release.
 
         Args:
@@ -656,7 +607,7 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
             context = json.loads(cls._decompress_data(row[3]))
             metadata = json.loads(cls._decompress_data(row[6]))
 
-            return cls(
+            return AuditData(
                 name=row[0],
                 release=datetime.fromisoformat(row[1]),
                 type=row[2],
@@ -664,7 +615,6 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
                 parent_run_id=row[4],
                 run_id=row[5],
                 runs_metadata=metadata,
-                extras=extras or {},
             )
 
     @staticmethod
@@ -691,10 +641,11 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
         """
         return zlib.decompress(data).decode("utf-8")
 
-    def save(self, excluded: Optional[list[str]] = None) -> Self:
+    def save(self, data: Any, excluded: Optional[list[str]] = None) -> Self:
         """Save logging data received from workflow execution result.
 
         Args:
+            data: Any
             excluded: Optional list of field names to exclude from saving.
 
         Returns:
@@ -703,9 +654,10 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
         Raises:
             ValueError: If SQLite database is not properly configured.
         """
+        audit = AuditData.model_validate(data)
         trace: TraceManager = get_trace(
-            self.run_id,
-            parent_run_id=self.parent_run_id,
+            audit.run_id,
+            parent_run_id=audit.parent_run_id,
             extras=self.extras,
         )
 
@@ -726,7 +678,7 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
 
         # Prepare data for storage
         exclude_set = set(excluded) if excluded else None
-        model_data = self.model_dump(exclude=exclude_set)
+        model_data = audit.model_dump(exclude=exclude_set)
 
         # Compress context and metadata
         context_blob = self._compress_data(
@@ -744,12 +696,12 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
                 VALUES (?, ?, ?, ?, ?, ?, ?, CURRENT_TIMESTAMP)
                 """,
                 (
-                    self.name,
-                    self.release.isoformat(),
-                    self.type,
+                    audit.name,
+                    audit.release.isoformat(),
+                    audit.type,
                     context_blob,
-                    self.parent_run_id,
-                    self.run_id,
+                    audit.parent_run_id,
+                    audit.run_id,
                     metadata_blob,
                 ),
             )
@@ -787,50 +739,27 @@ class SQLiteAudit(BaseAudit):  # pragma: no cov
             return cursor.rowcount
 
 
-Audit = Union[
-    FileAudit,
-    SQLiteAudit,
+Audit = Annotated[
+    Union[
+        FileAudit,
+        SQLiteAudit,
+    ],
+    Field(discriminator="type"),
 ]
-AuditType = TypeVar("AuditType", bound=BaseAudit)
 
 
-def get_audit_model(
+def get_audit(
     *,
     extras: Optional[DictData] = None,
-) -> type[AuditType]:  # pragma: no cov
+) -> Audit:  # pragma: no cov
     """Get an audit model dynamically based on the config audit path value.
 
     Args:
         extras: Optional extra parameters to override the core config.
-            This function allow you to pass `audit_model_mapping` for override
-            the audit model object with your custom model.
 
     Returns:
-        type[Audit]: The appropriate audit model class based on configuration.
-
-    Raises:
-        NotImplementedError: If the audit URL scheme is not supported.
+        Audit: The appropriate audit model class based on configuration.
     """
-    # NOTE: Allow you to override audit model by the extra parameter.
-    map_audit_models: dict[str, type[AuditType]] = (extras or {}).get(
-        "audit_model_mapping", {}
-    )
-
-    audit_url = dynamic("audit_url", extras=extras)
-    if audit_url is None:
-        return map_audit_models.get("file", FileAudit)
-
-    audit_url_parse: ParseResult = urlparse(audit_url)
-    if not audit_url_parse.scheme:
-        return map_audit_models.get("file", FileAudit)
-
-    if audit_url_parse.scheme == "sqlite" or (
-        audit_url_parse.scheme == "file"
-        and Path(audit_url_parse.path).is_file()
-    ):
-        return map_audit_models.get("sqlite", SQLiteAudit)
-    elif audit_url_parse.scheme != "file":
-        raise NotImplementedError(
-            f"Does not implement the audit model support for URL: {audit_url_parse}"
-        )
-    return map_audit_models.get("file", FileAudit)
+    audit_conf = dynamic("audit_conf", extras=extras)
+    model = TypeAdapter(Audit).validate_python(audit_conf | {"extras": extras})
+    return model

ddeutil/workflow/conf.py

@@ -155,8 +155,10 @@ class Config:  # pragma: no cov
         )
 
     @property
-    def audit_url(self) -> str:
-        return env("LOG_AUDIT_URL", "file:./audits")
+    def audit_conf(self) -> str:
+        return json.loads(
+            env("LOG_AUDIT_URL", '{"type": "file", "path": "./audits"}')
+        )
 
     @property
     def enable_write_audit(self) -> bool:

ddeutil/workflow/job.py

@@ -1401,7 +1401,6 @@ def docker_execution(
             ),
             extras=job.extras,
         )
-    print(params)
     return Result(
         run_id=run_id,
         parent_run_id=parent_run_id,

ddeutil/workflow/traces.py

@@ -107,7 +107,9 @@ class Message(BaseModel):
     with emoji support and categorization.
     """
 
-    name: Optional[str] = Field(default=None, description="A prefix name.")
+    name: Optional[str] = Field(
+        default=None, description="A prefix name of message."
+    )
     message: Optional[str] = Field(default=None, description="A message.")
 
     @classmethod
@@ -952,9 +954,8 @@ class SQLiteHandler(BaseHandler):  # pragma: no cov
         except Exception as e:
             logger.error(f"Failed to read from SQLite database: {e}")
 
-    @classmethod
     def find_trace_with_id(
-        cls,
+        self,
         run_id: str,
         force_raise: bool = True,
         *,
@@ -962,17 +963,7 @@ class SQLiteHandler(BaseHandler):  # pragma: no cov
         extras: Optional[DictData] = None,
     ) -> TraceData:
         """Find trace log with specific run ID from SQLite database."""
-        if path is None:
-            url = dynamic("trace_url", extras=extras)
-            if (
-                url is not None
-                and hasattr(url, "path")
-                and getattr(url, "path", None)
-            ):
-                path = Path(url.path)
-            else:
-                path = Path("./logs/workflow_traces.db")
-
+        path = path or Path(self.path)
         if not path.exists():
             if force_raise:
                 raise FileNotFoundError(f"SQLite database not found: {path}")
@@ -1737,7 +1728,9 @@ TraceHandler = Annotated[
     Union[
         ConsoleHandler,
         FileHandler,
-        SQLiteHandler,
+        # SQLiteHandler,
+        # RestAPIHandler,
+        # ElasticHandler
     ],
     Field(discriminator="type"),
 ]
@@ -1874,7 +1867,9 @@ class BaseAsyncEmit(ABC):
 
 
 class TraceManager(BaseModel, BaseEmit, BaseAsyncEmit):
-    """Trace Management that keep all trance handler."""
+    """Trace Manager model that keep all trance handler and emit log to its
+    handler.
+    """
 
     extras: DictData = Field(
         default_factory=dict,
@@ -1892,7 +1887,7 @@ class TraceManager(BaseModel, BaseEmit, BaseAsyncEmit):
         description="A list of Trace handler model."
     )
     buffer_size: int = Field(
-        default=1,
+        default=10,
         description="A buffer size to trigger flush trace log",
     )
 
@@ -1929,8 +1924,8 @@ class TraceManager(BaseModel, BaseEmit, BaseAsyncEmit):
         """Emit a trace log to all handler. This will use synchronise process.
 
         Args:
-            msg: A message.
-            level: A tracing level.
+            msg (str): A message.
+            level (Level): A tracing level.
         """
         _msg: str = self.make_message(msg)
         metadata: Metadata = Metadata.make(
@@ -1942,16 +1937,18 @@ class TraceManager(BaseModel, BaseEmit, BaseAsyncEmit):
             parent_run_id=self.parent_run_id,
             extras=self.extras,
         )
-        if self._enable_buffer:  # pragma: no cov
-            self._buffer.append(metadata)
-
-            if len(self._buffer) >= self.buffer_size:
-                for handler in self.handlers:
-                    handler.flush(self._buffer, extra=self.extras)
-                self._buffer.clear()
-        else:
+        if not self._enable_buffer:
             for handler in self.handlers:
                 handler.emit(metadata, extra=self.extras)
+            return
+
+        # NOTE: Update metadata to the buffer.
+        self._buffer.append(metadata)
+
+        if len(self._buffer) >= self.buffer_size:  # pragma: no cov
+            for handler in self.handlers:
+                handler.flush(self._buffer, extra=self.extras)
+            self._buffer.clear()
 
     async def amit(self, msg: str, level: Level) -> None:
         """Async write trace log with append mode and logging this message with
@@ -1974,22 +1971,43 @@ class TraceManager(BaseModel, BaseEmit, BaseAsyncEmit):
         for handler in self.handlers:
             await handler.amit(metadata, extra=self.extras)
 
-    def __enter__(self):  # pragma: no cov
+    def __enter__(self):
+        """Enter the trace for catching the logs that run so fast. It will use
+        buffer strategy to flush the logs instead emit.
+        """
         self._enable_buffer = True
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit the trace that will clear all log in the buffer."""
+        if exc_type:
+            _msg: str = self.make_message(str(exc_val))
+            metadata: Metadata = Metadata.make(
+                error_flag=True,
+                level="error",
+                message=_msg,
+                cutting_id=self.cut_id,
+                run_id=self.run_id,
+                parent_run_id=self.parent_run_id,
+                extras=self.extras,
+            )
+            self._buffer.append(metadata)
 
-    def __exit__(self, exc_type, exc_val, exc_tb):  # pragma: no cov
         if self._buffer:
             for handler in self.handlers:
                 handler.flush(self._buffer, extra=self.extras)
             self._buffer.clear()
 
+        # NOTE: Re-raise the exception if one occurred
+        return False
+
 
 def get_trace(
     run_id: str,
     *,
     parent_run_id: Optional[str] = None,
     extras: Optional[DictData] = None,
-) -> TraceManager:  # pragma: no cov
+) -> TraceManager:
     """Get dynamic TraceManager instance from the core config.
 
     This factory function returns the appropriate trace implementation based on
@@ -1997,8 +2015,8 @@ def get_trace(
     and parent running ID.
 
     Args:
-        run_id: A running ID.
-        parent_run_id: A parent running ID.
+        run_id (str): A running ID.
+        parent_run_id (str | None, default None): A parent running ID.
         extras: An extra parameter that want to override the core
             config values.
 

ddeutil/workflow/workflow.py

@@ -42,7 +42,7 @@ from pydantic.functional_validators import field_validator, model_validator
 from typing_extensions import Self
 
 from .__types import DictData
-from .audits import Audit, get_audit_model
+from .audits import Audit, get_audit
 from .conf import YamlParser, dynamic
 from .errors import WorkflowCancelError, WorkflowError, WorkflowTimeoutError
 from .event import Event
@@ -509,24 +509,27 @@ class Workflow(BaseModel):
         trace.info(f"[RELEASE]: End {name!r} : {release:%Y-%m-%d %H:%M:%S}")
         trace.debug(f"[RELEASE]: Writing audit: {name!r}.")
         (
-            (audit or get_audit_model(extras=self.extras))(
-                name=name,
-                release=release,
-                type=release_type,
-                context=context,
-                parent_run_id=parent_run_id,
-                run_id=run_id,
-                extras=self.extras,
-                runs_metadata=(
-                    (runs_metadata or {})
-                    | rs.info
-                    | {
-                        "timeout": timeout,
-                        "original_name": self.name,
-                        "audit_excluded": audit_excluded,
-                    }
-                ),
-            ).save(excluded=audit_excluded)
+            (audit or get_audit(extras=self.extras)).save(
+                data={
+                    "name": name,
+                    "release": release,
+                    "type": release_type,
+                    "context": context,
+                    "parent_run_id": parent_run_id,
+                    "run_id": run_id,
+                    "extras": self.extras,
+                    "runs_metadata": (
+                        (runs_metadata or {})
+                        | rs.info
+                        | {
+                            "timeout": timeout,
+                            "original_name": self.name,
+                            "audit_excluded": audit_excluded,
+                        }
+                    ),
+                },
+                excluded=audit_excluded,
+            )
         )
         return Result(
             run_id=run_id,

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ddeutil-workflow
-Version: 0.0.79
+Version: 0.0.80
 Summary: Lightweight workflow orchestration with YAML template
 Author-email: ddeutils <korawich.anu@gmail.com>
 License: MIT
@@ -168,19 +168,6 @@ For comprehensive API documentation, examples, and best practices:
 - **[Full Documentation](https://ddeutils.github.io/ddeutil-workflow/)** - Complete user guide and API reference
 - **[Getting Started](https://ddeutils.github.io/ddeutil-workflow/getting-started/)** - Quick start guide
 - **[API Reference](https://ddeutils.github.io/ddeutil-workflow/api/workflow/)** - Detailed API documentation
-- **[Optimized Tracing](docs/optimized-tracing.md)** - High-performance logging system (2-5x faster)
-
-## ⚡ Performance Improvements
-
-The workflow system now includes an optimized tracing system that provides significant performance improvements:
-
-- **🚀 2-5x faster logging** with buffered I/O operations
-- **💾 60-80% reduction** in disk I/O operations
-- **🛡️ Built-in thread safety** with minimal overhead
-- **🔄 Backward compatible** - existing code automatically benefits
-- **📊 Lower memory footprint** for high-volume logging
-
-See [Optimized Tracing Documentation](docs/optimized-tracing.md) for details and performance benchmarks.
 
 ## 🎯 Usage
 
@@ -316,21 +303,21 @@ it will use default value and do not raise any error to you.
 > The config value that you will set on the environment should combine with
 > prefix, component, and name which is `WORKFLOW_{component}_{name}` (Upper case).
 
-| Name                         | Component | Default                                                                                                                         | Description                                                                                      |
-|:-----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
-| **REGISTRY_CALLER**          |   CORE    | `.`                                                                                                                             | List of importable string for the call stage.                                                    |
-| **REGISTRY_FILTER**          |   CORE    | `ddeutil.workflow.templates`                                                                                                    | List of importable string for the filter template.                                               |
-| **CONF_PATH**                |   CORE    | `./conf`                                                                                                                        | The config path that keep all template `.yaml` files.                                            |
-| **STAGE_DEFAULT_ID**         |   CORE    | `false`                                                                                                                         | A flag that enable default stage ID that use for catch an execution output.                      |
-| **GENERATE_ID_SIMPLE_MODE**  |   CORE    | `true`                                                                                                                          | A flog that enable generating ID with `md5` algorithm.                                           |
-| **DEBUG_MODE**               |    LOG    | `true`                                                                                                                          | A flag that enable logging with debug level mode.                                                |
-| **TIMEZONE**                 |    LOG    | `Asia/Bangkok`                                                                                                                  | A Timezone string value that will pass to `ZoneInfo` object.                                     |
-| **FORMAT**                   |    LOG    | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format.                                                                  |
-| **FORMAT_FILE**              |    LOG    | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})`                                                   | A trace message format that use to write to target pointer.                                      |
-| **DATETIME_FORMAT**          |    LOG    | `%Y-%m-%d %H:%M:%S`                                                                                                             | A datetime format of the trace log.                                                              |
-| **TRACE_HANDLERS**           |    LOG    | `[{"type": "console"}]`                                                                                                         | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default.  |
-| **AUDIT_URL**                |    LOG    | `file:./audits`                                                                                                                 | A pointer URL of audit log that use to write audit metrix.                                       |
-| **AUDIT_ENABLE_WRITE**       |    LOG    | `true`                                                                                                                          | A flag that enable writing audit log after end execution in the workflow release step.           |
+| Name                        | Component | Default                                                                                                                         | Description                                                                                      |
+|:----------------------------|:---------:|:--------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------|
+| **REGISTRY_CALLER**         |   CORE    | `.`                                                                                                                             | List of importable string for the call stage.                                                    |
+| **REGISTRY_FILTER**         |   CORE    | `ddeutil.workflow.templates`                                                                                                    | List of importable string for the filter template.                                               |
+| **CONF_PATH**               |   CORE    | `./conf`                                                                                                                        | The config path that keep all template `.yaml` files.                                            |
+| **STAGE_DEFAULT_ID**        |   CORE    | `false`                                                                                                                         | A flag that enable default stage ID that use for catch an execution output.                      |
+| **GENERATE_ID_SIMPLE_MODE** |   CORE    | `true`                                                                                                                          | A flog that enable generating ID with `md5` algorithm.                                           |
+| **DEBUG_MODE**              |    LOG    | `true`                                                                                                                          | A flag that enable logging with debug level mode.                                                |
+| **TIMEZONE**                |    LOG    | `Asia/Bangkok`                                                                                                                  | A Timezone string value that will pass to `ZoneInfo` object.                                     |
+| **FORMAT**                  |    LOG    | `%(asctime)s.%(msecs)03d (%(name)-10s, %(process)-5d,%(thread)-5d) [%(levelname)-7s] %(message)-120s (%(filename)s:%(lineno)s)` | A trace message console format.                                                                  |
+| **FORMAT_FILE**             |    LOG    | `{datetime} ({process:5d}, {thread:5d}) {message:120s} ({filename}:{lineno})`                                                   | A trace message format that use to write to target pointer.                                      |
+| **DATETIME_FORMAT**         |    LOG    | `%Y-%m-%d %H:%M:%S`                                                                                                             | A datetime format of the trace log.                                                              |
+| **TRACE_HANDLERS**          |    LOG    | `[{"type": "console"}]`                                                                                                         | A pointer URL of trace log that use to emit log message. Now uses optimized handler by default.  |
+| **AUDIT_CONF**              |    LOG    | `{"type": "file", "path": "./audits"}`                                                                                          | A pointer URL of audit log that use to write audit metrix.                                       |
+| **AUDIT_ENABLE_WRITE**      |    LOG    | `true`                                                                                                                          | A flag that enable writing audit log after end execution in the workflow release step.           |
 
 ## :rocket: Deployment
 

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

@@ -1,36 +1,36 @@
-ddeutil/workflow/__about__.py,sha256=yvfj2RwP4ItaAPfKbYC9qJNcrKY9lxnnSRd6wZ4-CgQ,28
+ddeutil/workflow/__about__.py,sha256=0fYC3KyobGtx1NtfXlGCbR9mrpL_yrH0UY_kp0NWaN8,28
 ddeutil/workflow/__cron.py,sha256=avOagaHl9xXOmizeRWm13cOrty9Tw0vRjFq-xoEgpAY,29167
-ddeutil/workflow/__init__.py,sha256=1xH6m7jXxFly_5FbWCoe8rqhdeSdnnrBMPzoiVo_Exo,3247
+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=7wfRXJmrG3T4YUSArABPfiWq6BzSBf8qoo24JAt433A,28280
+ddeutil/workflow/audits.py,sha256=h7WVHe3z_FqtmLRvAxhnSqae8fFtZPN0tICrVr39wP4,25456
 ddeutil/workflow/cli.py,sha256=aNFOZ3Re_QJBBP6vkT9Lsjrg8wLxrw_LKrl-1SIvSOg,8152
-ddeutil/workflow/conf.py,sha256=vdTvR1OVk2TZBK5ZwwUpfxgg8GU4ldV8ukLzG1-tGDQ,16603
+ddeutil/workflow/conf.py,sha256=4bFl1ufX7-p6ely7tJnanpTZ0wJoik81yTcmBrbcyxY,16661
 ddeutil/workflow/errors.py,sha256=UpUIqoyqkvzqjuxtUQ9535l1HeAsyh-plEG0PgDVR2w,5541
 ddeutil/workflow/event.py,sha256=qm7QHw-Pozm6oIUzAIxpDkPzzVZVtHgJIUlIle0vEfQ,13943
-ddeutil/workflow/job.py,sha256=UvzU66CebZkwIBg1KZch_aA3bZL0jpVrhRUQ2JIyiN4,46615
+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/stages.py,sha256=QufIa2b7A_ngOndVoGzyxKm_o5ZrauNeqxAC4vBkKFM,122678
-ddeutil/workflow/traces.py,sha256=0crly_08a7dfi8-w8QPmYizxh6T7VR8yDnEoxEEiwM0,72838
+ddeutil/workflow/traces.py,sha256=e12_rDnwVo-XR6Ca1KLwCjo3tAwbJP7yXc1YU62YOt8,73415
 ddeutil/workflow/utils.py,sha256=-E-Z5hN_UTFuWDk-NpfKhNj0QtLfJSvZNDI5NzJsd5E,12122
-ddeutil/workflow/workflow.py,sha256=WTQAoSUNOmGpvZYgl28ziTY3kxtqQQw4jbTXPJOIBY4,42790
+ddeutil/workflow/workflow.py,sha256=Uojf7k7l91sqOlsPMeSPwQmbrB5pgbWEmx9QgKYngmI,42924
 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
 ddeutil/workflow/api/routes/job.py,sha256=8eu2OAOS3fENQ54OO723lFpzgHMyz1D-b_xZj6OnmcA,2550
-ddeutil/workflow/api/routes/logs.py,sha256=RiZ62eQVMWArPHE3lpan955U4DdLLkethlvSMlwF7Mg,5312
-ddeutil/workflow/api/routes/workflows.py,sha256=1Mqx4Hft4uJglgJI-Wcw-JzkhomFYZrtP0DnQDBkAFQ,4410
+ddeutil/workflow/api/routes/logs.py,sha256=O0I9L059SvtVHZ-TXCShChxbrHKUoT7MYRK0xZWwIMc,5282
+ddeutil/workflow/api/routes/workflows.py,sha256=0pEZEsIrscRFBXG9gf6nttKw0aNbcdw7NsAZKLoKWtk,4392
 ddeutil/workflow/plugins/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ddeutil/workflow/plugins/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ddeutil/workflow/plugins/providers/aws.py,sha256=61uIFBEWt-_D5Sui24qUPier1Hiqlw_RP_eY-rXBCKc,31551
 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.79.dist-info/licenses/LICENSE,sha256=nGFZ1QEhhhWeMHf9n99_fdt4vQaXS29xWKxt-OcLywk,1085
-ddeutil_workflow-0.0.79.dist-info/METADATA,sha256=V6nV4VeqzwryOpJVDmd4sK5U9rqgn8H4qs8WcTf8ugw,16755
-ddeutil_workflow-0.0.79.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ddeutil_workflow-0.0.79.dist-info/entry_points.txt,sha256=qDTpPSauL0ciO6T4iSVt8bJeYrVEkkoEEw_RlGx6Kgk,63
-ddeutil_workflow-0.0.79.dist-info/top_level.txt,sha256=m9M6XeSWDwt_yMsmH6gcOjHZVK5O0-vgtNBuncHjzW4,8
-ddeutil_workflow-0.0.79.dist-info/RECORD,,
+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,,