Function setup_logger

quantmind/utils/logger.py:80–137

Set up a logger with consistent formatting and optional colors. Args: name: Logger name (defaults to 'quantmind') level: Logging level format_string: Custom format string use_color: Whether to use colors (auto-detect if None) file_output: Optional file pa

(
    name: Optional[str] = None,
    level: int = logging.INFO,
    format_string: Optional[str] = None,
    use_color: Optional[bool] = None,
    file_output: Optional[str] = None,
)

def setup_logger(
    name: Optional[str] = None,
    level: int = logging.INFO,
    format_string: Optional[str] = None,
    use_color: Optional[bool] = None,
    file_output: Optional[str] = None,
) -> logging.Logger:
    """Set up a logger with consistent formatting and optional colors.

    Args:
        name: Logger name (defaults to 'quantmind')
        level: Logging level
        format_string: Custom format string
        use_color: Whether to use colors (auto-detect if None)
        file_output: Optional file path for file logging

    Returns:
        Configured logger instance
    """
    if name is None:
        name = "quantmind"

    if format_string is None:
        format_string = "[%(asctime)s %(levelname)-8s %(name)s %(filename)s:%(lineno)d] %(message)s"

    logger = logging.getLogger(name)

    # Only configure if not already configured
    if not logger.handlers:
        logger.setLevel(level)

        # Create console handler
        console_handler = logging.StreamHandler(sys.stdout)
        console_handler.setLevel(level)

        # Create colored formatter for console
        console_formatter = ColoredFormatter(
            format_string, datefmt="%Y-%m-%d %H:%M:%S", use_color=use_color
        )
        console_handler.setFormatter(console_formatter)
        logger.addHandler(console_handler)

        # Add file handler if requested
        if file_output:
            file_handler = logging.FileHandler(file_output)
            file_handler.setLevel(level)

            # File output should not have colors
            file_formatter = logging.Formatter(
                format_string, datefmt="%Y-%m-%d %H:%M:%S"
            )
            file_handler.setFormatter(file_formatter)
            logger.addHandler(file_handler)

        # Prevent propagation to root logger
        logger.propagate = False

    return logger