BaseShell

BaseShell

Bases: Widget

Base class for the shell. Subclasses need to implement the command_entered method.

Pressing the up arrow key will cycle up through the history. Pressing the down arrow key will cycle down through the history, Pressing ctrl+c will clear the prompt input.

Parameters:

Name	Type	Description	Default
commands	List[Command]	List of shell commands.	required
prompt	str	prompt for the shell.	required
history_log	str	The path for the history log file.	None

Source code in src/textual_shell/widgets/shell/base_shell.py

class BaseShell(Widget):
    """
    Base class for the shell. 
    Subclasses need to implement the command_entered method.

    Pressing the up arrow key will cycle up through the history.
    Pressing the down arrow key will cycle down through the history,
    Pressing ctrl+c will clear the prompt input.

    Args:
        commands (List[Command]): List of shell commands.
        prompt (str): prompt for the shell.
        history_log (str): The path for the history log file. 
    """

    is_prompt_focused = reactive(True)
    are_suggestions_focused = reactive(False)
    show_suggestions = reactive(False)
    history_list: reactive[deque[str]] = reactive(deque)
    history_count = 0;

    BINDINGS = [
        Binding('up', 'up_history', 'Cycle up through the history'),
        Binding('down', 'down_history', 'Cycle down through the history'),
        Binding('ctrl+c', 'clear_prompt', 'Clear the input prompt', priority=True)
    ]

    def __init__(
        self,
        commands: Annotated[List[Command], 'List of Shell Commands'],
        prompt: Annotated[str, 'prompt for the shell.'],
        history_log: Annotated[str, 'The path to write the history log too.']=None,
        *args, **kwargs
    ) -> None:
        super().__init__(*args, **kwargs)
        self.commands = commands
        self.command_list = [cmd.name for cmd in self.commands]
        self.prompt = prompt
        self.current_history_index = None

        for cmd in self.commands:
            cmd.shell = self

    def _get_prompt(self) -> Prompt:
        """
        Query the DOM for the child Prompt widget.

        Returns:
            prompt (Prompt): The child widget.
        """
        return self.query_one(Prompt)

    def _get_prompt_input(self) -> PromptInput:
        """
        Retrieve the PromptInput widget from the DOM.

        Returns:
            prompt_input (PromptInput): The child widget.
        """
        prompt = self._get_prompt()
        return prompt.query_one(PromptInput)

    def on_mount(self):
        """Update the location and suggestions for auto-completions."""
        self.get_offset()
        self.update_suggestions(self.command_list)

    def compose(self) -> ComposeResult:
        yield Container(
            RichLog(markup=True),
            Prompt(
                prompt=self.prompt,
            )
        )
        yield Suggestions()

    def get_cmd_obj(
        self,
        cmd: Annotated[str, 'The name of the command.']
    ) -> Command:
        """
        Retrieve the cmd instance.

        Args:
            cmd (str): The name of the command.

        Returns:
            command (Command): The command instance for the command.
        """
        for command in self.commands:
            if command.name == cmd:
                return command

        return None

    def get_offset(self) -> None:
        """Calculate the offset for the cursor location."""
        prompt_input = self._get_prompt_input()
        self.prompt_input_offset = Offset(
            prompt_input.offset.x + len(self.prompt) + 1,
            prompt_input.offset.y + 2
        )

    def update_suggestions(
        self,
        suggestions: Annotated[List[str], 'suggestions for the OptionList.']
    ) -> None:
        """
        Update the list of Suggestions.

        Args:
            suggestions (List[str]): The new suggestions.

        """
        ol = self.query_one(Suggestions)
        ol.clear_options()
        if self.show_suggestions:
            ol.visible = False if len(suggestions) == 0 else True
        ol.add_options(suggestions)

    def update_suggestions_location(
        self, 
        cursor: Annotated[int, 'The x location of the cursor.']
    ) -> None:
        """
        Update the location of the Suggestions.

        Args:
            cursor (int): The x location of the cursor.
        """
        rich_log = self.query_one(RichLog)
        ol = self.query_one(Suggestions)
        ol.styles.offset = (
            self.prompt_input_offset.x + cursor,
            self.prompt_input_offset.y + min(
                self.history_count, rich_log.styles.max_height.value
            )
        )

    def update_prompt_input(
        self,
        suggestion: Annotated[str, 'The selected suggestion.']
    ) -> None:
        """
        Add the suggestion to the prompt input.
        This will prevent Input.Changed events from generating.

        Args:
            suggestion (str): The selected suggestion.
        """
        prompt_input = self._get_prompt_input()
        with prompt_input.prevent(Input.Changed):
            cmd_split = prompt_input.value.split(' ')
            cmd_split[-1] = suggestion
            prompt_input.value = ' '.join(cmd_split)

    def on_prompt_input_auto_complete(
        self,
        event: PromptInput.AutoComplete
    ) -> None:
        """
        Handle auto complete request. 

        Args:
            event (PromptInput.AutoComplete)
        """
        event.stop()
        ol = self.query_one(Suggestions)
        if ol.option_count == 0 or not ol.visible:
            return

        if not ol.highlighted:
            ol.highlighted = 0

        ol.focus()
        suggestion = ol.get_option_at_index(ol.highlighted).prompt
        self.update_prompt_input(suggestion)

    def on_suggestions_cycle(self, event: Suggestions.Cycle) -> None:
        """
        Update the prompt input with the next suggestion.

        Args:
            event (Suggestions.Cycle)
        """
        event.stop()
        self.update_prompt_input(event.next)

    def on_suggestions_continue(self, event: Suggestions.Continue) -> None:
        """
        Add a space to the prompt_input and switch back focus.

        Args:
            event (Suggestions.Continue)
        """
        event.stop()
        prompt_input = self._get_prompt_input()
        prompt_input.value += ' '
        prompt_input.action_end()
        prompt_input.focus()

    def on_suggestions_execute(self, event: Suggestions.Execute) -> None:
        """
        Execute the command.

        Args:
            event (Suggestions.Execute)
        """
        event.stop()
        prompt_input = self._get_prompt_input()
        self.command_entered(prompt_input.value)
        prompt_input.value = ''
        prompt_input.action_home()
        prompt_input.focus()

    def on_prompt_input_focus_change(self, event: PromptInput.FocusChange) -> None:
        """
        Handler for when the prompt_input has gained or lost focus.

        Args:
            event (PromptInput.FocusChange)
        """
        event.stop()
        self.is_prompt_focused = event.is_focused

    def on_prompt_input_show(self, event: PromptInput.Show) -> None:
        """
        Handler for showing the Suggestions.

        Args:
            event (PromptInput.Show)
        """
        event.stop()
        self.update_suggestions_location(event.cursor_position)
        self.show_suggestions = True

    def on_prompt_input_hide(self, event: PromptInput.Hide) -> None:
        """
        Handler for hiding the Suggestions.

        Args:
            event (PromptInput.Hide)
        """
        event.stop()
        self.show_suggestions = False

    def get_suggestions(
        self,
        cmd_line: Annotated[str, 'The input from the prompt.']
    ) -> None:
        """
        Get the suggestions for the current state of the command line.

        Args:
            cmd_line (str): The input from the prompt.
        """
        cmd_input = cmd_line.split(' ')
        if len(cmd_input) == 1:
            val = cmd_input[0]
            suggestions = ([cmd for cmd in self.command_list if cmd.startswith(val)] 
                                if val else self.command_list)

        else:
            if cmd_input[0] == 'help':
                if len(cmd_input) < 3:
                    suggestions = self.command_list

                else: 
                    suggestions = []

            else:
                if cmd := self.get_cmd_obj(cmd_input[0]):
                    suggestions = cmd.get_suggestions(cmd_input[:-1])

                else:
                    suggestions = []

            suggestions = [sub_cmd for sub_cmd in suggestions if sub_cmd.startswith(cmd_input[-1])]

        self.update_suggestions(suggestions)

    def on_prompt_command_input(self, event: Prompt.CommandInput) -> None:
        """
        Handler for when the user has typed into the prompt.

        Args:
            event (Prompt.CommandInput)
        """
        event.stop()
        self.get_suggestions(event.cmd_input)
        self.update_suggestions_location(event.cursor_position)

    def command_entered(
        self,
        cmdline: Annotated[str, 'The command line entered.']
    ) -> None:
        """
        Handler for how the shell should go about executing the command.
        Please override this in your shell.

        Args:
            cmdline (str): The command line entered.

        Raises:
            NotImplementedError: If not overridden in a derived class.
        """
        raise NotImplementedError('Subclasses must override.')

    def on_prompt_command_entered(self, event: Prompt.CommandEntered) -> None:
        """
        Handler for when a command has been entered.
        Execute the command in a worker thread.

        Args:
            event (Prompt.CommandEntered)
        """
        event.stop()
        self.command_entered(event.cmd)

    def on_suggestions_focus_change(self, event: Suggestions.FocusChange) -> None:
        """
        Handler for when the focus on the Suggestions widget changes.

        Args:
            event (Suggestions.FocusChange) 
        """
        event.stop()
        self.are_suggestions_focused = event.is_focused

    def on_suggestions_hide(self, event: Suggestions.Hide) -> None:
        """
        Handler for hiding the Suggestions.

        Args:
            event (Suggestions.Hide)
        """
        event.stop()
        prompt_input = self._get_prompt_input()
        prompt_input.action_end()
        prompt_input.focus()
        self.show_suggestions = False

    def on_suggestions_cancel(self, event: Suggestions.Cancel) -> None:
        """
        Handler for canceling the suggestion

        Args:
            event (Suggestions.Cancel)
        """
        event.stop()
        prompt_input = self._get_prompt_input()

        cmd_line = prompt_input.value.split(' ')
        cmd_line.pop(-1)
        prompt_input.value = " ".join(cmd_line)

        if len(prompt_input.value) > 0:
            prompt_input.value += ' '

        prompt_input.action_end()
        prompt_input.focus()


    def toggle_suggestions(self, toggle: bool):
        """
        Handler for hiding or showing the suggestions pop up.

        Args:
            toggle (bool): If True show the suggestions as long as there are
                suggestions else False will hide them.
        """
        ol = self.query_one(Suggestions)
        if not toggle:
            ol.visible = toggle

        if ol.option_count > 0:
            ol.visible = toggle

    def decide_to_show_suggestions(self) -> None:
        """
        Based on reactive attributes evaluate whether to show
        or hide the suggestions.
        """
        if self.show_suggestions:

            if self.is_prompt_focused or self.are_suggestions_focused:
                self.toggle_suggestions(True)

            else:
                self.toggle_suggestions(False)

        else:
            self.toggle_suggestions(False)

    def watch_is_prompt_focused(self, is_prompt_focused: bool) -> None:
        """
        Watcher for when the prompt gains or loses focus.

        Args:
            is_prompt_focused (bool): The reactive attribute.
        """
        self.decide_to_show_suggestions()

    def watch_are_suggestions_focused(self, are_suggestions_focused: bool) -> None:
        """
        Watcher for when the suggestions gains or lose focus.

        Ars:
            are_suggestions_focused (bool): The reactive attribute.
        """
        self.decide_to_show_suggestions()

    def watch_show_suggestions(self, show_suggestions: bool) -> None:
        """
        Watcher for when to show suggestions.

        Args:
            show_suggestions (bool): The reactive attribute.
        """
        self.decide_to_show_suggestions()

    def watch_history_list(self, history_list: deque[str]) -> None:
        """
        Watcher for when the history has been updated.

        Args:
            history_list (List[str]): The history of the command line.
        """
        try:
            rich_log = self.query_one(RichLog)
            rich_log.write(f'{self.prompt}{history_list[0]}')

        except:
            return

    def action_clear_prompt(self) -> None:
        """
        When ctrl+c is pressed clear the command line.
        """
        prompt_input = self._get_prompt_input()
        prompt_input.value = ''
        prompt_input.action_home()

        ol = self.query_one(Suggestions)
        ol.highlighted = None

        if ol.has_focus:
            prompt_input.focus()

        self.current_history_index = None

    def action_up_history(self):
        """When the up arrow is hit cycle upwards through the history."""
        if len(self.history_list) == 0:
            return

        if self.current_history_index is None:
            self.current_history_index = 0

        elif self.current_history_index == len(self.history_list) - 1:
            return

        else:
            self.current_history_index += 1

        previous_cmd = self.history_list[self.current_history_index]
        prompt_input = self._get_prompt_input()
        prompt_input.value = previous_cmd
        prompt_input.action_end()

    def action_down_history(self):
        """When the down arrow key is pressed cycle downwards through the history."""
        if len(self.history_list) == 0:
            return

        if self.current_history_index == 0:
            self.current_history_index = None
            self.action_clear_prompt()
            return

        elif self.current_history_index is None:
            return

        prompt_input = self._get_prompt_input()
        self.current_history_index -= 1
        previous_cmd = self.history_list[self.current_history_index]
        prompt_input.value = previous_cmd
        prompt_input.action_end()

