Merge pull request #23 from Textualize/new-dismiss-method

davep · web-flow · commit 0c391a427170 · 2023-05-02T21:43:26.000+01:00
Move the input dialogs over to the newer `Screen` result approach
diff --git a/frogmouth/dialogs/input_dialog.py b/frogmouth/dialogs/input_dialog.py
@@ -2,18 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Any
-
 from textual.app import ComposeResult
 from textual.binding import Binding
 from textual.containers import Horizontal, Vertical
-from textual.message import Message
 from textual.screen import ModalScreen
-from textual.widget import Widget
 from textual.widgets import Button, Input, Label
 
 
-class InputDialog(ModalScreen[None]):
+class InputDialog(ModalScreen[str]):
     """A modal dialog for getting a single input from the user."""
 
     DEFAULT_CSS = """
@@ -59,32 +55,18 @@ class InputDialog(ModalScreen[None]):
     ]
     """Bindings for the dialog."""
 
-    def __init__(  # pylint:disable=redefined-builtin,too-many-arguments
-        self,
-        requester: Widget,
-        prompt: str,
-        initial: str | None = None,
-        cargo: Any = None,
-        id: str | None = None,
-    ) -> None:
+    def __init__(self, prompt: str, initial: str | None = None) -> None:
         """Initialise the input dialog.
 
         Args:
-            requester: The widget requesting the input.
             prompt: The prompt for the input.
             initial: The initial value for the input.
-            cargo: Any cargo value for the input.
-            id: The ID for the dialog.
         """
-        super().__init__(id=id)
-        self._requester = requester
-        """A reference to the widget requesting the input."""
+        super().__init__()
         self._prompt = prompt
         """The prompt to display for the input."""
         self._initial = initial
         """The initial value to use for the input."""
-        self._cargo = cargo
-        """Any cargo data for the input dialog."""
 
     def compose(self) -> ComposeResult:
         """Compose the child widgets."""
@@ -100,33 +82,6 @@ def on_mount(self) -> None:
         """Set up the dialog once the DOM is ready."""
         self.query_one(Input).focus()
 
-    class Result(Message):
-        """The input dialog result message."""
-
-        def __init__(
-            self, sender_id: str | None, value: str, cargo: Any = None
-        ) -> None:
-            """Initialise the result message.
-
-            Args:
-                sender_id: The ID of the dialog sending the message.
-                value: The value to attach as the result.
-                cargo: Any cargo data for the result.
-            """
-            super().__init__()
-            self.sender_id: str | None = sender_id
-            """The ID of the sending dialog."""
-            self.value: str = value
-            """The value of the result."""
-            self.cargo: Any = cargo
-            """Cargo data for the result."""
-
-    def _return_input(self) -> None:
-        """Return the input value from the dialog."""
-        self._requester.post_message(
-            self.Result(self.id, self.query_one(Input).value, self._cargo)
-        )
-
     def on_button_pressed(self, event: Button.Pressed) -> None:
         """Handle one of the dialog's buttons been pressed.
 
@@ -136,8 +91,7 @@ def on_button_pressed(self, event: Button.Pressed) -> None:
         if event.button.id == "cancel":
             self.app.pop_screen()
         elif event.button.id == "ok" and self.query_one(Input).value.strip():
-            self._return_input()
-            self.app.pop_screen()
+            self.dismiss(self.query_one(Input).value)
 
     def on_input_submitted(self) -> None:
         """Do default processing when the user hits enter in the input."""
diff --git a/frogmouth/dialogs/yes_no_dialog.py b/frogmouth/dialogs/yes_no_dialog.py
@@ -2,18 +2,14 @@
 
 from __future__ import annotations
 
-from typing import Any
-
 from textual.app import ComposeResult
 from textual.binding import Binding
 from textual.containers import Center, Horizontal, Vertical
-from textual.message import Message
 from textual.screen import ModalScreen
-from textual.widget import Widget
 from textual.widgets import Button, Static
 
 
