Skip to content

libdebug.liblog

LibLog

Custom logger singleton class that can be used to log messages to the console.

Source code in libdebug/liblog.py 
 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
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
class LibLog:
    """Custom logger singleton class that can be used to log messages to the console."""

    _instance = None

    def __new__(cls: type):
        """Create a new instance of the class if it does not exist yet.

        Returns:
            LibLog: the instance of the class.
        """
        if cls._instance is None:
            cls._instance = super().__new__(cls)
            cls._instance._initialized = False
        return cls._instance

    def __init__(self: LibLog) -> None:
        """Initializes the logger."""
        if self._initialized:
            return

        # Add custom log levels
        logging.addLevelName(60, "SILENT")
        logging.SILENT = 60

        # General logger
        self.general_logger = self._setup_logger("libdebug", logging.INFO)

        # Component-specific loggers
        self.debugger_logger = self._setup_logger("debugger", logging.SILENT)
        self.pipe_logger = self._setup_logger("pipe", logging.SILENT)

        self._initialized = True

    def _setup_logger(self: LibLog, name: str, level: int) -> logging.Logger:
        """Setup a logger with the given name and level.

        Args:
            name (str): name of the logger.
            level (int): logging level.

        Returns:
            logging.Logger: the logger object.
        """
        logger = logging.getLogger(name)
        logger.setLevel(level)
        handler = logging.StreamHandler()
        formatter = logging.Formatter("%(message)s")
        handler.setFormatter(formatter)
        logger.addHandler(handler)

        return logger

    def debugger(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
        """Log a message to the debugger logger.

        Args:
            message (str): the message to log.
            *args: positional arguments to pass to the logger.
            **kwargs: keyword arguments to pass to the logger.
        """
        header = f"[{ANSIColors.RED}DEBUGGER{ANSIColors.DEFAULT_COLOR}]"
        self.debugger_logger.debug(f"{header} {message}", *args, **kwargs)

    def pipe(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
        """Log a message to the pipe logger.

        Args:
            message (str): the message to log.
            *args: positional arguments to pass to the logger.
            **kwargs: keyword arguments to pass to the logger.
        """
        header = f"[{ANSIColors.BLUE}PIPE{ANSIColors.DEFAULT_COLOR}]"
        self.pipe_logger.debug(f"{header} {message}", *args, **kwargs)

    def info(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
        """Log a info message to the general logger.

        Args:
            message (str): the message to log.
            *args: positional arguments to pass to the logger.
            **kwargs: keyword arguments to pass to the logger.
        """
        header = f"[{ANSIColors.GREEN}INFO{ANSIColors.DEFAULT_COLOR}]"
        self.general_logger.info(f"{header} {message}", *args, **kwargs)

    def warning(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
        """Log a warning message to the general logger.

        Args:
            message (str): the message to log.
            *args: positional arguments to pass to the logger.
            **kwargs: keyword arguments to pass to the logger.
        """
        header = f"[{ANSIColors.BRIGHT_YELLOW}WARNING{ANSIColors.DEFAULT_COLOR}]"
        self.general_logger.warning(f"{header} {message}", *args, **kwargs)

    def error(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
        """Log an error message to the general logger.

        Args:
            message (str): the message to log.
            *args: positional arguments to pass to the logger.
            **kwargs: keyword arguments to pass to the logger.
        """
        header = f"[{ANSIColors.RED}ERROR{ANSIColors.DEFAULT_COLOR}]"
        self.general_logger.error(f"{header} {message}", *args, **kwargs)

__init__()

Initializes the logger.

Source code in libdebug/liblog.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
def __init__(self: LibLog) -> None:
    """Initializes the logger."""
    if self._initialized:
        return

    # Add custom log levels
    logging.addLevelName(60, "SILENT")
    logging.SILENT = 60

    # General logger
    self.general_logger = self._setup_logger("libdebug", logging.INFO)

    # Component-specific loggers
    self.debugger_logger = self._setup_logger("debugger", logging.SILENT)
    self.pipe_logger = self._setup_logger("pipe", logging.SILENT)

    self._initialized = True

__new__()

Create a new instance of the class if it does not exist yet.

Returns:

Name Type Description
LibLog

the instance of the class.
Source code in libdebug/liblog.py 
19
20
21
22
23
24
25
26
27
28
def __new__(cls: type):
    """Create a new instance of the class if it does not exist yet.

    Returns:
        LibLog: the instance of the class.
    """
    if cls._instance is None:
        cls._instance = super().__new__(cls)
        cls._instance._initialized = False
    return cls._instance

debugger(message, *args, **kwargs)

Log a message to the debugger logger.

Parameters:

Name Type Description Default
message str

the message to log.

 required
*args str

positional arguments to pass to the logger.

 ()
**kwargs str

keyword arguments to pass to the logger.

 {}
Source code in libdebug/liblog.py 
67
68
69
70
71
72
73
74
75
76
def debugger(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
    """Log a message to the debugger logger.

    Args:
        message (str): the message to log.
        *args: positional arguments to pass to the logger.
        **kwargs: keyword arguments to pass to the logger.
    """
    header = f"[{ANSIColors.RED}DEBUGGER{ANSIColors.DEFAULT_COLOR}]"
    self.debugger_logger.debug(f"{header} {message}", *args, **kwargs)

error(message, *args, **kwargs)

Log an error message to the general logger.

Parameters:

Name Type Description Default
message str

the message to log.

 required
*args str

positional arguments to pass to the logger.

 ()
**kwargs str

keyword arguments to pass to the logger.

 {}
Source code in libdebug/liblog.py 
111
112
113
114
115
116
117
118
119
120
def error(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
    """Log an error message to the general logger.

    Args:
        message (str): the message to log.
        *args: positional arguments to pass to the logger.
        **kwargs: keyword arguments to pass to the logger.
    """
    header = f"[{ANSIColors.RED}ERROR{ANSIColors.DEFAULT_COLOR}]"
    self.general_logger.error(f"{header} {message}", *args, **kwargs)

info(message, *args, **kwargs)

Log a info message to the general logger.

Parameters:

Name Type Description Default
message str

the message to log.

 required
*args str

positional arguments to pass to the logger.

 ()
**kwargs str

keyword arguments to pass to the logger.

 {}
Source code in libdebug/liblog.py 
89
90
91
92
93
94
95
96
97
98
def info(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
    """Log a info message to the general logger.

    Args:
        message (str): the message to log.
        *args: positional arguments to pass to the logger.
        **kwargs: keyword arguments to pass to the logger.
    """
    header = f"[{ANSIColors.GREEN}INFO{ANSIColors.DEFAULT_COLOR}]"
    self.general_logger.info(f"{header} {message}", *args, **kwargs)

pipe(message, *args, **kwargs)

Log a message to the pipe logger.

Parameters:

Name Type Description Default
message str

the message to log.

 required
*args str

positional arguments to pass to the logger.

 ()
**kwargs str

keyword arguments to pass to the logger.

 {}
Source code in libdebug/liblog.py 
78
79
80
81
82
83
84
85
86
87
def pipe(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
    """Log a message to the pipe logger.

    Args:
        message (str): the message to log.
        *args: positional arguments to pass to the logger.
        **kwargs: keyword arguments to pass to the logger.
    """
    header = f"[{ANSIColors.BLUE}PIPE{ANSIColors.DEFAULT_COLOR}]"
    self.pipe_logger.debug(f"{header} {message}", *args, **kwargs)

warning(message, *args, **kwargs)

Log a warning message to the general logger.

Parameters:

Name Type Description Default
message str

the message to log.

 required
*args str

positional arguments to pass to the logger.

 ()
**kwargs str

keyword arguments to pass to the logger.

 {}
Source code in libdebug/liblog.py 
100
101
102
103
104
105
106
107
108
109
def warning(self: LibLog, message: str, *args: str, **kwargs: str) -> None:
    """Log a warning message to the general logger.

    Args:
        message (str): the message to log.
        *args: positional arguments to pass to the logger.
        **kwargs: keyword arguments to pass to the logger.
    """
    header = f"[{ANSIColors.BRIGHT_YELLOW}WARNING{ANSIColors.DEFAULT_COLOR}]"
    self.general_logger.warning(f"{header} {message}", *args, **kwargs)