cli-tools-kit 0.6.3__tar.gz → 0.6.4__tar.gz

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli-tools-kit
-Version: 0.6.3
+Version: 0.6.4
 Summary: Installer protocol + helpers for self-installing Python CLI/GUI tools (desktop shortcuts, bash aliases, cron entries), plus reusable tkinter and curses installer screens
 Author: Steffen Probst
 License: MIT License

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/cli_tools_kit/gui_installer.py

@@ -5434,13 +5434,37 @@ class InstallerApp:
 # ================= CLI FUNCTIONS =================
 
 def _self_shortcut_path() -> str:
-    """The manager's own shortcut: a .desktop file, or a .lnk on Windows."""
+    """The manager's own shortcut: a .desktop file, or a .lnk on Windows.
+
+    Windows shows the file name in the Start Menu, where freedesktop reads the
+    Name= line inside the file, so the .lnk is named after SELF_DESKTOP_NAME.
+    Characters a file name cannot hold become spaces, and a name that is empty
+    or all-punctuation falls back to the desktop file's stem.
+    """
     if host.IS_WINDOWS:
-        return os.path.join(APPS_DIR,
-                            os.path.splitext(SELF_DESKTOP_FILE)[0] + ".lnk")
+        stem = "".join(" " if c in '<>:"/\\|?*' else c
+                       for c in SELF_DESKTOP_NAME).strip(" .")
+        stem = " ".join(stem.split()) or os.path.splitext(SELF_DESKTOP_FILE)[0]
+        return os.path.join(APPS_DIR, stem + ".lnk")
     return os.path.join(APPS_DIR, SELF_DESKTOP_FILE)
 
 
+def _windows_icon(icon: str) -> Optional[str]:
+    """The .ico Windows can draw for `icon`, or None.
+
+    A .lnk renders only .ico/.exe/.dll; the shell stores a .png path without
+    complaint and then draws nothing. Consumers configure one icon, normally a
+    .png for freedesktop, so take a sibling .ico of the same stem when there is
+    one and otherwise leave the shortcut on its default picture.
+    """
+    if not icon:
+        return None
+    for candidate in (icon, os.path.splitext(icon)[0] + ".ico"):
+        if candidate.lower().endswith(".ico") and os.path.isfile(candidate):
+            return candidate
+    return None
+
+
 def cli_install_self(quiet: bool = False) -> tuple[bool, str]:
     """Install the manager's own desktop shortcut. Returns (success, message)."""
     try:
@@ -5450,9 +5474,19 @@ def cli_install_self(quiet: bool = False) -> tuple[bool, str]:
         if host.IS_WINDOWS:
             lnk_path = _self_shortcut_path()
             ok = host.write_shortcut(lnk_path, python_exec, f'"{script_path}"',
+                                     icon=_windows_icon(SELF_DESKTOP_ICON),
                                      workdir=ROOT_DIR)
             if not ok:
                 return False, f"Could not write {lnk_path}"
+            # Before 0.6.4 the .lnk was named after the desktop file's stem.
+            # Drop that one, or the Start Menu keeps both.
+            legacy = os.path.join(APPS_DIR,
+                                  os.path.splitext(SELF_DESKTOP_FILE)[0] + ".lnk")
+            if legacy != lnk_path and os.path.isfile(legacy):
+                try:
+                    os.remove(legacy)
+                except OSError:
+                    pass
             if not quiet:
                 print(f"Installed: {lnk_path}")
             return True, lnk_path

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/cli_tools_kit/sources.py

@@ -157,7 +157,15 @@ def save_local_root(config_path, root, local_path=None, log: Callable = print) -
         except OSError as exc:
             log(f"{local.name}: not updated ({exc})")
             return False
-    line = f'root = "{root}"\n'
+    # A TOML literal string, because a Windows root is full of backslashes and
+    # a basic string would read them as escapes: "C:\Users\..." dies on \U and
+    # takes the whole file with it, so the question would be asked again on
+    # every launch. A path holding a single quote falls back to a basic string
+    # with the two characters TOML needs escaped there.
+    if "'" in root:
+        line = 'root = "{}"\n'.format(root.replace("\\", "\\\\").replace('"', '\\"'))
+    else:
+        line = f"root = '{root}'\n"
     try:
         local.write_text(line + ("\n" + existing.lstrip("\n") if existing.strip() else ""),
                          encoding="utf-8")

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/cli_tools_kit.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cli-tools-kit
-Version: 0.6.3
+Version: 0.6.4
 Summary: Installer protocol + helpers for self-installing Python CLI/GUI tools (desktop shortcuts, bash aliases, cron entries), plus reusable tkinter and curses installer screens
 Author: Steffen Probst
 License: MIT License

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cli-tools-kit"
-version = "0.6.3"
+version = "0.6.4"
 description = "Installer protocol + helpers for self-installing Python CLI/GUI tools (desktop shortcuts, bash aliases, cron entries), plus reusable tkinter and curses installer screens"
 readme = "README.md"
 requires-python = ">=3.10"

{cli_tools_kit-0.6.3 → cli_tools_kit-0.6.4}/tests/test_sources.py

@@ -445,6 +445,21 @@ def test_an_existing_root_in_the_local_file_is_never_overwritten(tmp_path: Path)
     assert sources.local_root(config) == str(tmp_path / "mine")
 
 
+def test_a_windows_root_survives_the_round_trip(tmp_path: Path) -> None:
+    """A backslash path must not be written as a TOML basic string.
+
+    ``root = "C:\\Users\\..."`` reads the \\U as a Unicode escape and kills the
+    whole file, so the install location was asked for again on every launch.
+    """
+    roots = [r"C:\Users\tester\WW3-tools", r"C:\temp\new\table\unicode",
+             r"C:\Users\o'brien\tools"]
+    for i, root in enumerate(roots):
+        config = _write(tmp_path / str(i) / "installer.toml", "")
+        assert sources.save_local_root(config, root, log=lambda *a: None)
+        local = config.with_name("installer.local.toml")
+        assert sources._read_toml(local).get("root") == root
+
+
 def test_the_default_root_name_names_the_suggested_folder(tmp_path: Path, engine,
                                                           monkeypatch) -> None:
     config = _tree(tmp_path)