action_clear_prompt()

When ctrl+c is pressed clear the command line.

Source code in src/textual_shell/widgets/shell/base_shell.py

def action_clear_prompt(self) -> None:
    """
    When ctrl+c is pressed clear the command line.
    """
    prompt_input = self._get_prompt_input()
    prompt_input.value = ''
    prompt_input.action_home()

    ol = self.query_one(Suggestions)
    ol.highlighted = None

    if ol.has_focus:
        prompt_input.focus()

    self.current_history_index = None

action_down_history()

When the down arrow key is pressed cycle downwards through the history.

Source code in src/textual_shell/widgets/shell/base_shell.py

def action_down_history(self):
    """When the down arrow key is pressed cycle downwards through the history."""
    if len(self.history_list) == 0:
        return

    if self.current_history_index == 0:
        self.current_history_index = None
        self.action_clear_prompt()
        return

    elif self.current_history_index is None:
        return

    prompt_input = self._get_prompt_input()
    self.current_history_index -= 1
    previous_cmd = self.history_list[self.current_history_index]
    prompt_input.value = previous_cmd
    prompt_input.action_end()

action_up_history()

When the up arrow is hit cycle upwards through the history.

Source code in src/textual_shell/widgets/shell/base_shell.py

def action_up_history(self):
    """When the up arrow is hit cycle upwards through the history."""
    if len(self.history_list) == 0:
        return

    if self.current_history_index is None:
        self.current_history_index = 0

    elif self.current_history_index == len(self.history_list) - 1:
        return

    else:
        self.current_history_index += 1

    previous_cmd = self.history_list[self.current_history_index]
    prompt_input = self._get_prompt_input()
    prompt_input.value = previous_cmd
    prompt_input.action_end()

