ddeutil-workflow 0.0.13__py3-none-any.whl → 0.0.14__py3-none-any.whl

ddeutil/workflow/log.py

@@ -12,7 +12,7 @@ from abc import ABC, abstractmethod
 from datetime import datetime
 from functools import lru_cache
 from pathlib import Path
-from typing import Optional, Union
+from typing import ClassVar, Optional, Union
 
 from ddeutil.core import str2bool
 from pydantic import BaseModel, Field
@@ -20,12 +20,15 @@ from pydantic.functional_validators import model_validator
 from typing_extensions import Self
 
 from .__types import DictData
-from .utils import config
+from .utils import load_config
 
 
 @lru_cache
 def get_logger(name: str):
-    """Return logger with an input module name."""
+    """Return logger object with an input module name.
+
+    :param name: A module name that want to log.
+    """
     logger = logging.getLogger(name)
     formatter = logging.Formatter(
         fmt=(
@@ -45,7 +48,10 @@ def get_logger(name: str):
 
 
 class BaseLog(BaseModel, ABC):
-    """Base Log Pydantic Model abstraction that implement only model fields."""
+    """Base Log Pydantic Model with abstraction class property that implement
+    only model fields. This model should to use with inherit to logging
+    sub-class like file, sqlite, etc.
+    """
 
     name: str = Field(description="A workflow name.")
     on: str = Field(description="A cronjob string of this piepline schedule.")
@@ -61,7 +67,11 @@ class BaseLog(BaseModel, ABC):
     update: datetime = Field(default_factory=datetime.now)
 
     @model_validator(mode="after")
-    def __model_action(self):
+    def __model_action(self) -> Self:
+        """Do before the Log action with WORKFLOW_LOG_ENABLE_WRITE env variable.
+
+        :rtype: Self
+        """
         if str2bool(os.getenv("WORKFLOW_LOG_ENABLE_WRITE", "false")):
             self.do_before()
         return self
@@ -71,7 +81,7 @@ class BaseLog(BaseModel, ABC):
 
     @abstractmethod
     def save(self, excluded: list[str] | None) -> None:
-        """Save logging"""
+        """Save this model logging to target logging store."""
         raise NotImplementedError("Log should implement ``save`` method.")
 
 
@@ -81,13 +91,19 @@ class FileLog(BaseLog):
     ``self.save`` method for file.
     """
 
+    filename: ClassVar[str] = (
+        "./logs/workflow={name}/release={release:%Y%m%d%H%M%S}"
+    )
+
     def do_before(self) -> None:
         """Create directory of release before saving log file."""
         self.pointer().mkdir(parents=True, exist_ok=True)
 
     @classmethod
     def find_logs(cls, name: str):
-        pointer: Path = config().engine.paths.root / f"./logs/workflow={name}"
+        pointer: Path = (
+            load_config().engine.paths.root / f"./logs/workflow={name}"
+        )
         for file in pointer.glob("./release=*/*.log"):
             with file.open(mode="r", encoding="utf-8") as f:
                 yield json.load(f)
@@ -96,7 +112,7 @@ class FileLog(BaseLog):
     def find_log(cls, name: str, release: datetime | None = None):
         if release is not None:
             pointer: Path = (
-                config().engine.paths.root
+                load_config().engine.paths.root
                 / f"./logs/workflow={name}/release={release:%Y%m%d%H%M%S}"
             )
             if not pointer.exists():
@@ -129,9 +145,8 @@ class FileLog(BaseLog):
             return False
 
         # NOTE: create pointer path that use the same logic of pointer method.
-        pointer: Path = (
-            config().engine.paths.root
-            / f"./logs/workflow={name}/release={release:%Y%m%d%H%M%S}"
+        pointer: Path = load_config().engine.paths.root / cls.filename.format(
+            name=name, release=release
         )
 
         if not queue:
@@ -143,9 +158,8 @@ class FileLog(BaseLog):
 
         :rtype: Path
         """
-        return (
-            config().engine.paths.root
-            / f"./logs/workflow={self.name}/release={self.release:%Y%m%d%H%M%S}"
+        return load_config().engine.paths.root / self.filename.format(
+            name=self.name, release=self.release
         )
 
     def save(self, excluded: list[str] | None) -> Self: