inquirer-textual 0.2.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

inquirer_textual/widgets/InquirerMulti.py

@@ -1,7 +1,6 @@
 from typing import Any
 
 from textual.app import ComposeResult
-from textual.widgets import ContentSwitcher
 
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
@@ -15,32 +14,32 @@ class InquirerMulti(InquirerWidget):
         }
     """
 
-    def __init__(self, widgets: list[InquirerWidget]) -> None:
+    def __init__(self, widgets: dict[str, InquirerWidget]) -> None:
         """
         Args:
-            widgets (list[InquirerWidget]): A list of InquirerWidget instances to present in sequence.
+            widgets (dict[str, InquirerWidget]): A dictionary of InquirerWidget instances to present in sequence of definition.
         """
         super().__init__()
         self.widgets = widgets
         self._current_widget_index = 0
-        self._return_values: list[Any] = []
+        self._return_values_dict: dict[str, Any] = {}
 
-    def on_mount(self):
-        self.query_one(ContentSwitcher).current = f'widget-{self._current_widget_index}'
-        self.query_one(ContentSwitcher).visible_content.focus()
-
-    def on_inquirer_widget_submit(self, message: InquirerWidget.Submit) -> None:
-        self._return_values.append(message.value)
+    async def on_inquirer_widget_submit(self, message: InquirerWidget.Submit) -> None:
+        current_item = list(self.widgets.items())[self._current_widget_index]
+        self._return_values_dict[current_item[0]] = message.value
+        await current_item[1].set_selected_value(message.value)
         self._current_widget_index += 1
         if self._current_widget_index < len(self.widgets):
             message.stop()
-            self.query_one(ContentSwitcher).current = f'widget-{self._current_widget_index}'
-            self.query_one(ContentSwitcher).visible_content.focus()
+            next_widget = self.query_one(f'#widget-{self._current_widget_index}')
+            next_widget.styles.display = 'block'
+            next_widget.focus()
         else:
-            message.value = self._return_values
+            message.value = self._return_values_dict
 
     def compose(self) -> ComposeResult:
-        with ContentSwitcher(initial=f'widget-{self._current_widget_index}'):
-            for idx, widget in enumerate(self.widgets):
-                widget.id = f'widget-{idx}'
-                yield widget
+        for idx, item in enumerate(self.widgets.items()):
+            item[1].id = f'widget-{idx}'
+            if idx > 0:
+                item[1].styles.display = 'none'
+            yield item[1]

inquirer_textual/widgets/InquirerNumber.py

@@ -1,13 +1,12 @@
 from __future__ import annotations
 
-from typing_extensions import Self
-
 from textual.app import ComposeResult
 from textual.containers import HorizontalGroup
 from textual.widgets import Input
+from typing_extensions import Self, Literal
 
+from inquirer_textual.common.Prompt import Prompt
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
-from inquirer_textual.common.PromptMessage import PromptMessage
 
 
 class InquirerNumber(InquirerWidget):
@@ -19,24 +18,28 @@ class InquirerNumber(InquirerWidget):
     }
     #inquirer-number-input {
         border: none;
-        background: transparent;
-        color: $input-color;
+        color: $inquirer-textual-input-color;
         padding: 0;
         height: 1;
     }
     """
 
-    def __init__(self, message: str):
+    def __init__(self, message: str, name: str | None = None, input_type: Literal['integer', 'number'] = 'integer',
+                 mandatory: bool = False):
         """
         Args:
             message (str): The prompt message to display.
+            name (str | None): The name of the input field.
+            input_type (Literal['integer', 'number']): The type of number input ('integer' or 'number').
+            mandatory (bool): Whether the input is mandatory.
         """
-        super().__init__()
+        super().__init__(name=name, mandatory=mandatory)
         self.message = message
+        self.input_type = input_type
         self.input: Input | None = None
 
-    def on_input_submitted(self, submitted: Input.Submitted):
-        self.post_message(InquirerWidget.Submit(submitted.value))
+    def on_input_submitted(self) -> None:
+        self.submit_current_value()
 
     def focus(self, scroll_visible: bool = True) -> Self:
         if self.input:
@@ -45,10 +48,15 @@ class InquirerNumber(InquirerWidget):
             return super().focus(scroll_visible)
 
     def current_value(self):
-        return self.input.value if self.input else None
+        if self.input and self.input.value:
+            if self.input_type == 'integer':
+                return int(self.input.value)
+            elif self.input_type == 'number':
+                return float(self.input.value)
+        return None
 
     def compose(self) -> ComposeResult:
         with HorizontalGroup():
