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

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: beans_logging
-Version: 6.0.1
-Summary: 'beans-logging' is a python package for simple logger and easily managing logging.
+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
 Project-URL: Documentation, https://pylogging-docs.bybatkhuu.dev
@@ -100,7 +100,7 @@ It is a `Loguru` based custom logging package for python projects.
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -213,7 +213,7 @@ logger.info("Logging info.")
 
 ### **Simple**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/configs/logger.yml):
+[**`configs/logger.yml`**](./examples/simple/configs/logger.yml):
 
 ```yml
 logger:
@@ -226,9 +226,11 @@ logger:
       enabled: true
 ```
 
-[**`main.py`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/main.py):
+[**`main.py`**](./examples/simple/main.py):
 
 ```python
+#!/usr/bin/env python
+
 from beans_logging.auto import logger
 
 
@@ -240,10 +242,12 @@ logger.warning("Warning something.")
 logger.error("Error occured.")
 logger.critical("CRITICAL ERROR.")
 
+
 def divide(a, b):
     _result = a / b
     return _result
 
+
 def nested(c):
     try:
         divide(5, c)
@@ -251,13 +255,14 @@ def nested(c):
         logger.error(err)
         raise
 
+
 try:
     nested(0)
-except Exception as err:
+except Exception:
     logger.exception("Show me, what value is wrong:")
 ```
 
