Merge pull request #36 from bybatkhuu/dev

bybatkhuu · web-flow · commit 941c671c43d1 · 2025-12-04T16:44:53.000+09:00
Streamline log path handling and simplify logger configuration
diff --git a/README.md b/README.md
@@ -261,22 +261,13 @@ logger:
     level:
       base: INFO
       err: WARNING
-    std:
-      format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-      colorize: true
     format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line}]: {message}"
     file:
       logs_dir: "./logs"
       rotate_size: 10000000
       rotate_time: "00:00:00"
       retention: 90
       encoding: utf8
-      plain:
-        log_path: "{app_name}.all.log"
-        err_path: "{app_name}.err.log"
-      json:
-        log_path: "json/{app_name}.json.all.log"
-        err_path: "json/{app_name}.json.err.log"
     custom_serialize: false
   intercept:
     enabled: true
@@ -287,20 +278,26 @@ logger:
   handlers:
     default.all.std_handler:
       type: STD
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
+      colorize: true
       enabled: true
     default.all.file_handler:
       type: FILE
+      sink: "{app_name}.all.log"
       enabled: false
     default.err.file_handler:
       type: FILE
+      sink: "{app_name}.err.log"
       error: true
       enabled: false
     default.all.json_handler:
       type: FILE
+      sink: "json/{app_name}.json.all.log"
       serialize: true
       enabled: false
     default.err.json_handler:
       type: FILE
+      sink: "json/{app_name}.json.err.log"
       serialize: true
       error: true
       enabled: false
diff --git a/src/beans_logging/_builder.py b/src/beans_logging/_builder.py
@@ -1,5 +1,6 @@
 import os
 from typing import Any
+from pathlib import Path
 
 from pydantic import validate_call
 
