pi-sync-cli 0.3.0__tar.gz → 0.4.0__tar.gz

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: pi-sync-cli
-Version: 0.3.0
+Version: 0.4.0
 Summary: Sync pi agent config and extensions between hosts over rsync
 Project-URL: Repository, https://github.com/say4n/pi-sync
 Project-URL: Issues, https://github.com/say4n/pi-sync/issues
@@ -143,7 +143,14 @@ without regenerating anything.
 
 - `settings.json` is machine-written by pi (`lastChangelogVersion` bumps, UI
   toggles), so two hosts pushing it will overwrite each other's local
-  preferences. Sync it when you change `packages`, not reflexively.
+  preferences. Sync it when you change `packages`, not reflexively — and note the
+  overwritten copy is kept as `settings.json.backup` on the receiving host.
+- Anything pi-sync overwrites is kept on the destination as `<name>.backup`, and
+  `*.backup` is never synced, so those copies stay host-local and never
+trampoline between hosts. `--delete` suppresses backups for the mirrored
+  directory, because mirroring means "match exactly" — which also sidesteps an
+  openrsync bug where backing up a file it deletes fails with
+  `fchownat: Operation not permitted`.
 - Extensions that write runtime files inside their own directory (logs,
   checkpoints) get those files synced too, and each host's copy is overwritten by
   whichever side pushed last — exclude them with `-x '*/logs/*'`.

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/README.md

@@ -126,7 +126,14 @@ without regenerating anything.
 
 - `settings.json` is machine-written by pi (`lastChangelogVersion` bumps, UI
   toggles), so two hosts pushing it will overwrite each other's local
-  preferences. Sync it when you change `packages`, not reflexively.
+  preferences. Sync it when you change `packages`, not reflexively — and note the
+  overwritten copy is kept as `settings.json.backup` on the receiving host.
+- Anything pi-sync overwrites is kept on the destination as `<name>.backup`, and
+  `*.backup` is never synced, so those copies stay host-local and never
+trampoline between hosts. `--delete` suppresses backups for the mirrored
+  directory, because mirroring means "match exactly" — which also sidesteps an
+  openrsync bug where backing up a file it deletes fails with
+  `fchownat: Operation not permitted`.
 - Extensions that write runtime files inside their own directory (logs,
   checkpoints) get those files synced too, and each host's copy is overwritten by
   whichever side pushed last — exclude them with `-x '*/logs/*'`.

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pi-sync-cli"
-version = "0.3.0"
+version = "0.4.0"
 description = "Sync pi agent config and extensions between hosts over rsync"
 readme = "README.md"
 requires-python = ">=3.10"

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/src/pi_sync/cli.py

@@ -16,6 +16,7 @@ import os
 import subprocess
 import sys
 from collections.abc import Sequence
+from dataclasses import dataclass
 from pathlib import Path
 
 import click
@@ -54,10 +55,29 @@ def local_agent_dir(override: str | None = None) -> Path:
     return Path(raw).expanduser()
 
 
-def ssh_hosts(
+@dataclass(frozen=True)
+class SshHost:
+    """A host alias, plus the details worth showing in shell completions."""
+
+    name: str
+    hostname: str | None = None
+    user: str | None = None
+
+    @property
+    def detail(self) -> str:
+        if self.hostname and self.user:
+            return f"{self.user}@{self.hostname}"
+        return self.hostname or self.user or ""
+
+
+def ssh_config_hosts(
     config: str = SSH_CONFIG, _seen: frozenset[str] = frozenset()
-) -> list[str]:
-    """Host aliases from an ssh config, following Include and skipping wildcards."""
+) -> list[SshHost]:
+    """Hosts from an ssh config, following Include and skipping wildcards.
+
+    Directives bind to the Host line that precedes them, so the current block is
+    flushed when the next Host or Include appears.
+    """
     path = Path(config).expanduser()
     if not path.is_file():
         return []
