Module pipettin-piper.piper.log

def setup_logging(directory:str=None, level:int=4, prefix="piper", verbose=True, make_symlink=True, loglimit_mb=None):
    """Set-up logging for the piper module."""

    current_handlers = logging.getLogger().handlers
    if prefix in [h.name for h in current_handlers]:
        logging.warning(f"Logging already setup for '{prefix}'. Doing nothing.")
        return

    _, logfile_path = tempfile.mkstemp(prefix=prefix + "-", suffix=".log", dir=directory)

    if loglimit_mb is None:
        # Create a FileHandler
        file_handler = logging.FileHandler(logfile_path)
    else:
        # Create a rotating file handler
        file_handler = handlers.RotatingFileHandler(
            logfile_path, maxBytes=loglimit_mb*BYTES_PER_MB, backupCount=4
        )

    log_level = LEVELS[max(0, min(int(level), 4))]
    file_handler.setLevel(log_level)

    # Set formatter for the handler
    formatter = logging.Formatter(
        '%(asctime)s - %(name)s - %(levelname)s - %(funcName)s [%(filename)s:%(lineno)s]: %(message)s',
        datefmt='%H:%M:%S'
    )
    file_handler.setFormatter(formatter)

    file_handler.name = prefix

    logging.basicConfig(handlers=[file_handler], level=log_level,
                        # By setting force to True, any previous handlers are removed.
                        # See: https://docs.python.org/3.11/library/logging.html#logging.basicConfig
                        force=True)

    if verbose:
        print(f"Logging to file at level {log_level}: {logfile_path}")

    # Symlink the logfile.
    if make_symlink:
        symlink_logfile(logfile_path, directory, prefix, verbose)

    # print("Handlers 1:")
    # handlers = logging.getLogger().handlers
    # print(handlers)
    # print(handlers[0])
    # print(handlers[0].name)

def symlink_logfile(logfile_path, directory, prefix, verbose):

    # Create a symlink to the log file.
    if directory is not None:
        symlink_path = os.path.join(directory, f"{prefix}.log")
    else:
        # Create a symlink to the log file in the system's temporary directory (e.g. "/tmp/piper.log")
        temp_dir = tempfile.gettempdir()
        symlink_path = os.path.join(temp_dir, f"{prefix}.log")

    try:
        if os.path.islink(symlink_path) or os.path.exists(symlink_path):
            if verbose:
                print(f"Deleting previous symlink to the logfile: {symlink_path}")
            os.remove(symlink_path)
        os.symlink(logfile_path, symlink_path)
        if verbose:
            print(f"Symlink to logfile created: {symlink_path} -> {logfile_path}")
    except OSError as e:
        print(f"Error creating symlink to logfile:  {symlink_path} -> {logfile_path} ({e})")

class CustomFormatter(logging.Formatter):

    grey = "\x1b[38;20m"
    yellow = "\x1b[33;20m"
    red = "\x1b[31;20m"
    bold_red = "\x1b[31;1m"
    reset = "\x1b[0m"
    # format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s (%(filename)s:%(lineno)d)"
    format_string = '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
    datefmt = '%H:%M:%S'

    FORMATS = {
        logging.DEBUG: grey + format_string + reset,
        logging.INFO: format_string,
        logging.WARNING: yellow + format_string + reset,
        logging.ERROR: red + format_string + reset,
        logging.CRITICAL: bold_red + format_string + reset
    }

    def format(self, record):
        log_fmt = self.FORMATS.get(record.levelno)
        formatter = logging.Formatter(log_fmt, datefmt=self.datefmt)
        return formatter.format(record)