yd-cli 0.12__tar.gz → 0.13__tar.gz

{yd_cli-0.12 → yd_cli-0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: yd-cli
-Version: 0.12
+Version: 0.13
 Summary: CLI tool to synchronize directories using rsync.
 Author: Christian Heinze
 License-Expression: MIT
@@ -104,7 +104,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src` | Relative source directory below `src_home`. |
-| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders (`%Y`, `%m`, and `%d` only!) are supported. A newly created dated target is removed if it contains only directories after synchronization. |
+| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders `%Y`, `%m`, and `%d` are supported. Each may appear at most once; no other use of `%` is allowed. A newly created dated target is removed if it contains only directories after synchronization. |
 | `delete_extra` | Delete files in the target that do not exist in the source. Defaults to `true`. |
 | `exclude` | Extra exclude patterns for this command only. |
 
@@ -116,7 +116,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 - Exactly one of `--src-home -` and `--target-home -` may read from standard input in a single run.
 - If `backup` is omitted, `yd` creates a timestamped backup directory automatically unless `--no-backup` is specified.
 - If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on hard-drive.
-- If `strftime` placeholders are included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
+- If a valid date placeholder is included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
   The 20 most recent matches are included as additional comparison destinations in the synchronization: if a file in `src` is included in one of those reference directories, then it will not be copied to `target`.
 
 ## Run a config

{yd_cli-0.12 → yd_cli-0.13}/README.md

@@ -81,7 +81,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 | Key | Meaning |
 | --- | --- |
 | `src` | Relative source directory below `src_home`. |
-| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders (`%Y`, `%m`, and `%d` only!) are supported. A newly created dated target is removed if it contains only directories after synchronization. |
+| `target` | Relative target directory below `target_home`; defaults to `src`. `strftime` placeholders `%Y`, `%m`, and `%d` are supported. Each may appear at most once; no other use of `%` is allowed. A newly created dated target is removed if it contains only directories after synchronization. |
 | `delete_extra` | Delete files in the target that do not exist in the source. Defaults to `true`. |
 | `exclude` | Extra exclude patterns for this command only. |
 
@@ -93,7 +93,7 @@ Leading comment lines directly at the top of the file are treated as the configu
 - Exactly one of `--src-home -` and `--target-home -` may read from standard input in a single run.
 - If `backup` is omitted, `yd` creates a timestamped backup directory automatically unless `--no-backup` is specified.
 - If a configured source directory exists but is empty, `yd` reports that no synchronization was performed for that command. E.g., forgetting to mount an external drive does not delete all corresponding copies on hard-drive.
-- If `strftime` placeholders are included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
+- If a valid date placeholder is included in the `target`, then the `target_home` is scanned for matching directories (possibly) created by this rule before today.
   The 20 most recent matches are included as additional comparison destinations in the synchronization: if a file in `src` is included in one of those reference directories, then it will not be copied to `target`.
 
 ## Run a config

{yd_cli-0.12 → yd_cli-0.13}/pyproject.toml

@@ -4,7 +4,7 @@ requires = [ "uv-build>=0.10,<0.12" ]
 
 [project]
 name = "yd-cli"
-version = "0.12"
+version = "0.13"
 description = "CLI tool to synchronize directories using rsync."
 readme = "README.md"
 license = "MIT"

{yd_cli-0.12 → yd_cli-0.13}/src/yd/cli.py

@@ -230,16 +230,22 @@ def _report_schedule_result(result: yd.types.ScheduleResult, /) -> None:
                 )
             case yd.types.ProcessStartError():
                 console.print(
-                    f"Failed to start rsync"
+                    "Failed to start rsync"
                     f" (command {cmd.id_}) for `{cmd.target_path}`.",
                     style="error",
                 )
             case yd.types.OutputParseError() | yd.types.OutputConsumeError():
                 console.print(
-                    f"Failed to handle rsync output"
+                    "Failed to handle rsync output"
                     f" (command {cmd.id_}) for `{cmd.target_path}`.",
                     style="error",
                 )
+            case yd.types.CleanupError():
+                console.print(
+                    "Failed to remove empty but newly"
+                    f" created target `{cmd.target_path}`.",
+                    style="error",
+                )
             case Exception():
                 console.print(
                     f"Command {cmd.id_} (target `{cmd.target_path}`) failed.",
@@ -423,6 +429,8 @@ async def _execute_commands(cs: Iterable[yd.types.Command]) -> int:
     with rich.progress.Progress(
         rich.progress.TimeElapsedColumn(table_column=rich.table.Column(width=8)),
         rich.progress.TextColumn(
+            # TODO: if possible replace this by a gren checkmark once the command is
+            # done.
             ":file_folder:",
             table_column=rich.table.Column(width=2),
         ),
@@ -539,6 +547,7 @@ async def _execute_commands(cs: Iterable[yd.types.Command]) -> int:
                             "Failed to remove empty but newly created target `%s`.",
                             target_path,
                         )
+                        raise yd.types.CleanupError from None
                     else:
                         log.info(
                             "Removed empty but newly created target `%s`.", target_path

{yd_cli-0.12 → yd_cli-0.13}/src/yd/commands.py

@@ -148,7 +148,13 @@ class CommandPaths:
         )
 
 
-def _derive_command_paths(
+_VAL_DATE_CMP_SPECS = ("%Y", "%m", "%d")
+_INVAL_DATE_CMP_SPEC = re.compile(
+    rf"%(?:[^{''.join(p.removeprefix('%') for p in _VAL_DATE_CMP_SPECS)}]|$)"
+)
+
+
+def _derive_command_paths(  # noqa: PLR0915
     cmd: types.CommandSpec,
     /,
     env: types.Environment,
@@ -168,9 +174,30 @@ def _derive_command_paths(
         )
     src_is_empty = _inspect_source(src)
 
-    target_spec = (
-        cmd.src if cmd.target is None else env.current_time.strftime(cmd.target)
-    )
+    if cmd.target is None:
+        target_spec = cmd.src
+        target_has_date_placeholder = False
+    elif inval_date_cmp := _INVAL_DATE_CMP_SPEC.findall(cmd.target):
+        inval_date_cmps = "`, `".join(inval_date_cmp)
+        raise types.CommandBuildError(
+            "found unsupported potential date specifiers"
+            f" `{inval_date_cmps}` in target `{cmd.target}`"
+        )
+    else:
+        date_cmps = {
+            c: n for c in _VAL_DATE_CMP_SPECS if (n := cmd.target.count(c)) > 0
+        }
+        if any(n > 1 for n in date_cmps.values()):
+            raise types.CommandBuildError(
+                f"found repeated date specifier in `{cmd.target}`"
+            )
+        if date_cmps:
+            target_spec = env.current_time.strftime(cmd.target)
+            target_has_date_placeholder = True
+        else:
+            target_spec = cmd.target
+            target_has_date_placeholder = False
+
     if (target_path := Path(target_spec)).is_absolute():
         raise types.CommandBuildError(
             f"found absolute target path `{target_path}` in command specification"
@@ -216,7 +243,6 @@ def _derive_command_paths(
                 f"target `{target}` intersects with backup path `{backup}`"
             )
 
-    target_has_date_placeholder = cmd.target is not None and target_spec != cmd.target
     if not target_has_date_placeholder:
         cmp_dests: list[Path] = []
     else:
@@ -264,7 +290,7 @@ class _DatePathMatch:
 
 
 # The capturing parenthesis modify the behavior of `split` used below.
-_PLACEHOLDER = re.compile(r"(%Y|%m|%d)")
+_PLACEHOLDER = re.compile(rf"({'|'.join(_VAL_DATE_CMP_SPECS)})")
 
 
 def _match_dirs(

{yd_cli-0.12 → yd_cli-0.13}/src/yd/types.py

@@ -31,6 +31,10 @@ class CommandBuildError(YdError):
     """Exception raised when building the rsync command fails."""
 
 
+class CleanupError(YdError):
+    """Exception raised when clean-up fails."""
+
+
 class ProcessStartError(YdError):
     """Exception raised when a process fails to start.