yd-cli 0.6__tar.gz → 0.8__tar.gz

{yd_cli-0.6 → yd_cli-0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yd-cli
-Version: 0.6
+Version: 0.8
 Summary: CLI tool to synchronize directories using rsync.
 Author: Christian Heinze
 License-Expression: MIT

{yd_cli-0.6 → yd_cli-0.8}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "uv-build>=0.10,<0.12" ]
 
 [project]
 name = "yd-cli"
-version = "0.6"
+version = "0.8"
 description = "CLI tool to synchronize directories using rsync."
 readme = "README.md"
 license = "MIT"
@@ -147,6 +147,8 @@ lint.ignore = [
     "PLR0913",
     # Comparison with hardcoded literals allowed.
     "PLR2004",
+    # open(Path) is ok
+    "PTH123",
     "Q000",
     "Q001",
     "Q002",

{yd_cli-0.6 → yd_cli-0.8}/src/yd/cli.py

@@ -24,7 +24,6 @@ import yd
 if TYPE_CHECKING:
     import enum
     from collections.abc import Callable
-    from collections.abc import Set as AbstractSet
 
     from rich.text import Text
 
@@ -41,7 +40,6 @@ class StrEnumHighlighter[T: enum.StrEnum](
     enum_type: type[T]
 
     _: dataclasses.KW_ONLY
-    ignore: AbstractSet[T] = dataclasses.field(default_factory=set)
     base_style_name: str | None = None
 
     @property
@@ -55,38 +53,36 @@ class StrEnumHighlighter[T: enum.StrEnum](
     def highlight(self, text: Text) -> None:
         base_style, hl = self.base_style, text.highlight_regex
         for cat in self.enum_type:
-            if cat in self.ignore:
-                continue
             # Using `__str__` instead of `cat.name.lower()` for more flexibility.
             hl(rf"(?P<{cat}>{cat})", style_prefix=base_style)
 
     def create_theme_addon(self, *, styler: Callable[[T], str]) -> dict[str, str]:
         base_style = self.base_style
-        return {
-            base_style + str(cat): styler(cat)
-            for cat in self.enum_type
-            if cat not in self.ignore
-        }
+        return {base_style + str(cat): styler(cat) for cat in self.enum_type}
+
+
+def _action_name(action: yd.types.Action) -> str:
+    if action is yd.types.Action.HARDLINK:
+        return str(yd.types.Action.COPY)
+    return str(action)
 
 
 def _action_styler(action: yd.types.Action) -> str:
     match action:
         case yd.types.Action.CREATE:
-            return "bold #aaccff on #0050aa"
+            return "bold #606060 on #0050aa"
         case yd.types.Action.COPY:
-            return "bold #aaffbb on #006020"
+            return "bold #606060 on #008020"
         case yd.types.Action.DELETE:
-            return "bold #ffaaaa on #aa0000"
+            return "bold #606060 on #aa0000"
         case yd.types.Action.HARDLINK:
             return "bold #aaaaaa on #606060"
         case yd.types.Action.ATTRUPDATE:
-            return "bold #aaaaaa on #606060"
+            return "bold #606060 on #ffffaa"
 
 
 def _setup_rich_devices() -> tuple[rich.console.Console, StrEnumHighlighter]:
-    highlighter = StrEnumHighlighter(
-        yd.types.Action, ignore={yd.types.Action.ATTRUPDATE}
-    )
+    highlighter = StrEnumHighlighter(yd.types.Action)
     theme = rich.theme.Theme(
         highlighter.create_theme_addon(styler=_action_styler)
         | {
@@ -115,6 +111,44 @@ available configurations together with their descriptions.
 app = typer.Typer(help=_YD_HELP, no_args_is_help=True, rich_markup_mode="markdown")
 
 
+# Use `list` as return value since type must be available at runtime for typer to work.
+# Argument is passed as kwarg by typer.
+def _complete_config_name(incomplete: str) -> list[str]:
+    env = yd.io.capture_environment()
+    return [
+        path.stem
+        for path in env.config_dir.glob("*.toml")
+        if re.match(incomplete, path.stem, re.IGNORECASE)
+    ]
+
+
+def _require_nonempty(param: typer.CallbackParam, v: str | None) -> str | None:
+    if v is None or v:
+        return v
+    raise typer.BadParameter(f"parameter `{param.name}` must not be an empty string")
+
+
+def _read_from_stdin(opt: str, /) -> str:
+    value = sys.stdin.read().strip()
+    if not value:
+        raise typer.BadParameter(f"no input via STDIN; `{opt}` cannot be determined")
+    return value
+
+
+def _resolve_home(
+    *, src: str | None, target: str | None
+) -> tuple[str | None, str | None]:
+    if src == "-" and target == "-":
+        raise typer.BadParameter(
+            "only one of `src-home` and `target-home` can be read from stdin."
+        )
+    if src == "-":
+        return _read_from_stdin("src-home"), target
+    if target == "-":
+        return src, _read_from_stdin("target-home")
+    return src, target
+
+
 @app.callback()
 def _setup_io() -> None:
     global env, console, highlighter  # noqa: PLW0603
@@ -159,79 +193,10 @@ def _setup_io() -> None:
             handler.setFormatter(JsonLineFormatter())
 
 
-# `min_width` chosen to fit min with in 88 character.
-def _description_column_width(min_width: int = 12) -> int:
-    import shutil
-
-    non_desc_with = (
-        10  # time elapsed
-        + 2  # dir symbol
-        + sum(
-            len(cat.name) + 10
-            for cat in highlighter.enum_type
-            if cat not in highlighter.ignore
-        )
+def _description_table_column(min_width: int = 10) -> rich.table.Column:
+    return rich.table.Column(
+        min_width=min_width, no_wrap=True, overflow="ellipsis", ratio=1
     )
-    return max(min_width, shutil.get_terminal_size().columns - non_desc_with)
-
-
-def _clip_path(path: str, *, max_len: int, prefix: str = ".../") -> str:
-    from pathlib import Path
-
-    if len(label := path) <= max_len:
-        return label
-
-    path_, max_len = Path(path), max_len - len(prefix)
-    parts = [
-        part
-        for part, cum_len in zip(
-            reversed(path_.parts),
-            # Count separating `/` character.
-            it.accumulate(len(s) + 1 for s in reversed(path_.parts)),
-            strict=True,
-        )
-        # Remove overcounted leading `/` character.
-        if cum_len - 1 <= max_len
-    ]
-    return prefix + "/".join(reversed(parts))
-
-
-# Use `list` as return value since type must be available at runtime for typer to work.
-# Argument is passed as kwarg by typer.
-def _complete_config_name(incomplete: str) -> list[str]:
-    env = yd.io.capture_environment()
-    return [
-        path.stem
-        for path in env.config_dir.glob("*.toml")
-        if re.match(incomplete, path.stem, re.IGNORECASE)
-    ]
-
-
-def _read_from_stdin(opt: str, /) -> str:
-    value = sys.stdin.read().strip()
-    if not value:
-        raise typer.BadParameter(f"no input via STDIN; `{opt}` cannot be determined")
-    return value
-
-
-def _resolve_home(
-    *, src: str | None, target: str | None
-) -> tuple[str | None, str | None]:
-    if src == "-" and target == "-":
-        raise typer.BadParameter(
-            "only one of `src-home` and `target-home` can be read from stdin."
-        )
-    if src == "-":
-        return _read_from_stdin("src-home"), target
-    if target == "-":
-        return src, _read_from_stdin("target-home")
-    return src, target
-
-
-def _require_nonempty(param: typer.CallbackParam, v: str | None) -> str | None:
-    if v is None or v:
-        return v
-    raise typer.BadParameter(f"parameter `{param.name}` must not be an empty string")
 
 
 @app.command()
@@ -343,7 +308,11 @@ def run(
             ),
             rich.progress.TextColumn(
                 "{task.description}",
-                table_column=rich.table.Column(width=_description_column_width()),
+                table_column=_description_table_column(),
+            ),
+            rich.progress.TextColumn(
+                "",
+                table_column=rich.table.Column(width=8),
             ),
             *it.chain.from_iterable(
                 (
@@ -359,11 +328,9 @@ def run(
                         table_column=rich.table.Column(min_width=7),
                     ),
                 )
-                for action_name in (
-                    str(cat)
-                    for cat in highlighter.enum_type
-                    if cat not in highlighter.ignore
-                )
+                for action_name in {
+                    _action_name(cat): None for cat in highlighter.enum_type
+                }
             ),
             console=console,
         ) as progress,
@@ -382,19 +349,16 @@ def run(
                     console.print(text, style="info")
                     return
                 case yd.types.Transaction() as transaction:
-                    if transaction.action is yd.types.Action.ATTRUPDATE:
-                        return
-
                     console.print(
                         template.format(
-                            action=transaction.action,
+                            action=_action_name(transaction.action),
                             filename=target.joinpath(transaction.filename).as_posix()
                             if not Path(transaction.filename).is_absolute()
                             else transaction.filename,
                             transfer_bytes=transaction.transfer_bytes,
                         )
                     )
-                    counter[str(transaction.action)] += 1
+                    counter[_action_name(transaction.action)] += 1
                     progress.update(
                         taskid,
                         **counter,  # type: ignore[ty:invalid-argument-type]
@@ -403,7 +367,7 @@ def run(
         for binary, args in commands:
             counter = {str(action): 0 for action in yd.types.Action}
             taskid = progress.add_task(
-                description=_clip_path(args[-1], max_len=_description_column_width()),
+                description=args[-1],
                 **counter,  # type: ignore[ty:invalid-argument-type]
                 total=1,
             )
@@ -423,6 +387,10 @@ def run(
                     )
                 )
             except (KeyboardInterrupt, asyncio.CancelledError) as err:
+                # The Runner instance registers a custom signal handler for
+                # SIGINT that cancels the main task and raises KeyboardInterrupt if
+                # no custom handler is registered. Catching the interrupt here is
+                # safer then interfering with the default behavior.
                 console.print("Terminated by user.", style="warning")
                 raise typer.Exit(2) from err
             except (yd.types.OutputParseError, yd.types.OutputConsumeError) as err:

{yd_cli-0.6 → yd_cli-0.8}/src/yd/commands.py

@@ -7,6 +7,7 @@ from __future__ import annotations
 
 import itertools as it
 import logging
+import sys
 import uuid
 from pathlib import Path
 
@@ -48,8 +49,10 @@ def _format_path(path: Path, /) -> str:
 
 def _create_error_command(
     enc_msg: str, /, environment: types.Environment
-) -> tuple[str, tuple[str]]:
-    return environment.echo_bin, (enc_msg,)
+) -> tuple[str, tuple[str, ...]]:
+    if environment.echo_bin is not None:
+        return environment.echo_bin, (enc_msg,)
+    return sys.executable, ("-m", "yd.echo", enc_msg)
 
 
 def create(  # noqa: PLR0915

yd_cli-0.8/src/yd/echo.py

@@ -0,0 +1,12 @@
+"""Echo command replacement.
+
+This is called instead of `echo` if the `echo` command is not available.
+"""
+
+from __future__ import annotations
+
+import sys
+
+if __name__ == "__main__":
+    if len(sys.argv) > 1:
+        print(sys.argv[1])

{yd_cli-0.6 → yd_cli-0.8}/src/yd/io.py

@@ -59,10 +59,7 @@ def _find_binary(binary: str, /, accept_failure: bool = False) -> str | None:
 
 
 def capture_environment() -> types.Environment:
-    """Capture environment.
-
-    Raises `types.ConfigLoadError` in case of failure.
-    """
+    """Capture environment."""
     home_dir = Path.home()
     if not home_dir.exists():
         raise types.EnvCaptureError(f"home dir `{home_dir}` does not exist")
@@ -85,11 +82,12 @@ def capture_environment() -> types.Environment:
         rsync_bin = _find_binary(_getenv("YD_RSYNC", "rsync"))
     except FileNotFoundError as err:
         raise types.EnvCaptureError("rsync binary not found") from err
-    try:
-        echo_bin = _find_binary(_getenv("YD_ECHO", "echo"))
-    except FileNotFoundError as err:
-        raise types.EnvCaptureError("echo binary not found") from err
+    echo_bin = _find_binary(_getenv("YD_ECHO", "echo"), accept_failure=True)
+    if echo_bin is None:
+        log.warning("Failed to find echo command. Resorting to builtin alternative.")
     editor_bin = _find_binary(_getenv("EDITOR", "vim"), accept_failure=True)
+    if editor_bin is None:
+        log.warning("Failed to find editor command.")
 
     try:
         log_level: int | None = int(os.getenv("YD_LOGLEVEL", ""))
@@ -116,7 +114,7 @@ def load_command_group(path: Path, /) -> types.CommandGroup:
         Path to TOML file specifying the program.
     """
     try:
-        with path.open(mode="rb") as fh:
+        with open(path, mode="rb") as fh:
             return msgspec.toml.decode(fh.read(), type=types.CommandGroup)
     except FileNotFoundError as err:
         log.exception("missing configuration file `%s`", path)
@@ -141,7 +139,7 @@ def list_available_configs(config_dir: Path, /) -> Iterable[types.AvailableConfi
         if not path.is_file():
             continue
         try:
-            with path.open(encoding="utf-8") as fh:
+            with open(path, encoding="utf-8") as fh:
                 # Benchmarked variants using one or more of `itertools.takewhile` and
                 # `yield` but this had best runtime.
                 lines = []

{yd_cli-0.6 → yd_cli-0.8}/src/yd/types.py

@@ -16,26 +16,26 @@ if TYPE_CHECKING:
     from pathlib import Path
 
 
-class SyfError(RuntimeError): ...
+class YdError(RuntimeError): ...
 
 
-class ConfigLoadError(SyfError):
+class ConfigLoadError(YdError):
     """Exception raised when loading a configuration fails."""
 
 
-class EnvCaptureError(SyfError):
+class EnvCaptureError(YdError):
     """Exception raised when capturing the environment fails."""
 
 
-class CommandBuildError(SyfError):
+class CommandBuildError(YdError):
     """Exception raised when building the rsync command fails."""
 
 
-class OutputParseError(SyfError):
+class OutputParseError(YdError):
     """Exception raised when parsing output of other CLI apps fails."""
 
 
-class OutputConsumeError(SyfError):
+class OutputConsumeError(YdError):
     """Exception raised when the consumption of parsed output fails."""
 
 
@@ -48,7 +48,7 @@ class Environment:
     config_dir: Path
 
     rsync_bin: str
-    echo_bin: str
+    echo_bin: str | None
     editor_bin: str | None