command_entered(cmdline)

Handler for how the shell should go about executing the command. Please override this in your shell.

Parameters:

Name	Type	Description	Default
cmdline	str	The command line entered.	required

Raises:

Type	Description
NotImplementedError	If not overridden in a derived class.

Source code in src/textual_shell/widgets/shell/base_shell.py

def command_entered(
    self,
    cmdline: Annotated[str, 'The command line entered.']
) -> None:
    """
    Handler for how the shell should go about executing the command.
    Please override this in your shell.

    Args:
        cmdline (str): The command line entered.

    Raises:
        NotImplementedError: If not overridden in a derived class.
    """
    raise NotImplementedError('Subclasses must override.')

decide_to_show_suggestions()

Based on reactive attributes evaluate whether to show or hide the suggestions.

Source code in src/textual_shell/widgets/shell/base_shell.py

def decide_to_show_suggestions(self) -> None:
    """
    Based on reactive attributes evaluate whether to show
    or hide the suggestions.
    """
    if self.show_suggestions:

        if self.is_prompt_focused or self.are_suggestions_focused:
            self.toggle_suggestions(True)

        else:
            self.toggle_suggestions(False)

    else:
        self.toggle_suggestions(False)

get_cmd_obj(cmd)

Retrieve the cmd instance.

Parameters:

