extract and refactor menu handling

Author: pvsr

src/qbpm/choose.py

@@ -1,38 +1,25 @@
-import shutil
 import subprocess
-from collections.abc import Iterable
 from pathlib import Path
-from sys import platform
 
 from . import Profile
 from .launch import launch_qutebrowser
-from .utils import env_menus, error, installed_menus, or_phrase
+from .menus import find_menu
+from .utils import error
 
 
 def choose_profile(
     profile_dir: Path, menu: str | None, foreground: bool, qb_args: tuple[str, ...]
 ) -> bool:
-    menu = menu or next(installed_menus(), None)
-    if not menu:
-        possible_menus = or_phrase([menu for menu in env_menus() if menu != "fzf-tmux"])
-        error(
-            "no menu program found, use --menu to provide a dmenu-compatible menu or install one of "
-            + possible_menus
-        )
-        return False
-    if menu == "applescript" and platform != "darwin":
-        error(f"applescript cannot be used on a {platform} host")
+    dmenu = find_menu(menu)
+    if not dmenu:
         return False
+
     real_profiles = {profile.name for profile in profile_dir.iterdir()}
     if len(real_profiles) == 0:
         error("no profiles")
         return False
     profiles = [*real_profiles, "qutebrowser"]
-
-    command = menu_command(menu, profiles, qb_args)
-    if not command:
-        return False
-
+    command = dmenu.commandline(sorted(profiles), "qutebrowser", " ".join(qb_args))
     selection_cmd = subprocess.Popen(
         command,
         shell=True,
@@ -50,36 +37,3 @@ def choose_profile(
     else:
         error("no profile selected")
         return False
-
-
-def menu_command(
-    menu: str, profiles: Iterable[str], qb_args: tuple[str, ...]
-) -> str | None:
-    profiles = sorted(profiles)
-    arg_string = " ".join(qb_args)
-    if menu == "applescript":
-        profile_list = '", "'.join(profiles)
-        return f"""osascript -e \'set profiles to {{"{profile_list}"}}
-set profile to choose from list profiles with prompt "qutebrowser: {arg_string}" default items {{item 1 of profiles}}
-item 1 of profile\'"""
-
-    prompt = "-p qutebrowser"
-    command = menu
-    if len(menu.split(" ")) == 1:
-        program = Path(menu).name
-        if program == "rofi":
-            command = f"{menu} -dmenu -no-custom {prompt} -mesg '{arg_string}'"
-        elif program == "wofi":
-            command = f"{menu} --dmenu {prompt}"
-        elif program.startswith("dmenu"):
-            command = f"{menu} {prompt}"
-        elif program.startswith("fzf"):
-            command = f"{menu} --prompt 'qutebrowser '"
-        elif program == "fuzzel":
-            command = f"{menu} -d"
-    exe = command.split(" ")[0]
-    if not shutil.which(exe):
-        error(f"command '{exe}' not found")
-        return None
-    profile_list = "\n".join(profiles)
-    return f'echo "{profile_list}" | {command}'

src/qbpm/main.py

@@ -10,8 +10,9 @@
 from . import Profile, operations, profiles
 from .choose import choose_profile
 from .launch import launch_qutebrowser
+from .menus import supported_menus
 from .paths import default_profile_dir, qutebrowser_data_dir
-from .utils import SUPPORTED_MENUS, error, or_phrase
+from .utils import error, or_phrase
 
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 
@@ -139,7 +140,8 @@ def launch(context: Context, profile_name: str, **kwargs: Any) -> None:
     "-m",
     "--menu",
     metavar="COMMAND",
-    help=f"A dmenu-compatible command or one of the following supported menus: {', '.join(sorted(SUPPORTED_MENUS))}",
+    help="A dmenu-compatible command or one of the following supported menus: "
+    + ", ".join(sorted([getattr(m, "name", "applescript") for m in supported_menus()])),
 )
 @click.option(
     "-f", "--foreground", is_flag=True, help="Run qutebrowser in the foreground."

src/qbpm/menus.py

@@ -0,0 +1,89 @@
+import platform
+import sys
+from collections.abc import Iterator
+from dataclasses import dataclass, replace
+from os import environ
+from pathlib import Path
+from shutil import which
+
+from .utils import error, or_phrase
+
+
+@dataclass
+class Dmenu:
+    name: str
+    args: str
+
+    def installed(self) -> bool:
+        return which(self.name) is not None
+
+    def command(self, prompt: str, qb_args: str) -> str:
+        return f"{self.name} {self.args.format(prompt=prompt, qb_args=qb_args)}"
+
+    def commandline(self, profiles: list[str], prompt: str, qb_args: str) -> str:
+        profile_list = "\n".join(profiles)
+        return f'echo "{profile_list}" | {self.command(prompt, qb_args)}'
+
+
+class ApplescriptMenu:
+    @classmethod
+    def installed(cls) -> bool:
+        return platform.system() == "Darwin"
+
+    @classmethod
+    def commandline(cls, profiles: list[str], _prompt: str, qb_args: str) -> str:
+        profile_list = '", "'.join(profiles)
+        return f"""osascript -e \'set profiles to {{"{profile_list}"}}
+set profile to choose from list profiles with prompt "qutebrowser: {qb_args}" default items {{item 1 of profiles}}
+item 1 of profile\'"""
+
+
+def find_menu(menu: str | None) -> Dmenu | ApplescriptMenu | None:
+    menus = list(supported_menus())
+    if not menu:
+        found = next(filter(lambda m: m.installed(), menus), None)
+        if not found:
+            error(
+                "no menu program found, use --menu to provide a dmenu-compatible menu or install one of "
+                + or_phrase([m.name for m in menus if isinstance(m, Dmenu)])
+            )
+        return found
+    dmenu = custom_dmenu(menu)
+    if not dmenu.installed():
+        error(f"{dmenu.name} not found")
+        return None
+    return dmenu
+
+
+def custom_dmenu(command: str) -> Dmenu:
+    split = command.split(" ", maxsplit=1)
+    if len(split) == 1 or not split[1]:
+        name = Path(command).name
+        for m in supported_menus():
+            if isinstance(m, Dmenu) and m.name == name:
+                return m if m.name == command else replace(m, name=command)
+    return Dmenu(split[0], split[1] if len(split) == 2 else "")
+
+
+def supported_menus() -> Iterator[Dmenu | ApplescriptMenu]:
+    if ApplescriptMenu.installed():
+        yield ApplescriptMenu()
+    if environ.get("WAYLAND_DISPLAY"):
+        yield from [
+            # default window is too narrow for a long prompt
+            Dmenu("fuzzel", "--dmenu"),
+            Dmenu("wofi", "--dmenu -p {prompt}"),
+            Dmenu("dmenu-wl", "-p {prompt}"),
+        ]
+    if environ.get("DISPLAY"):
+        yield from [
+            Dmenu(
+                "rofi",
+                "-dmenu -no-custom -p {prompt} -mesg '{qb_args}'",
+            ),
+            Dmenu("dmenu", "-p {prompt}"),
+        ]
+    if sys.stdin.isatty():
+        if environ.get("TMUX"):
+            yield Dmenu("fzf-tmux", "--prompt {prompt}")
+        yield Dmenu("fzf", "--prompt {prompt}")

src/qbpm/utils.py

@@ -1,12 +1,4 @@
 import logging
-import platform
-from collections.abc import Iterator
-from os import environ
-from shutil import which
-
-WAYLAND_MENUS = ["fuzzel", "wofi", "dmenu-wl"]
-X11_MENUS = ["rofi", "dmenu"]
-SUPPORTED_MENUS = [*WAYLAND_MENUS, *X11_MENUS, "fzf", "applescript"]
 
 
 def info(msg: str) -> None:
@@ -17,29 +9,6 @@ def error(msg: str) -> None:
     logging.error(msg)
 
 
-def installed_menus() -> Iterator[str]:
-    if platform.system() == "Darwin":
-        yield "applescript"
-    for menu_cmd in env_menus():
-        if which(menu_cmd) is not None:
-            if menu_cmd == "fzf":
-                info("no graphical launchers found, trying fzf")
-            yield menu_cmd
-
-
-def env_menus() -> Iterator[str]:
-    if environ.get("WAYLAND_DISPLAY"):
-        yield from WAYLAND_MENUS
-    elif environ.get("DISPLAY"):
-        yield from X11_MENUS
-    if environ.get("TMUX"):
-        yield "fzf-tmux"
-    # if there's no display and fzf is installed we're probably(?) in a term
-    if which("fzf") is not None:
-        info("no graphical launchers found, trying fzf")
-        yield "fzf"
-
-
 def or_phrase(items: list) -> str:
     strings = list(map(str, items))
     size = len(strings)