custom-python-logger 2.0.0__tar.gz → 2.0.2__tar.gz

{custom_python_logger-2.0.0/custom_python_logger.egg-info → custom_python_logger-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 2.0.0
+Version: 2.0.2
 Summary: A custom logger with color support and additional features.
 Home-page: https://github.com/aviz92/custom-python-logger
 Author: Avi Zaguri

custom_python_logger-2.0.2/custom_python_logger/consts.py

@@ -0,0 +1,16 @@
+from enum import Enum
+
+LOG_COLORS = {
+    "DEBUG": "white",
+    "INFO": "green",
+    "WARNING": "yellow",
+    "STEP": "blue",
+    "ERROR": "red,bold",
+    "EXCEPTION": "light_red,bold",
+    "CRITICAL": "red,bg_white",
+}
+
+
+class CustomLoggerLevel(Enum):
+    EXCEPTION = 45
+    STEP = 25

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2}/custom_python_logger/logger.py

@@ -2,20 +2,39 @@ import json
 import logging
 import os
 import time
-from logging import Logger, LoggerAdapter
+from logging import Logger
 from pathlib import Path
 from typing import Any, Callable, Optional
 
 import yaml
 from colorlog import ColoredFormatter
 
+from custom_python_logger.consts import LOG_COLORS, CustomLoggerLevel
 
-def get_project_path_by_file(marker: str = ".git") -> Path:
+
+def json_pretty_format(
+    data: Any, indent: int = 4, sort_keys: bool = True, default: Callable = None
+) -> str:
+    return json.dumps(data, indent=indent, sort_keys=sort_keys, default=default)
+
+
+def yaml_pretty_format(
+    data: Any, indent: int = 4, sort_keys: bool = False, allow_unicode=True
+) -> str:
+    return yaml.dump(
+        data, sort_keys=sort_keys, indent=indent, allow_unicode=allow_unicode
+    )
+
+
+def get_project_path_by_file(markers: Optional[list[str]] = None) -> Path:
+    if not markers:
+        markers = ["pyproject.toml", "setup.py", ".git", "requirements.txt", ".gitignore", ".github", ".gitlab"]
     path = Path(__file__).resolve()
     for parent in path.parents:
-        if (parent / marker).exists():
-            return parent
-    raise RuntimeError(f"Project root with marker '{marker}' not found.")
+        for marker in markers:
+            if (parent / marker).exists():
+                return parent
+    raise RuntimeError(f'Project root with one of the markers: "{markers}" not found.')
 
 
 def print_before_logger(project_name: str) -> None:
@@ -30,16 +49,55 @@ def print_before_logger(project_name: str) -> None:
 
 class CustomLoggerAdapter(logging.LoggerAdapter):
     def exception(self, msg: str, *args, **kwargs):
-        level_no = 45
-        logging.addLevelName(level_no, "EXCEPTION")
+        logging.addLevelName(CustomLoggerLevel.EXCEPTION.value, "EXCEPTION")
         kwargs.setdefault("stacklevel", 2)
-        self.log(level_no, msg, *args, exc_info=True, **kwargs)
+        self.log(CustomLoggerLevel.EXCEPTION.value, msg, *args, exc_info=True, **kwargs)
 
     def step(self, msg: str, *args, **kwargs):
-        level_no = 25
-        logging.addLevelName(level_no, "STEP")
+        logging.addLevelName(CustomLoggerLevel.STEP.value, "STEP")
         kwargs.setdefault("stacklevel", 2)