@@ -39,40 +40,24 @@ def build_handler(handler: LogHandlerPM, config: LoggerConfigPM) -> dict[str, An
     if _handler_dict.get("sink") is None:
         if _handler_dict.get("type") == LogHandlerTypeEnum.STD:
             _handler_dict["sink"] = std_sink
-        elif _handler_dict.get("type") == LogHandlerTypeEnum.FILE:
-            _logs_path: str = ""
-            if _handler_dict.get("serialize") or _handler_dict.get("custom_serialize"):
-                if _handler_dict.get("error"):
-                    _logs_path = os.path.join(
-                        config.default.file.logs_dir,
-                        config.default.file.json_.err_path,
-                    )
-                else:
-                    _logs_path = os.path.join(
-                        config.default.file.logs_dir,
-                        config.default.file.json_.log_path,
-                    )
-            else:
-                if _handler_dict.get("error"):
-                    _logs_path = os.path.join(
-                        config.default.file.logs_dir,
-                        config.default.file.plain.err_path,
-                    )
-                else:
-                    _logs_path = os.path.join(
-                        config.default.file.logs_dir,
-                        config.default.file.plain.log_path,
-                    )
-
-            if "{app_name}" in _logs_path:
-                _logs_path = _logs_path.format(app_name=config.app_name)
-
-            _handler_dict["sink"] = _logs_path
         else:
             raise ValueError(
-                "'sink' attribute is empty, required for any log handler except std and file handlers!"
+                "'sink' attribute is empty, required for any log handler except std handler!"
             )
 
+    _sink = _handler_dict.get("sink")
+    if isinstance(_sink, (str, Path)):
+        if not os.path.isabs(_sink):
+            _sink = os.path.join(config.default.file.logs_dir, _sink)
+
+        if isinstance(_sink, Path):
+            _sink = str(_sink)
+
+        if "{app_name}" in _sink:
+            _sink = _sink.format(app_name=config.app_name)
+
+        _handler_dict["sink"] = _sink
+
     if _handler_dict.get("level") is None:
         if _handler_dict.get("error"):
             _handler_dict["level"] = config.default.level.err
@@ -89,10 +74,7 @@ def build_handler(handler: LogHandlerPM, config: LoggerConfigPM) -> dict[str, An
         _handler_dict["format"] = json_formatter
 
     if (_handler_dict.get("format") is None) and (not _handler_dict.get("serialize")):
-        if _handler_dict.get("type") == LogHandlerTypeEnum.STD:
-            _handler_dict["format"] = config.default.std.format_str
-        else:
-            _handler_dict["format"] = config.default.format_str
+        _handler_dict["format"] = config.default.format_str
 
     if _handler_dict.get("filter") is None:
         if _handler_dict.get("type") == LogHandlerTypeEnum.STD:
@@ -120,11 +102,6 @@ def build_handler(handler: LogHandlerPM, config: LoggerConfigPM) -> dict[str, An
     ):
         _handler_dict["diagnose"] = True
 
-    if (_handler_dict.get("colorize") is None) and (
-        _handler_dict.get("type") == LogHandlerTypeEnum.STD
-    ):
-        _handler_dict["colorize"] = config.default.std.colorize
-
     if _handler_dict.get("type") == LogHandlerTypeEnum.FILE:
         if _handler_dict.get("enqueue") is None:
             _handler_dict["enqueue"] = True
diff --git a/src/beans_logging/config.py b/src/beans_logging/config.py
@@ -1,14 +1,9 @@
-import sys
+import os
 import datetime
 from typing import Any
 
-if sys.version_info >= (3, 11):
-    from typing import Self
-else:
-    from typing_extensions import Self
-
 import potato_util as utils
-from pydantic import Field, model_validator, field_validator
+from pydantic import Field, field_validator
 
 from ._constants import LogHandlerTypeEnum, LogLevelEnum
 from .schemas import ExtraBaseModel, LogHandlerPM, LoguruHandlerPM
@@ -22,53 +17,46 @@ def _get_handlers() -> dict[str, LogHandlerPM]:
     """
 
     _log_handlers: dict[str, LogHandlerPM] = {
-        "default.all.std_handler": LogHandlerPM(type_=LogHandlerTypeEnum.STD),
+        "default.all.std_handler": LogHandlerPM(
+            type_=LogHandlerTypeEnum.STD,
+            format_=(
+                "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | "
+                "<w>{name}:{line}</w>]: <level>{message}</level>"
+            ),
+            colorize=True,
+        ),
         "default.all.file_handler": LogHandlerPM(
-            type_=LogHandlerTypeEnum.FILE, enabled=False
+            type_=LogHandlerTypeEnum.FILE,
+            sink="{app_name}.all.log",
+            enabled=False,
         ),
         "default.err.file_handler": LogHandlerPM(
-            type_=LogHandlerTypeEnum.FILE, error=True, enabled=False
+            type_=LogHandlerTypeEnum.FILE,
+            sink="{app_name}.err.log",
+            error=True,
+            enabled=False,
         ),
         "default.all.json_handler": LogHandlerPM(
-            type_=LogHandlerTypeEnum.FILE, serialize=True, enabled=False
+            type_=LogHandlerTypeEnum.FILE,
+            sink="json/{app_name}.json.all.log",
+            serialize=True,
+            enabled=False,
         ),
         "default.err.json_handler": LogHandlerPM(
-            type_=LogHandlerTypeEnum.FILE, serialize=True, error=True, enabled=False
+            type_=LogHandlerTypeEnum.FILE,
+            sink="json/{app_name}.json.err.log",
+            serialize=True,
+            error=True,
+            enabled=False,
         ),
     }
 
     return _log_handlers
 
 
-class StdConfigPM(ExtraBaseModel):
-    format_str: str = Field(
-        default=(
-            "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>]:"
-            " <level>{message}</level>"
-        ),
-        min_length=8,
-        max_length=512,
-    )
-    colorize: bool = Field(default=True)
-
-
-class PathsConfigPM(ExtraBaseModel):
-    log_path: str = Field(..., min_length=4, max_length=1024)
-    err_path: str = Field(..., min_length=4, max_length=1024)
-
-    @model_validator(mode="after")
-    def _check_log_path(self) -> Self:
-        if self.log_path == self.err_path:
-            raise ValueError(
-                f"`log_path` and `err_path` attributes have same value: '{self.log_path}', must be different!"
-            )
-
-        return self
-
-
 class FileConfigPM(ExtraBaseModel):
     logs_dir: str = Field(
-        default="./logs",
+        default_factory=lambda: os.path.join(os.getcwd(), "logs"),
         min_length=2,
         max_length=1024,
     )
@@ -79,21 +67,6 @@ class FileConfigPM(ExtraBaseModel):
     retention: int = Field(default=90, ge=1)
     encoding: str = Field(default="utf8", min_length=2, max_length=31)
 
-    plain: PathsConfigPM = Field(
-        default_factory=lambda: PathsConfigPM(
-            log_path="{app_name}.all.log",
-            err_path="{app_name}.err.log",
-        )
-    )
-    json_: PathsConfigPM = Field(
-        default_factory=lambda: PathsConfigPM(
-            log_path="json/{app_name}.json.all.log",
-            err_path="json/{app_name}.json.err.log",
-        ),
-        validation_alias="json",
-        serialization_alias="json",
-    )
-
     @field_validator("rotate_time", mode="before")
     @classmethod
     def _check_rotate_time(cls, val: Any) -> Any:
@@ -102,6 +75,14 @@ def _check_rotate_time(cls, val: Any) -> Any:
 
         return val
 
+    @field_validator("logs_dir", mode="before")
+    @classmethod
+    def _check_logs_dir(cls, val: Any) -> Any:
+        if isinstance(val, str) and (not os.path.isabs(val)):
+            val = os.path.abspath(val)
+
+        return val
+
 
 class LevelConfigPM(ExtraBaseModel):
     base: str | int | LogLevelEnum = Field(default=LogLevelEnum.INFO)
@@ -123,7 +104,6 @@ def _check_level(cls, val: Any) -> Any:
 
 class DefaultConfigPM(ExtraBaseModel):
     level: LevelConfigPM = Field(default_factory=LevelConfigPM)
-    std: StdConfigPM = Field(default_factory=StdConfigPM)
     format_str: str = Field(
         default="[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line}]: {message}",
         min_length=8,
diff --git a/templates/configs/logger.yml b/templates/configs/logger.yml
@@ -4,22 +4,13 @@ logger:
     level:
       base: INFO
       err: WARNING
-    std:
-      format_str: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
-      colorize: true
     format_str: "[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {extra[level_short]:<5} | {name}:{line}]: {message}"
     file:
       logs_dir: "./logs"
       rotate_size: 10000000
       rotate_time: "00:00:00"
       retention: 90
       encoding: utf8
-      plain:
-        log_path: "{app_name}.all.log"
-        err_path: "{app_name}.err.log"
-      json:
-        log_path: "json/{app_name}.json.all.log"
-        err_path: "json/{app_name}.json.err.log"
     custom_serialize: false
   intercept:
     enabled: true
@@ -30,20 +21,26 @@ logger:
   handlers:
     default.all.std_handler:
       type: STD
+      format: "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{extra[level_short]:<5}</level> | <w>{name}:{line}</w>]: <level>{message}</level>"
+      colorize: true
       enabled: true
     default.all.file_handler:
       type: FILE
+      sink: "{app_name}.all.log"
       enabled: false
     default.err.file_handler:
       type: FILE
+      sink: "{app_name}.err.log"
       error: true
       enabled: false
     default.all.json_handler:
       type: FILE
+      sink: "json/{app_name}.json.all.log"
       serialize: true
       enabled: false
     default.err.json_handler:
       type: FILE
+      sink: "json/{app_name}.json.err.log"
       serialize: true
       error: true
       enabled: false
