Skip to content

Prompt

Prompt

Bases: Widget

Custom Widget for Containing the Prompt Input and Label.

Parameters:

Name Type Description Default
prompt str

The prompt for the shell.

 required
Source code in src/textual_shell/widgets/shell/prompt.py 
 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
class Prompt(Widget):
    """
    Custom Widget for Containing the Prompt Input and Label.

    Args:
        prompt (str): The prompt for the shell.
    """

    class CommandInput(Message):
        """User Typed into the shell."""
        def __init__(self, cmd_input: str, position: int) -> None:
            super().__init__()
            self.cmd_input = cmd_input
            self.cursor_position = position


    class CommandEntered(Message):
        """User entered a command."""
        def __init__(self, cmd: str):
            super().__init__()
            self.cmd = cmd


    def __init__(
        self, 
        prompt: Annotated[str, 'prompt for the shell.']
    ) -> None:
        super().__init__()
        self.prompt = prompt

    def on_mount(self) -> None:
        prompt_input = self.query_one(PromptInput)
        prompt_input.focus()

    def compose(self) -> ComposeResult:
        yield Label(f'[b]{self.prompt}[/b]')
        yield PromptInput(select_on_focus=False)

    def on_input_changed(self, event: Input.Changed) -> None:
        """
        Catch when the input value has changed and 
        and notify the parent shell of the current input 
        and location of the cursor.
        """
        event.stop()
        prompt_input = self.query_one(PromptInput)
        self.post_message(
            self.CommandInput(
                event.value,
                prompt_input.cursor_position
            )
        )

    def on_input_submitted(self, event: Input.Submitted) -> None:
        """
        Catch when a command has been entered.
        """
        event.stop()
        prompt_input = self.query_one(PromptInput)
        prompt_input.value = ''
        prompt_input.action_home()
        self.post_message(self.CommandEntered(event.value))

CommandEntered

Bases: Message

User entered a command.

Source code in src/textual_shell/widgets/shell/prompt.py 
92
93
94
95
96
class CommandEntered(Message):
    """User entered a command."""
    def __init__(self, cmd: str):
        super().__init__()
        self.cmd = cmd

CommandInput

Bases: Message

User Typed into the shell.

Source code in src/textual_shell/widgets/shell/prompt.py 
84
85
86
87
88
89
class CommandInput(Message):
    """User Typed into the shell."""
    def __init__(self, cmd_input: str, position: int) -> None:
        super().__init__()
        self.cmd_input = cmd_input
        self.cursor_position = position

on_input_changed(event)

Catch when the input value has changed and and notify the parent shell of the current input and location of the cursor.

Source code in src/textual_shell/widgets/shell/prompt.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def on_input_changed(self, event: Input.Changed) -> None:
    """
    Catch when the input value has changed and 
    and notify the parent shell of the current input 
    and location of the cursor.
    """
    event.stop()
    prompt_input = self.query_one(PromptInput)
    self.post_message(
        self.CommandInput(
            event.value,
            prompt_input.cursor_position
        )
    )

on_input_submitted(event)

Catch when a command has been entered.

Source code in src/textual_shell/widgets/shell/prompt.py 
129
130
131
132
133
134
135
136
137
def on_input_submitted(self, event: Input.Submitted) -> None:
    """
    Catch when a command has been entered.
    """
    event.stop()
    prompt_input = self.query_one(PromptInput)
    prompt_input.value = ''
    prompt_input.action_home()
    self.post_message(self.CommandEntered(event.value))

PromptInput

Bases: Input

Custom Input widget for entering commands. Pressing ctrl+space will activate the Suggestions widget. Pressing tab will switch focus to the Suggestions widget. Pressing escape will hide the Suggestions widget.

