singleton-logger 0.1.0__py3-none-any.whl

singleton_logger/__init__.py

@@ -0,0 +1,7 @@
+from .start_logger import Logger
+from .start_logger import get_logger
+
+__all__ = [
+  "Logger",
+  "get_logger"
+]

singleton_logger/start_logger.py

@@ -0,0 +1,285 @@
+
+import os 
+import sys
+import logging
+import pathlib 
+import types
+import typing
+
+from atexit import register
+from datetime import datetime
+# ==============================================================================
+class _Lazy_Logger( object ):
+  
+  '''
+  Proxy logger that queues messages until Logger.configure() is called.
+  This allows modules to create log = get_logger() at import time.
+  '''
+  
+  # ! Why standard python logging does not have this behaviour by default instead a global logger.
+  
+  # ============================================================================
+  def __init__( self ) -> None:
+    self._queue : list = []
+    self._real_logger : logging.Logger | _Lazy_Logger | None = None
+  
+  # ============================================================================
+  def _get_real_logger( self ):
+    
+    if self._real_logger is None:
+      
+      if Logger._configured:
+        
+        self._real_logger : logging.Logger | _Lazy_Logger | None = Logger.get_global( )
+      
+        for method, args, kwargs in self._queue:
+      
+          getattr( self._real_logger, method )( *args, **kwargs )
+      
+        self._queue.clear( )
+    
+    return self._real_logger
+  
+  # ============================================================================
+  def _log_method( self, method_name ) -> typing.Callable:
+  
+    def method( *args, **kwargs ):
+  
+      real : logging.Logger | None | _Lazy_Logger = self._get_real_logger( )
+      
+      if real:
+        return getattr( real, method_name )( *args, **kwargs )
+      
+      else:
+        self._queue.append( ( method_name, args, kwargs ) )
+        
+    return method
+  
+  # ============================================================================
+  def __getattr__( self, name ) -> typing.Callable:
+    
+    return self._log_method( name )
+
+# ==============================================================================
+class Flushing_File_Handler( logging.FileHandler ):
+  '''
+  A file handler that flushes after every log entry.
+  Use this for maximum crash resistance at the cost of performance.
+  Custom logging handler that auto-flushes on every write (use for critical apps)
+  '''
+  
+  def emit( self, record ) -> None:
+    
+    super( ).emit( record )
+    self.flush( )
+    
+# ==============================================================================
+def get_logger( ) -> logging.Logger | _Lazy_Logger | None:
+  '''
+  Returns the global LOG instance. Import and call this in every module.
+  '''
+  
+  return Logger.get_global( )
+# ==============================================================================
+class Logger:
+  '''
+  A crash-resilient logger using Singleton design that maintains consistent
+  configuration across modules, ensuring logs are captured even during crashes.
+
+  # Example
+  #
+  #  In your main.py
+    
+    from log import Logger
+    
+    logfile_name = basename(__file__).split('.')[0]
+    Logger.configure( name_ = logfile_name, level_ = log_level_)
+    
+    def main():
+      log = logger.get_logger()
+      log.info( "This message gets queued" )
+
+  # In module:
+  
+    from lib.log import Logger
+    
+    def some_function( ):
+      
+      log = logger.get_logger( )
+      log.info( "Function called" )
+      
+      log.debug( "Debug info" )
+      
+      try:
+        result = 1 / 0
+        
+      except Exception as e:
+        log.debug( f"Error occurred {e}" )
+        Logger.flush_all( )
+        raise
+  '''
+
+  _loggers : dict = {}
+  _configured : bool = False
+  _console_level : int = logging.DEBUG
+  _file_handler : logging.FileHandler | None = None
+  _global_logger : logging.Logger | None = None
+  # ============================================================================
+  @classmethod
+  def configure(
+    cls,
+    name_ : str = "default",
+    level_ : int = logging.INFO,
+    var_log_dir_path_ : str = "./var/log/"
+  ) -> None | logging.Logger:
+  
+    '''
+    Explicitly configure the logger. Call this once at program startup.
+    Creates the log file immediately to ensure crash logs are captured.
+    '''
+  
+    if cls._configured:
+      return cls._global_logger
+
+    _logfile_folder = var_log_dir_path_
+    _logfile_format : str = f"{_logfile_folder}_{name_}_{datetime.today( ).strftime( '%Y-%m-%d_-_%H-%M-%S' )}.log"
+
+    cls._logfile = _logfile_format
+    cls._console_level = level_
+
+    log_path = pathlib.Path( cls._logfile )
+
+    if not log_path.parent.exists( ):
+    
+      try:
+        os.makedirs( log_path.parent, exist_ok = True )
+        
+      except PermissionError as _:
+        print( f"WARNING {_}: Permission denied creating {log_path.parent}, logs file may fail" )
+
+    try:
+      with open( cls._logfile, 'a', encoding='utf-8' ) as _file:
+        _file.write( f"=== Log initialized at {datetime.now( )} ===\n" )
+
+    except Exception as e:
+      print( f"WARNING: LOG FILE COULD NOT BE CREATED: {e}" )
+
+    cls._configured = True
+
+    # Create the global LOG instance
+    cls._global_logger = cls._create_logger( "GLOBAL" )
+
+    register( cls._cleanup )
+
+    return cls._global_logger
+  
+  # ============================================================================
+  @classmethod
+  def _create_logger(
+    cls,
+    name_ : str = "default",
+    log_format_ : str = "%(asctime)s | %(name)s | %(funcName)s.%(lineno)d | %(levelname)s | %(message)s",
+    date_format_ : str = "%Y-%m-%d %H:%M:%S",
+  ) -> logging.Logger:
+    
+    '''
+    Internal method for logger instance.
+    '''
+
+    if name_ in cls._loggers:
+      return cls._loggers[ name_ ]
+
+    logger : logging.Logger = logging.getLogger( name_ )
+    logger.setLevel( logging.DEBUG )
+
+    logger.handlers.clear( )
+
+    formatter = logging.Formatter(
+      fmt = log_format_,
+      datefmt = date_format_
+    )
+
+    try:
+      file_handler = logging.FileHandler(
+        cls._logfile,
+        mode = "a",
+        encoding = "utf-8"
+      )
+      
+      # Debug is default
+      file_handler.setLevel( logging.DEBUG )
+      file_handler.setFormatter( formatter )
+
+      if cls._file_handler is None:
+        cls._file_handler = file_handler
+
+      logger.addHandler( file_handler )
+
+    except Exception as e:
+      print( f"Warning: Cannot create file handler: {e}" )
+
+    cli_handler = logging.StreamHandler( sys.stdout )
+    cli_handler.setLevel( cls._console_level )
+    cli_handler.setFormatter( formatter )
+    logger.addHandler( cli_handler )
+
+    cls._loggers[ name_ ] = logger
+
+    return logger
+  
+  # ============================================================================
+  @classmethod
+  def get_logger(
+    cls,
+    name_ : str = "default",
+  ) -> _Lazy_Logger | logging.Logger:
+    
+    '''
+    Returns a configured logger with immediate disk flushing.
+    If not configured yet, returns the global logger which will be properly
+    initialized when configure() is called.
+    '''
+    # If asking for global or not configured logger, return global logger
+    if not cls._configured:
+      return _Lazy_Logger( )
+    
+    _name : str = name_
+    if name_ == "default" :
+      _frame : types.FrameType= sys._getframe( 1 )
+      _filepath : pathlib.Path = pathlib.Path( _frame.f_code.co_filename )
+      _name = _filepath.stem
+
+    return cls._create_logger( _name )
+  # ============================================================================
+  @classmethod
+  def get_global( cls ) -> _Lazy_Logger | logging.Logger | None:
+    '''
+    Returns the global LOG instance. Use this for the global LOG object.
+    '''
+    
+    if not cls._configured:
+      return _Lazy_Logger( )
+    
+    return cls._global_logger
+  # ============================================================================
+  @classmethod
+  def _cleanup( cls ) -> None:
+    '''Ensure all handlers are properly flushed and closed.'''
+    
+    for logger in cls._loggers.values( ):
+    
+      for handler in logger.handlers:
+    
+        handler.flush( )
+        handler.close( )
+        
+  # ============================================================================
+  @classmethod
+  def flush_all( cls ) -> None:
+    '''Manually flush all log handlers. Call this before risky operations.'''
+    
+    for logger in cls._loggers.values( ):
+      for handler in logger.handlers:
+        handler.flush( )
+        
+# ==============================================================================

