|
| 1 | +import logging |
| 2 | + |
| 3 | + |
| 4 | +# Custom log formatter to add colors for different log levels and show line numbers |
| 5 | +class ColoredFormatter(logging.Formatter): |
| 6 | + """Custom log formatter to add colors for different log levels and show line numbers""" |
| 7 | + |
| 8 | + # ANSI color codes |
| 9 | + COLORS = { |
| 10 | + 'DEBUG': '\033[36m', # cyan |
| 11 | + 'INFO': '\033[32m', # green |
| 12 | + 'WARNING': '\033[33m', # yellow |
| 13 | + 'ERROR': '\033[31m', # red |
| 14 | + 'CRITICAL': '\033[35m', # purple |
| 15 | + 'RESET': '\033[0m', # reset |
| 16 | + } |
| 17 | + |
| 18 | + def format(self, record: logging.LogRecord) -> str: |
| 19 | + # Obtain the color corresponding to the log level |
| 20 | + log_color = self.COLORS.get(record.levelname, self.COLORS['RESET']) |
| 21 | + reset_color = self.COLORS['RESET'] |
| 22 | + |
| 23 | + # Add color to log level |
| 24 | + record.levelname = f'{log_color}{record.levelname}{reset_color}' |
| 25 | + |
| 26 | + # Call the format method of the parent class |
| 27 | + return super().format(record) |
| 28 | + |
| 29 | + |
| 30 | +def get_logger(logger: logging.Logger) -> logging.Logger: |
| 31 | + """ |
| 32 | + Configure and return a custom logger with a specific format and color scheme |
| 33 | +
|
| 34 | + Args: |
| 35 | + logger (logging.Logger): The logger to configure. |
| 36 | +
|
| 37 | + Returns: |
| 38 | + logging.Logger: The configured logger. |
| 39 | + """ |
| 40 | + # Configure the logger |
| 41 | + logger.setLevel(logging.INFO) |
| 42 | + |
| 43 | + # Create console processor |
| 44 | + console_handler = logging.StreamHandler() |
| 45 | + console_handler.setLevel(logging.INFO) |
| 46 | + |
| 47 | + # Create formatter with function name before line number |
| 48 | + formatter = ColoredFormatter('%(asctime)s | %(levelname)s | %(name)s:%(funcName)s:%(lineno)d | %(message)s') |
| 49 | + console_handler.setFormatter(formatter) |
| 50 | + |
| 51 | + # Add handler to logger |
| 52 | + logger.addHandler(console_handler) |
| 53 | + |
| 54 | + return logger |
0 commit comments