Name	Type	Description	Default
cmd	str	The name of the command.	required

Returns:

Name	Type	Description
command	Command	The command instance for the command.

Source code in src/textual_shell/widgets/shell/base_shell.py

def get_cmd_obj(
    self,
    cmd: Annotated[str, 'The name of the command.']
) -> Command:
    """
    Retrieve the cmd instance.

    Args:
        cmd (str): The name of the command.

    Returns:
        command (Command): The command instance for the command.
    """
    for command in self.commands:
        if command.name == cmd:
            return command

    return None

get_offset()

Calculate the offset for the cursor location.

Source code in src/textual_shell/widgets/shell/base_shell.py

def get_offset(self) -> None:
    """Calculate the offset for the cursor location."""
    prompt_input = self._get_prompt_input()
    self.prompt_input_offset = Offset(
        prompt_input.offset.x + len(self.prompt) + 1,
        prompt_input.offset.y + 2
    )

get_suggestions(cmd_line)

Get the suggestions for the current state of the command line.

Parameters:

Name	Type	Description	Default
cmd_line	str	The input from the prompt.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def get_suggestions(
    self,
    cmd_line: Annotated[str, 'The input from the prompt.']
) -> None:
    """
    Get the suggestions for the current state of the command line.

    Args:
        cmd_line (str): The input from the prompt.
    """
    cmd_input = cmd_line.split(' ')
    if len(cmd_input) == 1:
        val = cmd_input[0]
        suggestions = ([cmd for cmd in self.command_list if cmd.startswith(val)] 
                            if val else self.command_list)

    else:
        if cmd_input[0] == 'help':
            if len(cmd_input) < 3:
                suggestions = self.command_list

            else: 
                suggestions = []

        else:
            if cmd := self.get_cmd_obj(cmd_input[0]):
                suggestions = cmd.get_suggestions(cmd_input[:-1])

            else:
                suggestions = []

        suggestions = [sub_cmd for sub_cmd in suggestions if sub_cmd.startswith(cmd_input[-1])]

    self.update_suggestions(suggestions)

