move system path handling to paths.py

Author: pvsr

src/qbpm/__init__.py

@@ -1,9 +1,8 @@
 from pathlib import Path
 from typing import Optional
 
-from xdg_base_dirs import xdg_data_home
-
-from .utils import error, qutebrowser_exe
+from .paths import qutebrowser_exe
+from .utils import error
 
 try:
     from qbpm.version import version as __version__  # type: ignore
@@ -16,9 +15,9 @@ class Profile:
     profile_dir: Path
     root: Path
 
-    def __init__(self, name: str, profile_dir: Path | None) -> None:
+    def __init__(self, name: str, profile_dir: Path) -> None:
         self.name = name
-        self.profile_dir = profile_dir or (xdg_data_home() / "qutebrowser-profiles")
+        self.profile_dir = profile_dir
         self.root = self.profile_dir / name
 
     def check(self) -> Optional["Profile"]:

src/qbpm/desktop.py

@@ -1,9 +1,8 @@
 import textwrap
 from pathlib import Path
 
-from xdg_base_dirs import xdg_data_home
-
 from . import Profile
+from .paths import default_qbpm_application_dir
 
 MIME_TYPES = [
     "text/html",
@@ -21,9 +20,7 @@
 
 
 # TODO expose application_dir through config
-def create_desktop_file(
-    profile: Profile, application_dir: Path | None = None
-) -> None:
+def create_desktop_file(profile: Profile, application_dir: Path | None = None) -> None:
     text = textwrap.dedent(f"""\
         [Desktop Entry]
         Name={profile.name} (qutebrowser profile)
@@ -49,9 +46,3 @@ def create_desktop_file(
     """)
     application_dir = application_dir or default_qbpm_application_dir()
     (application_dir / f"{profile.name}.desktop").write_text(text)
-
-
-def default_qbpm_application_dir() -> Path:
-    path = xdg_data_home() / "applications" / "qbpm"
-    path.mkdir(parents=True, exist_ok=True)
-    return path

src/qbpm/main.py

@@ -8,7 +8,8 @@
 import click
 
 from . import Profile, operations, profiles
-from .utils import SUPPORTED_MENUS, default_profile_dir, error, or_phrase, user_data_dir
+from .paths import default_profile_dir, qutebrowser_data_dir
+from .utils import SUPPORTED_MENUS, error, or_phrase
 
 CONTEXT_SETTINGS = {"help_option_names": ["-h", "--help"]}
 
@@ -68,7 +69,7 @@ def format(self, record: logging.LogRecord) -> str:
     type=click.Path(file_okay=False, writable=True, path_type=Path),
     envvar="QBPM_PROFILE_DIR",
     show_envvar=True,
-    default=default_profile_dir,
+    default=None,
     help="Location to store qutebrowser profiles.",
 )
 @click.option(
@@ -78,13 +79,13 @@ def format(self, record: logging.LogRecord) -> str:
     type=click.Choice(["debug", "info", "error"], case_sensitive=False),
 )
 @click.pass_context
-def main(ctx: click.Context, profile_dir: Path, log_level: str) -> None:
+def main(ctx: click.Context, profile_dir: Path | None, log_level: str) -> None:
     root_logger = logging.getLogger()
     root_logger.setLevel(log_level.upper())
     handler = logging.StreamHandler()
     handler.setFormatter(LowerCaseFormatter("{levelname}: {message}", style="{"))
     root_logger.addHandler(handler)
-    ctx.obj = Context(profile_dir)
+    ctx.obj = Context(profile_dir or default_profile_dir())
 
 
 @main.command()