Source code in src/textual_shell/widgets/shell/prompt.py 
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
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
class PromptInput(Input):
    """
    Custom Input widget for entering commands.
    Pressing ctrl+space will activate the Suggestions widget.
    Pressing tab will switch focus to the Suggestions widget.
    Pressing escape will hide the Suggestions widget.
    """

    class AutoComplete(Message):
        """Switch to the suggestions widget for auto-completions."""
        pass

    class Show(Message):
        """
        Activate the suggestions widget.

        Args:
            cursor (int): The x location of the cursor.
                Used to position the suggestions widget.
        """
        def __init__(self, cursor: int) -> None:
            super().__init__()
            self.cursor_position = cursor

    class Hide(Message):
        """Hide the suggestions widget."""
        pass

    class FocusChange(Message):
        """
        A message for when the prompt input 
        has either gained or lost focus.
        """
        def __init__(self, is_focused: bool):
            super().__init__()
            self.is_focused = is_focused


    BINDINGS = [
        Binding('tab', 'switch_autocomplete', 'Switch to auto-complete if active', show=True, priority=True),
        Binding('escape', 'hide', 'Hide auto-complete', show=True),
        Binding('ctrl+@', 'activate_autocomplete', 'Activate auto-completions', show=True, key_display='ctrl+space')
    ]

    def on_focus(self, event: events.Focus) -> None:
        """PromptInput widget has gained focus."""
        self.post_message(self.FocusChange(True))

    def on_blur(self, event: events.Blur) -> None:
        """PromptInput widget has lost focus."""
        self.post_message(self.FocusChange(False))

    def action_switch_autocomplete(self) -> None:
        """Switch to the Suggestion focus."""
        self.post_message(self.AutoComplete())

    def action_activate_autocomplete(self) -> None:
        """Activate the Suggestions."""
        self.post_message(self.Show(self.cursor_position))

    def action_hide(self):
        """Hide the Suggestions."""
        self.post_message(self.Hide())

AutoComplete

Bases: Message

Switch to the suggestions widget for auto-completions.

Source code in src/textual_shell/widgets/shell/prompt.py 
19
20
21
class AutoComplete(Message):
    """Switch to the suggestions widget for auto-completions."""
    pass

FocusChange

Bases: Message

A message for when the prompt input has either gained or lost focus.

Source code in src/textual_shell/widgets/shell/prompt.py 
39
40
41
42
43
44
45
46
class FocusChange(Message):
    """
    A message for when the prompt input 
    has either gained or lost focus.
    """
    def __init__(self, is_focused: bool):
        super().__init__()
        self.is_focused = is_focused

Hide

Bases: Message

Hide the suggestions widget.

Source code in src/textual_shell/widgets/shell/prompt.py 
35
36
37
class Hide(Message):
    """Hide the suggestions widget."""
    pass

Show

Bases: Message

Activate the suggestions widget.

Parameters:

Name Type Description Default
cursor int

The x location of the cursor. Used to position the suggestions widget.

 required
Source code in src/textual_shell/widgets/shell/prompt.py 
23
24
25
26
27
28
29
30
31
32
33
class Show(Message):
    """
    Activate the suggestions widget.

    Args:
        cursor (int): The x location of the cursor.
            Used to position the suggestions widget.
    """
    def __init__(self, cursor: int) -> None:
        super().__init__()
        self.cursor_position = cursor

action_activate_autocomplete()

Activate the Suggestions.

Source code in src/textual_shell/widgets/shell/prompt.py 
67
68
69
def action_activate_autocomplete(self) -> None:
    """Activate the Suggestions."""
    self.post_message(self.Show(self.cursor_position))

action_hide()

Hide the Suggestions.

Source code in src/textual_shell/widgets/shell/prompt.py 
71
72
73
def action_hide(self):
    """Hide the Suggestions."""
    self.post_message(self.Hide())

action_switch_autocomplete()

Switch to the Suggestion focus.

Source code in src/textual_shell/widgets/shell/prompt.py 
63
64
65
def action_switch_autocomplete(self) -> None:
    """Switch to the Suggestion focus."""
    self.post_message(self.AutoComplete())

on_blur(event)

PromptInput widget has lost focus.

Source code in src/textual_shell/widgets/shell/prompt.py 
59
60
61
def on_blur(self, event: events.Blur) -> None:
    """PromptInput widget has lost focus."""
    self.post_message(self.FocusChange(False))

on_focus(event)

PromptInput widget has gained focus.

Source code in src/textual_shell/widgets/shell/prompt.py 
55
56
57
def on_focus(self, event: events.Focus) -> None:
    """PromptInput widget has gained focus."""
    self.post_message(self.FocusChange(True))