Add package-level logging initialization and enhance LoggingConfig

- Introduced example_package_level_initialisation.py for logging setup.
- Updated LoggingConfig to include initialization check and finalization phase.
- Refactored imports in conftest.py for consistency.

Author: vertok

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+# pre-commit run --all-files
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.5.0

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to `prismalog` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v0.1.3] - 2025-05-28
+
+### Added
+- Introduced example_package_level_initialisation.py for logging setup on package level.
+- Updated LoggingConfig to include initialization check and finalization phase.
+
 ## [v0.1.2] - 2025-05-15
 
 ### Added

example/example_package_level_initialisation.py

@@ -0,0 +1,30 @@
+""" Example package-level initialization script for logging.
+This script initializes logging for a package, ensuring that
+the logging configuration is set up correctly when the package is imported."""
+import logging
+import os
+
+from prismalog.config import LoggingConfig
+from prismalog.log import get_logger
+
+# Initialize logging when package is imported
+if not LoggingConfig.is_initialized():
+    config_path = os.path.join(os.path.dirname(__file__), "config.yaml")
+    if os.path.exists(config_path):
+        LoggingConfig.initialize(config_file=config_path)
+
+# Export commonly used items
+__all__ = ["get_logger"]
+
+
+def get_package_logger(name: str) -> logging.Logger:
+    """Get a logger for this package."""
+    return get_logger(name)
+
+
+if __name__ == "__main__":
+    logger = get_package_logger("example_package")
+    logger.info("This is an example package-level initialization log message.")
+    logger.debug("Debugging information for package initialization.")
+    logger.warning("This is a warning during package initialization.")
+    logger.error("An error occurred during package initialization.")

prismalog/config.py

@@ -132,7 +132,7 @@ class LoggingConfig:
     }
 
     _instance = None
-    _config: Dict[str, Any] = {}  # Add type annotation
+    _config: Dict[str, Any] = {}
     _initialized = False
     _debug_mode = False
 
@@ -162,6 +162,7 @@ def initialize(cls, config_file: Optional[str] = None, use_cli_args: bool = True
         The configuration is loaded in two phases:
         1. Collection Phase: Gather and convert configurations from all sources
         2. Application Phase: Apply configurations in priority order
+        3. Finalization Phase: Set the initialized flag
 
         Args:
             config_file: Path to configuration file (YAML)
@@ -187,6 +188,9 @@ def initialize(cls, config_file: Optional[str] = None, use_cli_args: bool = True
         # Phase 2: Apply configurations in priority order
         cls._apply_configurations(config_sources)
 
+        # Phase 3: Set initialized flag
+        cls._initialized = True
+
         return cls._config
 
     @classmethod
@@ -792,6 +796,11 @@ def map_level(cls, level: str) -> int:
             "CRITICAL": logging.CRITICAL,
         }.get(level, logging.INFO)
 
+    @classmethod
+    def is_initialized(cls) -> bool:
+        """Check if logging configuration has been initialized."""
+        return cls._initialized
+
     @classmethod
     def reset(cls) -> Type["LoggingConfig"]:
         """

tests/conftest.py

@@ -12,7 +12,7 @@
 import pytest
 
 from prismalog.config import LoggingConfig
-from prismalog.log import ColoredFormatter, ColoredLogger, CriticalExitHandler, get_logger
+from prismalog.log import ColoredLogger, CriticalExitHandler, get_logger
 
 
 class TestCaptureIO: