Skip to content

textual_shell.app

BaseShellApp

Bases: App

Base app for the shell. Needed to catch messages sent by commands.

Source code in src/textual_shell/app.py 
 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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class BaseShellApp(App):
    """Base app for the shell. Needed to catch messages sent by commands."""

    DEFAULT_CSS = """
            Screen {
                layers: shell popup;
            }
        """

    def _get_job_manager(self) -> JobManager:
        """Search through all of the screens to find
        the one with the Job Manager widget."""
        for screen in self.app.screen_stack:
            try: 
                return screen.query_one(JobManager)

            except NoMatches as e:
                pass

    def _get_shell(self) -> BaseShell:
        """Search through all of the screens to find
        the one with the Shell widget."""
        for screen in self.app.screen_stack:
            try:
                return screen.query_one(BaseShell)

            except NoMatches as e:
                pass

    def _get_console_log(self) -> ConsoleLog:
        """Search through all of the screens to find
        the one with the ConsoleLog widget"""
        for screen in self.app.screen_stack:
            try: 
                return screen.query_one(ConsoleLog)

            except NoMatches as e:
                pass     

    def on_set_job_settings_changed(self, event: SetJob.SettingsChanged) -> None:
        """
        Catch messages for when a setting has been changed.
        Update the settings display to reflect the new value.
        """
        event.stop()
        try:
            settings_display = self.query_one(SettingsDisplay)
            table = settings_display.query_one(DataTable)
            row_key = f'{event.section_name}.{event.setting_name}'
            column_key = settings_display.column_keys[1]
            table.update_cell(row_key, column_key, event.value, update_width=True)

        except NoMatches as e:
            log(f'SettingsDisplay widget is not in the DOM.')

    def on_console_log_reload(self, event: ConsoleLog.Reload) -> None:
        """Handle Reloading the settings."""
        event.stop()
        shell = self._get_shell()
        if set := shell.get_cmd_obj('set'):
            set.load_sections()

        try:
            settings_display = self.query_one(SettingsDisplay)
            settings_display.reload()

        except NoMatches as e:
            log(f'SettingsDisplay widget is not in the DOM.')

    def on_job_log(self, event: Job.Log) -> None:
        """
        Catch any logs sent by any Job and write 
        them to the ConsoleLog widget.
        """
        event.stop()
        try:
            console_log = self._get_console_log()
            rich_log = console_log.query_one(RichLog)
            log_entry = console_log.gen_record(event)
            if log_entry:
                rich_log.write(log_entry)

        except NoMatches as e:
            log(f'Console Log not found')

    def on_command_log(self, event: Command.Log) -> None:
        """
        Catch any logs sent by any Command and write
        them to the ConsoleLog widget
        """
        event.stop()
        try:
            console_log = self._get_console_log()
            rich_log = console_log.query_one(RichLog)
            log_entry = console_log.gen_record(event)
            if log_entry:
                rich_log.write(log_entry)

        except NoMatches as e:
            log(f'Console Log not found.')

    def on_console_clear(self, event: Console.Clear):
        """Handler for clearing the console."""
        event.stop()
        try:
            console_log = self.query_one(ConsoleLog)
            rich_log = console_log.query_one(RichLog)
            rich_log.clear()

        except NoMatches as e:
            pass      

    def on_history_clear(self, event: History.Clear):
        """Handler for clearing the history log."""
        event.stop()
        try:
            shell = self._get_shell()
            history = shell.query_one(RichLog)
            history.clear()
            shell.history_count = 0
            shell.update_suggestions_location(0)

        except NoMatches as e:
            pass

    def on_job_start(self, event: Job.Start) -> None:
        """Add new jobs."""
        event.stop()
        job_manager = self._get_job_manager()
        job_manager.add_job(event.job)

        shell = self._get_shell()
        jobs = shell.get_cmd_obj('jobs')
        jobs.add_job_id(event.job.id)

    def on_job_finish(self, event: Job.Finish) -> None:
        """Clean up finished jobs."""
        event.stop()
        job_manager = self._get_job_manager()
        job_manager.remove_job(event.job_id)

        shell = self._get_shell()
        jobs = shell.get_cmd_obj('jobs')
        jobs.remove_job_id(event.job_id)

    def on_job_status_change(self, event: Job.StatusChange) -> None:
        """Update the status of a job."""
        event.stop()
        job_manager = self._get_job_manager()
        job_manager.update_job_status(event.job_id, event.status)

    def on_attach_to_job(self, event: Attach.To_Job) -> None:
        """Attach to the jobs screen."""
        event.stop()
        job_manager = self._get_job_manager()
        job_manager.switch_job_screen(event.job_id)

    def on_kill_selected(self, event: Kill.Selected) -> None:
        """Kill the job."""
        event.stop()
        job_manager =self._get_job_manager()
        job_manager.kill_job(event.job_id)

on_attach_to_job(event)

Attach to the jobs screen.