-Run the [**`examples/simple`**](https://github.com/bybatkhuu/module-python-logging/tree/main/examples/simple):
+Run the [**`examples/simple`**](./examples/simple):
 
 ```sh
 cd ./examples/simple
@@ -303,7 +308,7 @@ ZeroDivisionError: division by zero
 
 ## ⚙️ Configuration
 
-[**`templates/configs/config.yml`**](./templates/configs/config.yml):
+[**`templates/configs/logger.yml`**](./templates/configs/logger.yml):
 
 ```yaml
 logger:

{beans_logging-6.0.1 → beans_logging-6.0.3}/README.md

@@ -38,7 +38,7 @@ It is a `Loguru` based custom logging package for python projects.
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -151,7 +151,7 @@ logger.info("Logging info.")
 
 ### **Simple**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/configs/logger.yml):
+[**`configs/logger.yml`**](./examples/simple/configs/logger.yml):
 
 ```yml
 logger:
@@ -164,9 +164,11 @@ logger:
       enabled: true
 ```
 
-[**`main.py`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/main.py):
+[**`main.py`**](./examples/simple/main.py):
 
 ```python
+#!/usr/bin/env python
+
 from beans_logging.auto import logger
 
 
@@ -178,10 +180,12 @@ logger.warning("Warning something.")
 logger.error("Error occured.")
 logger.critical("CRITICAL ERROR.")
 
+
 def divide(a, b):
     _result = a / b
     return _result
 
+
 def nested(c):
     try:
         divide(5, c)
@@ -189,13 +193,14 @@ def nested(c):
         logger.error(err)
         raise
 
+
 try:
     nested(0)
-except Exception as err:
+except Exception:
     logger.exception("Show me, what value is wrong:")
 ```
 
-Run the [**`examples/simple`**](https://github.com/bybatkhuu/module-python-logging/tree/main/examples/simple):
+Run the [**`examples/simple`**](./examples/simple):
 
 ```sh
 cd ./examples/simple
@@ -241,7 +246,7 @@ ZeroDivisionError: division by zero
 
 ## ⚙️ Configuration
 
-[**`templates/configs/config.yml`**](./templates/configs/config.yml):
+[**`templates/configs/logger.yml`**](./templates/configs/logger.yml):
 
 ```yaml
 logger:

{beans_logging-6.0.1 → beans_logging-6.0.3}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "beans_logging"
 authors = [{ name = "Batkhuu Byambajav", email = "batkhuu10@gmail.com" }]
-description = "'beans-logging' is a python package for simple logger and easily managing logging."
+description = "'beans-logging' is a python package for simple logger and easily managing logs."
 readme = "README.md"
 requires-python = ">=3.10,<4.0"
 keywords = [

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

@@ -1,8 +1,6 @@
-# -*- coding: utf-8 -*-
-
 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.1 → beans_logging-6.0.3}/src/beans_logging/_base.py

@@ -1,28 +1,21 @@
-# -*- coding: utf-8 -*-
-
-## Standard libraries
+# Standard libraries
 import os
 import copy
 import json
 import logging
-from typing import Union, Dict, Any
+from typing import Any
 
-## Third-party libraries
+# Third-party libraries
 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
+# 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 (
@@ -67,7 +60,7 @@ class LoggerLoader:
     @validate_call
     def __init__(
         self,
-        config: Union[LoggerConfigPM, Dict[str, Any], None] = None,
+        config: LoggerConfigPM | dict[str, Any] | None = None,
         config_file_path: str = _CONFIG_FILE_PATH,
         auto_config_file: bool = True,
         auto_load: bool = False,
@@ -75,12 +68,14 @@ class LoggerLoader:
         """LoggerLoader constructor method.
 
         Args:
-            config           (Union[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 `LoggerLoader._CONFIG_FILE_PATH`.
-            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 handlers or not. Defaults to False.
+            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
+                                                                            `LoggerLoader._CONFIG_FILE_PATH`.
+            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
+                                                                            handlers or not. Defaults to False.
         """
 
         self.handlers_map = {"default": 0}
@@ -125,9 +120,7 @@ class LoggerLoader:
         return logger
 
     @validate_call
-    def remove_handler(
-        self, handler: Union[str, None] = None, handler_type: str = "NAME"
-    ):
+    def remove_handler(self, handler: str | None = None, handler_type: str = "NAME"):
         """Remove all handlers or specific handler by name or id from logger.
 
         Raises:
@@ -162,7 +155,7 @@ class LoggerLoader:
         self.handlers_map.clear()
 
     @validate_call
-    def update_config(self, config: Union[LoggerConfigPM, Dict[str, Any]]):
+    def update_config(self, config: LoggerConfigPM | dict[str, Any]):
         """Update logger config with new config.
 
         Args:
@@ -173,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)
@@ -213,13 +202,11 @@ class LoggerLoader:
         # elif self.config_file_path.lower().endswith(".toml"):
         #     _file_format = "TOML"
 
-        ## Loading config from file, if it's exits:
+        # Loading config from file, if it's exits:
         if os.path.isfile(self.config_file_path):
             if _file_format == "YAML":
                 try:
-                    with open(
-                        self.config_file_path, "r", encoding="utf-8"
-                    ) as _config_file:
+                    with open(self.config_file_path, encoding="utf-8") as _config_file:
                         _new_config_dict = yaml.safe_load(_config_file) or {}
                         if "logger" not in _new_config_dict:
                             logger.warning(
@@ -228,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)
@@ -242,9 +226,7 @@ class LoggerLoader:
                     raise
             elif _file_format == "JSON":
                 try:
-                    with open(
-                        self.config_file_path, "r", encoding="utf-8"
-                    ) as _config_file:
+                    with open(self.config_file_path, encoding="utf-8") as _config_file:
                         _new_config_dict = json.load(_config_file) or {}
                         if "logger" not in _new_config_dict:
                             logger.warning(
@@ -253,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)
@@ -280,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)
@@ -296,7 +272,7 @@ class LoggerLoader:
     def _check_env(self):
         """Check environment variables for logger config."""
 
-        ## Checking environment for DEBUG option:
+        # Checking environment for DEBUG option:
         _is_debug = False
         _ENV = str(os.getenv("ENV")).strip().lower()
         _DEBUG = str(os.getenv("DEBUG")).strip().lower()
@@ -314,7 +290,7 @@ class LoggerLoader:
             self.config.file.logs_dir = os.getenv("BEANS_LOGGING_LOGS_DIR")
 
         # if self.config.stream.use_color:
-        #     ## Checking terminal could support xterm colors:
+        #     # Checking terminal could support xterm colors:
         #     _TERM = str(os.getenv("TERM")).strip()
         #     if not "xterm" in _TERM:
         #         self.config.stream.use_color = False
@@ -536,7 +512,7 @@ class LoggerLoader:
 
         _intercept_handler = InterceptHandler()
 
-        ## Intercepting all logs from standard (root logger) logging:
+        # Intercepting all logs from standard (root logger) logging:
         logging.basicConfig(handlers=[_intercept_handler], level=0, force=True)
 
         _intercepted_modules = set()
@@ -579,10 +555,10 @@ class LoggerLoader:
             f"Intercepted modules: {list(_intercepted_modules)}; Muted modules: {list(_muted_modules)};"
         )
 
