dycw-restic 0.2.22__py3-none-any.whl → 0.3.9__py3-none-any.whl

{dycw_restic-0.2.22.dist-info → dycw_restic-0.3.9.dist-info}/METADATA

@@ -1,13 +1,14 @@
 Metadata-Version: 2.3
 Name: dycw-restic
-Version: 0.2.22
+Version: 0.3.9
 Summary: Library to operate `restic`
 Author: Derek Wan
 Author-email: Derek Wan <d.wan@icloud.com>
 Requires-Dist: click>=8.3.1,<9
-Requires-Dist: dycw-utilities>=0.172.5,<1
+Requires-Dist: dycw-utilities>=0.176.3,<1
+Requires-Dist: pydantic>=2.12.5,<3
 Requires-Dist: typed-settings[attrs,click]>=25.3.0,<26
-Requires-Python: >=3.14
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
 # `restic`

dycw_restic-0.3.9.dist-info/RECORD

@@ -0,0 +1,16 @@
+restic/__init__.py,sha256=1R3lI2sjBNAPTtK4HP7ZglqUphNcoj7YV8YvqS_AsVE,58
+restic/cli.py,sha256=TK2SGlaxCusUrm0TEQ7TpOtgNeXo_18UmHhx4CcvoLQ,6035
+restic/click.py,sha256=LsM3wEHablcV7vsdAHJAgde4l8mikOW7MHy67ICeJ90,953
+restic/constants.py,sha256=uu2dXIlx3vyMNgJUs1lrCMOYBPGGUviVJ5qvxqOx6Tw,911
+restic/lib.py,sha256=vGkoeSoqpV9q5RpS6EA4JxZ8v314aihH0kRzUFNX4fk,12875
+restic/logging.py,sha256=tzoiz1F2T-AavxahNduXxfnFvhmcBh6JHskDgUhcNVU,119
+restic/models.py,sha256=UEVhXzXTaoHxrOmXR9-RSaxuC0Q_AH4RWwFfCrWL3ek,805
+restic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+restic/repo.py,sha256=wzSvqtxXvlYg_3Fjv7xc3-H_sGxwHcCPVXM_Z3cTK_E,6870
+restic/settings.py,sha256=TJraIkjJVDzu3ReuQIXKVry1Nwn2YR1uWNT4RYzKvsU,13588
+restic/types.py,sha256=lCchCT7Y7yo0PMBGHgYjpuTDf9z2orPjKiPuje1vfmE,229
+restic/utilities.py,sha256=PROHOEqEm5KM9p9LoSggVMd5kxX2-nyuAMS_YBcU4QY,3690
+dycw_restic-0.3.9.dist-info/WHEEL,sha256=RRVLqVugUmFOqBedBFAmA4bsgFcROUBiSUKlERi0Hcg,79
+dycw_restic-0.3.9.dist-info/entry_points.txt,sha256=6byn-7KAIlNAdTjaNQ3DjylzzazsZB8SLFvvrqv641o,48
+dycw_restic-0.3.9.dist-info/METADATA,sha256=kkeyYE1-GUITJGBJQX7oxXosW63OTXAPaRkSQfYx38M,421
+dycw_restic-0.3.9.dist-info/RECORD,,

