custom-python-logger 0.1.0__py3-none-any.whl

custom_python_logger/logger.py

@@ -0,0 +1,149 @@
+# logger.py
+
+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_project_path(project_name: str) -> str:
+    current_path = Path(__file__).parent
+    while current_path != current_path.parent:
+        if str(current_path).endswith(f'/{project_name}'):
+            return str(current_path)
+        current_path = current_path.parent
+    raise FileNotFoundError(
+        f'Project "{project_name}" not found in any parent directories.\n'
+        f'Current path: {Path(__file__)}',
+    )
+
+
+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)
+
+    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)

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-0.1.0.dist-info/METADATA

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: custom-python-logger
+Version: 0.1.0
+Summary: A custom logger with color support and additional features.
+Home-page: https://github.com/aviz92/custom-python-logger
+Author: Avi Zaguri
+Author-email: 
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: colorlog>=4.0.0
+Requires-Dist: setuptools>=42.0.0
+Requires-Dist: wheel>=0.36.2
+Requires-Dist: colorlog>=6.7.0
+Requires-Dist: pytest>=6.2.4
+Requires-Dist: pathlib>=1.0.1
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Custom Logger
+A Python logger with colored output and additional log levels. <br> 
+The logger supports custom log levels like `STEP` and `EXCEPTION` and can be easily integrated into your Python projects.
+
+## Installation
+You can install the package using pip:
+```bash
+pip install custom-python-logger
+```
+
+## Usage
+please see the [usage_example](custom_python_logger/usage_example.py) file for more details.

custom_python_logger-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+custom_python_logger/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+custom_python_logger/logger.py,sha256=iwc5FzFszqZ7J9LaywQrcRi8H4NZnJ9GNOM5C-Dt82Y,4611
+custom_python_logger/usage_example.py,sha256=pZixjxVJCgqK8j-KsWgtZ3I_TlpRhkEOvZ1rPV96py4,887
+custom_python_logger-0.1.0.dist-info/licenses/LICENSE,sha256=cSikHY6SZFsPZSBizCDAJ0-Bjjzxt-JtX6TVbKxwimo,1067
+custom_python_logger-0.1.0.dist-info/METADATA,sha256=EeAs5gwTalO-TZXDQO2wBRgDYu0nuDqxdodp9f8qwPQ,1299
+custom_python_logger-0.1.0.dist-info/WHEEL,sha256=GHB6lJx2juba1wDgXDNlMTyM13ckjBMKf-OnwgKOCtA,91
+custom_python_logger-0.1.0.dist-info/top_level.txt,sha256=lMihLuDQUTn0aSzzzbv9LZZTWTAap0IKpKabUHwOgks,21
+custom_python_logger-0.1.0.dist-info/RECORD,,

custom_python_logger-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.3.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

custom_python_logger-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Avi Zaguri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

custom_python_logger-0.1.0.dist-info/top_level.txt

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