@@ -65,7 +85,22 @@ def ssh_hosts(
     if resolved in _seen:
         return []
     seen = _seen | {resolved}
-    hosts: list[str] = []
+    hosts: list[SshHost] = []
+    names: set[str] = set()
+    pending: list[str] = []
+    hostname: str | None = None
+    user: str | None = None
+
+    def add(entries: list[SshHost]) -> None:
+        for entry in entries:
+            if entry.name not in names:
+                names.add(entry.name)
+                hosts.append(entry)
+
+    def flush() -> None:
+        add([SshHost(name, hostname, user) for name in pending])
+        pending.clear()
+
     for raw_line in path.read_text(errors="replace").splitlines():
         line = raw_line.strip()
         if not line or line.startswith("#"):
@@ -75,22 +110,32 @@ def ssh_hosts(
             continue
         keyword, rest = parts[0].lower(), parts[1].strip()
         if keyword == "host":
-            for token in rest.split():
-                wildcard = "*" in token or "?" in token or token.startswith("!")
-                if not wildcard and token not in hosts:
-                    hosts.append(token)
+            flush()
+            hostname = user = None
+            pending += [t for t in rest.split() if not any(c in t for c in "*?!")]
+        elif keyword == "hostname":
+            hostname = rest.split()[0]
+        elif keyword == "user":
+            user = rest.split()[0]
         elif keyword == "include":
+            flush()
             for pattern in rest.split():
                 target = Path(pattern).expanduser()
                 if not target.is_absolute():
                     target = Path.home() / ".ssh" / target
                 for included in sorted(target.parent.glob(target.name)):
-                    hosts += [
-                        h for h in ssh_hosts(str(included), seen) if h not in hosts
-                    ]
+                    add(ssh_config_hosts(str(included), seen))
+    flush()
     return hosts
 
 
+def ssh_hosts(
+    config: str = SSH_CONFIG, _seen: frozenset[str] = frozenset()
+) -> list[str]:
+    """Host alias names from an ssh config (see ssh_config_hosts)."""
+    return [host.name for host in ssh_config_hosts(config, _seen)]
+
+
 def complete_target(
     ctx: click.Context, param: click.Parameter, incomplete: str
 ) -> list[CompletionItem]:
@@ -98,9 +143,9 @@ def complete_target(
     prefix = incomplete.rpartition("@")[2]
     lead = incomplete[: len(incomplete) - len(prefix)] if prefix else incomplete
     return [
-        CompletionItem(f"{lead}{host}")
-        for host in ssh_hosts()
-        if host.startswith(prefix)
+        CompletionItem(f"{lead}{host.name}", help=host.detail)
+        for host in ssh_config_hosts()
+        if host.name.startswith(prefix)
     ]
 
 
@@ -128,7 +173,14 @@ def rsync_argv(
     argv = ["rsync", "-az", "-i"]
     argv += [f"--exclude={pattern}" for pattern in excludes]
     if delete and rel in DIRECTORY_ITEMS:
+        # Mirroring wins over backups here: the destination is meant to match the
+        # source exactly, and openrsync (the rsync macOS ships) errors out when it
+        # has to back up a file it deletes.
         argv.append("--delete-during")
+    else:
+        # Keep the destination's copy of whatever we replace, as <file>.backup.
+        argv += ["--backup", "--suffix=.backup"]
+    argv.append("--exclude=*.backup")  # backups stay host-local
     if dry_run:
         argv.append("-n")
     argv += [remote, local] if pull else [local, remote]
@@ -309,6 +361,7 @@ def sync_host(
 
 
 @click.command(context_settings={"help_option_names": ["-h", "--help"]})
+@click.version_option(package_name="pi-sync-cli")
 @click.argument(
     "targets",
     nargs=-1,

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/tests/test_cli.py

@@ -13,6 +13,7 @@ from pathlib import Path
 
 import click
 import pytest
+from click.shell_completion import CompletionItem
 from click.testing import CliRunner
 
 from pi_sync import cli
@@ -130,10 +131,31 @@ def test_select_items(groups: set[str], expected: list[str]) -> None:
 @pytest.mark.parametrize(
     ("argv_kwargs", "expected"),
     [
-        ({}, ["rsync", "-az", "-i", "/a/models.json", "host:~/.pi/agent/models.json"]),
+        (
+            {},
+            [
+                "rsync",
+                "-az",
+                "-i",
+                "--backup",
+                "--suffix=.backup",
+                "--exclude=*.backup",
+                "/a/models.json",
+                "host:~/.pi/agent/models.json",
+            ],
+        ),
         (
             {"pull": True},
-            ["rsync", "-az", "-i", "host:~/.pi/agent/models.json", "/a/models.json"],
+            [
+                "rsync",
+                "-az",
+                "-i",
+                "--backup",
+                "--suffix=.backup",
+                "--exclude=*.backup",
+                "host:~/.pi/agent/models.json",
+                "/a/models.json",
+            ],
         ),
         (
             {"dry_run": True},
@@ -141,6 +163,9 @@ def test_select_items(groups: set[str], expected: list[str]) -> None:
                 "rsync",
                 "-az",
                 "-i",
+                "--backup",
+                "--suffix=.backup",
+                "--exclude=*.backup",
                 "-n",
                 "/a/models.json",
                 "host:~/.pi/agent/models.json",
@@ -148,7 +173,16 @@ def test_select_items(groups: set[str], expected: list[str]) -> None:
         ),
         (
             {"delete": True},
-            ["rsync", "-az", "-i", "/a/models.json", "host:~/.pi/agent/models.json"],
+            [
+                "rsync",
+                "-az",
+                "-i",
+                "--backup",
+                "--suffix=.backup",
+                "--exclude=*.backup",
+                "/a/models.json",
+                "host:~/.pi/agent/models.json",
+            ],
         ),
     ],
 )
@@ -173,6 +207,20 @@ def test_rsync_argv_delete_only_for_directories() -> None:
     )
 
 
+def test_backups_are_taken_except_when_mirroring() -> None:
+    """Originals are kept as .backup, unless --delete means "match exactly"."""
+    plain = cli.rsync_argv("models.json", "host", Path("/a"), "~/.pi/agent")
+    assert "--backup" in plain
+    assert "--suffix=.backup" in plain
+    assert "--exclude=*.backup" in plain  # never propagate backups to other hosts
+
+    mirroring = cli.rsync_argv(
+        "extensions", "host", Path("/a"), "~/.pi/agent", delete=True
+    )
+    assert "--backup" not in mirroring
+    assert "--exclude=*.backup" in mirroring  # existing backups survive the delete
+
+
 def test_rsync_argv_excludes() -> None:
     argv = cli.rsync_argv(
         "extensions", "host", Path("/a"), "~/.pi/agent", excludes=("*/logs/*",)
@@ -396,28 +444,51 @@ class TestSshHosts:
 
 class TestCompletion:
     @staticmethod
-    def complete(incomplete: str) -> list[str]:
+    def hosts(*names: str) -> list[cli.SshHost]:
+        return [cli.SshHost(name) for name in names]
+
+    @staticmethod
+    def items(incomplete: str) -> list[CompletionItem]:
         """Run the completion callback the way click would."""
         ctx = click.Context(cli.main)
-        items = cli.complete_target(ctx, cli.main.params[0], incomplete)
-        return [item.value for item in items]
+        return cli.complete_target(ctx, cli.main.params[0], incomplete)
+
+    def complete(self, incomplete: str) -> list[str]:
+        return [item.value for item in self.items(incomplete)]
 
     def test_completes_matching_hosts(self, monkeypatch: pytest.MonkeyPatch) -> None:
         monkeypatch.setattr(
-            cli, "ssh_hosts", lambda *a, **k: ["tinfoil", "zero-frame", "phatboi"]
+            cli, "ssh_config_hosts", lambda *a, **k: self.hosts("tinfoil", "zero-frame")
         )
         assert self.complete("t") == ["tinfoil"]
 
     def test_empty_incomplete_lists_everything(
         self, monkeypatch: pytest.MonkeyPatch
     ) -> None:
-        monkeypatch.setattr(cli, "ssh_hosts", lambda *a, **k: ["a", "b"])
+        monkeypatch.setattr(
+            cli, "ssh_config_hosts", lambda *a, **k: self.hosts("a", "b")
+        )
         assert self.complete("") == ["a", "b"]
 
     def test_user_at_prefix_is_preserved(self, monkeypatch: pytest.MonkeyPatch) -> None:
-        monkeypatch.setattr(cli, "ssh_hosts", lambda *a, **k: ["tinfoil", "zero-frame"])
+        monkeypatch.setattr(
+            cli, "ssh_config_hosts", lambda *a, **k: self.hosts("tinfoil", "zero-frame")
+        )
         assert self.complete("sayan@zer") == ["sayan@zero-frame"]
 
+    def test_suggestions_carry_the_real_hostname(
+        self, monkeypatch: pytest.MonkeyPatch
+    ) -> None:
+        """zsh and fish render CompletionItem.help next to the suggestion."""
+        monkeypatch.setattr(
+            cli,
+            "ssh_config_hosts",
+            lambda *a, **k: [cli.SshHost("tinfoil", "tinfoil.sayan.page", "sayan")],
+        )
+        (item,) = self.items("t")
+        assert item.value == "tinfoil"
+        assert item.help == "sayan@tinfoil.sayan.page"
+
 
 class TestProbe:
     def test_reports_pi_path(self, monkeypatch: pytest.MonkeyPatch) -> None:
@@ -630,3 +701,50 @@ class TestUninstall:
         assert result.exit_code == 1
         assert "unreachable" in result.output
         assert self.uninstall_calls(fake) == []
+
+
+class TestSshHostDetails:
+    def test_hostname_and_user_are_captured(self, tmp_path: Path) -> None:
+        cfg = tmp_path / "config"
+        cfg.write_text(
+            "Host tinfoil\n  HostName tinfoil.sayan.page\n  User sayan\nHost bare\n"
+        )
+        hosts = cli.ssh_config_hosts(str(cfg))
+        assert hosts == [
+            cli.SshHost("tinfoil", "tinfoil.sayan.page", "sayan"),
+            cli.SshHost("bare"),
+        ]
+        assert hosts[0].detail == "sayan@tinfoil.sayan.page"
+        assert hosts[1].detail == ""
+
+    def test_directives_bind_to_the_preceding_host(self, tmp_path: Path) -> None:
+        cfg = tmp_path / "config"
+        cfg.write_text("Host first\n  HostName one.example\nHost second\n  User bob\n")
+        hosts = cli.ssh_config_hosts(str(cfg))
+        assert [h.hostname for h in hosts] == ["one.example", None]
+        assert [h.user for h in hosts] == [None, "bob"]
+        assert hosts[1].detail == "bob"
+
+    def test_details_survive_includes(self, tmp_path: Path) -> None:
+        extra = tmp_path / "extra"
+        extra.write_text("Host orb\n  HostName orb.local\n")
+        cfg = tmp_path / "config"
+        cfg.write_text(f"Host tinfoil\n  User sayan\nInclude {extra}\n")
+        hosts = cli.ssh_config_hosts(str(cfg))
+        assert [(h.name, h.hostname, h.user) for h in hosts] == [
+            ("tinfoil", None, "sayan"),
+            ("orb", "orb.local", None),
+        ]
+
+    def test_names_still_available_as_strings(self, tmp_path: Path) -> None:
+        cfg = tmp_path / "config"
+        cfg.write_text("Host tinfoil\n  HostName tinfoil.sayan.page\n")
+        assert cli.ssh_hosts(str(cfg)) == ["tinfoil"]
+
+
+def test_version_option_reports_the_installed_version() -> None:
+    from importlib.metadata import version
+
+    result = CliRunner().invoke(cli.main, ["--version"])
+    assert result.exit_code == 0, result.output
+    assert version("pi-sync-cli") in result.output

{pi_sync_cli-0.3.0 → pi_sync_cli-0.4.0}/uv.lock

@@ -52,7 +52,7 @@ wheels = [
 
 [[package]]
 name = "pi-sync-cli"
-version = "0.3.0"
+version = "0.4.0"
 source = { editable = "." }
 dependencies = [
     { name = "click" },