custom-python-logger 1.0.2__tar.gz → 1.0.4__tar.gz

{custom_python_logger-1.0.2/custom_python_logger.egg-info → custom_python_logger-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 1.0.2
+Version: 1.0.4
 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-1.0.4/custom_python_logger/__init__.py

@@ -0,0 +1,3 @@
+from custom_python_logger.logger import get_logger
+
+__all__ = ["get_logger", "json_pretty_format"]

custom_python_logger-1.0.4/custom_python_logger/logger.py

@@ -0,0 +1,156 @@
+# logger.py
+import json
+import logging
+import os
+import time
+from logging import LoggerAdapter, Logger
+from pathlib import Path
+from typing import Optional, Any
+from colorlog import ColoredFormatter
+
+
+def get_root_project_path() -> Path:
+    if 'venv' in str(Path(__file__)):
+        return Path(__file__).parents[5]
+    return Path(__file__).parent
+
+
+def print_before_logger(project_name: str) -> None:
+    main_string = f'Start "{project_name}" Process'
+
+    number_of_ladder = "#" * len(f"### {main_string} ###")
+    print(f"\n{number_of_ladder}")
+    print(f"### {main_string} ###")
+    print(f"{number_of_ladder}\n")
+    time.sleep(0.3)
+
+
+class CustomLoggerAdapter(logging.LoggerAdapter):
+    def exception(self, msg: str, *args, **kwargs):
+        level_no = 45
+        logging.addLevelName(level_no, "EXCEPTION")
+        kwargs.setdefault('stacklevel', 2)
+        self.log(level_no, msg, *args, exc_info=True, **kwargs)
+
+    def step(self, msg: str, *args, **kwargs):
+        level_no = 25
+        logging.addLevelName(level_no, "STEP")
+        kwargs.setdefault('stacklevel', 2)
+        self.log(level_no, msg, *args, exc_info=False, **kwargs)
+
+
+def configure_logging(
+        log_format: str,
+        utc: bool,
+        log_level: int = logging.INFO,
+        log_file: Optional[str] = None,
+        console_output: bool = True,
+) -> None:
+    """
+    Configure global logging settings.
+
+    Args:
+        log_level: Logging level (default: INFO)
+        log_format: Format string for log messages
+        log_file: 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
+    """
+    if utc:
+        logging.Formatter.converter = time.gmtime
+
+    root_logger = logging.getLogger()
+    root_logger.setLevel(log_level)
+
+    # Clear existing handlers
+    for handler in root_logger.handlers[:]:
+        root_logger.removeHandler(handler)
+
+    # Add file handler if specified
+    if log_file is not None:
+        log_file_formatter = logging.Formatter(log_format)
+
+        # Create directory if it doesn't exist
+        log_dir = os.path.dirname(log_file)
+        if log_dir and not os.path.exists(log_dir):
+            os.makedirs(log_dir)
+
+        file_handler = logging.FileHandler(log_file)
+
+        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',
+            }
+        )
+
+        console_handler = logging.StreamHandler()
+        console_handler.setFormatter(log_console_formatter)
+        root_logger.addHandler(console_handler)
+
+
+def get_logger(
+        project_name: str,
+        extra: Optional[dict[str, Any]] = None,
+        log_format: str = "%(asctime)s | %(levelname)-10s(l.%(levelno)s) | %(filename)s:%(lineno)s | %(message)s",
+        log_level: int = logging.INFO,
+        log_file: str = None,
+        console_output: bool = True,
+        utc: bool = False,
+) -> CustomLoggerAdapter[Logger | LoggerAdapter[Any] | Any] | Logger:
+    """
+    Get a named logger with optional extra context.
+
+    Args:
+        project_name: Name of the project
+        log_level: Optional specific log level
+        extra: Optional dictionary of extra context values
+        log_format: Format string for log messages
+        log_file: 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:
+        log_file = f'{get_root_project_path()}/logs/{project_name}.log'
+        log_file = log_file.lower().replace(' ', '_')
+
+    configure_logging(
+        log_level=logging.DEBUG,
+        log_format=log_format,
+        log_file=log_file,
+        console_output=console_output,
+        utc=utc
+    )
+
+    logger = logging.getLogger()
+
+    if log_level is not None:
+        logger.setLevel(log_level)
+
+    return CustomLoggerAdapter(logger, extra)
+
+
+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)

custom_python_logger-1.0.4/custom_python_logger/usage_example.py

@@ -0,0 +1,39 @@
+import logging
+
+
+class LoggerTest:
+    def __init__(self):
+        self.logger = logging.getLogger(self.__class__.__name__)
+
+    def main(self):
+        self.logger.info('Hello World')
+        self.logger.debug('Hello World')
+
+
+def main():
+    from custom_python_logger.logger import get_logger
+
+    logger = get_logger(
+        project_name='Logger Project Test',
+        log_level=logging.DEBUG,
+        # extra={'user': 'test_user'}
+    )
+
+    logger.debug("This is a debug message.")
+    logger.info("This is an info message.")
+    logger.step("This is a step message.")
+    logger.warning("This is a warning message.")
+
+    try:
+        _ = 1 / 0
+    except ZeroDivisionError:
+        logger.exception("This is an exception message.")
+
+    logger.critical("This is a critical message.")
+
+    logger_test = LoggerTest()
+    logger_test.main()
+
+
+if __name__ == '__main__':
+    main()

{custom_python_logger-1.0.2 → custom_python_logger-1.0.4/custom_python_logger.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: custom-python-logger
-Version: 1.0.2
+Version: 1.0.4
 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-1.0.2 → custom_python_logger-1.0.4}/custom_python_logger.egg-info/SOURCES.txt

@@ -4,6 +4,9 @@ README.md
 pyproject.toml
 requirements.txt
 setup.py
+custom_python_logger/__init__.py
+custom_python_logger/logger.py
+custom_python_logger/usage_example.py
 custom_python_logger.egg-info/PKG-INFO
 custom_python_logger.egg-info/SOURCES.txt
 custom_python_logger.egg-info/dependency_links.txt

custom_python_logger-1.0.4/custom_python_logger.egg-info/top_level.txt

@@ -0,0 +1 @@
+custom_python_logger

{custom_python_logger-1.0.2 → custom_python_logger-1.0.4}/setup.py

@@ -1,10 +1,11 @@
 from setuptools import setup, find_packages
 
-package_version = '1.0.2'
+package_version = '1.0.4'
 
 package_name = 'custom-python-logger'
 package_description = 'A custom logger with color support and additional features.'
 
+package_name_ = package_name.replace('-', '_')
 package_long_description_content_type = 'text/markdown'
 package_url = f'https://github.com/aviz92/{package_name}'
 package_python_requires = '>=3.11'
@@ -21,7 +22,7 @@ with open('README.md', 'r') as file:
 setup(
     name=package_name,
     version=package_version,
-    packages=find_packages(include=[package_name, f'{package_name}.*']),
+    packages=find_packages(include=[package_name_, f'{package_name_}.*']),
     install_requires=package_install_requires,
     author=package_author,
     author_email='',

custom_python_logger-1.0.2/custom_python_logger.egg-info/top_level.txt

@@ -1 +0,0 @@
-