🔀 Merge pull request #9 from davidfokkema/windows-drive-select

Add a drive selection widget, only on Windows

Author: davep

textual_fspicker/base_dialog.py

@@ -3,6 +3,8 @@
 ##############################################################################
 # Python imports.
 from __future__ import annotations
+
+import sys
 from pathlib import Path
 from typing import Optional
 
@@ -17,7 +19,7 @@
 
 ##############################################################################
 # Local imports.
-from .parts import DirectoryNavigation
+from .parts import DirectoryNavigation, DriveNavigation
 
 
 ##############################################################################
@@ -100,12 +102,19 @@ def compose(self) -> ComposeResult:
         """
         with Dialog() as dialog:
             dialog.border_title = self._title
-            yield DirectoryNavigation(self._location)
+            with Horizontal():
+                if sys.platform == "win32":
+                    yield DriveNavigation(self._location)
+                yield DirectoryNavigation(self._location)
             with InputBar():
                 yield from self._input_bar()
                 yield Button(self._select_button, id="select")
                 yield Button("Cancel", id="cancel")
 
+    def on_mount(self) -> None:
+        """Focus directory widget on mount."""
+        self.query_one(DirectoryNavigation).focus()
+
     def _set_error(self, message: str = "") -> None:
         """Set or clear the error message.
 