@@ -199,7 +200,7 @@ def then_launch(
 def session_info(
     session: str, profile_name: str | None, context: Context
 ) -> tuple[Profile, Path]:
-    user_session_dir = user_data_dir() / "sessions"
+    user_session_dir = qutebrowser_data_dir() / "sessions"
     session_paths = []
     if "/" not in session:
         session_paths.append(user_session_dir / (session + ".yml"))

src/qbpm/operations.py

@@ -6,7 +6,8 @@
 
 from . import Profile, profiles
 from .desktop import create_desktop_file
-from .utils import env_menus, error, installed_menus, or_phrase, qutebrowser_exe
+from .paths import qutebrowser_exe
+from .utils import env_menus, error, installed_menus, or_phrase
 
 
 def from_session(

src/qbpm/paths.py

@@ -0,0 +1,45 @@
+import platform
+from pathlib import Path
+
+from click import get_app_dir
+from xdg_base_dirs import xdg_config_home, xdg_data_home
+
+
+def qutebrowser_exe() -> str:
+    macos_app = "/Applications/qutebrowser.app/Contents/MacOS/qutebrowser"
+    if platform == "darwin" and Path(macos_app).exists():
+        return macos_app
+    else:
+        return "qutebrowser"
+
+
+def default_qbpm_application_dir() -> Path:
+    path = xdg_data_home() / "applications" / "qbpm"
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def default_profile_dir() -> Path:
+    path = xdg_data_home() / "qutebrowser-profiles"
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
+def qutebrowser_data_dir() -> Path:
+    if platform.system() == "Linux":
+        return xdg_data_home() / "qutebrowser"
+    # TODO confirm this works on windows
+    return Path(get_app_dir("qutebrowser", roaming=True))
+
+
+def qutebrowser_config_dirs() -> list[Path]:
+    # deduplicate while maintaining order
+    return list(
+        dict.fromkeys(
+            [
+                Path(get_app_dir("qutebrowser", roaming=True)),
+                xdg_config_home() / "qutebrowser",
+                Path.home() / ".qutebrowser",
+            ]
+        )
+    )

src/qbpm/profiles.py

@@ -4,7 +4,8 @@
 
 from . import Profile
 from .desktop import create_desktop_file
-from .utils import error, or_phrase, user_config_dirs
+from .paths import qutebrowser_config_dirs
+from .utils import error, or_phrase
 
 MIME_TYPES = [
     "text/html",
@@ -71,7 +72,7 @@ def new_profile(
     desktop_file: bool | None = None,
     overwrite: bool = False,
 ) -> bool:
-    qb_config_dir = resolve_qb_config_dir(qb_config_dir)
+    qb_config_dir = find_qutebrowser_config_dir(qb_config_dir)
     if not qb_config_dir:
         return False
     if create_profile(profile, overwrite):
@@ -82,12 +83,12 @@ def new_profile(
     return False
 
 
-def resolve_qb_config_dir(qb_config_dir: Path | None) -> Path | None:
+def find_qutebrowser_config_dir(qb_config_dir: Path | None) -> Path | None:
     config_file = "config.py"
     dirs = (
         [qb_config_dir, qb_config_dir / "config"]
         if qb_config_dir
-        else user_config_dirs()
+        else qutebrowser_config_dirs()
     )
     for config_dir in dirs:
         if (config_dir / config_file).exists():

src/qbpm/utils.py

@@ -2,12 +2,8 @@
 import platform
 from collections.abc import Iterator
 from os import environ
-from pathlib import Path
 from shutil import which
 
-from click import get_app_dir
-from xdg_base_dirs import xdg_config_home, xdg_data_home
-
 WAYLAND_MENUS = ["fuzzel", "wofi", "dmenu-wl"]
 X11_MENUS = ["rofi", "dmenu"]
 SUPPORTED_MENUS = [*WAYLAND_MENUS, *X11_MENUS, "fzf", "applescript"]
@@ -21,32 +17,6 @@ def error(msg: str) -> None:
     logging.error(msg)
 
 
-def default_profile_dir() -> Path:
-    path = xdg_data_home() / "qutebrowser-profiles"
-    path.mkdir(parents=True, exist_ok=True)
-    return path
-
-
-def user_data_dir() -> Path:
-    if platform.system() == "Linux":
-        return xdg_data_home() / "qutebrowser"
-    # TODO confirm this works on windows
-    return Path(get_app_dir("qutebrowser", roaming=True))
-
-
-def user_config_dirs() -> list[Path]:
-    # deduplicate while maintaining order
-    return list(
-        dict.fromkeys(
-            [
-                Path(get_app_dir("qutebrowser", roaming=True)),
-                xdg_config_home() / "qutebrowser",
-                Path.home() / ".qutebrowser",
-            ]
-        )
-    )
-
-
 def installed_menus() -> Iterator[str]:
     if platform.system() == "Darwin":
         yield "applescript"
@@ -81,11 +51,3 @@ def or_phrase(items: list) -> str:
         return " or ".join(strings)
     else:
         return ", or ".join([", ".join(strings[0:-1]), strings[-1]])
-
-
-def qutebrowser_exe() -> str:
-    macos_app = "/Applications/qutebrowser.app/Contents/MacOS/qutebrowser"
-    if platform == "darwin" and Path(macos_app).exists():
-        return macos_app
-    else:
-        return "qutebrowser"