on_mount()

Update the location and suggestions for auto-completions.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_mount(self):
    """Update the location and suggestions for auto-completions."""
    self.get_offset()
    self.update_suggestions(self.command_list)

on_prompt_command_entered(event)

Handler for when a command has been entered. Execute the command in a worker thread.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_command_entered(self, event: Prompt.CommandEntered) -> None:
    """
    Handler for when a command has been entered.
    Execute the command in a worker thread.

    Args:
        event (Prompt.CommandEntered)
    """
    event.stop()
    self.command_entered(event.cmd)

on_prompt_command_input(event)

Handler for when the user has typed into the prompt.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_command_input(self, event: Prompt.CommandInput) -> None:
    """
    Handler for when the user has typed into the prompt.

    Args:
        event (Prompt.CommandInput)
    """
    event.stop()
    self.get_suggestions(event.cmd_input)
    self.update_suggestions_location(event.cursor_position)

on_prompt_input_auto_complete(event)

Handle auto complete request.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_input_auto_complete(
    self,
    event: PromptInput.AutoComplete
) -> None:
    """
    Handle auto complete request. 

    Args:
        event (PromptInput.AutoComplete)
    """
    event.stop()
    ol = self.query_one(Suggestions)
    if ol.option_count == 0 or not ol.visible:
        return

    if not ol.highlighted:
        ol.highlighted = 0

    ol.focus()
    suggestion = ol.get_option_at_index(ol.highlighted).prompt
    self.update_prompt_input(suggestion)