@@ -114,6 +123,11 @@ def _set_error(self, message: str = "") -> None:
         """
         self.query_one(Dialog).border_subtitle = message
 
+    @on(DriveNavigation.DriveSelected)
+    def _change_drive(self, event: DriveNavigation.DriveSelected) -> None:
+        """Reload DirectoryNavigation in response to drive change."""
+        self.query_one(DirectoryNavigation).location = event.drive_root
+
     @on(DirectoryNavigation.Changed)
     def _clear_error(self) -> None:
         """Clear any error that might be showing."""

textual_fspicker/file_dialog.py

@@ -3,6 +3,8 @@
 ##############################################################################
 # Python imports.
 from __future__ import annotations
+
+import sys
 from pathlib import Path
 
 ##############################################################################
@@ -15,7 +17,7 @@
 ##############################################################################
 # Local imports.
 from .base_dialog import FileSystemPickerScreen
-from .parts import DirectoryNavigation
+from .parts import DirectoryNavigation, DriveNavigation
 from .path_filters import Filters
 from .path_maker import MakePath
 
@@ -160,9 +162,13 @@ def _confirm_file(self, event: Input.Submitted | Button.Pressed) -> None:
         # doing a "cd".
         try:
             if chosen.is_dir():
-                self.query_one(Input).value = ""
+                if sys.platform == "win32":
+                    drive = MakePath.of(file_name.value).drive
+                    if drive:
+                        self.query_one(DriveNavigation).drive = drive
                 self.query_one(DirectoryNavigation).location = chosen
                 self.query_one(DirectoryNavigation).focus()
+                self.query_one(Input).value = ""
                 return
         except PermissionError:
             self._set_error("Permission error")

textual_fspicker/parts/__init__.py

@@ -3,9 +3,10 @@
 ##############################################################################
 # Local imports.
 from .directory_navigation import DirectoryNavigation
+from .drive_navigation import DriveNavigation
 
 ##############################################################################
 # Export public items.
-__all__ = ["DirectoryNavigation"]
+__all__ = ["DirectoryNavigation", "DriveNavigation"]
 
 ### __init__.py ends here

textual_fspicker/parts/directory_navigation.py

@@ -3,6 +3,7 @@
 ##############################################################################
 # Python imports.
 from __future__ import annotations
+
 from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
@@ -19,8 +20,8 @@
 ##############################################################################
 # Textual imports.
 from textual import work
-from textual.reactive import var
 from textual.message import Message
+from textual.reactive import var
 from textual.widgets import OptionList
 from textual.widgets.option_list import Option
 from textual.worker import get_current_worker
@@ -51,7 +52,7 @@ class DirectoryEntryStyling(NamedTuple):
 
 ##############################################################################
 class DirectoryEntry(Option):
-    """A directory entry for the `DirectoryNaviation` class."""
+    """A directory entry for the `DirectoryNavigation` class."""
 
     FOLDER_ICON: Final[Text] = Text.from_markup(":file_folder:")
     """The icon to use for a folder."""
@@ -305,8 +306,7 @@ def _settle_highlight(self) -> None:
     @property
     def is_root(self) -> bool:
         """Are we at the root of the filesystem?"""
-        # TODO: Worry about portability.
-        return self._location == MakePath.of(self._location.root)
+        return self._location == MakePath.of(self._location.parent)
 
     @staticmethod
     def is_hidden(path: Path) -> bool:

textual_fspicker/parts/drive_navigation.py

@@ -0,0 +1,133 @@
+"""Provides a widget for drive navigation."""
+
+##############################################################################
+# Python imports.
+import sys
+from dataclasses import dataclass
+from pathlib import Path
+
+try:
+    from os import listdrives  # type: ignore[attr-defined]
+except ImportError:
+    import string
+
+    def listdrives() -> list[str]:
+        """Return a list containing the names of drives in the system.
+
+        A drive name typically looks like 'C:\\'. This is an implementation for
+        Python versions before 3.12. It does _not_ list removable drives which
+        have no media inserted.
+
+        Returns:
+            list[str]: The list of available drives.
+        """
+        return [
+            f"{letter}:"
+            for letter in string.ascii_uppercase
+            if Path(f"{letter}:\\").exists()
+        ]
+
+
+##############################################################################
+# Textual imports.
+from textual import on
+from textual.message import Message
+from textual.reactive import var
+from textual.widgets import OptionList
+from textual.widgets.option_list import Option
+
+##############################################################################
+# Local imports.
+from ..path_maker import MakePath
+
+
+##############################################################################
+class DriveEntry(Option):
+    """A drive entry for the `DriveNavigation` class."""
+
+    def __init__(self, drive: Path | str) -> None:
+        self.drive_root: Path = MakePath.of(drive)
+        """The drive root for this entry."""
+        super().__init__(self.drive_root.drive, id=self.drive_root.drive)
+
+
+class DriveNavigation(OptionList):
+    """A drive navigation widget.
+
+    Provides a single-pane widget that lets the user select a drive. This is
+    very useful in combination with the `DirectoryNavigation` widget. A dialog can
+    reload that widget in response to drive selection changes.
+    """
+
+    DEFAULT_CSS = """
+    DriveNavigation, DriveNavigation:focus {
+        border: blank;
+        border-right: $panel-darken-1;
+        width: 10;
+        height: 100%;
+    }
+
+    DriveNavigation > .option-list--option-highlighted {
+        text-style: bold;
+        color: white;
+    }
+    """
+    """Default styling for the widget."""
+
+    @dataclass
+    class DriveSelected(Message):
+        """Message sent when a drive is selected."""
+
+        drive_root: Path
+        """The selected drive root, like `c:\\`."""
+
+    drive: var[str] = var[str](MakePath.of(".").absolute().drive, init=False)
+
+    def __init__(self, location: Path | str = ".") -> None:
+        """Initialise the drive navigation widget.
+
+        Args:
+            location: The starting location.
+        """
+        super().__init__()
+        self.set_reactive(DriveNavigation.drive, MakePath.of(location).absolute().drive)
+        if sys.platform == "win32":
+            self._entries = [DriveEntry(drive) for drive in listdrives()]
+        else:
+            self._entries: list[DriveEntry] = []
+
+    def on_mount(self) -> None:
+        """Add available drives to the widget."""
+        self.add_options(self._entries)
+        self.highlight_drive(self.drive)
+
+    def _watch_drive(self, drive: str) -> None:
+        """Highlight the new drive.
+
+        Args:
+            drive: The new value of the current drive.
+        """
+        self.highlight_drive(drive)
+
+    def highlight_drive(self, drive: str) -> None:
+        """Highlight the given drive.
+
+        Args:
+            drive: The drive to be highlighted.
+        """
+        self.highlighted = self.get_option_index(drive.upper())
+
+    @on(OptionList.OptionSelected)
+    def drive_selected(self, event: OptionList.OptionSelected) -> None:
+        """Post a DriveSelected message.
+
+        Args:
+            event: The drive selected event from the parent `OptionList`.
+        """
+        assert isinstance(event.option, DriveEntry)
+        event.stop()
+        self.drive = event.option.drive_root.drive
+        self.post_message(self.DriveSelected(drive_root=event.option.drive_root))
+
+
+### drive_navigation.py ends here