-    ### ATTRIBUTES ###
-    ## handlers_map ##
+    # ATTRIBUTES #
+    # handlers_map
     @property
-    def handlers_map(self) -> Dict[str, int]:
+    def handlers_map(self) -> dict[str, int]:
         try:
             return self.__handlers_map
         except AttributeError:
@@ -591,7 +567,7 @@ class LoggerLoader:
         return self.__handlers_map
 
     @handlers_map.setter
-    def handlers_map(self, handlers_map: Dict[str, int]):
+    def handlers_map(self, handlers_map: dict[str, int]):
         if not isinstance(handlers_map, dict):
             raise TypeError(
                 f"`handlers_map` attribute type {type(handlers_map)} is invalid, must be <dict>!."
@@ -599,9 +575,9 @@ class LoggerLoader:
 
         self.__handlers_map = copy.deepcopy(handlers_map)
 
-    ## handlers_map ##
+    # handlers_map
 
-    ## config ##
+    # config
     @property
     def config(self) -> LoggerConfigPM:
         try:
@@ -620,9 +596,9 @@ class LoggerLoader:
 
         self.__config = copy.deepcopy(config)
 
-    ## config ##
+    # config
 
-    ## config_file_path ##
+    # config_file_path
     @property
     def config_file_path(self) -> str:
         try:
@@ -648,11 +624,13 @@ class LoggerLoader:
         ):
             if not config_file_path.lower().endswith(".toml"):
                 raise NotImplementedError(
-                    f"`config_file_path` attribute value '{config_file_path}' is invalid, TOML file format is not supported yet!"
+                    f"`config_file_path` attribute value '{config_file_path}' is invalid, "
+                    f"TOML file format is not supported yet!"
                 )
 
             raise ValueError(
-                f"`config_file_path` attribute value '{config_file_path}' is invalid, file must be '.yml', '.yaml' or '.json' format!"
+                f"`config_file_path` attribute value '{config_file_path}' is invalid, "
+                f"file must be '.yml', '.yaml' or '.json' format!"
             )
 
         if not os.path.isabs(config_file_path):
@@ -660,5 +638,5 @@ class LoggerLoader:
 
         self.__config_file_path = config_file_path
 
-    ## config_file_path ##
-    ### ATTRIBUTES ###
+    # config_file_path
+    # ATTRIBUTES #

beans_logging-6.0.1/src/beans_logging/_consts.py → beans_logging-6.0.3/src/beans_logging/_constants.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 from enum import Enum
 
 

{beans_logging-6.0.1 → beans_logging-6.0.3}/src/beans_logging/_handlers.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 import sys
 import logging
 from logging import LogRecord
@@ -25,13 +23,13 @@ class InterceptHandler(logging.Handler):
             record (LogRecord, required): Log needs to be handled.
         """
 
-        ## Get corresponding Loguru level if it exists
+        # Get corresponding Loguru level if it exists
         try:
             _level = logger.level(record.levelname).name
         except ValueError:
             _level = record.levelno
 
-        ## Find caller from where originated the logged message
+        # Find caller from where originated the logged message
         _frame, _depth = sys._getframe(6), 6
         while _frame and _frame.f_code.co_filename == logging.__file__:
             _frame = _frame.f_back

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

@@ -1,19 +1,12 @@
-# -*- coding: utf-8 -*-
-
 import os
 import sys
 import copy
 import errno
 
 from loguru 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
 
-from ._consts import WarnEnum
+from ._constants import WarnEnum
 
 
 @validate_call
@@ -22,7 +15,8 @@ def create_dir(create_dir: str, warn_mode: WarnEnum = WarnEnum.DEBUG):
 
     Args:
         create_dir (str, required): Create directory path.
-        warn_mode  (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'. Defaults to "DEBUG".
+        warn_mode  (str, optional): Warning message mode, for example: 'ERROR', 'ALWAYS', 'DEBUG', 'IGNORE'.
+                                        Defaults to "DEBUG".
     """
 
     if not os.path.isdir(create_dir):
