beans-logging 7.0.0__tar.gz → 8.0.0__tar.gz

{beans_logging-7.0.0/src/beans_logging.egg-info → beans_logging-8.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: beans_logging
-Version: 7.0.0
+Version: 8.0.0
 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
@@ -25,7 +25,7 @@ Requires-Dist: pydantic[timezone]<3.0.0,>=2.5.3
 Requires-Dist: loguru<1.0.0,>=0.7.3
 Requires-Dist: potato_util<1.0.0,>=0.2.0
 Provides-Extra: fastapi
-Requires-Dist: beans-logging-fastapi<2.0.0,>=1.0.0; extra == "fastapi"
+Requires-Dist: beans-logging-fastapi<3.0.0,>=1.0.0; extra == "fastapi"
 Provides-Extra: test
 Requires-Dist: pytest<10.0.0,>=8.0.2; extra == "test"
 Requires-Dist: pytest-cov<8.0.0,>=5.0.0; extra == "test"
@@ -38,6 +38,7 @@ Requires-Dist: build<2.0.0,>=1.1.1; extra == "build"
 Requires-Dist: twine<7.0.0,>=6.0.1; extra == "build"
 Provides-Extra: docs
 Requires-Dist: pylint<5.0.0,>=3.0.4; extra == "docs"
+Requires-Dist: click<8.2.2,>=8.0.0; extra == "docs"
 Requires-Dist: mkdocs-material<10.0.0,>=9.5.50; extra == "docs"
 Requires-Dist: mkdocs-awesome-nav<4.0.0,>=3.0.0; extra == "docs"
 Requires-Dist: mkdocstrings[python]<2.0.0,>=0.24.3; extra == "docs"
@@ -52,6 +53,7 @@ Requires-Dist: wheel<1.0.0,>=0.43.0; extra == "dev"
 Requires-Dist: build<2.0.0,>=1.1.1; extra == "dev"
 Requires-Dist: twine<7.0.0,>=6.0.1; extra == "dev"
 Requires-Dist: pylint<5.0.0,>=3.0.4; extra == "dev"
+Requires-Dist: click<8.2.2,>=8.0.0; extra == "dev"
 Requires-Dist: mkdocs-material<10.0.0,>=9.5.50; extra == "dev"
 Requires-Dist: mkdocs-awesome-nav<4.0.0,>=3.0.0; extra == "dev"
 Requires-Dist: mkdocstrings[python]<2.0.0,>=0.24.3; extra == "dev"
@@ -102,42 +104,7 @@ It is a `Loguru` based custom logging package for python projects.
 - 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)
 
-### 2. 📥 Download or clone the repository
-
-[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
-
-**2.1.** Prepare projects directory (if not exists):
-
-```sh
-# Create projects directory:
-mkdir -pv ~/workspaces/projects
-
-# Enter into projects directory:
-cd ~/workspaces/projects
-```
-
-**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
-
-**OPTION A.** Clone the repository:
-
-```sh
-git clone https://github.com/bybatkhuu/module-python-logging.git && \
-    cd module-python-logging
-```
-
-**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
-
-```sh
-git clone git@github.com:bybatkhuu/module-python-logging.git && \
-    cd module-python-logging
-```
-
-**OPTION C.** Download source code:
-
-1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-logging/releases).
-2. Extract it into the projects directory.
-
-### 3. 📦 Install the package
+### 2. 📦 Install the package
 
 [NOTE] Choose one of the following methods to install the package **[A ~ F]**:
 
