beans-logging 6.0.2__tar.gz → 6.0.3__tar.gz

{beans_logging-6.0.2/src/beans_logging.egg-info → beans_logging-6.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging
-Version: 6.0.2
+Version: 6.0.3
 Summary: 'beans-logging' is a python package for simple logger and easily managing logs.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-python-logging

{beans_logging-6.0.2 → beans_logging-6.0.3}/src/beans_logging/__init__.py

@@ -1,6 +1,6 @@
 from ._base import Logger, logger, LoggerLoader
-from .schemas import LoggerConfigPM
-from ._consts import WarnEnum
+from .config import LoggerConfigPM
+from ._constants import WarnEnum
 from .__version__ import __version__
 
 

beans_logging-6.0.3/src/beans_logging/__version__.py

@@ -0,0 +1 @@
+__version__ = "6.0.3"

{beans_logging-6.0.2 → beans_logging-6.0.3}/src/beans_logging/_base.py

@@ -9,18 +9,13 @@ from typing import Any
 import yaml
 from loguru import logger
 from loguru._logger import Logger
-import pydantic
-
-if "2.0.0" <= pydantic.__version__:
-    from pydantic import validate_call
-else:
-    from pydantic import validate_arguments as validate_call
+from pydantic import validate_call
 
 # Internal modules
 from ._utils import create_dir, deep_merge
 from ._handlers import InterceptHandler
 from .rotation import RotationChecker
-from .schemas import LoggerConfigPM
+from .config import LoggerConfigPM
 from .sinks import std_sink
 from .formats import json_format
 from .filters import (
@@ -73,13 +68,13 @@ class LoggerLoader:
         """LoggerLoader constructor method.
 
         Args:
-            config           (LoggerConfigPM | dict | None], optional): New logger config to update loaded config.
+            config           (LoggerConfigPM | dict | None, optional): New logger config to update loaded config.
                                                                             Defaults to None.
-            config_file_path (str                          , optional): Logger config file path. Defaults to
+            config_file_path (str                         , optional): Logger config file path. Defaults to
                                                                             `LoggerLoader._CONFIG_FILE_PATH`.
-            auto_config_file (bool                         , optional): Indicates whether to load logger config
+            auto_config_file (bool                        , optional): Indicates whether to load logger config
                                                                             file or not. Defaults to True.
-            auto_load        (bool                         , optional): Indicates whether to load logger
+            auto_load        (bool                        , optional): Indicates whether to load logger
                                                                             handlers or not. Defaults to False.
         """
 
@@ -171,11 +166,7 @@ class LoggerLoader:
         """
 
         if isinstance(config, dict):
-            if "2.0.0" <= pydantic.__version__:
-                _config_dict = self.config.model_dump()
-            else:
-                _config_dict = self.config.dict()
-
+            _config_dict = self.config.model_dump()
             _merged_dict = deep_merge(_config_dict, config)
             try:
                 self.config = LoggerConfigPM(**_merged_dict)
@@ -224,10 +215,7 @@ class LoggerLoader:
                             return
 
                         _new_config_dict = _new_config_dict["logger"]
-                        if "2.0.0" <= pydantic.__version__:
-                            _config_dict = self.config.model_dump()
-                        else:
-                            _config_dict = self.config.dict()
+                        _config_dict = self.config.model_dump()
 
                         _merged_dict = deep_merge(_config_dict, _new_config_dict)
                         self.config = LoggerConfigPM(**_merged_dict)
@@ -247,10 +235,7 @@ class LoggerLoader:
                             return
 
                         _new_config_dict = _new_config_dict["logger"]
-                        if "2.0.0" <= pydantic.__version__:
-                            _config_dict = self.config.model_dump()
-                        else:
-                            _config_dict = self.config.dict()
+                        _config_dict = self.config.model_dump()
 
                         _merged_dict = deep_merge(_config_dict, _new_config_dict)
                         self.config = LoggerConfigPM(**_merged_dict)
@@ -274,10 +259,7 @@ class LoggerLoader:
             #                 return
 
             #             _new_config_dict = _new_config_dict["logger"]
-            #             if "2.0.0" <= pydantic.__version__:
-            #                 _config_dict = self.config.model_dump()
-            #             else:
-            #                 _config_dict = self.config.dict()
+            #             _config_dict = self.config.model_dump()
 
             #             _merged_dict = deep_merge(_config_dict, _new_config_dict)
             #             self.config = LoggerConfigPM(**_merged_dict)

{beans_logging-6.0.2 → beans_logging-6.0.3}/src/beans_logging/_utils.py

@@ -4,14 +4,9 @@ import copy
 import errno
 
 from loguru import logger
-import pydantic
+from pydantic import validate_call
 
-if "2.0.0" <= pydantic.__version__:
-    from pydantic import validate_call
-else:
-    from pydantic import validate_arguments as validate_call
-
-from ._consts import WarnEnum
+from ._constants import WarnEnum
 
 
 @validate_call
@@ -74,26 +69,33 @@ def deep_merge(dict1: dict, dict2: dict) -> dict:
     return _merged
 
 
-def get_default_logs_dir() -> str:
-    """Return default logs directory path (current working directory + 'logs').
-
-    Returns:
-        str: Default logs directory path.
-    """
-
-    return os.path.join(os.getcwd(), "logs")
-
+@validate_call
+def get_slug_name(file_path: str | None = None) -> str:
+    """Slugify the file name from the given file path or the current script's file path.
 
-def get_app_name() -> str:
-    """Return application name (sys.argv[0]).
+    Args:
+        file_path (str | None, optional): The file path to slugify. If None, uses the current script's file path.
+                                            Defaults to None.
 
     Returns:
-        str: Application name.
+        str: The slugified file name.
     """
 
-    return (
-        os.path.splitext(os.path.basename(sys.argv[0]))[0]
+    if not file_path:
+        file_path = sys.argv[0]
+
+    _slug_name = (
+        os.path.splitext(os.path.basename(file_path))[0]
         .strip()
         .replace(" ", "-")
+        .replace("_", "-")
         .lower()
     )
+    return _slug_name
+
+
+__all__ = [
+    "create_dir",
+    "deep_merge",
+    "get_slug_name",
+]

beans_logging-6.0.3/src/beans_logging/config.py

@@ -0,0 +1,138 @@
+import os
+import datetime
+from typing import Any
+from typing_extensions import Self
+
+from pydantic import BaseModel, Field, field_validator, model_validator, ConfigDict
+
+from ._constants import LogLevelEnum
+from ._utils import get_slug_name
+
+
+class ExtraBaseModel(BaseModel):
+    model_config = ConfigDict(extra="allow")
+
+
+class StdHandlerConfigPM(ExtraBaseModel):
+    enabled: bool = Field(default=True)
+
+
+class StreamConfigPM(ExtraBaseModel):
+    use_color: bool = Field(default=True)
+    use_icon: bool = Field(default=False)
+    format_str: str = Field(
+        default=(
+            "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: "
+            "<level>{message}</level>"
+        ),
+        min_length=8,
+        max_length=512,
+    )
+    std_handler: StdHandlerConfigPM = Field(default_factory=StdHandlerConfigPM)
+
+
+class LogHandlersConfigPM(ExtraBaseModel):
+    enabled: bool = Field(default=False)
+    format_str: str = Field(
+        default="[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}",
+        min_length=8,
+        max_length=512,
+    )
+    log_path: str = Field(
+        default="{app_name}.std.all.log", min_length=4, max_length=1024
+    )
+    err_path: str = Field(
+        default="{app_name}.std.err.log", 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 JsonHandlersConfigPM(ExtraBaseModel):
+    enabled: bool = Field(default=False)
+    use_custom: bool = Field(default=False)
+    log_path: str = Field(
+        default="{app_name}.json.all.log", min_length=4, max_length=1024
+    )
+    err_path: str = Field(
+        default="{app_name}.json.err.log", 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_factory=lambda: os.path.join(os.getcwd(), "logs"),
+        min_length=2,
+        max_length=1024,
+    )
+    rotate_size: int = Field(
+        default=10_000_000, ge=1_000, lt=1_000_000_000  # 10MB = 10 * 1000 * 1000
+    )
+    rotate_time: datetime.time = Field(default_factory=lambda: datetime.time(0, 0, 0))
+    backup_count: int = Field(default=90, ge=1)
+    encoding: str = Field(default="utf8", min_length=2, max_length=31)
+    log_handlers: LogHandlersConfigPM = Field(default_factory=LogHandlersConfigPM)
+    json_handlers: JsonHandlersConfigPM = Field(default_factory=JsonHandlersConfigPM)
+
+    @field_validator("rotate_time", mode="before")
+    @classmethod
+    def _check_rotate_time(cls, val: Any) -> Any:
+        if isinstance(val, str):
+            val = datetime.time.fromisoformat(val)
+
+        return val
+
+
+class AutoLoadConfigPM(ExtraBaseModel):
+    enabled: bool = Field(default=True)
+    only_base: bool = Field(default=False)
+    ignore_modules: list[str] = Field(default=[])
+
+
+class InterceptConfigPM(ExtraBaseModel):
+    auto_load: AutoLoadConfigPM = Field(default_factory=AutoLoadConfigPM)
+    include_modules: list[str] = Field(default=[])
+    mute_modules: list[str] = Field(default=[])
+
+
+class ExtraConfigPM(ExtraBaseModel):
+    pass
+
+
+class LoggerConfigPM(ExtraBaseModel):
+    app_name: str = Field(default_factory=get_slug_name, min_length=1, max_length=128)
+    level: LogLevelEnum = Field(default=LogLevelEnum.INFO)
+    use_backtrace: bool = Field(default=True)
+    use_diagnose: bool = Field(default=False)
+    stream: StreamConfigPM = Field(default_factory=StreamConfigPM)
+    file: FileConfigPM = Field(default_factory=FileConfigPM)
+    intercept: InterceptConfigPM = Field(default_factory=InterceptConfigPM)
+    extra: ExtraConfigPM | None = Field(default_factory=ExtraConfigPM)
+
+
+__all__ = [
+    "StdHandlerConfigPM",
+    "StreamConfigPM",
+    "LogHandlersConfigPM",
+    "JsonHandlersConfigPM",
+    "FileConfigPM",
+    "AutoLoadConfigPM",
+    "InterceptConfigPM",
+    "LoggerConfigPM",
+]

{beans_logging-6.0.2 → beans_logging-6.0.3/src/beans_logging.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging
-Version: 6.0.2
+Version: 6.0.3
 Summary: 'beans-logging' is a python package for simple logger and easily managing logs.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-python-logging

{beans_logging-6.0.2 → beans_logging-6.0.3}/src/beans_logging.egg-info/SOURCES.txt

@@ -1,7 +1,6 @@
 .python-version
 LICENSE.txt
 README.md
-auto.py
 pyproject.toml
 requirements.txt
 setup.cfg
@@ -20,14 +19,14 @@ requirements/requirements.test.txt
 src/beans_logging/__init__.py
 src/beans_logging/__version__.py
 src/beans_logging/_base.py
-src/beans_logging/_consts.py
+src/beans_logging/_constants.py
 src/beans_logging/_handlers.py
 src/beans_logging/_utils.py
 src/beans_logging/auto.py
+src/beans_logging/config.py
 src/beans_logging/filters.py
 src/beans_logging/formats.py
 src/beans_logging/rotation.py
-src/beans_logging/schemas.py
 src/beans_logging/sinks.py
 src/beans_logging.egg-info/PKG-INFO
 src/beans_logging.egg-info/SOURCES.txt

beans_logging-6.0.2/auto.py

@@ -1,6 +0,0 @@
-# flake8: noqa
-
-try:
-    from .src.beans_logging.auto import *
-except ImportError:
-    from src.beans_logging.auto import *

beans_logging-6.0.2/src/beans_logging/__version__.py

@@ -1 +0,0 @@
-__version__ = "6.0.2"

beans_logging-6.0.2/src/beans_logging/schemas.py

@@ -1,173 +0,0 @@
-import datetime
-
-
-import pydantic
-from pydantic import BaseModel, constr, Field
-
-if "2.0.0" <= pydantic.__version__:
-    from pydantic import field_validator, model_validator, ConfigDict
-else:
-    from pydantic import validator, root_validator
-
-
-from ._consts import LogLevelEnum
-from ._utils import get_default_logs_dir, get_app_name
-
-
-class ExtraBaseModel(BaseModel):
-    if "2.0.0" <= pydantic.__version__:
-        model_config = ConfigDict(extra="allow")
-    else:
-
-        class Config:
-            extra = "allow"
-
-
-class StdHandlerPM(ExtraBaseModel):
-    enabled: bool = Field(default=True)
-
-
-class StreamPM(ExtraBaseModel):
-    use_color: bool = Field(default=True)
-    use_icon: bool = Field(default=False)
-    format_str: constr(strip_whitespace=True) = Field(
-        default=(
-            "[<c>{time:YYYY-MM-DD HH:mm:ss.SSS Z}</c> | <level>{level_short:<5}</level> | <w>{name}:{line}</w>]: "
-            "<level>{message}</level>"
-        ),
-        min_length=3,
-        max_length=511,
-    )
-    std_handler: StdHandlerPM = Field(default_factory=StdHandlerPM)
-
-
-class LogHandlersPM(ExtraBaseModel):
-    enabled: bool = Field(default=False)
-    format_str: constr(strip_whitespace=True) = Field(
-        default="[{time:YYYY-MM-DD HH:mm:ss.SSS Z} | {level_short:<5} | {name}:{line}]: {message}",
-        min_length=4,
-        max_length=511,
-    )
-    log_path: constr(strip_whitespace=True) = Field(
-        default="{app_name}.std.all.log", min_length=4, max_length=1023
-    )
-    err_path: constr(strip_whitespace=True) = Field(
-        default="{app_name}.std.err.log", min_length=4, max_length=1023
-    )
-
-    if "2.0.0" <= pydantic.__version__:
-
-        @model_validator(mode="after")
-        def _check_log_path(self) -> "LogHandlersPM":
-            if self.log_path == self.err_path:
-                raise ValueError(
-                    f"`log_path` and `err_path` attributes are same: '{self.log_path}', must be different!"
-                )
-            return self
-
-    else:
-
-        @root_validator
-        def _check_log_path(cls, values):
-            _log_path, _err_path = values.get("log_path"), values.get("err_path")
-            if _log_path == _err_path:
-                raise ValueError(
-                    f"`log_path` and `err_path` attributes are same: '{_log_path}', must be different!"
-                )
-            return values
-
-
-class JsonHandlersPM(ExtraBaseModel):
-    enabled: bool = Field(default=False)
-    use_custom: bool = Field(default=False)
-    log_path: constr(strip_whitespace=True) = Field(
-        default="{app_name}.json.all.log", min_length=4, max_length=1023
-    )
-    err_path: constr(strip_whitespace=True) = Field(
-        default="{app_name}.json.err.log", min_length=4, max_length=1023
-    )
-
-    if "2.0.0" <= pydantic.__version__:
-
-        @model_validator(mode="after")
-        def _check_log_path(self) -> "JsonHandlersPM":
-            if self.log_path == self.err_path:
-                raise ValueError(
-                    f"`log_path` and `err_path` attributes are same: '{self.log_path}', must be different!"
-                )
-            return self
-
-    else:
-
-        @root_validator
-        def _check_log_path(cls, values):
-            _log_path, _err_path = values.get("log_path"), values.get("err_path")
-            if _log_path == _err_path:
-                raise ValueError(
-                    f"`log_path` and `err_path` attributes are same: '{_log_path}', must be different!"
-                )
-            return values
-
-
-class FilePM(ExtraBaseModel):
-    logs_dir: constr(strip_whitespace=True) = Field(
-        default_factory=get_default_logs_dir, min_length=2, max_length=1023
-    )
-    rotate_size: int = Field(
-        default=10_000_000, ge=1_000, lt=1_000_000_000  # 10MB = 10 * 1000 * 1000
-    )
-    rotate_time: datetime.time = Field(datetime.time(0, 0, 0))
-    backup_count: int = Field(default=90, ge=1)
-    encoding: constr(strip_whitespace=True) = Field(
-        default="utf8", min_length=2, max_length=31
-    )
-    log_handlers: LogHandlersPM = Field(default_factory=LogHandlersPM)
-    json_handlers: JsonHandlersPM = Field(default_factory=JsonHandlersPM)
-
-    if "2.0.0" <= pydantic.__version__:
-
-        @field_validator("rotate_time", mode="before")
-        @classmethod
-        def _check_rotate_time(cls, val):
-            if isinstance(val, str):
-                val = datetime.time.fromisoformat(val)
-            return val
-
-    else:
-
-        @validator("rotate_time", pre=True, always=True)
-        def _check_rotate_time(cls, val):
-            if val and isinstance(val, str):
-                val = datetime.time.fromisoformat(val)
-            return val
-
-
-class AutoLoadPM(ExtraBaseModel):
-    enabled: bool = Field(default=True)
-    only_base: bool = Field(default=False)
-    ignore_modules: list[str] = Field(default=[])
-
-
-class InterceptPM(ExtraBaseModel):
-    auto_load: AutoLoadPM = Field(default_factory=AutoLoadPM)
-    include_modules: list[str] = Field(default=[])
-    mute_modules: list[str] = Field(default=[])
-
-
-class ExtraPM(ExtraBaseModel):
-    pass
-
-
-class LoggerConfigPM(ExtraBaseModel):
-    app_name: constr(strip_whitespace=True) = Field(
-        default_factory=get_app_name,
-        min_length=1,
-        max_length=127,
-    )
-    level: LogLevelEnum = Field(default=LogLevelEnum.INFO)
-    use_backtrace: bool = Field(default=True)
-    use_diagnose: bool = Field(default=False)
-    stream: StreamPM = Field(default_factory=StreamPM)
-    file: FilePM = Field(default_factory=FilePM)
-    intercept: InterceptPM = Field(default_factory=InterceptPM)
-    extra: ExtraPM = Field(default_factory=ExtraPM)