@@ -75,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.1 → beans_logging-6.0.3}/src/beans_logging/auto.py

@@ -1,11 +1,10 @@
-# -*- coding: utf-8 -*-
+# flake8: noqa
 
 import os
-from typing import Union
 
 from . import *
 
-logger_loader: Union[LoggerLoader, None] = None
+logger_loader: LoggerLoader | None = None
 _DISABLE_DEFAULT_LOGGER = (
     str(os.getenv("BEANS_LOGGING_DISABLE_DEFAULT")).strip().lower()
 )

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.1 → beans_logging-6.0.3}/src/beans_logging/filters.py

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-
-
 def add_level_short(record: dict) -> dict:
     """Filter for adding short level name to log record.
 

{beans_logging-6.0.1 → beans_logging-6.0.3}/src/beans_logging/formats.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 import json
 import traceback
 

{beans_logging-6.0.1 → beans_logging-6.0.3}/src/beans_logging/rotation.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 import datetime
 from typing import TextIO
 
@@ -35,8 +33,8 @@ class RotationChecker:
         )
 
         if _current_dtime >= self._dtime_limit:
-            ## The current time is already past the target time so it would rotate already.
-            ## Add one day to prevent an immediate rotation.
+            # The current time is already past the target time so it would rotate already.
+            # Add one day to prevent an immediate rotation.
             self._dtime_limit += datetime.timedelta(days=1)
 
     def should_rotate(self, message: Message, file: TextIO) -> bool:

{beans_logging-6.0.1 → beans_logging-6.0.3}/src/beans_logging/sinks.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 import sys
 
 from loguru._handler import Message

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: beans_logging
-Version: 6.0.1
-Summary: 'beans-logging' is a python package for simple logger and easily managing logging.
+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
 Project-URL: Documentation, https://pylogging-docs.bybatkhuu.dev
@@ -100,7 +100,7 @@ It is a `Loguru` based custom logging package for python projects.
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -213,7 +213,7 @@ logger.info("Logging info.")
 
 ### **Simple**
 
-[**`configs/logger.yml`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/configs/logger.yml):
+[**`configs/logger.yml`**](./examples/simple/configs/logger.yml):
 
 ```yml
 logger:
@@ -226,9 +226,11 @@ logger:
       enabled: true
 ```
 
-[**`main.py`**](https://github.com/bybatkhuu/module-python-logging/blob/main/examples/simple/main.py):
+[**`main.py`**](./examples/simple/main.py):
 
 ```python
+#!/usr/bin/env python
+
 from beans_logging.auto import logger
 
 
@@ -240,10 +242,12 @@ logger.warning("Warning something.")
 logger.error("Error occured.")
 logger.critical("CRITICAL ERROR.")
 
+
 def divide(a, b):
     _result = a / b
     return _result
 
+
 def nested(c):
     try:
         divide(5, c)
@@ -251,13 +255,14 @@ def nested(c):
         logger.error(err)
         raise
 
+
 try:
     nested(0)
-except Exception as err:
+except Exception:
     logger.exception("Show me, what value is wrong:")
 ```
 
-Run the [**`examples/simple`**](https://github.com/bybatkhuu/module-python-logging/tree/main/examples/simple):
+Run the [**`examples/simple`**](./examples/simple):
 
 ```sh
 cd ./examples/simple
@@ -303,7 +308,7 @@ ZeroDivisionError: division by zero
 
 ## ⚙️ Configuration
 
-[**`templates/configs/config.yml`**](./templates/configs/config.yml):
+[**`templates/configs/logger.yml`**](./templates/configs/logger.yml):
 
 ```yaml
 logger:

{beans_logging-6.0.1 → 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.1/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.1/src/beans_logging/__version__.py

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

beans_logging-6.0.1/src/beans_logging/schemas.py

@@ -1,173 +0,0 @@
-# -*- coding: utf-8 -*-
-
-import datetime
-from typing import List
-
-
-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)