singleton_logger-0.1.0.dist-info/METADATA

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: singleton-logger
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pip>=26.2.1
+Dynamic: license-file
+
+# Run-time persistent Logger
+
+## Overview
+
+**TLDR:** Gives the option to initialise the logger once (`Singleton`) across different modules while preventing/denying global access.
+
+The provided logging suite offers a robust, crash-resilient mechanism for capturing software execution states. The architecture is designed to address the synchronisation of log events across multiple modules avoiding repetitive formal configuration. implementation deferred execution queue, the system ensures that early-stage initialisation logs are preserved and subsequently written to disk once the primary logging configuration is exited (halted or crashed).
+
+## Installation
+
+### Pypi
+
+1. Create your `.venv` as usual
+
+2. Add 
+  ```bash
+  pip install -i https://test.pypi.org/simple/ singleton-logger
+  ```
+
+3. Import the module normally
+
+   ```python
+   from singleton_logger import Logger
+   
+   def main() -> None:
+     log = Logger.get_logger( )
+     Logger.configure(
+       level_ = 10, #Debug
+       name_ = "main_logger"
+     )
+   
+     log.debug("Message")
+   ```
+
+## Architectural Design
+
+The framework employs a modified `Singleton` pattern to manage a non-global logging state. The architecture comprises three primary components: the central `Logger` class, a proxy `_Lazy_Logger` class, and a customised `Flushing_File_Handler`.
+
+mermaid diagram
+
+![singleton-logger](./docs/art/singleton-logger.png)
+
+## Design Logic and Theoretical Framework
+
+### Deferred Execution and State Management
+
+A significant challenge in distributed or multi-module software architectures is the instantiation of logging mechanisms before the central configuration is applied. Standard Python logging modules often discard or improperly route these early messages. The implementation resolves this through the `_Lazy_Logger` class. This proxy object captures logging method calls and arguments, storing them in memory. Upon the invocation of `Logger.configure()`, the queue is flushed to the permanent disk location. This behaviour ensures zero data loss during application bootstrapping.
+
+### Application of SOLID Principles
+
+The design aligns with a couple SOLID principles, which was the inspiration for writing this project after discussion with some of my students.
+
+**Single Responsibility Principle**: The `_Lazy_Logger` is strictly responsible for message queuing, while the Logger class manages file handles and configuration state.
+
+**Open/Closed Principle**: The system can be extended with custom handlers, such as the `Flushing_File_Handler`, without modifying the core Logger class logic.
+
+**Liskov Substitution Principle**: The `_Lazy_Logger` dynamically mimics the interface of a standard `logging.Logger` via the __getattr__ method, allowing it to serve as a transparent substitute for the underlying logging object.
+
+### Crash Resiliency
+
+`Singleton-Logger` prioritizes message preservation during runtime error. By registering the `_cleanup` method with the `atexit` module, the suite ensures that all file buffers are flushed to the disk/file upon normal or abnormal termination. Additionally, the `Flushing_File_Handler` forces a disk write operation after every individual log emission, minimizing the risk of data loss from operating system buffering delays.
+
+### System Advantages
+
+**Initialisation Safety**: Modules can safely request and utilize logger instances at import time without waiting for the primary application entry point to execute configuration parameters.
+
+**Data Integrity**: The explicit use of the `atexit` registry and immediate file creation ensures that diagnostic information is captured even when unhandled exceptions occur.
+
+**Centralised Configuration**: All module-level loggers inherit the formatting and output destinations defined during the single configure method call. This eliminates fragmented log files.
+
+### System Limitations
+
+**Performance Overhead**: The stringent flushing protocols introduce significant disk input/output latency, particularly if `Flushing_File_Handler` is widely applied. Writing to disk after every event reduces the overall throughput of high-frequency execution paths.
+
+**Memory Constraints**: If the application fails to call `Logger.configure()` in a timely manner, the `_Lazy_Logger` queue will expand indefinitely. In long-running applications that fail to initialize properly, this behaviour may lead to memory exhaustion.
+
+**Singleton State Complexity**: The reliance on class-level attributes introduces global state. This design choice complicates unit testing, as test environments must explicitly reset the `_configured` flag and internal dictionaries between test suites to prevent state leakage.
+
+## Implementation Guidelines
+The following code illustrates the intended usage paradigm for the suite.
+
+in `main.py`, the first logger is initialized.
+
+```python
+import os
+import logging
+import singleton_logger as Logger
+
+from .do_something import do_something
+from .do_something_else import do_something_else
+
+def main():
+
+  Logger.configure(
+    level_ = logging.DEBUG, # integer values also available
+    name_ = "singleton_logger"
+  )
+  
+  log = Logger.get_logger()
+  log.info( "Application initialized successfully" )
+  
+  try:
+    do_something()
+  
+  except Exception as e:
+
+    log.error( f"Critical failure: {e}" )
+    Logger.flush_all()
+    raise
+
+  do_something_else()
+```
+
+in module `do_something.py`, logger gets the singleton if a new logger is not instantiated.
+
+```python 
+import Logger
+
+def do_something():
+
+  log = Logger.get_logger("singleton_logger")
+  log.debug("Processing routine started")
+```
+
+in module `do_something_else.py`
+
+```python 
+import Logger
+
+def do_something_else():
+
+  log = Logger.get_logger("singleton_logger")
+  log.warning("Processing routine started")
+
+```
+
+## Future implementations 
+
+1. Logger streams log messages via api, email, ...
+1. Improvements module ux, specially for `Logger.configuration`
+
+
+## References
+
+Gamma, E., Helm, R., Johnson, R., & Vlissides, J. (1994). Design patterns: elements of reusable object-oriented software. Addison-Wesley.
+
+Yuan, D., Zheng, J., Park, S., Zhou, Y., & Balaraman, S. (2012). Improving software diagnosability via log enhancement. ACM Transactions on Computer Systems (TOCS), 30(1), 1-28.
+
+Fu, Q., Lou, J. G., Wang, Y., & Li, J. (2014). Execution anomaly detection in distributed systems through unstructured log analysis. In 2009 Ninth IEEE International Conference on Data Mining (pp. 149-158). IEEE.
+
+## Support
+
+If you really want to support this and other projects that I am involved, you can buy me a coffee.
+
+<img src="/home/contesini/00_keys/qr-code.png" alt="buymeacoffee" style="zoom: 25%;" />
+
+Thank you,
+
+And I hope you have a great day ahead.

singleton_logger-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+singleton_logger/__init__.py,sha256=CnciChXpGX3rGbUuvo7KuN3_nCQoxANTac2dt3WKAzQ,111
+singleton_logger/start_logger.py,sha256=tO3hsmDoi6QPJPl_MNdZlLj64hJR8q-J_Lcor_2Y_Eo,8316
+singleton_logger-0.1.0.dist-info/licenses/LICENSE,sha256=46mU2C5kSwOnkqkw9XQAJlhBL2JAf1_uCD8lVcXyMRg,7652
+singleton_logger-0.1.0.dist-info/METADATA,sha256=9mELujusAka0pXht1ROPe19l8-GRHNw7jxwxOAY6EHE,6950
+singleton_logger-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+singleton_logger-0.1.0.dist-info/top_level.txt,sha256=5TvGV_9ZetvE-yTI8tvpISauP9Ki5GHrtyEoatX3NEs,17
+singleton_logger-0.1.0.dist-info/RECORD,,

singleton_logger-0.1.0.dist-info/WHEEL

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

singleton_logger-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

singleton_logger-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+singleton_logger