-        self.log(level_no, msg, *args, exc_info=False, **kwargs)
+        self.log(CustomLoggerLevel.STEP.value, msg, *args, exc_info=False, **kwargs)
+
+
+def clear_existing_handlers(logger: Logger) -> None:
+    for handler in logger.handlers[:]:
+        logger.removeHandler(handler)
+
+
+def add_file_handler_if_specified(
+    logger: Logger,
+    log_file: bool,
+    log_file_path: Optional[str],
+    log_format: str,
+) -> None:
+    if log_file and log_file_path is not None:
+        log_file_formatter = logging.Formatter(log_format)
+
+        # Create directory if it doesn't exist
+        log_dir = os.path.dirname(log_file_path)
+        if log_dir and not os.path.exists(log_dir):
+            os.makedirs(log_dir)
+
+        file_handler = logging.FileHandler(log_file_path)
+
+        file_handler.setFormatter(log_file_formatter)
+        logger.addHandler(file_handler)
+
+
+def add_console_handler_if_specified(
+    logger: Logger,
+    console_output: bool,
+    log_format: str
+):
+    if console_output:
+        log_console_formatter = ColoredFormatter(
+            "%(log_color)s " + log_format,
+            log_colors=LOG_COLORS,
+        )
+
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(log_console_formatter)
+        logger.addHandler(console_handler)
 
 
 def configure_logging(
@@ -67,49 +125,26 @@ def configure_logging(
     root_logger = logging.getLogger()
     root_logger.setLevel(log_level)
 
-    # Clear existing handlers
-    for handler in root_logger.handlers[:]:
-        root_logger.removeHandler(handler)
+    clear_existing_handlers(logger=root_logger)
 
-    # Add file handler if specified
-    if log_file and log_file_path is not None:
-        log_file_formatter = logging.Formatter(log_format)
-
-        # Create directory if it doesn't exist
-        log_dir = os.path.dirname(log_file_path)
-        if log_dir and not os.path.exists(log_dir):
-            os.makedirs(log_dir)
-
-        file_handler = logging.FileHandler(log_file_path)
-
-        file_handler.setFormatter(log_file_formatter)
-        root_logger.addHandler(file_handler)
-
-    # Add console handler if specified
-    if console_output:
-        # log_console_formatter = logging.Formatter('%(log_color)s ' + log_format)
-        log_console_formatter = ColoredFormatter(
-            "%(log_color)s " + log_format,
-            log_colors={
-                "DEBUG": "white",
-                "INFO": "green",
-                "WARNING": "yellow",
-                "STEP": "blue",
-                "ERROR": "red,bold",
-                "EXCEPTION": "light_red,bold",
-                "CRITICAL": "red,bg_white",
-            },
-        )
+    add_file_handler_if_specified(
+        logger=root_logger,
+        log_file=log_file,
+        log_file_path=log_file_path,
+        log_format=log_format,
+    )
 
-        console_handler = logging.StreamHandler()
-        console_handler.setFormatter(log_console_formatter)
-        root_logger.addHandler(console_handler)
+    add_console_handler_if_specified(
+        logger=root_logger,
+        console_output=console_output,
+        log_format=log_format,
+    )
 
 
 def build_logger(
     project_name: str,
     extra: Optional[dict[str, Any]] = None,
-    log_format: str = "%(asctime)s | %(levelname)-10s(l.%(levelno)s) | %(name)s | %(filename)s:%(lineno)s | %(message)s",
+    log_format: str = "%(asctime)s | %(levelname)-9s | l.%(levelno)s | %(name)s | %(filename)s:%(lineno)s | %(message)s",
     log_level: int = logging.INFO,
     log_file: bool = False,
     log_file_path: str = None,
@@ -128,12 +163,9 @@ def build_logger(
         log_file_path: Path to log file (if None, no file logging)
         console_output: Whether to output logs to console
         utc: Whether to use UTC time for log timestamps
-
     Returns:
         Configured logger
     """
-    print_before_logger(project_name=project_name)
-
     if not log_file_path:
         log_file_path = f"{get_project_path_by_file()}/logs/{project_name}.log"
         log_file_path = log_file_path.lower().replace(" ", "_")
@@ -147,7 +179,7 @@ def build_logger(
         utc=utc,
     )
 
-    logger = logging.getLogger()
+    logger = logging.getLogger(project_name)
 
     if log_level is not None:
         logger.setLevel(log_level)
@@ -155,19 +187,5 @@ def build_logger(
     return CustomLoggerAdapter(logger, extra)
 
 
-def get_logger(name: str) -> CustomLoggerAdapter:
-    return CustomLoggerAdapter(logging.getLogger(name), {})
-
-
-def json_pretty_format(
-    data: Any, indent: int = 4, sort_keys: bool = True, default: Callable = None
-) -> str:
-    return json.dumps(data, indent=indent, sort_keys=sort_keys, default=default)
-
-
-def yaml_pretty_format(
-    data: Any, indent: int = 4, sort_keys: bool = False, allow_unicode=True
-) -> str:
-    return yaml.dump(
-        data, sort_keys=sort_keys, indent=indent, allow_unicode=allow_unicode
-    )
+def get_logger(name: str, extra: Optional[dict] = None) -> CustomLoggerAdapter:
+    return CustomLoggerAdapter(logging.getLogger(name), extra=extra)

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2}/custom_python_logger/usage_example.py

@@ -5,7 +5,7 @@ from custom_python_logger import build_logger, get_logger
 
 class LoggerTest:
     def __init__(self):
-        self.logger = get_logger(self.__class__.__name__)
+        self.logger = get_logger(self.__class__.__name__, extra={"class": self.__class__.__name__})
 
     def main(self):
         self.logger.debug("Hello World")

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2/custom_python_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 2.0.0
+Version: 2.0.2
 Summary: A custom logger with color support and additional features.
 Home-page: https://github.com/aviz92/custom-python-logger
 Author: Avi Zaguri

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2}/custom_python_logger.egg-info/SOURCES.txt

@@ -5,6 +5,7 @@ pyproject.toml
 requirements.txt
 setup.py
 custom_python_logger/__init__.py
+custom_python_logger/consts.py
 custom_python_logger/logger.py
 custom_python_logger/usage_example.py
 custom_python_logger.egg-info/PKG-INFO

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-package_version = '2.0.0'
+package_version = '2.0.2'
 
 package_name = 'custom-python-logger'
 package_description = 'A custom logger with color support and additional features.'

{custom_python_logger-2.0.0 → custom_python_logger-2.0.2}/custom_python_logger/__init__.py

@@ -7,9 +7,9 @@ from custom_python_logger.logger import (
 )
 
 __all__ = [
+    "CustomLoggerAdapter",
     "build_logger",
     "get_logger",
-    "CustomLoggerAdapter",
     "json_pretty_format",
     "yaml_pretty_format",
 ]