Source code in src/textual_shell/app.py 
177
178
179
180
181
def on_attach_to_job(self, event: Attach.To_Job) -> None:
    """Attach to the jobs screen."""
    event.stop()
    job_manager = self._get_job_manager()
    job_manager.switch_job_screen(event.job_id)

on_command_log(event)

Catch any logs sent by any Command and write them to the ConsoleLog widget

Source code in src/textual_shell/app.py 
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
def on_command_log(self, event: Command.Log) -> None:
    """
    Catch any logs sent by any Command and write
    them to the ConsoleLog widget
    """
    event.stop()
    try:
        console_log = self._get_console_log()
        rich_log = console_log.query_one(RichLog)
        log_entry = console_log.gen_record(event)
        if log_entry:
            rich_log.write(log_entry)

    except NoMatches as e:
        log(f'Console Log not found.')

on_console_clear(event)

Handler for clearing the console.

Source code in src/textual_shell/app.py 
127
128
129
130
131
132
133
134
135
136
def on_console_clear(self, event: Console.Clear):
    """Handler for clearing the console."""
    event.stop()
    try:
        console_log = self.query_one(ConsoleLog)
        rich_log = console_log.query_one(RichLog)
        rich_log.clear()

    except NoMatches as e:
        pass

on_console_log_reload(event)

Handle Reloading the settings.

Source code in src/textual_shell/app.py 
81
82
83
84
85
86
87
88
89
90
91
92
93
def on_console_log_reload(self, event: ConsoleLog.Reload) -> None:
    """Handle Reloading the settings."""
    event.stop()
    shell = self._get_shell()
    if set := shell.get_cmd_obj('set'):
        set.load_sections()

    try:
        settings_display = self.query_one(SettingsDisplay)
        settings_display.reload()

    except NoMatches as e:
        log(f'SettingsDisplay widget is not in the DOM.')

on_history_clear(event)

Handler for clearing the history log.

Source code in src/textual_shell/app.py 
138
139
140
141
142
143
144
145
146
147
148
149
def on_history_clear(self, event: History.Clear):
    """Handler for clearing the history log."""
    event.stop()
    try:
        shell = self._get_shell()
        history = shell.query_one(RichLog)
        history.clear()
        shell.history_count = 0
        shell.update_suggestions_location(0)

    except NoMatches as e:
        pass

on_job_finish(event)

Clean up finished jobs.

Source code in src/textual_shell/app.py 
161
162
163
164
165
166
167
168
169
def on_job_finish(self, event: Job.Finish) -> None:
    """Clean up finished jobs."""
    event.stop()
    job_manager = self._get_job_manager()
    job_manager.remove_job(event.job_id)

    shell = self._get_shell()
    jobs = shell.get_cmd_obj('jobs')
    jobs.remove_job_id(event.job_id)

on_job_log(event)

Catch any logs sent by any Job and write them to the ConsoleLog widget.

Source code in src/textual_shell/app.py 
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def on_job_log(self, event: Job.Log) -> None:
    """
    Catch any logs sent by any Job and write 
    them to the ConsoleLog widget.
    """
    event.stop()
    try:
        console_log = self._get_console_log()
        rich_log = console_log.query_one(RichLog)
        log_entry = console_log.gen_record(event)
        if log_entry:
            rich_log.write(log_entry)

    except NoMatches as e:
        log(f'Console Log not found')

on_job_start(event)

Add new jobs.

Source code in src/textual_shell/app.py 
151
152
153
154
155
156
157
158
159
def on_job_start(self, event: Job.Start) -> None:
    """Add new jobs."""
    event.stop()
    job_manager = self._get_job_manager()
    job_manager.add_job(event.job)

    shell = self._get_shell()
    jobs = shell.get_cmd_obj('jobs')
    jobs.add_job_id(event.job.id)

on_job_status_change(event)

Update the status of a job.

Source code in src/textual_shell/app.py 
171
172
173
174
175
def on_job_status_change(self, event: Job.StatusChange) -> None:
    """Update the status of a job."""
    event.stop()
    job_manager = self._get_job_manager()
    job_manager.update_job_status(event.job_id, event.status)

on_kill_selected(event)

Kill the job.

Source code in src/textual_shell/app.py 
183
184
185
186
187
def on_kill_selected(self, event: Kill.Selected) -> None:
    """Kill the job."""
    event.stop()
    job_manager =self._get_job_manager()
    job_manager.kill_job(event.job_id)

on_set_job_settings_changed(event)

Catch messages for when a setting has been changed. Update the settings display to reflect the new value.

Source code in src/textual_shell/app.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def on_set_job_settings_changed(self, event: SetJob.SettingsChanged) -> None:
    """
    Catch messages for when a setting has been changed.
    Update the settings display to reflect the new value.
    """
    event.stop()
    try:
        settings_display = self.query_one(SettingsDisplay)
        table = settings_display.query_one(DataTable)
        row_key = f'{event.section_name}.{event.setting_name}'
        column_key = settings_display.column_keys[1]
        table.update_cell(row_key, column_key, event.value, update_width=True)

    except NoMatches as e:
        log(f'SettingsDisplay widget is not in the DOM.')