-            yield PromptMessage(self.message)
-            self.input = Input(id="inquirer-number-input", type="integer")
+            yield Prompt(self.message)
+            self.input = Input(id="inquirer-number-input", type=self.input_type)
             yield self.input

inquirer_textual/widgets/InquirerPath.py

@@ -0,0 +1,95 @@
+from __future__ import annotations
+
+from enum import Enum
+from pathlib import Path
+
+from textual.app import ComposeResult
+from textual.containers import HorizontalGroup
+from textual.widgets import Input, Static
+from typing_extensions import Self
+
+from inquirer_textual.common.Prompt import Prompt
+from inquirer_textual.widgets.InquirerWidget import InquirerWidget
+
+
+class PathType(Enum):
+    FILE = 'file'
+    DIRECTORY = 'directory'
+    ANY = 'any'
+
+
+class InquirerPath(InquirerWidget):
+    """An input prompt that allows the user to enter a file path."""
+
+    DEFAULT_CSS = """
+    InquirerPath {
+        height: auto;
+    }
+    #inquirer-path-input {
+        border: none;
+        color: $inquirer-textual-input-color;
+        padding: 0;
+        height: 1;
+    }
+    #inquirer-path-error-message {
+        color: $error;
+        height: auto;
+    }
+    """
+
+    def __init__(self, message: str, name: str | None = None, default: str = '', exists: bool = False,
+                 path_type: PathType = PathType.ANY, mandatory: bool = False):
+        """
+        Args:
+            message (str): The prompt message to display.
+            default (str): The default value if the user presses Enter without input.
+            exists (bool): If True, validate that the entered path exists.
+        """
+        super().__init__(name=name, mandatory=mandatory)
+        self.message = message
+        self.input: Input | None = None
+        self.default = default
+        self.exists = exists
+        self.path_type = path_type
+
+    def on_mount(self):
+        super().on_mount()
+        self.input.value = self.default
+
+    def on_input_submitted(self, submitted: Input.Submitted):
+        if self.exists:
+            if not Path(submitted.value).exists():
+                self._show_validation_error("The specified path does not exist.")
+                return
+        if self.path_type != PathType.ANY:
+            path = Path(submitted.value)
+            if self.path_type == PathType.FILE and not path.is_file():
+                self._show_validation_error("The specified path is not a file.")
+                return
+            if self.path_type == PathType.DIRECTORY and not path.is_dir():
+                self._show_validation_error("The specified path is not a directory.")
+                return
+        self._show_validation_error('')
+        if self.input:
+            self.input._cursor_visible = False
+        self.submit_current_value()
+
+    def _show_validation_error(self, message: str):
+        error_message = self.query_one('#inquirer-path-error-message', Static)
+        error_message.update(message)
+
+    def focus(self, scroll_visible: bool = True) -> Self:
+        if self.input:
+            return self.input.focus(scroll_visible)
+        else:
+            return super().focus(scroll_visible)
+
+    def current_value(self):
+        return self.input.value if self.input else None
+
+    def compose(self) -> ComposeResult:
+        with HorizontalGroup():
+            yield Prompt(self.message)
+            self.input = Input(id="inquirer-path-input")
+            yield self.input
+        yield Static("", id="inquirer-path-error-message")

inquirer_textual/widgets/InquirerPattern.py

