Once again revert subclassing logging.Logger (setLoggerClass is not working / ignored by the plugins)

Author: marcelzwiers

bidscoin/__init__.py

@@ -28,7 +28,7 @@
 from pathlib import Path
 from importlib import metadata
 from typing import Tuple, Union, List
-import logging
+from logging import getLogger
 from .due import due, Doi
 try:
     import tomllib
@@ -61,8 +61,9 @@
 bidscoinroot = Path(__file__).parent
 schemafolder = bidscoinroot/'schema'
 
-# Get the BIDSCOIN_DEBUG environment variable to set the log-messages and logging level, etc
-DEBUG = os.getenv('BIDSCOIN_DEBUG','').upper() in ('1', 'TRUE', 'Y', 'YES')
+# Get the LOGGER and BIDSCOIN_DEBUG environment variable to set the log-messages and logging level, etc
+LOGGER = getLogger(__name__)
+DEBUG  = os.getenv('BIDSCOIN_DEBUG','').upper() in ('1', 'TRUE', 'Y', 'YES')
 
 # Create a BIDScoin user configuration directory if needed
 configdir      = Path(os.getenv('BIDSCOIN_CONFIGDIR') or (Path.home() if os.access(Path.home(),os.W_OK) else Path(tempfile.gettempdir()))/'.bidscoin')/__version__
@@ -99,40 +100,6 @@
          path='bidscoin', version=__version__, cite_module=True, tags=['reference-implementation'])
 
 
-class CustomLogger(logging.Logger):
-    """Extend the Logger class to add custom methods for the new levels"""
-
-    # Define custom logging levels
-    BCDEBUG, BCDEBUG_LEVEL = 'BCDEBUG', 11      # NB: using the standard debug mode will generate may debug messages from imports
-    VERBOSE, VERBOSE_LEVEL = 'VERBOSE', 15
-    SUCCESS, SUCCESS_LEVEL = 'SUCCESS', 25
-
-    # Add custom log levels to logging
-    logging.addLevelName(BCDEBUG_LEVEL, BCDEBUG)
-    logging.addLevelName(VERBOSE_LEVEL, VERBOSE)
-    logging.addLevelName(SUCCESS_LEVEL, SUCCESS)
-
-    def bcdebug(self, message, *args, **kwargs):
-        """Custom BIDSCOIN DEBUG messages"""
-        if self.isEnabledFor(self.BCDEBUG_LEVEL):
-            self._log(self.BCDEBUG_LEVEL, message, args, **kwargs)
-
-    def verbose(self, message, *args, **kwargs):
-        """Custom BIDSCOIN VERBOSE messages"""
-        if self.isEnabledFor(self.VERBOSE_LEVEL):
-            self._log(self.VERBOSE_LEVEL, message, args, **kwargs)
-
-    def success(self, message, *args, **kwargs):
-        """Custom BIDSCOIN SUCCESS messages"""
-        if self.isEnabledFor(self.SUCCESS_LEVEL):
-            self._log(self.SUCCESS_LEVEL, message, args, **kwargs)
-
-
-# Get a logger from the custom logger class
-logging.setLoggerClass(CustomLogger)
-LOGGER = logging.getLogger(__name__)
-
-
 def check_version() -> Tuple[str, Union[bool, None], str]:
     """
     Compares the BIDSCOIN version from the local metadata to the remote pypi repository

bidscoin/bcoin.py

@@ -113,10 +113,16 @@ def synchronize(pbatch, jobids: list, wait: int=15):
 def setup_logging(logfile: Path=Path()):
     """
     Set up the logging framework:
-    - Add a console stream handler for generating terminal output.
-    - Optionally add file handlers for normal log and warning/error log if logfile is provided.
+    1) Extend the Logger class with custom 'bcdebug', 'verbose' and 'success' logging levels / methods
+    2) Add a console streamhandler
+    3) If given a logfile, then add a regular log + a warning/error filehandler
 
-    :param logfile: Path to the logfile. If none, logging is console-only
+    NB: Defining a `CustomLogger(logging.Logger)` class + setting `logging.setLoggerClass(CustomLogger)`
+    (as in https://github.com/xolox/python-verboselogs/blob/master/verboselogs/__init__.py)
+    does not seem to work / is ignored by the plugins. Extending `logging.getLoggerClass()` works robustly
+
+    :param logfile:     Name of the logfile
+    :return:
     """
 
     # Set the default formats
@@ -128,7 +134,28 @@ def setup_logging(logfile: Path=Path()):
         cfmt = '%(levelname)s | %(message)s'
     datefmt  = '%Y-%m-%d %H:%M:%S'
 
-    # Get the root logger and set the appropriate level
+    # Register custom log levels
+    for name, level in {'BCDEBUG': 11, 'VERBOSE': 15, 'SUCCESS': 25}.items():
+        logging.addLevelName(level, name)
+        setattr(logging, name, level)
+
+    # Register custom log methods
+    def bcdebug(self, message, *args, **kws):
+        if self.isEnabledFor(logging.BCDEBUG):
+            self._log(logging.BCDEBUG, message, args, **kws)
+    logging.getLoggerClass().bcdebug = bcdebug
+
+    def verbose(self, message, *args, **kws):
+        if self.isEnabledFor(logging.VERBOSE):
+            self._log(logging.VERBOSE, message, args, **kws)
+    logging.getLoggerClass().verbose = verbose
+
+    def success(self, message, *args, **kws):
+        if self.isEnabledFor(logging.SUCCESS):
+            self._log(logging.SUCCESS, message, args, **kws)
+    logging.getLoggerClass().success = success
+
+    # Set the root logging level
     logger = logging.getLogger()
     logger.setLevel('BCDEBUG' if DEBUG else 'VERBOSE')