@@ -156,6 +123,9 @@ pip install git+https://github.com/bybatkhuu/module-python-logging.git
 **OPTION C.** Install from the downloaded **source code**:
 
 ```sh
+git clone https://github.com/bybatkhuu/module-python-logging.git && \
+    cd ./module-python-logging
+
 # Install directly from the source code:
 pip install .
 
@@ -323,9 +293,6 @@ 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"
@@ -333,12 +300,6 @@ logger:
       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
@@ -348,24 +309,30 @@ logger:
     mute_modules: []
   handlers:
     default.all.std_handler:
-      type: STD
       enabled: true
+      h_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
     default.all.file_handler:
-      type: FILE
       enabled: false
+      h_type: FILE
+      sink: "{app_name}.all.log"
     default.err.file_handler:
-      type: FILE
-      error: true
       enabled: false
+      h_type: FILE
+      sink: "{app_name}.err.log"
+      error: true
     default.all.json_handler:
-      type: FILE
-      serialize: true
       enabled: false
+      h_type: FILE
+      sink: "json/{app_name}.all.json.log"
+      serialize: true
     default.err.json_handler:
-      type: FILE
+      enabled: false
+      h_type: FILE
+      sink: "json/{app_name}.err.json.log"
       serialize: true
       error: true
-      enabled: false
   extra:
 ```
 
@@ -418,7 +385,7 @@ To build the documentation, run the following command:
 pip install -r ./requirements/requirements.docs.txt
 
 # Serve documentation locally (for development):
-mkdocs serve -a 0.0.0.0:8000
+mkdocs serve -a 0.0.0.0:8000 --livereload
 # Or use the docs script:
 ./scripts/docs.sh
 

{beans_logging-7.0.0 → beans_logging-8.0.0}/README.md

@@ -40,42 +40,7 @@ It is a `Loguru` based custom logging package for python projects.
 - 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)
 