@@ -0,0 +1,175 @@
+from __future__ import annotations
+
+from textual import on, events
+from textual.app import ComposeResult
+from textual.containers import VerticalGroup, HorizontalGroup
+from textual.css.query import NoMatches
+from textual.reactive import reactive
+from textual.widgets import ListView, ListItem, Input, Static
+from typing_extensions import Self
+
+from inquirer_textual.common.Answer import Answer
+from inquirer_textual.common.Choice import Choice
+from inquirer_textual.common.ChoiceLabel import ChoiceLabel
+from inquirer_textual.common.Prompt import Prompt
+from inquirer_textual.common.defaults import POINTER_CHARACTER
+from inquirer_textual.widgets.InquirerWidget import InquirerWidget
+
+
+class InquirerPattern(InquirerWidget):
+    """A select widget that allows a single selection from a list of choices with pattern filtering."""
+
+    DEFAULT_CSS = """
+        #inquirer-pattern-query-container {
+            width: auto;
+        }
+        #inquirer-pattern-query {
+            border: none;
+            color: $inquirer-textual-input-color;
+            padding: 0;
+            height: 1;
+            width: 20;
+        }
+        #inquirer-pattern-query-pointer {
+            width: auto;
+            color: $accent;
+        }
+        """
+
+    candidates: reactive[list[str | Choice]] = reactive([])
+
+    def __init__(self, message: str, choices: list[str | Choice], name: str | None = None,
+                 default: str | Choice | None = None, mandatory: bool = True):
+        """
+        Args:
+            message (str): The prompt message to display.
+            choices (list[str | Choice]): A list of choices to present to the user.
+            default (str | Choice | None): The default choice to pre-select.
+            mandatory (bool): Whether a response is mandatory.
+        """
+        super().__init__(name=name, mandatory=mandatory)
+        self.message = message
+        self.choices = choices
+        self.candidates = choices.copy()
+        self.list_view: ListView | None = None
+        self.selected_label: ChoiceLabel | None = None
+        self.selected_item: str | Choice | None = None
+        self.default = default
+        self.query: Input | None = None
+        self.selected_value: str | Choice | None = None
+        self.show_selected_value: bool = False
+
+    def on_mount(self):
+        super().on_mount()
+        if self.app.is_inline:
+            self.styles.height = min(10, len(self.choices) + 1)
+        else:
+            self.styles.height = '1fr'
+
+    def on_list_view_highlighted(self, event: ListView.Highlighted) -> None:
+        if self.selected_label:
+            self.selected_label.remove_pointer()
+        if event.item:
+            try:
+                label = event.item.query_one(ChoiceLabel)
+                label.add_pointer()
+                self.selected_label = label
+                self.selected_item = label.item
+                return
+            except NoMatches:
+                pass
+        self.selected_label = None
+        self.selected_item = None
+
+    def on_list_view_selected(self, _: ListView.Selected):
+        if isinstance(self.selected_item, Choice):
+            self.submit_current_value(self.selected_item.command)
+        else:
+            self.submit_current_value()
+
+    def focus(self, scroll_visible: bool = True) -> Self:
+        if self.query:
+            return self.query.focus(scroll_visible)
+        else:
+            return super().focus(scroll_visible)
+
+    def current_value(self):
+        return self.selected_item
+
+    def _collect_list_items(self):
+        items: list[ListItem] = []
+        for candidate in self.candidates:
+            list_item = ListItem(ChoiceLabel(candidate, self.query.value if self.query else None))
+            items.append(list_item)
+        return items
+
+    def _find_initial_index(self):
+        initial_index = 0
+        for idx, choice in enumerate(self.choices):
+            if self.default and choice == self.default:
+                initial_index = idx
+        return initial_index
+
+    @on(Input.Changed, '#inquirer-pattern-query')
+    async def handle_query_changed(self, event: Input.Changed):
+        query = event.value.lower()
+        if query == '':
+            self.candidates = self.choices.copy()
+        else:
+            filtered = []
+            for choice in self.choices:
+                name = choice.name if isinstance(choice, Choice) else choice
+                if query in name.lower():
+                    filtered.append(choice)
+            self.candidates = filtered
+        assert isinstance(self.list_view, ListView)
+        await self.list_view.clear()
+        list_items = self._collect_list_items()
+        await self.list_view.extend(list_items)
+        if list_items:
+            self.list_view.index = 0
+
+    def watch_candidates(self, candidates: list[str | Choice]) -> None:
+        count_suffix = f'[{len(candidates)}/{len(self.choices)}]'
+        try:
+            count_widget = self.query_one('#inquirer-pattern-query-count-suffix', Static)
+            count_widget.update(count_suffix)
+        except NoMatches:
+            pass
+
+    def on_key(self, event: events.Key):
+        assert isinstance(self.list_view, ListView)
+        if event.key == 'down':
+            event.stop()
+            self.list_view.action_cursor_down()
+        elif event.key == 'up':
+            event.stop()
+            self.list_view.action_cursor_up()
+        elif event.key == 'enter':
+            event.stop()
+            self.list_view.action_select_cursor()
+
+    async def set_selected_value(self, value: str | Choice) -> None:
+        self.selected_value = value
+        self.styles.height = 1
+        self.show_selected_value = True
+        await self.recompose()
+
+    def compose(self) -> ComposeResult:
+        if self.show_selected_value:
+            with HorizontalGroup():
+                yield Prompt(self.message)
+                yield Answer(str(self.selected_value))
+        else:
+            with VerticalGroup():
+                self.list_view = ListView(*self._collect_list_items(), id='inquirer-pattern-list-view',
+                                          initial_index=self._find_initial_index())
+                with HorizontalGroup():
+                    yield Prompt(self.message)
+                    yield Static(f'[{len(self.candidates)}/{len(self.choices)}]',
+                                 id='inquirer-pattern-query-count-suffix')
+                with HorizontalGroup(id='inquirer-pattern-query-container'):
+                    yield Static(f'{POINTER_CHARACTER} ', id='inquirer-pattern-query-pointer')
+                    self.query = Input(id="inquirer-pattern-query")
+                    yield self.query
+                yield self.list_view

