Skip to content

ConsoleLog

This widget is used to display logs from commands.

ConsoleLog

Bases: Widget

Custom widget to write logs from the commands. The severity levels are the same as the logging module. The different levels map to different colors for markup. Command names are magenta1 and all uppercase.

Parameters:

Name Type Description Default
config_path str

The path to the config.

 required
Source code in src/textual_shell/widgets/console_log.py 
 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
class ConsoleLog(Widget):
    """
    Custom widget to write logs from the commands.
    The severity levels are the same as the logging module.
    The different levels map to different colors for markup.
    Command names are magenta1 and all uppercase.

    Args:
        config_path (str): The path to the config.
    """

    class Reload(Message):
        """Message to Reload both the Set command and settings display"""
        pass

    COLOR_MAPPING = {
        logging.INFO: 'steel_blue1',
        logging.DEBUG: 'green1',
        logging.WARNING: 'yellow1',
        logging.ERROR: 'bright_red',
        logging.CRITICAL: 'dark_red'
    }

    DEFAULT_CSS = """
        ConsoleLog {
            height: 50;
            border: round white;

            Label {
                text-align: center;
                width: auto;
            }

            RichLog {
                height: auto;
                max-height: 50;
                border: none;
                border-top: solid white;
                background: transparent;
            }
        }
    """

    DEFAULT_CONFIG = {
        'Logging': {
            'description': 'The config for logging.',
            'console-lvl': {
                'description': 'The minimum severity level for the console log.',
                'value': 'INFO',
                'options': {
                    'DEBUG': 10,
                    'INFO': 20,
                    'WARNING': 30,
                    'ERROR': 40,
                    'CRITICAL': 50
                }
            }   
        }
    }

    def __init__(
        self,
        config_path: Annotated[str, 'The path to the config.'],
        *args, **kwargs
    ) -> None:
        super().__init__(*args, **kwargs)
        self.config_path = config_path

    def compose(self) -> ComposeResult:
        yield Container(
            Label('Console Log'),
            RichLog(markup=True)
        )

    def on_mount(self) -> None:
        if not configure.check_section('Logging', self.config_path):
            configure.add_section(
                'Logging',
                self.DEFAULT_CONFIG,
                self.config_path
            )
            self.post_message(self.Reload())

    def check_log_level(
        self,
        severity: Annotated[int, 'The severity level of the log.']
    ) -> Annotated[
        bool, 
        'True if the severity level is >= to the logging level.'
    ]:
        """
        Check if the log level is greater or equal to the current logging
        level

        Args:
            severity (int): The severity level of the log.

        Returns:
            check (bool): True if it is else False.
        """
        current_level_name = configure.get_setting_value(
            'Logging',
            'console-lvl',
            self.config_path
        )

        current_level = logging.getLevelNamesMapping()[current_level_name]

        if severity >= current_level:
            return True

        return False

    def gen_record(self, event: Command.Log | Job.Log) -> str:
        """
        Handle the log from the command or Job.

        Args:
            event (Command.Log)

        Returns:
            msg (str): The Rich formatted log.
        """
        if not self.check_log_level(event.severity):
            return None

        level_name = logging.getLevelName(event.severity)
        color = self.COLOR_MAPPING[event.severity]

        lvl = f'[{color}]{level_name}[/{color}]'
        cmd = f'[bold magenta1]{event.sender.upper()}[/bold magenta1]'
        time = f"[steel_blue]{datetime.now().strftime('[%H:%M:%S]')}[/steel_blue]"

        msg = f'{time} {lvl}  {cmd} - {event.msg}'
        return msg

Reload

Bases: Message

Message to Reload both the Set command and settings display

Source code in src/textual_shell/widgets/console_log.py 
26
27
28
class Reload(Message):
    """Message to Reload both the Set command and settings display"""
    pass

check_log_level(severity)

Check if the log level is greater or equal to the current logging level

Parameters:

Name Type Description Default
severity int

The severity level of the log.

 required

Returns:

Name Type Description
check bool

True if it is else False.
Source code in src/textual_shell/widgets/console_log.py 
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def check_log_level(
    self,
    severity: Annotated[int, 'The severity level of the log.']
) -> Annotated[
    bool, 
    'True if the severity level is >= to the logging level.'
]:
    """
    Check if the log level is greater or equal to the current logging
    level

    Args:
        severity (int): The severity level of the log.

    Returns:
        check (bool): True if it is else False.
    """
    current_level_name = configure.get_setting_value(
        'Logging',
        'console-lvl',
        self.config_path
    )

    current_level = logging.getLevelNamesMapping()[current_level_name]

    if severity >= current_level:
        return True

    return False

gen_record(event)

Handle the log from the command or Job.

Returns:

Name Type Description
msg str

The Rich formatted log.
Source code in src/textual_shell/widgets/console_log.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def gen_record(self, event: Command.Log | Job.Log) -> str:
    """
    Handle the log from the command or Job.

    Args:
        event (Command.Log)

    Returns:
        msg (str): The Rich formatted log.
    """
    if not self.check_log_level(event.severity):
        return None

    level_name = logging.getLevelName(event.severity)
    color = self.COLOR_MAPPING[event.severity]

    lvl = f'[{color}]{level_name}[/{color}]'
    cmd = f'[bold magenta1]{event.sender.upper()}[/bold magenta1]'
    time = f"[steel_blue]{datetime.now().strftime('[%H:%M:%S]')}[/steel_blue]"

    msg = f'{time} {lvl}  {cmd} - {event.msg}'
    return msg