Merge pull request #1 from inokufu/feature/logger

pierrocknroll · web-flow · commit 9f0440bb8acd · 2025-04-09T09:27:08.000Z
✨ Logger system
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -5,3 +5,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.0] - 2025-03-20
+
+### Added
+
+- Initial release of the logging framework
+- `LoggerContract` abstract base class defining the logger interface
+- `LoguruLogger` implementation using Loguru library
+- `LogLevel` enum for standardized log levels
+- `LoggableMixin` for adding logging capabilities to classes
+- Comprehensive test suite for all components
+- Support for structured logging with context information
+- Exception logging with type and message extraction
diff --git a/docs/README.md b/docs/README.md
@@ -13,7 +13,19 @@
 
 ## Overview
 
-Python logger
+This project provides a flexible and extensible logging framework for Python
+applications. It offers a clean interface for consistent logging with rich
+context information, built on top of the Loguru library while maintaining a
+contract-based approach for easy adaptation to other logging backends.
+
+Key features:
+
+- 📏 Standardized logging interface through a contract
+- 🔄 Easy integration into existing classes via a mixin
+- 🌈 Beautiful, colorized console output via Loguru
+- 🧩 Structured logging with context support
+- 📊 Granular log level control
+- 🧪 Thoroughly tested implementation
 
 ## Setup and installation
 
@@ -24,18 +36,135 @@ Python logger
 
 ### Installation
 
+1. Clone the repository
+
+2. Install dependencies
+   ```sh
+   make init
+   ```
+
 ## Usage
 