-class YesNoDialog(ModalScreen[None]):
+class YesNoDialog(ModalScreen[bool]):
     """A dialog for asking a user a yes/no question."""
 
     DEFAULT_CSS = """
@@ -66,16 +62,13 @@ class YesNoDialog(ModalScreen[None]):
     ]
     """Bindings for the yes/no dialog."""
 
-    def __init__(  # pylint:disable=redefined-builtin,too-many-arguments
+    def __init__(  # pylint:disable=too-many-arguments
         self,
-        requester: Widget,
         title: str,
         question: str,
         yes_label: str = "Yes",
         no_label: str = "No",
         yes_first: bool = True,
-        cargo: Any = None,
-        id: str | None = None,
     ) -> None:
         """Initialise the yes/no dialog.
 
@@ -89,9 +82,7 @@ def __init__(  # pylint:disable=redefined-builtin,too-many-arguments
             cargo: Any cargo value for the question.
             id: The ID for the dialog.
         """
-        super().__init__(id=id)
-        self._requester = requester
-        """A reference to the widget asking the question."""
+        super().__init__()
         self._title = title
         """The title for the dialog."""
         self._question = question
@@ -102,8 +93,6 @@ def __init__(  # pylint:disable=redefined-builtin,too-many-arguments
         """The label for the no button."""
         self._aye_first = yes_first
         """Should the positive button come first?"""
-        self._cargo = cargo
-        """Any cargo data for the reply."""
 
     def compose(self) -> ComposeResult:
         """Compose the content of the dialog."""
@@ -127,37 +116,10 @@ def on_mount(self) -> None:
         """Configure the dialog once the DOM is ready."""
         self.query(Button).first().focus()
 
-    class Reply(Message):
-        """Base class for replies from the yes/no dialog."""
-
-        def __init__(self, sender_id: str | None, cargo: Any = None) -> None:
-            """Initialise the reply message.
-
-            Args:
-                sender_id: The ID of the dialog sending the message.
-                cargo: Any cargo data for the result.
-            """
-            super().__init__()
-            self.sender_id: str | None = sender_id
-            """The ID of the sending dialog."""
-            self.cargo: Any = cargo
-            """Cargo data for the result."""
-
-    class PositiveReply(Reply):
-        """A positive reply from the yes/no dialog."""
-
-    class NegativeReply(Reply):
-        """A negative reply from the yes/no dialog."""
-
     def on_button_pressed(self, event: Button.Pressed) -> None:
         """Handle a button being pressed on the dialog.
 
         Args:
             event: The event to handle.
         """
-        self._requester.post_message(
-            (self.PositiveReply if event.button.id == "yes" else self.NegativeReply)(
-                self.id, self._cargo
-            )
-        )
-        self.app.pop_screen()
+        self.dismiss(event.button.id == "yes")
diff --git a/frogmouth/screens/main.py b/frogmouth/screens/main.py
@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from functools import partial
 from pathlib import Path
 from typing import Awaitable, Callable
 from webbrowser import open as open_url
@@ -471,6 +472,15 @@ def action_about(self) -> None:
             )
         )
 
+    def add_bookmark(self, location: Path | URL, bookmark: str) -> None:
+        """Handle adding the bookmark.
+
+        Args:
+            location: The location to bookmark.
+            bookmark: The bookmark to add.
+        """
+        self.query_one(Navigation).bookmarks.add_bookmark(bookmark, location)
+
     def action_bookmark_this(self) -> None:
         """Add a bookmark for the currently-viewed file."""
 
@@ -493,23 +503,10 @@ def action_bookmark_this(self) -> None:
 
         # Give the user a chance to edit the title.
         self.app.push_screen(
-            InputDialog(self, "Bookmark title:", title, location, id="add_bookmark")
+            InputDialog("Bookmark title:", title),
+            partial(self.add_bookmark, location),
         )
 
-    def on_input_dialog_result(self, event: InputDialog.Result) -> None:
-        """Handle a result coming back from an input dialog.
-
-        Args:
-            event: The input dialog result event.
-        """
-        # Handle the correct source dialog.
-        if event.sender_id == "add_bookmark":
-            # The cargo value for the result should be the location, which
-            # should be a path or a URL.
-            assert isinstance(event.cargo, (Path, URL))
-            # Save the bookmark.
-            self.query_one(Navigation).bookmarks.add_bookmark(event.value, event.cargo)
-
     def action_toggle_theme(self) -> None:
         """Toggle the light/dark mode theme."""
         config = load_config()
diff --git a/frogmouth/widgets/navigation.py b/frogmouth/widgets/navigation.py
@@ -11,10 +11,10 @@
 from textual.widgets import TabbedContent, Tabs
 from typing_extensions import Self
 
-from .navigation_panes.navigation_pane import NavigationPane
 from .navigation_panes.bookmarks import Bookmarks
 from .navigation_panes.history import History
 from .navigation_panes.local_files import LocalFiles
+from .navigation_panes.navigation_pane import NavigationPane
 from .navigation_panes.table_of_contents import TableOfContents
 
 
diff --git a/frogmouth/widgets/navigation_panes/bookmarks.py b/frogmouth/widgets/navigation_panes/bookmarks.py
@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from functools import partial
 from pathlib import Path
 
 from httpx import URL
@@ -123,50 +124,47 @@ def on_option_list_option_selected(self, event: OptionList.OptionSelected) -> No
         assert isinstance(event.option, Entry)
         self.post_message(self.Goto(event.option.bookmark))
 
+    def delete_bookmark(self, bookmark: int, delete_it: bool) -> None:
+        """Delete a given bookmark.
+
+        Args:
+            bookmark: The bookmark to delete.
+            delete_it: Should it be deleted?
+        """
+        if delete_it:
+            del self._bookmarks[bookmark]
+            self._bookmarks_updated()
+
     def action_delete(self) -> None:
         """Delete the highlighted bookmark."""
-        if self.query_one(OptionList).highlighted is not None:
+        if (bookmark := self.query_one(OptionList).highlighted) is not None:
             self.app.push_screen(
                 YesNoDialog(
-                    self,
                     "Delete bookmark",
                     "Are you sure you want to delete the bookmark?",
-                    id="delete",
-                )
+                ),
+                partial(self.delete_bookmark, bookmark),
             )
 
-    def on_yes_no_dialog_positive_reply(self, event: YesNoDialog.PositiveReply) -> None:
-        """Handle a yes/no dialog giving a positive reply.
+    def rename_bookmark(self, bookmark: int, new_name: str) -> None:
+        """Rename the current bookmark.
 
         Args:
-            event: The event to handle.
+            bookmark: The location of the bookmark to rename.
+            new_name: The input dialog result that is the new name.
         """
-        bookmarks = self.query_one(OptionList)
-        if event.sender_id == "delete" and bookmarks.highlighted is not None:
-            del self._bookmarks[bookmarks.highlighted]
-            self._bookmarks_updated()
+        self._bookmarks[bookmark] = Bookmark(
+            new_name, self._bookmarks[bookmark].location
+        )
+        self._bookmarks_updated()
 
     def action_rename(self) -> None:
         """Rename the highlighted bookmark."""
         if (bookmark := self.query_one(OptionList).highlighted) is not None:
             self.app.push_screen(
                 InputDialog(
-                    self,
                     "Bookmark title:",
                     self._bookmarks[bookmark].title,
-                    bookmark,
-                    id="edit_title",
-                )
+                ),
+                partial(self.rename_bookmark, bookmark),
             )
-
-    def on_input_dialog_result(self, event: InputDialog.Result) -> None:
-        """Handle an input dialog result being passed to us."""
-        if event.sender_id == "edit_title":
-            # The cargo value for the result should be the index of the
-            # bookmark we're changing.
-            assert isinstance(event.cargo, int)
-            # Everything looks good, update the bookmarks.
-            self._bookmarks[event.cargo] = Bookmark(
-                event.value, self._bookmarks[event.cargo].location
-            )
-            self._bookmarks_updated()
diff --git a/frogmouth/widgets/navigation_panes/navigation_pane.py b/frogmouth/widgets/navigation_panes/navigation_pane.py
@@ -1,9 +1,7 @@
 """Provides a base class for all navigation panes."""
 
-from typing_extensions import Self
-
-
 from textual.widgets import TabbedContent, TabPane
+from typing_extensions import Self
 
 
 class NavigationPane(TabPane):