{dycw_restic-0.2.22.dist-info → dycw_restic-0.3.9.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.9.18
+Generator: uv 0.9.21
 Root-Is-Purelib: true
 Tag: py3-none-any

restic/__init__.py

@@ -1,3 +1,3 @@
 from __future__ import annotations
 
-__version__ = "0.2.22"
+__version__ = "0.3.9"

restic/cli.py

@@ -12,7 +12,7 @@ from utilities.os import is_pytest
 
 import restic.click
 import restic.repo
-from restic.lib import backup, copy, forget, init, restore, snapshots
+from restic.lib import backup, copy, forget, init, restore, snapshots, unlock
 from restic.logging import LOGGER
 from restic.settings import (
     LOADERS,
@@ -22,6 +22,7 @@ from restic.settings import (
     InitSettings,
     RestoreSettings,
     SnapshotsSettings,
+    UnlockSettings,
 )
 
 if TYPE_CHECKING:
@@ -38,6 +39,7 @@ def _main() -> None: ...
 def init_sub_cmd(settings: InitSettings, /, *, repo: restic.repo.Repo) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     init(repo, password=settings.password)
 
 
@@ -50,11 +52,10 @@ def backup_sub_cmd(
 ) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     backup(
         path,
         repo,
-        chmod=settings.chmod,
-        chown=settings.chown,
         password=settings.password,
         dry_run=settings.dry_run,
         exclude=settings.exclude,
@@ -74,6 +75,7 @@ def backup_sub_cmd(
         keep_within_weekly=settings.keep_within_weekly,
         keep_within_monthly=settings.keep_within_monthly,
         keep_within_yearly=settings.keep_within_yearly,
+        group_by=settings.group_by,
         prune=settings.prune,
         repack_cacheable_only=settings.repack_cacheable_only,
         repack_small=settings.repack_small,
@@ -92,12 +94,14 @@ def copy_sub_cmd(
 ) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     copy(
         src,
         dest,
         src_password=settings.src_password,
         dest_password=settings.dest_password,
         tag=settings.tag,
+        sleep=settings.sleep,
     )
 
 
@@ -107,6 +111,7 @@ def copy_sub_cmd(
 def forget_sub_cmd(settings: ForgetSettings, /, *, repo: restic.repo.Repo) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     forget(
         repo,
         password=settings.password,
@@ -123,6 +128,7 @@ def forget_sub_cmd(settings: ForgetSettings, /, *, repo: restic.repo.Repo) -> No
         keep_within_weekly=settings.keep_within_weekly,
         keep_within_monthly=settings.keep_within_monthly,
         keep_within_yearly=settings.keep_within_yearly,
+        group_by=settings.group_by,
         prune=settings.prune,
         repack_cacheable_only=settings.repack_cacheable_only,
         repack_small=settings.repack_small,
@@ -131,6 +137,16 @@ def forget_sub_cmd(settings: ForgetSettings, /, *, repo: restic.repo.Repo) -> No
     )
 
 
+@_main.command(name="unlock", **CONTEXT_SETTINGS)
+@argument("repo", type=restic.click.Repo())
+@click_options(UnlockSettings, LOADERS, show_envvars_in_help=True)
+def unlock_sub_cmd(settings: UnlockSettings, /, *, repo: restic.repo.Repo) -> None:
+    if is_pytest():
+        return
+    basic_config(obj=LOGGER)
+    unlock(repo, password=settings.password, remove_all=settings.remove_all)
+
+
 @_main.command(name="restore", **CONTEXT_SETTINGS)
 @argument("repo", type=restic.click.Repo())
 @argument("target", type=click.Path(path_type=Path))
@@ -140,6 +156,7 @@ def restore_sub_cmd(
 ) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     restore(
         repo,
         target,
@@ -163,9 +180,9 @@ def snapshots_sub_cmd(
 ) -> None:
     if is_pytest():
         return
+    basic_config(obj=LOGGER)
     snapshots(repo, password=settings.password)
 
 
 if __name__ == "__main__":
-    basic_config(obj=LOGGER)
     _main()

restic/click.py

@@ -1,14 +1,10 @@
 from __future__ import annotations
 
-from contextlib import suppress
-from pathlib import Path
-from re import search
 from typing import TYPE_CHECKING, assert_never, override
 
 from click import Context, Parameter, ParamType
-from utilities.re import ExtractGroupError, ExtractGroupsError
 
-from restic.repo import SFTP, Backblaze, Local
+from restic.repo import SFTP, Backblaze, Local, ParseRepoBackblazeError, parse_repo
 
 if TYPE_CHECKING:
     import restic.repo
@@ -33,17 +29,9 @@ class Repo(ParamType):
                 return value
             case str():
                 try:
-                    return Backblaze.parse(value)
-                except ValueError, ExtractGroupsError:
-                    if search("b2", value):
-                        message = f"For a Backblaze repository {value!r}, the environment varaibles 'BACKBLAZE_KEY_ID' and 'BACKBLAZE_APPLICATION_KEY' must be defined"
-                        return self.fail(message, param, ctx)
-                with suppress(ExtractGroupsError):
-                    return SFTP.parse(value)
-                try:
-                    return Local.parse(value)
-                except ExtractGroupError:
-                    return Local(Path(value))
+                    return parse_repo(value)
+                except ParseRepoBackblazeError as error:
+                    return self.fail(str(error), param, ctx)
             case never:
                 assert_never(never)
 

restic/lib.py

@@ -3,12 +3,16 @@ from __future__ import annotations
 import time
 from re import MULTILINE, search
 from subprocess import CalledProcessError
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Literal, overload
 
-from utilities.subprocess import run
+from pydantic import TypeAdapter
+from utilities.iterables import one
+from utilities.subprocess import cp, run
+from utilities.tempfile import TemporaryDirectory
 from whenever import TimeDelta
 
 from restic.logging import LOGGER
+from restic.models import Snapshot
 from restic.repo import yield_repo_env
 from restic.settings import SETTINGS
 from restic.utilities import (
@@ -16,12 +20,14 @@ from restic.utilities import (
     expand_dry_run,
     expand_exclude,
     expand_exclude_i,
+    expand_group_by,
     expand_include,
     expand_include_i,
     expand_keep,
     expand_keep_within,
+    expand_read_concurrency,
     expand_tag,
-    run_chmod,
+    expand_target,
     yield_password,
 )
 
@@ -37,8 +43,6 @@ def backup(
     repo: Repo,
     /,
     *,
-    chmod: bool = SETTINGS.chmod,
-    chown: str | None = SETTINGS.chown,
     password: PasswordLike = SETTINGS.password,
     dry_run: bool = SETTINGS.dry_run,
     exclude: list[str] | None = SETTINGS.exclude_backup,
@@ -58,6 +62,7 @@ def backup(
     keep_within_weekly: str | None = SETTINGS.keep_within_weekly,
     keep_within_monthly: str | None = SETTINGS.keep_within_monthly,
     keep_within_yearly: str | None = SETTINGS.keep_within_yearly,
+    group_by: list[str] | None = SETTINGS.group_by,
     prune: bool = SETTINGS.prune,
     repack_cacheable_only: bool = SETTINGS.repack_cacheable_only,
     repack_small: bool = SETTINGS.repack_small,
@@ -66,11 +71,6 @@ def backup(
     sleep: int | None = SETTINGS.sleep,
 ) -> None:
     LOGGER.info("Backing up '%s' to '%s'...", path, repo)
-    if chmod:
-        run_chmod(path, "d", "u=rwx,g=rx,o=rx")
-        run_chmod(path, "f", "u=rw,g=r,o=r")
-    if chown is not None:
-        run("sudo", "chown", "-R", f"{chown}:{chown}", str(path))
     try:
         _backup_core(
             path,
@@ -102,7 +102,20 @@ def backup(
             )
         else:
             raise
-    if run_forget:
+    if run_forget and (
+        (keep_last is not None)
+        or (keep_hourly is not None)
+        or (keep_daily is not None)
+        or (keep_weekly is not None)
+        or (keep_monthly is not None)
+        or (keep_yearly is not None)
+        or (keep_within is not None)
+        or (keep_within_hourly is not None)
+        or (keep_within_daily is not None)
+        or (keep_within_weekly is not None)
+        or (keep_within_monthly is not None)
+        or (keep_within_yearly is not None)
+    ):
         forget(
             repo,
             password=password,
@@ -118,6 +131,7 @@ def backup(
             keep_within_weekly=keep_within_weekly,
             keep_within_monthly=keep_within_monthly,
             keep_within_yearly=keep_within_yearly,
+            group_by=group_by,
             prune=prune,
             repack_cacheable_only=repack_cacheable_only,
             repack_small=repack_small,
@@ -154,21 +168,13 @@ def _backup_core(
             *expand_dry_run(dry_run=dry_run),
             *expand_exclude(exclude=exclude),
             *expand_exclude_i(exclude_i=exclude_i),
-            "--read-concurrency",
-            str(read_concurrency),
+            *expand_read_concurrency(read_concurrency),
             *expand_tag(tag=tag),
             str(path),
             print=True,
         )
 
 
-def init(repo: Repo, /, *, password: PasswordLike = SETTINGS.password) -> None:
-    LOGGER.info("Initializing '%s'", repo)
-    with yield_repo_env(repo), yield_password(password=password):
-        run("restic", "init", print=True)
-    LOGGER.info("Finished initializing '%s'", repo)
-
-
 def copy(
     src: Repo,
     dest: Repo,
@@ -177,6 +183,7 @@ def copy(
     src_password: PasswordLike = SETTINGS.password,
     dest_password: PasswordLike = SETTINGS.password,
     tag: list[str] | None = SETTINGS.tag_copy,
+    sleep: int | None = SETTINGS.sleep,
 ) -> None:
     LOGGER.info("Copying snapshots from '%s' to '%s'...", src, dest)
     with (
@@ -186,7 +193,15 @@ def copy(
         yield_password(password=dest_password),
     ):
         run("restic", "copy", *expand_tag(tag=tag), print=True)
-    LOGGER.info("Finished copying snapshots from '%s' to '%s'", src, dest)
+    if sleep is None:
+        LOGGER.info("Finished copying snapshots from '%s' to '%s'", src, dest)
+    else:
+        delta = TimeDelta(seconds=sleep)
+        LOGGER.info(
+            "Finished copying snapshots from '%s' to '%s'; sleeping for %s...", delta
+        )
+        time.sleep(sleep)
+        LOGGER.info("Finishing sleeping for %s", delta)
 
 
 def forget(
@@ -207,6 +222,7 @@ def forget(
     keep_within_weekly: str | None = SETTINGS.keep_within_weekly,
     keep_within_monthly: str | None = SETTINGS.keep_within_monthly,
     keep_within_yearly: str | None = SETTINGS.keep_within_yearly,
+    group_by: list[str] | None = SETTINGS.group_by,
     prune: bool = SETTINGS.prune,
     repack_cacheable_only: bool = SETTINGS.repack_cacheable_only,
     repack_small: bool = SETTINGS.repack_small,
@@ -231,6 +247,7 @@ def forget(
             *expand_keep_within("within-weekly", duration=keep_within_weekly),
             *expand_keep_within("within-monthly", duration=keep_within_monthly),
             *expand_keep_within("within-yearly", duration=keep_within_yearly),
+            *expand_group_by(group_by=group_by),
             *expand_bool("prune", bool_=prune),
             *expand_bool("repack-cacheable-only", bool_=repack_cacheable_only),
             *expand_bool("repack-small", bool_=repack_small),
@@ -241,6 +258,28 @@ def forget(
     LOGGER.info("Finished forgetting snapshots in '%s'", repo)
 
 
+def init(repo: Repo, /, *, password: PasswordLike = SETTINGS.password) -> None:
+    LOGGER.info("Initializing '%s'", repo)
+    with yield_repo_env(repo), yield_password(password=password):
+        run("restic", "init", print=True)
+    LOGGER.info("Finished initializing '%s'", repo)
+
+
+def unlock(
+    repo: Repo,
+    /,
+    *,
+    password: PasswordLike = SETTINGS.password,
+    remove_all: bool = SETTINGS.remove_all,
+) -> None:
+    LOGGER.info("Unlocking '%s'", repo)
+    with yield_repo_env(repo), yield_password(password=password):
+        run(
+            "restic", "unlock", *expand_bool("remove-all", bool_=remove_all), print=True
+        )
+    LOGGER.info("Finished unlocking '%s'", repo)
+
+
 def restore(
     repo: Repo,
     target: PathLike,
@@ -257,7 +296,11 @@ def restore(
     snapshot: str = SETTINGS.snapshot,
 ) -> None:
     LOGGER.info("Restoring snapshot '%s' of '%s' to '%s'...", snapshot, repo, target)
-    with yield_repo_env(repo), yield_password(password=password):
+    with (
+        yield_repo_env(repo),
+        yield_password(password=password),
+        TemporaryDirectory() as temp,
+    ):
         run(
             "restic",
             "restore",
@@ -268,22 +311,63 @@ def restore(
             *expand_include(include=include),
             *expand_include_i(include_i=include_i),
             *expand_tag(tag=tag),
-            "--target",
-            str(target),
+            *expand_target(temp),
             "--verify",
             snapshot,
             print=True,
         )
+        snaps = snapshots(repo, password=password, return_=True)
+        path = one(snaps[-1].paths)
+        src = temp / path.relative_to(path.anchor)
+        cp(src, target)
     LOGGER.info(
         "Finished restoring snapshot '%s' of '%s' to '%s'", snapshot, repo, target
     )
 
 
-def snapshots(repo: Repo, /, *, password: PasswordLike = SETTINGS.password) -> None:
+@overload
+def snapshots(
+    repo: Repo,
+    /,
+    *,
+    password: PasswordLike = SETTINGS.password,
+    return_: Literal[True],
+    print: bool = False,
+) -> list[Snapshot]: ...
+@overload
+def snapshots(
+    repo: Repo,
+    /,
+    *,
+    password: PasswordLike = SETTINGS.password,
+    return_: Literal[False] = False,
+    print: bool = False,
+) -> None: ...
+@overload
+def snapshots(
+    repo: Repo,
+    /,
+    *,
+    password: PasswordLike = SETTINGS.password,
+    return_: bool = False,
+    print: bool = False,
+) -> list[Snapshot] | None: ...
+def snapshots(
+    repo: Repo,
+    /,
+    *,
+    password: PasswordLike = SETTINGS.password,
+    return_: bool = False,
+    print: bool = False,  # noqa: A002
+) -> list[Snapshot] | None:
     LOGGER.info("Listing snapshots in '%s'...", repo)
+    args: list[str] = ["restic", "snapshots"]
+    if return_:
+        args.append("--json")
     with yield_repo_env(repo), yield_password(password=password):
-        run("restic", "snapshots", print=True)
+        result = run(*args, print=print, return_=return_)
     LOGGER.info("Finished listing snapshots in '%s'", repo)
+    return None if result is None else TypeAdapter(list[Snapshot]).validate_json(result)
 
 
-__all__ = ["backup", "copy", "forget", "init", "restore", "snapshots"]
+__all__ = ["backup", "copy", "forget", "init", "restore", "snapshots", "unlock"]

restic/models.py

@@ -0,0 +1,43 @@
+from __future__ import annotations
+
+import datetime as dt  # noqa: TC003
+from pathlib import Path  # noqa: TC003
+
+from pydantic import BaseModel
+
+
+class Snapshot(BaseModel):
+    time: dt.datetime
+    tree: str
+    paths: list[Path]
+    hostname: str
+    username: str
+    uid: int
+    gid: int
+    program_version: str
+    summary: Summary
+    id: str
+    short_id: str
+
+
+class Summary(BaseModel):
+    backup_start: dt.datetime
+    backup_end: dt.datetime
+    files_new: int
+    files_changed: int
+    files_unmodified: int
+    dirs_new: int
+    dirs_changed: int
+    dirs_unmodified: int
+    data_blobs: int
+    tree_blobs: int
+    data_added: int
+    data_added_packed: int
+    total_files_processed: int
+    total_bytes_processed: int
+
+
+_ = Snapshot.model_rebuild()
+
+
+__all__ = ["Snapshot", "Summary"]

restic/repo.py

@@ -1,13 +1,19 @@
 from __future__ import annotations
 
-from contextlib import contextmanager
+from contextlib import contextmanager, suppress
 from dataclasses import dataclass
 from pathlib import Path
-from typing import TYPE_CHECKING, Self, assert_never
+from re import search
+from typing import TYPE_CHECKING, Self, assert_never, override
 
 from typed_settings import Secret, load_settings
 from utilities.os import temp_environ
-from utilities.re import extract_group, extract_groups
+from utilities.re import (
+    ExtractGroupError,
+    ExtractGroupsError,
+    extract_group,
+    extract_groups,
+)
 
 from restic.settings import LOADERS, SETTINGS, Settings
 
@@ -20,13 +26,38 @@ if TYPE_CHECKING:
 type Repo = Backblaze | Local | SFTP
 
 
-@dataclass(order=True, unsafe_hash=True, slots=True)
+##
+
+
+@dataclass(order=True, slots=True)
 class Backblaze:
     key_id: Secret[str]
     application_key: Secret[str]
     bucket: str
     path: Path
 
+    @override
+    def __eq__(self, other: object, /) -> bool:
+        return (
+            isinstance(other, type(self))
+            and (self.key_id.get_secret_value() == other.key_id.get_secret_value())
+            and (
+                self.application_key.get_secret_value()
+                == other.application_key.get_secret_value()
+            )
+            and (self.bucket == other.bucket)
+            and (self.path == other.path)
+        )
+
+    @override
+    def __hash__(self) -> int:
+        return hash((
+            self.key_id.get_secret_value(),
+            self.application_key.get_secret_value(),
+            self.bucket,
+            self.path,
+        ))
+
     @classmethod
     def parse(
         cls,
@@ -45,8 +76,7 @@ class Backblaze:
             case None, Secret() as key_id_use:
                 ...
             case None, None:
-                msg = "'BACKBLAZE_KEY_ID' is missing"
-                raise ValueError(msg)
+                raise BackblazeKeyIdMissingError
             case never:
                 assert_never(never)
         match application_key, settings.backblaze_application_key:
@@ -57,11 +87,14 @@ class Backblaze:
             case None, Secret() as application_key_use:
                 ...
             case None, None:
-                msg = "'BACKBLAZE_APPLICATION_KEY' is missing"
-                raise ValueError(msg)
+                raise BackblazeApplicationIdMissingError
             case never:
                 assert_never(never)
-        bucket, path = extract_groups(r"^b2:([^@:]+):([^@+]+)$", text)
+        pattern = r"^b2:([^@:]+):([^@+]+)$"
+        try:
+            bucket, path = extract_groups(pattern, text)
+        except ExtractGroupsError:
+            raise BackblazeInvalidStrError(pattern=pattern, text=text) from None
         return cls(key_id_use, application_key_use, bucket, Path(path))
 
     @property
@@ -69,13 +102,48 @@ class Backblaze:
         return f"b2:{self.bucket}:{self.path}"
 
 
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class BackblazeParseError(Exception): ...
+
+
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class BackblazeKeyIdMissingError(BackblazeParseError):
+    @override
+    def __str__(self) -> str:
+        return "'BACKBLAZE_KEY_ID' is missing"
+
+
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class BackblazeApplicationIdMissingError(BackblazeParseError):
+    @override
+    def __str__(self) -> str:
+        return "'BACKBLAZE_APPLICATION_ID' is missing"
+
+
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class BackblazeInvalidStrError(BackblazeParseError):
+    pattern: str
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Text must be of the form {self.pattern!r}; got {self.text!r}"
+
+
+##
+
+
 @dataclass(order=True, unsafe_hash=True, slots=True)
 class Local:
     path: Path
 
     @classmethod
     def parse(cls, text: str, /) -> Self:
-        path = extract_group(r"^local:([^@:]+)$", text)
+        pattern = r"^local:([^@:]+)$"
+        try:
+            path = extract_group(pattern, text)
+        except ExtractGroupError:
+            raise LocalParseError(pattern=pattern, text=text) from None
         return cls(Path(path))
 
     @property
@@ -83,6 +151,19 @@ class Local:
         return f"local:{self.path}"
 
 
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class LocalParseError(Exception):
+    pattern: str
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Text must be of the form {self.pattern!r}; got {self.text!r}"
+
+
+##
+
+
 @dataclass(order=True, unsafe_hash=True, slots=True)
 class SFTP:
     user: str
@@ -91,9 +172,11 @@ class SFTP:
 
     @classmethod
     def parse(cls, text: str, /) -> Self:
-        user, hostname, path = extract_groups(
-            r"^sftp:([^@:]+)@([^@:]+):([^@:]+)$", text
-        )
+        pattern = r"^sftp:([^@:]+)@([^@:]+):([^@:]+)$"
+        try:
+            user, hostname, path = extract_groups(pattern, text)
+        except ExtractGroupsError:
+            raise SFTPParseError(pattern=pattern, text=text) from None
         return cls(user, hostname, Path(path))
 
     @property
@@ -101,6 +184,45 @@ class SFTP:
         return f"sftp:{self.user}@{self.hostname}:{self.path}"
 
 
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class SFTPParseError(Exception):
+    pattern: str
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return f"Text must be of the form {self.pattern!r}; got {self.text!r}"
+
+
+##
+
+
+def parse_repo(text: str, /) -> Repo:
+    try:
+        return Backblaze.parse(text)
+    except BackblazeParseError as error:
+        if search("b2", text):
+            raise ParseRepoBackblazeError(text=str(error)) from None
+    with suppress(SFTPParseError):
+        return SFTP.parse(text)
+    try:
+        return Local.parse(text)
+    except LocalParseError:
+        return Local(Path(text))
+
+
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class ParseRepoBackblazeError(Exception):
+    text: str
+
+    @override
+    def __str__(self) -> str:
+        return self.text
+
+
+##
+
+
 @contextmanager
 def yield_repo_env(
     repo: Repo, /, *, env_var: str = "RESTIC_REPOSITORY"
@@ -120,4 +242,18 @@ def yield_repo_env(
             assert_never(never)
 
 
-__all__ = ["SFTP", "Backblaze", "Local", "Repo", "yield_repo_env"]
+__all__ = [
+    "SFTP",
+    "Backblaze",
+    "BackblazeApplicationIdMissingError",
+    "BackblazeInvalidStrError",
+    "BackblazeKeyIdMissingError",
+    "BackblazeParseError",
+    "Local",
+    "LocalParseError",
+    "ParseRepoBackblazeError",
+    "Repo",
+    "SFTPParseError",
+    "parse_repo",
+    "yield_repo_env",
+]

restic/settings.py

@@ -17,6 +17,8 @@ from typed_settings import (
 )
 from utilities.os import CPU_COUNT
 
+from restic.logging import LOGGER
+
 CONFIG_FILE = getenv("RESTIC_CONFIG_FILE", "config.toml")
 SECRETS_FILE = getenv("RESTIC_SECRETS_FILE", "secrets.toml")
 LOADERS = [
@@ -38,10 +40,6 @@ class Settings:
         default=None, help="Backblaze application key"
     )
     # backup
-    chmod: bool = option(default=False, help="Change permissions of the directory/file")
-    chown: str | None = option(
-        default=None, help="Change ownership of the directory/file"
-    )
     exclude_backup: list[str] | None = option(default=None, help="Exclude a pattern")
     exclude_i_backup: list[str] | None = option(
         default=None, help="Exclude a pattern but ignores the casing of filenames"
@@ -101,6 +99,9 @@ class Settings:
         default=None,
         help="Keep yearly snapshots that are newer than duration relative to the latest snapshot",
     )
+    group_by: list[str] | None = option(
+        default=None, help="Group snapshots by host, paths and/or tags"
+    )
     prune: bool = option(
         default=True,
         help="Automatically run the 'prune' command if snapshots have been removed",
@@ -117,6 +118,10 @@ class Settings:
     tag_forget: list[str] | None = option(
         default=None, help="Only consider snapshots including tag[,tag,...]"
     )
+    # unlock
+    remove_all: bool = option(
+        default=False, help="Remove all locks, even non-stale ones"
+    )
     # restore
     delete: bool = option(
         default=False,
@@ -137,6 +142,7 @@ class Settings:
     snapshot: str = option(default="latest", help="Snapshot ID to restore")
 
 
+LOGGER.info("Loading settings from '%s' and '%s'...", CONFIG_FILE, SECRETS_FILE)
 SETTINGS = load_settings(Settings, LOADERS)
 
 
@@ -146,17 +152,8 @@ def _get_help(member_descriptor: Any, /) -> None:
     ]
 
 
-@settings(kw_only=True)
-class InitSettings:
-    password: Secret[str] = secret(
-        default=SETTINGS.password, help=_get_help(Settings.password)
-    )
-
-
 @settings(kw_only=True)
 class BackupSettings:
-    chmod: bool = option(default=SETTINGS.chmod, help=_get_help(Settings.chmod))
-    chown: str | None = option(default=SETTINGS.chown, help=_get_help(Settings.chown))
     password: Secret[str] = secret(
         default=SETTINGS.password, help=_get_help(Settings.password)
     )
@@ -213,6 +210,9 @@ class BackupSettings:
     keep_within_yearly: str | None = option(
         default=SETTINGS.keep_within_yearly, help=_get_help(Settings.keep_within_yearly)
     )
+    group_by: list[str] | None = option(
+        default=SETTINGS.group_by, help=_get_help(Settings.group_by)
+    )
     prune: bool = option(default=SETTINGS.prune, help=_get_help(Settings.prune))
     repack_cacheable_only: bool = option(
         default=SETTINGS.repack_cacheable_only,
@@ -242,6 +242,7 @@ class CopySettings:
     tag: list[str] | None = option(
         default=SETTINGS.tag_copy, help=_get_help(Settings.tag_copy)
     )
+    sleep: int | None = option(default=SETTINGS.sleep, help=_get_help(Settings.sleep))
 
 
 @settings(kw_only=True)
@@ -287,6 +288,9 @@ class ForgetSettings:
     keep_within_yearly: str | None = option(
         default=SETTINGS.keep_within_yearly, help=_get_help(Settings.keep_within_yearly)
     )
+    group_by: list[str] | None = option(
+        default=SETTINGS.group_by, help=_get_help(Settings.group_by)
+    )
     prune: bool = option(default=SETTINGS.prune, help=_get_help(Settings.prune))
     repack_cacheable_only: bool = option(
         default=SETTINGS.repack_cacheable_only,
@@ -304,6 +308,23 @@ class ForgetSettings:
     )
 
 
+@settings(kw_only=True)
+class InitSettings:
+    password: Secret[str] = secret(
+        default=SETTINGS.password, help=_get_help(Settings.password)
+    )
+
+
+@settings(kw_only=True)
+class UnlockSettings:
+    password: Secret[str] = secret(
+        default=SETTINGS.password, help=_get_help(Settings.password)
+    )
+    remove_all: bool = option(
+        default=SETTINGS.remove_all, help=_get_help(Settings.remove_all)
+    )
+
+
 @settings(kw_only=True)
 class RestoreSettings:
     password: Secret[str] = secret(
@@ -346,4 +367,5 @@ __all__ = [
     "RestoreSettings",
     "Settings",
     "SnapshotsSettings",
+    "UnlockSettings",
 ]

restic/utilities.py

@@ -1,14 +1,15 @@
 from __future__ import annotations
 
 from contextlib import contextmanager
+from dataclasses import dataclass
 from itertools import chain
 from pathlib import Path
-from typing import TYPE_CHECKING, Literal, assert_never
+from typing import TYPE_CHECKING, assert_never, override
 
 from typed_settings import Secret
 from utilities.os import temp_environ
-from utilities.subprocess import run
 from utilities.tempfile import TemporaryFile
+from utilities.text import repr_str
 
 from restic.settings import SETTINGS
 
@@ -36,6 +37,10 @@ def expand_exclude_i(*, exclude_i: list[str] | None = None) -> list[str]:
     return _expand_list("iexclude", arg=exclude_i)
 
 
+def expand_group_by(*, group_by: list[str] | None = None) -> list[str]:
+    return [] if group_by is None else ["--group-by", ",".join(group_by)]
+
+
 def expand_include(*, include: list[str] | None = None) -> list[str]:
     return _expand_list("include", arg=include)
 
@@ -52,12 +57,19 @@ def expand_keep_within(freq: str, /, *, duration: str | None = None) -> list[str
     return [] if duration is None else [f"--keep-{freq}", duration]
 
 
+def expand_read_concurrency(n: int, /) -> list[str]:
+    return ["--read-concurrency", str(n)]
+
+
 def expand_tag(*, tag: list[str] | None = None) -> list[str]:
     return _expand_list("tag", arg=tag)
 
 
-def run_chmod(path: PathLike, type_: Literal["f", "d"], mode: str, /) -> None:
-    run("sudo", "find", str(path), "-type", type_, "-exec", "chmod", mode, "{}", "+")
+def expand_target(target: PathLike, /) -> list[str]:
+    return ["--target", str(target)]
+
+
+##
 
 
 @contextmanager
@@ -77,8 +89,7 @@ def yield_password(
                 with temp_environ({env_var: str(value)}):
                     yield
             else:
-                msg = f"Password file not found: '{value!s}'"
-                raise FileNotFoundError(msg)
+                raise YieldPasswordError(path=value)
         case str():
             if Path(value).is_file():
                 with temp_environ({env_var: value}):
@@ -91,6 +102,18 @@ def yield_password(
             assert_never(never)
 
 
+@dataclass(order=True, unsafe_hash=True, kw_only=True, slots=True)
+class YieldPasswordError(Exception):
+    path: Path
+
+    @override
+    def __str__(self) -> str:
+        return f"Password file not found: {repr_str(self.path)}"
+
+
+##
+
+
 def _expand_list(flag: str, /, *, arg: list[str] | None = None) -> list[str]:
     return (
         [] if arg is None else list(chain.from_iterable([f"--{flag}", a] for a in arg))
@@ -98,15 +121,18 @@ def _expand_list(flag: str, /, *, arg: list[str] | None = None) -> list[str]:
 
 
 __all__ = [
+    "YieldPasswordError",
     "expand_bool",
     "expand_dry_run",
     "expand_exclude",
     "expand_exclude_i",
+    "expand_group_by",
     "expand_include",
     "expand_include_i",
     "expand_keep",
     "expand_keep_within",
+    "expand_read_concurrency",
     "expand_tag",
-    "run_chmod",
+    "expand_target",
     "yield_password",
 ]

dycw_restic-0.2.22.dist-info/RECORD

@@ -1,15 +0,0 @@
-restic/__init__.py,sha256=yhMJ-0LPYMf--j6qVDnbLfF1nV_AHSSJISPpIr9pFm8,59
-restic/cli.py,sha256=YVrgIwCkAMI9BmbjAC1M4aFZ2WjNk1f8YqfauwfLwG8,5432
-restic/click.py,sha256=cuqKKXlErXsb_vNkWHKyo_xnrTgo8qhscaEWqsT7Nl8,1525
-restic/constants.py,sha256=uu2dXIlx3vyMNgJUs1lrCMOYBPGGUviVJ5qvxqOx6Tw,911
-restic/lib.py,sha256=-d3dPReAJikNdLWHNC7QjJiAHYG6vj435KTCc0A09Xc,10454
-restic/logging.py,sha256=tzoiz1F2T-AavxahNduXxfnFvhmcBh6JHskDgUhcNVU,119
-restic/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-restic/repo.py,sha256=uDOEzkSWz0vJR-SFFraYtVSD-bl7C6FWlPtfAdDy9KI,3544
-restic/settings.py,sha256=a2WPOeB_VwvbZJ-uxuJpJB1RE5TH1S-BD0IeIIf1v_8,12988
-restic/types.py,sha256=lCchCT7Y7yo0PMBGHgYjpuTDf9z2orPjKiPuje1vfmE,229
-restic/utilities.py,sha256=uXq5Jl_FFjVNCLYG9si4KNiiCJWG2nk0Yr49c4TgA1Q,3215
-dycw_restic-0.2.22.dist-info/WHEEL,sha256=ZyFSCYkV2BrxH6-HRVRg3R9Fo7MALzer9KiPYqNxSbo,79
-dycw_restic-0.2.22.dist-info/entry_points.txt,sha256=6byn-7KAIlNAdTjaNQ3DjylzzazsZB8SLFvvrqv641o,48
-dycw_restic-0.2.22.dist-info/METADATA,sha256=PHpIDO2qcLXFznHv-ujYWYzW6byripPVLxTqOVyjzfA,387
-dycw_restic-0.2.22.dist-info/RECORD,,