-### 2. 📥 Download or clone the repository
-
-[TIP] Skip this step, if you're going to install the package directly from **PyPi** or **GitHub** repository.
-
-**2.1.** Prepare projects directory (if not exists):
-
-```sh
-# Create projects directory:
-mkdir -pv ~/workspaces/projects
-
-# Enter into projects directory:
-cd ~/workspaces/projects
-```
-
-**2.2.** Follow one of the below options **[A]**, **[B]** or **[C]**:
-
-**OPTION A.** Clone the repository:
-
-```sh
-git clone https://github.com/bybatkhuu/module-python-logging.git && \
-    cd module-python-logging
-```
-
-**OPTION B.** Clone the repository (for **DEVELOPMENT**: git + ssh key):
-
-```sh
-git clone git@github.com:bybatkhuu/module-python-logging.git && \
-    cd module-python-logging
-```
-
-**OPTION C.** Download source code:
-
-1. Download archived **zip** file from [**releases**](https://github.com/bybatkhuu/module-python-logging/releases).
-2. Extract it into the projects directory.
-
-### 3. 📦 Install the package
+### 2. 📦 Install the package
 
 [NOTE] Choose one of the following methods to install the package **[A ~ F]**:
 
@@ -94,6 +59,9 @@ pip install git+https://github.com/bybatkhuu/module-python-logging.git
 **OPTION C.** Install from the downloaded **source code**:
 
 ```sh
+git clone https://github.com/bybatkhuu/module-python-logging.git && \
+    cd ./module-python-logging
+
 # Install directly from the source code:
 pip install .
 
@@ -261,9 +229,6 @@ 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"
@@ -271,12 +236,6 @@ logger:
       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
@@ -286,24 +245,30 @@ logger:
     mute_modules: []
   handlers:
     default.all.std_handler:
-      type: STD
       enabled: true
+      h_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
     default.all.file_handler:
-      type: FILE
       enabled: false
+      h_type: FILE
+      sink: "{app_name}.all.log"
     default.err.file_handler:
-      type: FILE
-      error: true
       enabled: false
+      h_type: FILE
+      sink: "{app_name}.err.log"
+      error: true
     default.all.json_handler:
-      type: FILE
-      serialize: true
       enabled: false
+      h_type: FILE
+      sink: "json/{app_name}.all.json.log"
+      serialize: true
     default.err.json_handler:
-      type: FILE
+      enabled: false
+      h_type: FILE
+      sink: "json/{app_name}.err.json.log"
       serialize: true
       error: true
-      enabled: false
   extra:
 ```
 
@@ -356,7 +321,7 @@ To build the documentation, run the following command:
 pip install -r ./requirements/requirements.docs.txt
 
 # Serve documentation locally (for development):
-mkdocs serve -a 0.0.0.0:8000
+mkdocs serve -a 0.0.0.0:8000 --livereload
 # Or use the docs script:
 ./scripts/docs.sh
 

{beans_logging-7.0.0 → beans_logging-8.0.0}/pyproject.toml

@@ -31,11 +31,6 @@ classifiers = [
 ]
 dynamic = ["version", "dependencies", "optional-dependencies"]
 
-# [tool.setuptools.packages.find]
-# where = ["src"]
-# include = ["beans_logging*"]
-# namespaces = false
-
 [tool.setuptools.dynamic]
 version = { attr = "beans_logging.__version__.__version__" }
 dependencies = { file = "./requirements.txt" }

{beans_logging-7.0.0 → beans_logging-8.0.0}/requirements/requirements.docs.txt

@@ -1,4 +1,5 @@
 pylint>=3.0.4,<5.0.0
+click>=8.0.0,<8.2.2
 mkdocs-material>=9.5.50,<10.0.0
 mkdocs-awesome-nav>=3.0.0,<4.0.0
 mkdocstrings[python]>=0.24.3,<2.0.0

beans_logging-8.0.0/requirements/requirements.fastapi.txt

@@ -0,0 +1 @@
+beans-logging-fastapi>=1.0.0,<3.0.0

{beans_logging-7.0.0 → beans_logging-8.0.0}/src/beans_logging/__init__.py

@@ -1,12 +1,16 @@
 from __future__ import annotations
 
 from .__version__ import __version__
-from .config import LoggerConfigPM
+from .schemas import LoguruHandlerPM, LogHandlerPM
+from .config import get_default_handlers, LoggerConfigPM
 from ._core import Logger, logger, LoggerLoader
 
 
 __all__ = [
     "__version__",
+    "LoguruHandlerPM",
+    "LogHandlerPM",
+    "get_default_handlers",
     "LoggerConfigPM",
     "Logger",
     "logger",

beans_logging-8.0.0/src/beans_logging/__version__.py

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

beans_logging-8.0.0/src/beans_logging/_builder.py

@@ -0,0 +1,132 @@
+import os
+from typing import Any
+from pathlib import Path
+
+from pydantic import validate_call
+
+from .constants import LogHandlerTypeEnum, LogLevelEnum
+from .schemas import LogHandlerPM
+from .config import LoggerConfigPM
+from .sinks import std_sink
+from .formats import json_formatter
+from .filters import (
+    use_all_filter,
+    use_std_filter,
+    use_file_filter,
+    use_file_err_filter,
+    use_file_json_filter,
+    use_file_json_err_filter,
+)
+from .rotators import Rotator
+
+
+@validate_call
+def build_handler(handler: LogHandlerPM, config: LoggerConfigPM) -> dict[str, Any]:
+    """Build handler config as dictionary for Loguru logger to add new handler.
+
+    Args:
+        handler (LogHandlerPM  , required): Target log handler model.
+        config  (LoggerConfigPM, required): Default main config model to fill missing values.
+
+    Raises:
+        ValueError: 'sink' attribute is empty, required for any log handler except std and file handlers!
+
+    Returns:
+        dict[str, Any]: Loguru handler config as dictionary.
+    """
+
+    if handler.sink is None:
+        if handler.h_type == LogHandlerTypeEnum.STD:
+            handler.sink = std_sink
+        else:
+            raise ValueError(
+                "'sink' attribute is empty, required for any log handler except std handler!"
+            )
+
+    _sink = handler.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.sink = _sink
+
+    if handler.level is None:
+        if handler.error:
+            handler.level = config.default.level.err
+        else:
+            handler.level = config.default.level.base
+
+    if (handler.custom_serialize is None) and handler.serialize:
+        handler.custom_serialize = config.default.custom_serialize
+
+    if handler.custom_serialize:
+        handler.serialize = False
+        handler.format_ = json_formatter
+
+    if (handler.format_ is None) and (not handler.serialize):
+        handler.format_ = config.default.format_str
+
+    if handler.filter_ is None:
+        if handler.h_type == LogHandlerTypeEnum.STD:
+            handler.filter_ = use_std_filter
+        elif handler.h_type == LogHandlerTypeEnum.FILE:
+            if handler.serialize or handler.custom_serialize:
+                if handler.error:
+                    handler.filter_ = use_file_json_err_filter
+                else:
+                    handler.filter_ = use_file_json_filter
+            else:
+                if handler.error:
+                    handler.filter_ = use_file_err_filter
+                else:
+                    handler.filter_ = use_file_filter
+        else:
+            handler.filter_ = use_all_filter
+
+    if handler.backtrace is None:
+        handler.backtrace = True
+
+    if (handler.diagnose is None) and (
+        (handler.level == LogLevelEnum.TRACE) or (handler.level == 5)
+    ):
+        handler.diagnose = True
+
+    if handler.h_type == LogHandlerTypeEnum.FILE:
+        if handler.enqueue is None:
+            handler.enqueue = True
+
+        if handler.rotation is None:
+            handler.rotation = Rotator(
+                rotate_size=config.default.file.rotate_size,
+                rotate_time=config.default.file.rotate_time,
+            ).should_rotate
+
+        if handler.retention is None:
+            handler.retention = config.default.file.retention
+
+        if handler.encoding is None:
+            handler.encoding = config.default.file.encoding
+
+    _handler_dict = handler.model_dump(
+        by_alias=True,
+        exclude_none=True,
+        exclude={
+            "enabled",
+            "h_type",
+            "error",
+            "custom_serialize",
+        },
+    )
+
+    return _handler_dict
+
+
+__all__ = [
+    "build_handler",
+]

{beans_logging-7.0.0 → beans_logging-8.0.0}/src/beans_logging/_core.py

@@ -17,10 +17,11 @@ from pydantic import validate_call
 from potato_util import io as io_utils
 
 # Internal modules
+from .constants import DEFAULT_LOGURU_HANDLER_NAME, DEFAULT_NO_HANDLER_NAME_PREFIX
 from .schemas import LogHandlerPM, LoguruHandlerPM
 from .config import LoggerConfigPM
 from ._builder import build_handler
-from ._intercept import init_intercepter
+from .intercepters import add_intercepter
 
 
 class LoggerLoader:
@@ -52,7 +53,7 @@ class LoggerLoader:
         **kwargs,
     ) -> None:
 
-        self.handlers_map = {"default.loguru_handler": 0}
+        self.handlers_map = {DEFAULT_LOGURU_HANDLER_NAME: 0}
         if not config:
             config = LoggerConfigPM()
 
@@ -63,15 +64,15 @@ class LoggerLoader:
         self.config_path = config_path
 
         if auto_load:
-            self.load()
+            self.load(load_config_file=True)
 
     @validate_call
-    def load(self, load_config_file: bool = True) -> "Logger":
+    def load(self, load_config_file: bool = False) -> "Logger":
         """Load logger handlers based on logger config.
 
         Args:
             load_config_file (bool, optional): Whether to load config from file before loading handlers.
-                                                    Default is True.
+                                                    Default is False.
 
         Returns:
             Logger: Main loguru logger instance.
@@ -84,7 +85,7 @@ class LoggerLoader:
         for _key, _handler in self.config.handlers.items():
             self.add_handler(name=_key, handler=_handler)
 
-        init_intercepter(config=self.config)
+        add_intercepter(config=self.config)
         return logger
 
     def _load_config_file(self) -> None:
@@ -195,7 +196,7 @@ class LoggerLoader:
 
                 _handler_id = logger.add(**_handler_dict)
                 if not name:
-                    name = f"log_handler.{uuid.uuid4().hex}"
+                    name = f"{DEFAULT_NO_HANDLER_NAME_PREFIX}{uuid.uuid4().hex}"
 
                 self.handlers_map[name] = _handler_id