Source code for sovabids.loggers

"""Module dealing with logging related functionality and settings"""

import os
import logging
import sys
from datetime import datetime



def _excepthook(*args):
    """Catch Exceptions to logger.
    
    Notes
    -----
    See https://code.activestate.com/recipes/577074-logging-asserts/
    """
    logging.getLogger().error('Uncaught exception:', exc_info=args)


sys.excepthook = _excepthook # See _excepthook documentation




def setup_logging(log_file=None, debug=False):
    """Setup the logging

    Parameters
    ----------
    log_file: str | pathlib.Path
        Name of the logfile
    debug: bool
        Set log level to DEBUG if debug==True

    Returns
    -------
    logging.logger:
        The logger.

    
    Notes
    -----
    This function is a copy of the one found in bidscoin.
    https://github.com/Donders-Institute/bidscoin/blob/748ea2ba537b06d8eee54ac7217b909bdf91a812/bidscoin/bidscoin.py#L41-L83
    """
    if log_file is not None:
        log_file = os.fspath(log_file)
    currentDT = datetime.now()
    currentDT.strftime("%Y-%m-%d %H:%M:%S")

    noDate = True
    # Get the root logger
    logger = logging.getLogger()

    # Set the format and logging level
    if debug:
        fmt = '%(asctime)s - %(name)s - %(levelname)s | %(message)s'
        logger.setLevel(logging.DEBUG)
    else:
        fmt = '%(asctime)s - %(levelname)s | %(message)s'
        logger.setLevel(logging.INFO)
    datefmt   = '%Y-%m-%d %H:%M:%S'
    formatter = logging.Formatter(fmt=fmt, datefmt=datefmt)

    # Add stderr handler for warnings/errors so they always appear on the console,
    # regardless of whether the caller invoked logging.basicConfig beforehand.
    # We remove any existing sovabids_streamhandler to ensure we use the current sys.stderr
    # (relevant for testing with capsys)
    for h in list(logger.handlers):
        if getattr(h, 'name', None) == 'sovabids_streamhandler':
            logger.removeHandler(h)

    streamhandler = logging.StreamHandler(sys.stderr)
    streamhandler.setLevel(logging.WARNING)
    streamhandler.setFormatter(formatter)
    streamhandler.set_name('sovabids_streamhandler')
    logger.addHandler(streamhandler)

    if not log_file:
        return logger

    # Set & add the log filehandler
    logdir,log_name = os.path.split(log_file)
    os.makedirs(logdir,exist_ok=True) # Create the log dir if it does not exist
    log_name = os.path.join(logdir,currentDT.strftime("%Y-%m-%d__%H_%M_%S") + '__' + log_name)
    if noDate:
        log_name=log_file
    loghandler = logging.FileHandler(log_name)
    loghandler.setLevel(logging.DEBUG)
    loghandler.setFormatter(formatter)
    loghandler.set_name('sovabids_loghandler')
    logger.addHandler(loghandler)

    # Set & add the error / warnings handler
    error_file = log_name +'.errors'            # Derive the name of the error logfile from the normal log_file
    errorhandler = logging.FileHandler(error_file, mode='w')
    errorhandler.setLevel(logging.WARNING)
    errorhandler.setFormatter(formatter)
    errorhandler.set_name('sovabids_errorhandler')
    logger.addHandler(errorhandler)


    logger.info(f"Full log: {log_name} | Errors/warnings: {error_file}")
    return logger