summaryrefslogtreecommitdiff
path: root/src/pyssg/custom_logger.py
blob: 4eebc4cae6f3f611513bded25a8dab78bebabbfa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
import sys
from logging import (Logger, StreamHandler, Formatter, LogRecord,
                     DEBUG, INFO, WARNING, ERROR, CRITICAL,
                     getLogger)
from typing import TextIO

LOG_LEVEL: int = INFO
# 'pyssg' es the name of the root logger
LOGGER_NAME: str = 'pyssg'


# only reason for this class is to get info formatting as normal text
#   and everything else with more info and with colors
class PerLevelFormatter(Formatter):
    # colors for the terminal in ansi
    __YELLOW: str = '\x1b[33m'
    __RED: str = '\x1b[31m'
    __BOLD_RED: str = '\x1b[31;1m'
    __RESET: str = '\x1b[0m'

    __DATE_FMT: str = '%Y-%m-%d %H:%M:%S'
    __COMMON_FMT: str = '[%(levelname)s] [%(module)s:%(funcName)s:%(lineno)d]: %(message)s'
    __FORMATS: dict[int, str] = {
        DEBUG: __COMMON_FMT,
        INFO: '%(message)s',
        WARNING: f'{__YELLOW}{__COMMON_FMT}{__RESET}',
        ERROR: f'{__RED}{__COMMON_FMT}{__RESET}',
        CRITICAL: f'{__BOLD_RED}{__COMMON_FMT}{__RESET}'
    }

    def format(self, record: LogRecord) -> str:
        # this should never fail, as __FORMATS is defined above,
        #   so no issue of just converting to str
        fmt: str = str(self.__FORMATS.get(record.levelno))
        formatter: Formatter = Formatter(
            fmt=fmt, datefmt=self.__DATE_FMT, style='%')
        return formatter.format(record)


def setup_logger(name: str = LOGGER_NAME, level: int = LOG_LEVEL) -> None:
    logger: Logger = getLogger(name)
    handler: StreamHandler[TextIO] = StreamHandler(sys.stdout)
    logger.setLevel(level)
    handler.setLevel(level)
    handler.setFormatter(PerLevelFormatter())
    logger.addHandler(handler)