on_prompt_input_focus_change(event)

Handler for when the prompt_input has gained or lost focus.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_input_focus_change(self, event: PromptInput.FocusChange) -> None:
    """
    Handler for when the prompt_input has gained or lost focus.

    Args:
        event (PromptInput.FocusChange)
    """
    event.stop()
    self.is_prompt_focused = event.is_focused

on_prompt_input_hide(event)

Handler for hiding the Suggestions.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_input_hide(self, event: PromptInput.Hide) -> None:
    """
    Handler for hiding the Suggestions.

    Args:
        event (PromptInput.Hide)
    """
    event.stop()
    self.show_suggestions = False

on_prompt_input_show(event)

Handler for showing the Suggestions.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_prompt_input_show(self, event: PromptInput.Show) -> None:
    """
    Handler for showing the Suggestions.

    Args:
        event (PromptInput.Show)
    """
    event.stop()
    self.update_suggestions_location(event.cursor_position)
    self.show_suggestions = True

on_suggestions_cancel(event)

Handler for canceling the suggestion

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_cancel(self, event: Suggestions.Cancel) -> None:
    """
    Handler for canceling the suggestion

    Args:
        event (Suggestions.Cancel)
    """
    event.stop()
    prompt_input = self._get_prompt_input()

    cmd_line = prompt_input.value.split(' ')
    cmd_line.pop(-1)
    prompt_input.value = " ".join(cmd_line)

    if len(prompt_input.value) > 0:
        prompt_input.value += ' '

    prompt_input.action_end()
    prompt_input.focus()

on_suggestions_continue(event)

Add a space to the prompt_input and switch back focus.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_continue(self, event: Suggestions.Continue) -> None:
    """
    Add a space to the prompt_input and switch back focus.

    Args:
        event (Suggestions.Continue)
    """
    event.stop()
    prompt_input = self._get_prompt_input()
    prompt_input.value += ' '
    prompt_input.action_end()
    prompt_input.focus()

on_suggestions_cycle(event)

Update the prompt input with the next suggestion.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_cycle(self, event: Suggestions.Cycle) -> None:
    """
    Update the prompt input with the next suggestion.

    Args:
        event (Suggestions.Cycle)
    """
    event.stop()
    self.update_prompt_input(event.next)

on_suggestions_execute(event)

Execute the command.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_execute(self, event: Suggestions.Execute) -> None:
    """
    Execute the command.

    Args:
        event (Suggestions.Execute)
    """
    event.stop()
    prompt_input = self._get_prompt_input()
    self.command_entered(prompt_input.value)
    prompt_input.value = ''
    prompt_input.action_home()
    prompt_input.focus()

on_suggestions_focus_change(event)

Handler for when the focus on the Suggestions widget changes.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_focus_change(self, event: Suggestions.FocusChange) -> None:
    """
    Handler for when the focus on the Suggestions widget changes.

    Args:
        event (Suggestions.FocusChange) 
    """
    event.stop()
    self.are_suggestions_focused = event.is_focused

on_suggestions_hide(event)

Handler for hiding the Suggestions.

Source code in src/textual_shell/widgets/shell/base_shell.py

def on_suggestions_hide(self, event: Suggestions.Hide) -> None:
    """
    Handler for hiding the Suggestions.

    Args:
        event (Suggestions.Hide)
    """
    event.stop()
    prompt_input = self._get_prompt_input()
    prompt_input.action_end()
    prompt_input.focus()
    self.show_suggestions = False

toggle_suggestions(toggle)

Handler for hiding or showing the suggestions pop up.

Parameters:

Name	Type	Description	Default
toggle	bool	If True show the suggestions as long as there are suggestions else False will hide them.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def toggle_suggestions(self, toggle: bool):
    """
    Handler for hiding or showing the suggestions pop up.

    Args:
        toggle (bool): If True show the suggestions as long as there are
            suggestions else False will hide them.
    """
    ol = self.query_one(Suggestions)
    if not toggle:
        ol.visible = toggle

    if ol.option_count > 0:
        ol.visible = toggle