inquirer_textual/widgets/InquirerSecret.py

@@ -5,7 +5,7 @@ from textual.containers import HorizontalGroup
 from textual.widgets import Input
 from typing_extensions import Self
 
-from inquirer_textual.common.PromptMessage import PromptMessage
+from inquirer_textual.common.Prompt import Prompt
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
 
@@ -18,19 +18,18 @@ class InquirerSecret(InquirerWidget):
     }
     #inquirer-secret-input {
         border: none;
-        background: transparent;
-        color: $input-color;
+        color: $inquirer-textual-input-color;
         padding: 0;
         height: 1;
     }
     """
 
-    def __init__(self, message: str):
+    def __init__(self, message: str, name: str | None = None, mandatory: bool = False):
         """
         Args:
             message (str): The prompt message to display.
         """
-        super().__init__()
+        super().__init__(name=name, mandatory=mandatory)
         self.message = message
         self.input: Input | None = None
 
@@ -48,7 +47,7 @@ class InquirerSecret(InquirerWidget):
 
     def compose(self) -> ComposeResult:
         with HorizontalGroup():
-            yield PromptMessage(self.message)
+            yield Prompt(self.message)
             self.input = Input(id="inquirer-secret-input")
             self.input.password = True
             yield self.input

inquirer_textual/widgets/InquirerSelect.py

@@ -1,31 +1,22 @@
 from __future__ import annotations
 
 from textual.app import ComposeResult
-from textual.containers import VerticalGroup
+from textual.containers import VerticalGroup, HorizontalGroup
 from textual.widgets import ListView, ListItem
 from typing_extensions import Self
 
+from inquirer_textual.common.Answer import Answer
 from inquirer_textual.common.Choice import Choice
 from inquirer_textual.common.ChoiceLabel import ChoiceLabel
-from inquirer_textual.common.PromptMessage import PromptMessage
+from inquirer_textual.common.Prompt import Prompt
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
 
 class InquirerSelect(InquirerWidget):
     """A select widget that allows a single selection from a list of choices."""
 
-    DEFAULT_CSS = """
-        #inquirer-select-list-view {
-            background: transparent;
-        }
-        #inquirer-select-list-view ListItem.-highlight {
-            color: $select-list-item-highlight-foreground;
-            background: transparent;
-        }
-        """
-
-    def __init__(self, message: str, choices: list[str | Choice], default: str | Choice | None = None,
-                 mandatory: bool = True):
+    def __init__(self, message: str, choices: list[str | Choice], name: str | None = None,
+                 default: str | Choice | None = None, mandatory: bool = True):
         """
         Args:
             message (str): The prompt message to display.