+### Basic Usage
+
+```python
+# Create a logger instance
+logger = LoguruLogger(level=LogLevel.DEBUG)
+
+# Basic logging
+logger.info("Application started")
+
+# Logging with context
+logger.debug("Processing item",
+             context={"item_id": "12345", "status": "pending"})
+
+# Error logging
+try:
+    result = 1 / 0
+except Exception as e:
+    logger.exception("Division error occurred", exc=e,
+                     context={"operation": "division"})
+```
+
+### Using the LoggableMixin
+
+```python
+# Create a class with logging capabilities
+class MyService(LoggableMixin):
+    def __init__(self, logger: LoggerContract):
+        super().__init__()
+        self.logger = logger
+
+    def process(self, data):
+        self.logger.info("Processing data", context={"data_size": len(data)})
+
+
+# Usage
+logger = LoguruLogger(level=LogLevel.INFO)
+service = MyService(logger)
+service.process([1, 2, 3])
+```
+
+### Log Levels
+
+Available log levels (from lowest to highest priority):
+
+- `LogLevel.DEBUG` - Detailed information for debugging
+- `LogLevel.INFO` - General information about system operation
+- `LogLevel.WARNING` - Indication of potential issues
+- `LogLevel.ERROR` - Error conditions preventing a function from working
+- `LogLevel.CRITICAL` - Critical conditions requiring immediate attention
+
+Set the log level when creating the logger:
+
+```python
+# Only show warnings and above
+logger = LoguruLogger(level=LogLevel.WARNING)
+```
+
+## API Reference
+
+### LoggerContract
+
+The abstract base class that defines the interface for all logger
+implementations:
+
+| Method                                  | Description                                     |
+|-----------------------------------------|-------------------------------------------------|
+| `debug(message, context=None)`          | Log debug message with optional context         |
+| `info(message, context=None)`           | Log info message with optional context          |
+| `warning(message, context=None)`        | Log warning message with optional context       |
+| `error(message, context=None)`          | Log error message with optional context         |
+| `critical(message, context=None)`       | Log critical message with optional context      |
+| `exception(message, exc, context=None)` | Log exception with message and optional context |
+
+### LoguruLogger
+
+An implementation of `LoggerContract` using
+the [Loguru](https://github.com/Delgan/loguru) library.
+
+### LoggableMixin
+
+A mixin class that adds logging capabilities to any class.
+
+| Property | Description                    |
+|----------|--------------------------------|
+| `logger` | Get or set the logger instance |
+
+### LogLevel
+
+An enum representing log levels:
+
+- `DEBUG`
+- `INFO`
+- `WARNING`
+- `ERROR`
+- `CRITICAL`
+
+With a helper method:
+
+- `from_str(value)` - Create LogLevel from a string (case-insensitive)
+
 ## Development
 
 ### Code Formatting and Linting
 
-### Environment Variables
+This project uses ruff for formatting and linting:
+
+```sh
+# Format code
+make format
+
+# Run linters
+make lint
+```
 
-| Variable | Description | Required | Default Value | Possible Values |
-|----------|-------------|----------|---------------|-----------------|
+### Running Tests
 
-### Architecture
+```sh
+# Run tests with coverage
+make test
+```
 
 ## Contributing
 
diff --git a/docs/api/loggable_mixin.md b/docs/api/loggable_mixin.md
@@ -0,0 +1,3 @@
+# LoggableMixin
+
+::: src.logger.loggable_mixin.LoggableMixin
diff --git a/docs/api/loglevel.md b/docs/api/loglevel.md
@@ -0,0 +1,3 @@
+# LogLevel
+
+::: src.logger.loglevel.LogLevel
diff --git a/docs/api/loguru_logger.md b/docs/api/loguru_logger.md
@@ -0,0 +1,4 @@
+# LoguruLogger
+
+::: src.logger.loguru.LoguruLogger
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -10,6 +10,7 @@ dependencies = [
     "mkdocstrings-python~=1.16.6",
     "mkdocs-material~=9.6.9",
     "griffe-inherited-docstrings~=1.1.1",
+    "loguru~=0.7.3",
 ]
 readme = "docs/README.md"
 requires-python = ">= 3.12"
diff --git a/requirements-dev.lock b/requirements-dev.lock
@@ -52,6 +52,8 @@ jinja2==3.1.6
     # via mkdocs
     # via mkdocs-material
     # via mkdocstrings
+loguru==0.7.3
+    # via logger
 markdown==3.7
     # via mkdocs
     # via mkdocs-autorefs
diff --git a/requirements.lock b/requirements.lock
@@ -36,6 +36,8 @@ jinja2==3.1.6
     # via mkdocs
     # via mkdocs-material
     # via mkdocstrings
+loguru==0.7.3
+    # via logger
 markdown==3.7
     # via mkdocs
     # via mkdocs-autorefs
diff --git a/src/logger/__init__.py b/src/logger/__init__.py
@@ -1 +1,13 @@
-"""Package init file."""
+"""Logger package for standardized logging across projects."""
+
+from .contract import LoggerContract
+from .loggable_mixin import LoggableMixin
+from .loglevel import LogLevel
+from .loguru import LoguruLogger
+
+__all__ = [
+    "LogLevel",
+    "LoggableMixin",
+    "LoggerContract",
+    "LoguruLogger",
+]
diff --git a/src/logger/__main__.py b/src/logger/__main__.py
diff --git a/src/logger/contract.py b/src/logger/contract.py
@@ -0,0 +1,73 @@
+from abc import ABC, abstractmethod
+from collections.abc import Mapping
+from typing import Any
+
+
+class LoggerContract(ABC):
+    """Abstract base class for logger implementations at various severity levels, with optional context information."""  # noqa: E501
+
+    @abstractmethod
+    def debug(self, message: str, context: Mapping[str, Any] | None = None) -> None:
+        """Log a debug message.
+
+        Args:
+            message: The message to log
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def info(self, message: str, context: Mapping[str, Any] | None = None) -> None:
+        """Log an info message.
+
+        Args:
+            message: The message to log
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def warning(self, message: str, context: Mapping[str, Any] | None = None) -> None:
+        """Log a warning message.
+
+        Args:
+            message: The message to log
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def error(self, message: str, context: Mapping[str, Any] | None = None) -> None:
+        """Log an error message.
+
+        Args:
+            message: The message to log
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def critical(self, message: str, context: Mapping[str, Any] | None = None) -> None:
+        """Log a critical message.
+
+        Args:
+            message: The message to log
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
+
+    @abstractmethod
+    def exception(
+        self,
+        message: str,
+        exc: Exception,
+        context: Mapping[str, Any] | None = None,
+    ) -> None:
+        """Log an exception.
+
+        Args:
+            message: A descriptive message about the exception
+            exc: The exception object
+            context: Additional contextual information to include with the log.
+        """
+        raise NotImplementedError
diff --git a/src/logger/loggable_mixin.py b/src/logger/loggable_mixin.py
@@ -0,0 +1,32 @@
+from .contract import LoggerContract
+
+
+class LoggableMixin:
+    """Mixin to add logging capabilities to a class."""
+
+    def __init__(self) -> None:
+        """Initialize the mixin."""
+        self._logger: LoggerContract | None = None
+
+    @property
+    def logger(self) -> LoggerContract:
+        """Get the logger instance.
+
+        Returns:
+            The configured logger instance.
+
+        Raises:
+            RuntimeError: If logger has not been set.
+        """
+        if self._logger is None:
+            raise RuntimeError("Logger not set")
+        return self._logger
+
+    @logger.setter
+    def logger(self, logger: LoggerContract) -> None:
+        """Set a logger.
+
+        Args:
+            logger: Logger instance to use.
+        """
+        self._logger = logger
diff --git a/src/logger/loglevel.py b/src/logger/loglevel.py
@@ -0,0 +1,34 @@
+import logging
+from enum import IntEnum
+from typing import Self
+
+
+class LogLevel(IntEnum):
+    """Represents the different log levels."""
+
+    DEBUG = logging.DEBUG
+    INFO = logging.INFO
+    WARNING = logging.WARNING
+    ERROR = logging.ERROR
+    CRITICAL = logging.CRITICAL
+
+    @classmethod
+    def from_str(cls, value: str) -> Self:
+        """Create a LogLevel from a string, case-insensitive.
+
+        Args:
+            value: String representation of the log level.
+
+        Returns:
+            LogLevel enum value.
+
+        Raises:
+            ValueError: If the string doesn't match any log level.
+        """
+        try:
+            return cls[value.upper()]
+        except KeyError as e:
+            valid_values = [e.name for e in cls]
+            raise ValueError(
+                f"Invalid log level '{value}'. Must be one of: {valid_values}",
+            ) from e
diff --git a/src/logger/loguru.py b/src/logger/loguru.py
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/logger/loggable_mixin_test.py b/tests/logger/loggable_mixin_test.py
diff --git a/tests/logger/loglevel_test.py b/tests/logger/loglevel_test.py
diff --git a/tests/logger/loguru_test.py b/tests/logger/loguru_test.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# LoggableMixin`
	`2`	`+`
	`3`	`+::: src.logger.loggable_mixin.LoggableMixin`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# LogLevel`
	`2`	`+`
	`3`	`+::: src.logger.loglevel.LogLevel`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +# LoguruLogger
++
 +::: src.logger.loguru.LoguruLogger
++
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ dependencies = [`
`10`	`10`	`"mkdocstrings-python~=1.16.6",`
`11`	`11`	`"mkdocs-material~=9.6.9",`
`12`	`12`	`"griffe-inherited-docstrings~=1.1.1",`
	`13`	`+ "loguru~=0.7.3",`
`13`	`14`	`]`
`14`	`15`	`readme = "docs/README.md"`
`15`	`16`	`requires-python = ">= 3.12"`