update_prompt_input(suggestion)

Add the suggestion to the prompt input. This will prevent Input.Changed events from generating.

Parameters:

Name	Type	Description	Default
suggestion	str	The selected suggestion.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def update_prompt_input(
    self,
    suggestion: Annotated[str, 'The selected suggestion.']
) -> None:
    """
    Add the suggestion to the prompt input.
    This will prevent Input.Changed events from generating.

    Args:
        suggestion (str): The selected suggestion.
    """
    prompt_input = self._get_prompt_input()
    with prompt_input.prevent(Input.Changed):
        cmd_split = prompt_input.value.split(' ')
        cmd_split[-1] = suggestion
        prompt_input.value = ' '.join(cmd_split)

update_suggestions(suggestions)

Update the list of Suggestions.

Parameters:

Name	Type	Description	Default
suggestions	List[str]	The new suggestions.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def update_suggestions(
    self,
    suggestions: Annotated[List[str], 'suggestions for the OptionList.']
) -> None:
    """
    Update the list of Suggestions.

    Args:
        suggestions (List[str]): The new suggestions.

    """
    ol = self.query_one(Suggestions)
    ol.clear_options()
    if self.show_suggestions:
        ol.visible = False if len(suggestions) == 0 else True
    ol.add_options(suggestions)

update_suggestions_location(cursor)

Update the location of the Suggestions.

Parameters:

Name	Type	Description	Default
cursor	int	The x location of the cursor.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def update_suggestions_location(
    self, 
    cursor: Annotated[int, 'The x location of the cursor.']
) -> None:
    """
    Update the location of the Suggestions.

    Args:
        cursor (int): The x location of the cursor.
    """
    rich_log = self.query_one(RichLog)
    ol = self.query_one(Suggestions)
    ol.styles.offset = (
        self.prompt_input_offset.x + cursor,
        self.prompt_input_offset.y + min(
            self.history_count, rich_log.styles.max_height.value
        )
    )

watch_are_suggestions_focused(are_suggestions_focused)

Watcher for when the suggestions gains or lose focus.

Ars

are_suggestions_focused (bool): The reactive attribute.

Source code in src/textual_shell/widgets/shell/base_shell.py

def watch_are_suggestions_focused(self, are_suggestions_focused: bool) -> None:
    """
    Watcher for when the suggestions gains or lose focus.

    Ars:
        are_suggestions_focused (bool): The reactive attribute.
    """
    self.decide_to_show_suggestions()

watch_history_list(history_list)

Watcher for when the history has been updated.

Parameters:

Name	Type	Description	Default
history_list	List[str]	The history of the command line.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def watch_history_list(self, history_list: deque[str]) -> None:
    """
    Watcher for when the history has been updated.

    Args:
        history_list (List[str]): The history of the command line.
    """
    try:
        rich_log = self.query_one(RichLog)
        rich_log.write(f'{self.prompt}{history_list[0]}')

    except:
        return

watch_is_prompt_focused(is_prompt_focused)

Watcher for when the prompt gains or loses focus.

Parameters:

Name	Type	Description	Default
is_prompt_focused	bool	The reactive attribute.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def watch_is_prompt_focused(self, is_prompt_focused: bool) -> None:
    """
    Watcher for when the prompt gains or loses focus.

    Args:
        is_prompt_focused (bool): The reactive attribute.
    """
    self.decide_to_show_suggestions()

watch_show_suggestions(show_suggestions)

Watcher for when to show suggestions.

Parameters:

Name	Type	Description	Default
show_suggestions	bool	The reactive attribute.	required

Source code in src/textual_shell/widgets/shell/base_shell.py

def watch_show_suggestions(self, show_suggestions: bool) -> None:
    """
    Watcher for when to show suggestions.

    Args:
        show_suggestions (bool): The reactive attribute.
    """
    self.decide_to_show_suggestions()