@@ -33,13 +24,15 @@ class InquirerSelect(InquirerWidget):
             default (str | Choice | None): The default choice to pre-select.
             mandatory (bool): Whether a response is mandatory.
         """
-        super().__init__(mandatory)
+        super().__init__(name=name, mandatory=mandatory)
         self.message = message
         self.choices = choices
         self.list_view: ListView | None = None
         self.selected_label: ChoiceLabel | None = None
         self.selected_item: str | Choice | None = None
         self.default = default
+        self.selected_value: str | Choice | None = None
+        self.show_selected_value: bool = False
 
     def on_mount(self):
         super().on_mount()
@@ -58,9 +51,9 @@ class InquirerSelect(InquirerWidget):
 
     def on_list_view_selected(self, _: ListView.Selected):
         if isinstance(self.selected_item, Choice):
-            self.post_message(InquirerWidget.Submit(self.selected_item, self.selected_item.command))
+            self.submit_current_value(self.selected_item.command)
         else:
-            self.post_message(InquirerWidget.Submit(self.selected_item))
+            self.submit_current_value()
 
     def focus(self, scroll_visible: bool = True) -> Self:
         if self.list_view:
@@ -71,15 +64,26 @@ class InquirerSelect(InquirerWidget):
     def current_value(self):
         return self.selected_item
 
+    async def set_selected_value(self, value: str | Choice) -> None:
+        self.selected_value = value
+        self.styles.height = 1
+        self.show_selected_value = True
+        await self.recompose()
+
     def compose(self) -> ComposeResult:
-        with VerticalGroup():
-            initial_index = 0
-            items: list[ListItem] = []
-            for idx, choice in enumerate(self.choices):
-                list_item = ListItem(ChoiceLabel(choice))
-                items.append(list_item)
-                if self.default and choice == self.default:
-                    initial_index = idx
-            self.list_view = ListView(*items, id='inquirer-select-list-view', initial_index=initial_index)
-            yield PromptMessage(self.message)
-            yield self.list_view
+        if self.show_selected_value:
+            with HorizontalGroup():
+                yield Prompt(self.message)
+                yield Answer(str(self.selected_value))
+        else:
+            with VerticalGroup():
+                initial_index = 0
+                items: list[ListItem] = []
+                for idx, choice in enumerate(self.choices):
+                    list_item = ListItem(ChoiceLabel(choice))
+                    items.append(list_item)
+                    if self.default and choice == self.default:
+                        initial_index = idx
+                self.list_view = ListView(*items, id='inquirer-select-list-view', initial_index=initial_index)
+                yield Prompt(self.message)
+                yield self.list_view

inquirer_textual/widgets/InquirerText.py

@@ -8,7 +8,7 @@ from textual.validation import Validator
 from textual.widgets import Input
 from typing_extensions import Self
 
-from inquirer_textual.common.PromptMessage import PromptMessage
+from inquirer_textual.common.Prompt import Prompt
 from inquirer_textual.widgets.InquirerWidget import InquirerWidget
 
 
@@ -21,14 +21,15 @@ class InquirerText(InquirerWidget):
     }
     #inquirer-text-input {
         border: none;
-        background: transparent;
-        color: $input-color;
+        color: $inquirer-textual-input-color;
         padding: 0;
         height: 1;
     }
     """
 
-    def __init__(self, message: str, default: str = '', validators: Validator | Iterable[Validator] | None = None):
+    def __init__(self, message: str, name: str | None = None, default: str = '',
+                 validators: Validator | Iterable[Validator] | None = None,
+                 mandatory: bool = False):
         """
         Args:
             message (str): The prompt message to display.
@@ -36,7 +37,7 @@ class InquirerText(InquirerWidget):
             validators (Validator | Iterable[Validator] | None): A validator or list of validators to validate the
                 input.
         """
-        super().__init__()
+        super().__init__(name=name, mandatory=mandatory)
         self.message = message
         self.input: Input | None = None
         self.default = default
@@ -48,7 +49,9 @@ class InquirerText(InquirerWidget):
 
     def on_input_submitted(self, submitted: Input.Submitted):
         if self.validators is None or submitted.validation_result.is_valid:
-            self.post_message(InquirerWidget.Submit(submitted.value))
+            if self.input:
+                self.input._cursor_visible = False
+            self.submit_current_value()
 
     def focus(self, scroll_visible: bool = True) -> Self:
         if self.input:
@@ -61,6 +64,6 @@ class InquirerText(InquirerWidget):
 
     def compose(self) -> ComposeResult:
         with HorizontalGroup():
-            yield PromptMessage(self.message)
+            yield Prompt(self.message)
             self.input = Input(id="inquirer-text-input", validators=self.validators)
             yield self.input

inquirer_textual/widgets/InquirerWidget.py

@@ -13,8 +13,8 @@ class InquirerWidget(Widget):
             self.value = value
             self.command = command
 
-    def __init__(self, mandatory: bool = True):
-        super().__init__()
+    def __init__(self, name: str | None = None, mandatory: bool = False):
+        super().__init__(name=name)
         self.mandatory = mandatory
 
     def on_mount(self):
@@ -26,3 +26,9 @@ class InquirerWidget(Widget):
 
     def current_value(self):
         raise NotImplementedError("Subclasses must implement current_value method")
+
+    async def set_selected_value(self, value: Any) -> None:
+        pass
+
+    def submit_current_value(self, command: str | None = "select"):
+        self.post_message(InquirerWidget.Submit(self.current_value(), command))