FileBackup 0.4.3__tar.gz → 0.5.1__tar.gz

{filebackup-0.4.3 → filebackup-0.5.1}/.github/workflows/CICD_impl.yml

@@ -66,6 +66,9 @@ jobs:
           python-version: ${{ matrix.python_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Run pre-commit scripts
         run: uv run pre-commit run --verbose
 
@@ -250,6 +253,9 @@ jobs:
           python-version: ${{ inputs.python_package_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Build Binary
         run: uv run python BuildBinary.py Build --verbose
 
@@ -261,6 +267,8 @@ jobs:
         with:
           name: Binary.${{ matrix.os }}
           path: FileBackup-${{ env.PACKAGE_VERSION }}.*
+
+  # ----------------------------------------------------------------------
   validate_binary:
     needs: [python_package, build_binary]
 

{filebackup-0.4.3 → filebackup-0.5.1}/BuildBinary.py

@@ -1,15 +1,21 @@
 import os
 import shutil
+import textwrap
+import uuid
 
 from pathlib import Path
 from typing import Annotated, Optional
 
 import typer
 
+from dbrownell_Common.ContextlibEx import ExitStack
 from dbrownell_Common import SubprocessEx
 from dbrownell_Common.Streams.DoneManager import DoneManager, Flags as DoneManagerFlags
+import inflect
 from typer.core import TyperGroup
 
+import FileBackup
+
 
 # ----------------------------------------------------------------------
 class NaturalOrderGrouper(TyperGroup):
@@ -46,12 +52,49 @@ def Build(
     with DoneManager.CreateCommandLine(
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
     ) as dm:
-        command_line = "cxfreeze --script src/FileBackup/CommandLine/EntryPoint.py --target-name=FileBackup"
-
-        dm.WriteVerbose(f"Command line: {command_line}\n\n")
-
-        with dm.YieldStream() as stream:
-            dm.result = SubprocessEx.Stream(command_line, stream)
+        # inflect uses the typeguard library, which relies on inspect to read the source code of
+        # inflect to enforce that arguments are the correct types when invoking functions. This
+        # works fine when running the application normally, but does not work by default with
+        # cx_Freeze because it does not include the source code of inflect in the built binary. This
+        # means that typeguard can't determine the types of the arguments, which causes it to raise
+        # an exception. The fix is to include the inflect source code in the built binary so that
+        # typeguard can find the function's types and not raise an exception.
+        inflect_filename = Path(inflect.__file__).relative_to(Path(__file__).parent)
+
+        configuration_filename = Path("setup{}.py".format(str(uuid.uuid4()).replace("-", "")))
+
+        configuration_filename.write_text(
+            textwrap.dedent(
+                f"""\
+                from cx_Freeze import setup, Executable
+
+                setup(
+                    name = "FileBackup",
+                    version = "{FileBackup.__version__}",
+                    options = {{
+                        "build_exe": {{
+                        "include_files": [
+                            (r"{inflect_filename}", "lib/inflect/{inflect_filename.name}"),
+                        ],
+                    "packages": []
+                        }},
+                    }},
+                    executables = [
+                        Executable(
+                            "src/FileBackup/CommandLine/EntryPoint.py",
+                            target_name="FileBackup",
+                            base=None,
+                        ),
+                    ],
+                )
+                """,
+            ),
+            encoding="utf-8",
+        )
+
+        with ExitStack(configuration_filename.unlink):
+            with dm.YieldStream() as stream:
+                dm.result = SubprocessEx.Stream(f'python "{configuration_filename}" build_exe', stream)
 
 
 # ----------------------------------------------------------------------

{filebackup-0.4.3 → filebackup-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: FileBackup
-Version: 0.4.3
+Version: 0.5.1
 Summary: Tool for creating and restoring file system backups.
 Project-URL: Homepage, https://github.com/davidbrownell/FileBackup
 Project-URL: Documentation, https://github.com/davidbrownell/FileBackup
@@ -28,7 +28,7 @@ Classifier: Topic :: System :: Archiving :: Mirroring
 Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Utilities
 Requires-Python: >=3.10
-Requires-Dist: dbrownell-common>=0.14.6
+Requires-Dist: dbrownell-common>=0.15.0
 Requires-Dist: paramiko>=3.5.1
 Requires-Dist: typer>=0.15.3
 Description-Content-Type: text/markdown

{filebackup-0.4.3 → filebackup-0.5.1}/pyproject.toml

@@ -7,7 +7,7 @@ authors = [
 ]
 requires-python = ">= 3.10"
 dependencies = [
-    "dbrownell-common>=0.14.6",
+    "dbrownell-common>=0.15.0",
     "paramiko>=3.5.1",
     "typer>=0.15.3",
 ]
@@ -23,7 +23,7 @@ keywords = [
 license = "MIT"
 
 classifiers = [
-    "Development Status :: 4 - Beta",  # TODO
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",

{filebackup-0.4.3 → filebackup-0.5.1}/src/FileBackup/CommandLine/OffsiteEntryPoint.py

@@ -241,6 +241,12 @@ def Restore(  # pylint: disable=dangerous-default-value
             help="Working directory to use when decompressing archives; provide this value during a dry run and subsequent execution to only download and extract the backup content once.",
         ),
     ] = None,
+    continue_on_errors: Annotated[
+        bool,
+        typer.Option(
+            "--continue-on-errors", help="Continue restoring files even if some files cannot be restored."
+        ),
+    ] = False,
 ) -> None:
     """Restores content from an offsite data store."""
 
@@ -263,6 +269,7 @@ def Restore(  # pylint: disable=dangerous-default-value
                 quiet=quiet,
                 dry_run=dry_run,
                 overwrite=overwrite,
+                continue_on_errors=continue_on_errors,
             )
 
 

{filebackup-0.4.3 → filebackup-0.5.1}/src/FileBackup/Offsite.py

@@ -30,16 +30,17 @@ import uuid
 from contextlib import contextmanager
 from dataclasses import dataclass
 from enum import auto, Enum
+from io import StringIO
 from pathlib import Path
 from typing import Any, Callable, cast, Iterator, Pattern
 
-from dbrownell_Common.ContextlibEx import ExitStack  # type: ignore[import-untyped]
-from dbrownell_Common import ExecuteTasks  # type: ignore[import-untyped]
-from dbrownell_Common.InflectEx import inflect  # type: ignore[import-untyped]
-from dbrownell_Common import PathEx  # type: ignore[import-untyped]
-from dbrownell_Common.Streams.DoneManager import DoneManager  # type: ignore[import-untyped]
-from dbrownell_Common import SubprocessEx  # type: ignore[import-untyped]
-from dbrownell_Common import TextwrapEx  # type: ignore[import-untyped]
+from dbrownell_Common.ContextlibEx import ExitStack
+from dbrownell_Common import ExecuteTasks
+from dbrownell_Common.InflectEx import inflect
+from dbrownell_Common import PathEx
+from dbrownell_Common.Streams.DoneManager import DoneManager, Flags as DoneManagerFlags
+from dbrownell_Common import SubprocessEx
+from dbrownell_Common import TextwrapEx
 
 from FileBackup.DataStore.FileSystemDataStore import FileSystemDataStore
 from FileBackup.DataStore.Interfaces.BulkStorageDataStore import BulkStorageDataStore
@@ -530,6 +531,7 @@ def Restore(
     quiet: bool,
     dry_run: bool,
     overwrite: bool,
+    continue_on_errors: bool = False,
 ) -> None:
     with Common.YieldDataStore(
         dm,
@@ -555,7 +557,7 @@ def Restore(
             )
             return
 
-        with _YieldTempDirectory("staging content") as staging_directory:
+        with _YieldTempDirectory(working_dir / "staging", "staging content") as staging_directory:
             # ----------------------------------------------------------------------
             @dataclass(frozen=True)
             class Instruction:
@@ -708,90 +710,118 @@ def Restore(
                     # ----------------------------------------------------------------------
                     def ExecuteTask(
                         status: ExecuteTasks.Status,
-                    ) -> Path:
-                        destination_dir = working_dir / directory
-
-                        if destination_dir.is_dir():
-                            # The destination already exists, no need to process it further
-                            return destination_dir
-
-                        with _YieldRestoredArchive(
-                            data_store,  # type: ignore
-                            directory,
-                            lambda bytes_transferred: cast(
-                                None,
-                                status.OnProgress(
-                                    ProcessDirectoryState.Transferring.value + 1,
-                                    bytes_transferred,
-                                ),
-                            ),
-                        ) as (archive_directory, archive_directory_is_temporary):
-                            with _YieldRestoredFiles(
+                    ) -> ExecuteTasks.TransformResultComplete:
+                        # This function will create the following directory structure:
+                        #
+                        #  <working_dir>
+                        #    └── <directory>
+                        #      └── transferred          (temporary)
+                        #      └── decompressed         (temporary)
+                        #      └── final
+
+                        sink = StringIO()
+
+                        with DoneManager.Create(
+                            sink,
+                            "",
+                            line_prefix="",
+                            flags=DoneManagerFlags.Create(verbose=dm.is_verbose, debug=dm.is_debug),
+                        ) as dm_sink:
+                            assert working_dir is not None
+                            this_working_dir = working_dir / directory
+                            final_dir = this_working_dir / "final"
+
+                            if final_dir.is_dir():
+                                # The destination already exists, no need to process it further
+                                return ExecuteTasks.TransformResultComplete(final_dir, 0)
+
+                            with _YieldTransferredArchive(
+                                data_store,  # type: ignore
                                 directory,
-                                archive_directory,
-                                encryption_password,
-                                lambda message: cast(
+                                this_working_dir / "transferred",
+                                lambda bytes_transferred: cast(
                                     None,
                                     status.OnProgress(
-                                        ProcessDirectoryState.Extracting.value + 1,
-                                        message,
+                                        ProcessDirectoryState.Transferring.value + 1,
+                                        bytes_transferred,
                                     ),
                                 ),
-                            ) as (contents_dir, contents_dir_is_temporary):
-                                # Validate the contents
-                                _VerifyRestoredFiles(
+                            ) as (transferred_dir, transferred_dir_is_temporary):
+                                with _YieldDecompressedFiles(
+                                    dm_sink,
+                                    transferred_dir,
+                                    this_working_dir / "decompressed",
                                     directory,
-                                    contents_dir,
+                                    encryption_password,
                                     lambda message: cast(
                                         None,
                                         status.OnProgress(
-                                            ProcessDirectoryState.Verifying.value + 1,
+                                            ProcessDirectoryState.Extracting.value + 1,
                                             message,
                                         ),
                                     ),
-                                )
+                                    continue_on_errors=continue_on_errors,
+                                ) as (decompressed_dir, decompressed_dir_is_temporary):
+                                    # Validate the contents
+                                    _VerifyFiles(
+                                        dm_sink,
+                                        directory,
+                                        decompressed_dir,
+                                        lambda message: cast(
+                                            None,
+                                            status.OnProgress(
+                                                ProcessDirectoryState.Verifying.value + 1,
+                                                message,
+                                            ),
+                                        ),
+                                        continue_on_errors=continue_on_errors,
+                                    )
 
-                                # Move/Copy the content. Note that the code assumes a flat
-                                # directory structure and doesn't do anything to account for
-                                # nested dirs. This assumption matches the current archive
-                                # format.
-                                if archive_directory_is_temporary or contents_dir_is_temporary:
-                                    func = cast(Callable[[Path, Path], None], shutil.move)
-                                else:
-                                    # ----------------------------------------------------------------------
-                                    def CreateSymLink(
-                                        source: Path,
-                                        dest: Path,
-                                    ) -> None:
-                                        dest /= source.name
-                                        os.symlink(source, dest, target_is_directory=source.is_dir())
+                                    # Move/Copy the content. Note that the code assumes a flat
+                                    # directory structure and doesn't do anything to account for
+                                    # nested dirs. This assumption matches the current archive
+                                    # format.
+                                    if transferred_dir_is_temporary or decompressed_dir_is_temporary:
+                                        func = cast(Callable[[Path, Path], None], shutil.move)
+                                    else:
+                                        # ----------------------------------------------------------------------
+                                        def CreateSymLink(
+                                            source: Path,
+                                            dest: Path,
+                                        ) -> None:
+                                            dest /= source.name
+                                            os.symlink(source, dest, target_is_directory=source.is_dir())
 
-                                    # ----------------------------------------------------------------------
+                                        # ----------------------------------------------------------------------
 
-                                    func = CreateSymLink
+                                        func = CreateSymLink
 
-                                temp_dest_dir = destination_dir.parent / (destination_dir.name + "__temp__")
+                                    temp_dest_dir = final_dir.parent / (final_dir.name + "__temp__")
 
-                                shutil.rmtree(temp_dest_dir, ignore_errors=True)
-                                temp_dest_dir.mkdir(parents=True)
+                                    shutil.rmtree(temp_dest_dir, ignore_errors=True)
+                                    temp_dest_dir.mkdir(parents=True)
 
-                                items = [
-                                    item
-                                    for item in contents_dir.iterdir()
-                                    if item.name != INDEX_HASH_FILENAME
-                                ]
+                                    items = [
+                                        item
+                                        for item in decompressed_dir.iterdir()
+                                        if item.name != INDEX_HASH_FILENAME
+                                    ]
 
-                                for item_index, item in enumerate(items):
-                                    status.OnProgress(
-                                        ProcessDirectoryState.Moving.value + 1,
-                                        f"Moving {item_index + 1} of {len(items)}...",
-                                    )
+                                    for item_index, item in enumerate(items):
+                                        status.OnProgress(
+                                            ProcessDirectoryState.Moving.value + 1,
+                                            f"Moving {item_index + 1} of {len(items)}...",
+                                        )
+
+                                        if item.exists():
+                                            func(item, temp_dest_dir)
 
-                                    func(item, temp_dest_dir)
+                                    shutil.move(temp_dest_dir, final_dir)
 
-                                shutil.move(temp_dest_dir, destination_dir)
+                        if dm_sink.result != 0:
+                            status.Log(sink.getvalue())
 
-                        return destination_dir
+                        return ExecuteTasks.TransformResultComplete(final_dir, dm_sink.result)
 
                     # ----------------------------------------------------------------------
 
@@ -799,7 +829,7 @@ def Restore(
 
                 # ----------------------------------------------------------------------
 
-                directory_working_dirs: list[Path | None | Exception] = ExecuteTasks.TransformTasksEx(
+                directory_working_dirs: list[object | None | Exception] = ExecuteTasks.TransformTasksEx(
                     preprocess_dm,
                     "Processing",
                     [ExecuteTasks.TaskData(str(directory), directory) for directory in directories],
@@ -809,7 +839,8 @@ def Restore(
                     refresh_per_second=Common.EXECUTE_TASKS_REFRESH_PER_SECOND,
                 )
 
-                if preprocess_dm.result != 0:
+                # Allow the process to continue if warnings were encountered
+                if preprocess_dm.result < 0:
                     return
 
                 assert all(isinstance(working_dir, Path) for working_dir in directory_working_dirs), (
@@ -960,13 +991,16 @@ def Restore(
             with dm.Nested("\nProcessing instructions...") as all_instructions_dm:
                 all_instructions_dm.WriteLine("")
 
-                temp_directory = PathEx.CreateTempDirectory()
+                temp_directory = working_dir / "instructions"
+                temp_directory.mkdir(parents=True, exist_ok=True)
 
                 with ExitStack(lambda: shutil.rmtree(temp_directory)):
                     commit_actions: list[Callable[[], None]] = []
 
                     # ----------------------------------------------------------------------
                     def WriteImpl(
+                        dm: DoneManager,
+                        action: str,
                         local_filename: Path,
                         content_filename: Path | None,
                     ) -> None:
@@ -985,25 +1019,29 @@ def Restore(
                             commit_actions.append(CommitDir)
                             return
 
+                        content_filename = content_filename.resolve()
                         temp_filename = temp_directory / str(uuid.uuid4())
 
-                        with content_filename.resolve().open("rb") as source:
-                            with temp_filename.open("wb") as dest:
-                                dest.write(source.read())
+                        if not content_filename.is_file():
+                            dm.WriteError(f"The file could not be {action} as its archive data is missing.\n")
+                        else:
+                            with content_filename.open("rb") as source:
+                                with temp_filename.open("wb") as dest:
+                                    dest.write(source.read())
 
-                        # ----------------------------------------------------------------------
-                        def CommitFile() -> None:
-                            if local_filename.is_dir():
-                                shutil.rmtree(local_filename)
-                            elif local_filename.is_file():
-                                local_filename.unlink()
+                            # ----------------------------------------------------------------------
+                            def CommitFile() -> None:
+                                if local_filename.is_dir():
+                                    shutil.rmtree(local_filename)
+                                elif local_filename.is_file():
+                                    local_filename.unlink()
 
-                            local_filename.parent.mkdir(parents=True, exist_ok=True)
-                            shutil.move(temp_filename, local_filename)
+                                local_filename.parent.mkdir(parents=True, exist_ok=True)
+                                shutil.move(temp_filename, local_filename)
 
-                        # ----------------------------------------------------------------------
+                            # ----------------------------------------------------------------------
 
-                        commit_actions.append(CommitFile)
+                            commit_actions.append(CommitFile)
 
                     # ----------------------------------------------------------------------
                     def OnAddInstruction(
@@ -1016,7 +1054,7 @@ def Restore(
                             )
                             return
 
-                        WriteImpl(instruction.local_filename, instruction.file_content_path)
+                        WriteImpl(dm, "restored", instruction.local_filename, instruction.file_content_path)
 
                     # ----------------------------------------------------------------------
                     def OnModifyInstruction(
@@ -1024,7 +1062,7 @@ def Restore(
                         instruction: Instruction,
                     ) -> None:
                         assert instruction.file_content_path is not None
-                        WriteImpl(instruction.local_filename, instruction.file_content_path)
+                        WriteImpl(dm, "modified", instruction.local_filename, instruction.file_content_path)
 
                     # ----------------------------------------------------------------------
                     def OnRemoveInstruction(
@@ -1101,7 +1139,7 @@ def Restore(
                                     ) as execute_dm:
                                         on_instruction_func(execute_dm, instruction)
 
-                                        if execute_dm.result != 0:
+                                        if execute_dm.result != 0 and not continue_on_errors:
                                             break
 
                                 instructions_dm.WriteLine("")
@@ -1287,9 +1325,9 @@ def _CommitFileBasedDataStore(
 # ----------------------------------------------------------------------
 @contextmanager
 def _YieldTempDirectory(
+    temp_directory: Path,
     desc: str,
 ) -> Iterator[Path]:
-    temp_directory = PathEx.CreateTempDirectory()
     should_delete = True
 
     try:
@@ -1299,7 +1337,8 @@ def _YieldTempDirectory(
         raise
     finally:
         if should_delete:
-            shutil.rmtree(temp_directory)
+            if temp_directory.is_dir():
+                shutil.rmtree(temp_directory)
         else:
             sys.stderr.write(
                 f"**** The temporary directory '{temp_directory}' was preserved due to errors while {desc}.\n",
@@ -1308,9 +1347,10 @@ def _YieldTempDirectory(
 
 # ----------------------------------------------------------------------
 @contextmanager
-def _YieldRestoredArchive(
+def _YieldTransferredArchive(
     data_store: FileBasedDataStore,
     directory: str,
+    working_dir: Path,
     status_func: Callable[[str], None],
 ) -> Iterator[
     tuple[
@@ -1318,6 +1358,8 @@ def _YieldRestoredArchive(
         bool,  # is temporary directory
     ],
 ]:
+    """Transfer content from the data store to the local filesystem."""
+
     if data_store.is_local_filesystem:
         working_dir = data_store.GetWorkingDir() / directory
         assert working_dir.is_dir(), working_dir
@@ -1327,7 +1369,7 @@ def _YieldRestoredArchive(
 
     status_func("Calculating files to transfer...")
 
-    with _YieldTempDirectory("transferring archive files") as temp_directory:
+    with _YieldTempDirectory(working_dir, "transferring archive files") as working_dir:
         # Map the remote filenames to local filenames
         filename_map: dict[Path, Path] = {}
 
@@ -1339,7 +1381,7 @@ def _YieldRestoredArchive(
             relative_root = root.relative_to(data_store_dir)
 
             for filename in filenames:
-                filename_map[root / filename] = temp_directory / relative_root / filename
+                filename_map[root / filename] = working_dir / relative_root / filename
 
         if not filename_map:
             raise Exception(f"The directory '{directory}' does not contain any files.")
@@ -1359,24 +1401,30 @@ def _YieldRestoredArchive(
                 ),
             )
 
-        yield temp_directory, True
+        yield working_dir, True
 
 
 # ----------------------------------------------------------------------
 @contextmanager
-def _YieldRestoredFiles(
+def _YieldDecompressedFiles(
+    dm: DoneManager,
+    transferred_dir: Path,
+    decompressed_dir: Path,
     directory_name: str,
-    archive_dir: Path,
     encryption_password: str | None,
     status_func: Callable[[str], None],
+    *,
+    continue_on_errors: bool,
 ) -> Iterator[
     tuple[
         Path,
         bool,  # is temporary directory
     ],
 ]:
-    if (archive_dir / INDEX_FILENAME).is_file():
-        yield archive_dir, False
+    """Decompress the archive if necessary"""
+
+    if (transferred_dir / INDEX_FILENAME).is_file():
+        yield transferred_dir, False
         return
 
     # By default, 7zip will prompt for a password with archives that were created
@@ -1391,18 +1439,17 @@ def _YieldRestoredFiles(
     #
     password = encryption_password or str(uuid.uuid4())
 
-    # Validate
-    status_func("Validating archive...")
-
-    archive_filename = archive_dir / (ARCHIVE_FILENAME + ".001")
+    archive_filename = transferred_dir / (ARCHIVE_FILENAME + ".001")
 
     if not archive_filename.is_file():
         raise Exception(f"The archive file '{archive_filename.name}' was not found.")
 
-    result = SubprocessEx.Run(f'{_GetZipBinary()} t "{archive_filename}" "-p{password}"')
-    if result.returncode != 0:
-        raise Exception(
-            textwrap.dedent(
+    # Validate
+    status_func("Validating archive...")
+    with dm.Nested("Validating archive...") as validate_dm:
+        result = SubprocessEx.Run(f'{_GetZipBinary()} t "{archive_filename}" "-p{password}"')
+        if result.returncode != 0:
+            message = textwrap.dedent(
                 """\
                 Archive validation failed for the directory '{}' ({}).
 
@@ -1418,27 +1465,32 @@ def _YieldRestoredFiles(
                     4,
                     skip_first_line=True,
                 ),
-            ),
-        )
+            )
 
-    # Extract
-    status_func("Extracting archive...")
+            if continue_on_errors:
+                validate_dm.WriteWarning(message)
+            else:
+                raise Exception(message)
 
-    with _YieldTempDirectory("extracting the archive") as temp_directory:
-        result = SubprocessEx.Run(
-            f'{_GetZipBinary()} x "{archive_filename}" "-p{password}"',
-            cwd=temp_directory,
-        )
+    # Extract
+    with _YieldTempDirectory(decompressed_dir, "extracting the archive") as decompressed_dir:
+        status_func("Extracting archive...")
+        with dm.Nested("Extracting archive...") as extract_dm:
+            decompressed_dir.mkdir(parents=True, exist_ok=True)
+
+            result = SubprocessEx.Run(
+                f'{_GetZipBinary()} x "{archive_filename}" "-p{password}"',
+                cwd=decompressed_dir,
+            )
 
-        if result.returncode != 0:
-            raise Exception(
-                textwrap.dedent(
+            if result.returncode != 0:
+                message = textwrap.dedent(
                     """\
-                    Archive extraction failed for the directory '{}' ({}).
+                        Archive extraction failed for the directory '{}' ({}).
 
-                        {}
+                            {}
 
-                    """,
+                        """,
                 ).format(
                     directory_name,
                     result.returncode,
@@ -1447,67 +1499,74 @@ def _YieldRestoredFiles(
                         4,
                         skip_first_line=True,
                     ),
-                ),
-            )
+                )
 
-        yield temp_directory, True
+                if continue_on_errors:
+                    extract_dm.WriteWarning(message)
+                else:
+                    raise Exception(message)
+
+        yield decompressed_dir, True
 
 
 # ----------------------------------------------------------------------
-def _VerifyRestoredFiles(
+def _VerifyFiles(
+    dm: DoneManager,
     directory_name: str,
     contents_dir: Path,
     status_func: Callable[[str], None],
+    *,
+    continue_on_errors: bool,
 ) -> None:
     # Ensure that the index is present
     for index_filename in [INDEX_FILENAME, INDEX_HASH_FILENAME]:
         if not (contents_dir / index_filename).is_file():
             raise Exception(f"The index file '{index_filename}' does not exist.")
 
-    # Ensure that the content is valid
-    all_filenames: list[Path] = []
+    with dm.Nested("Verifying files...") as verify_dm:
+        # Ensure that the content is valid
+        all_filenames: list[Path] = []
 
-    for root_str, _, filenames in os.walk(contents_dir):
-        root = Path(root_str)
+        for root_str, _, filenames in os.walk(contents_dir):
+            root = Path(root_str)
 
-        all_filenames += [root / filename for filename in filenames if filename != INDEX_HASH_FILENAME]
+            all_filenames += [root / filename for filename in filenames if filename != INDEX_HASH_FILENAME]
 
-    data_store = FileSystemDataStore()
+        data_store = FileSystemDataStore()
 
-    errors: list[str] = []
+        errors: list[str] = []
 
-    for filename_index, filename in enumerate(all_filenames):
-        if filename.name == INDEX_FILENAME:
-            expected_hash_value = (contents_dir / INDEX_HASH_FILENAME).read_text().strip()
-        else:
-            expected_hash_value = filename.name
+        for filename_index, filename in enumerate(all_filenames):
+            if filename.name == INDEX_FILENAME:
+                expected_hash_value = (contents_dir / INDEX_HASH_FILENAME).read_text().strip()
+            else:
+                expected_hash_value = filename.name
 
-        file_size = filename.stat().st_size or 1
+            file_size = filename.stat().st_size or 1
 
-        status_template = f"Validating file {filename_index + 1} of {len(all_filenames)} [{PathEx.GetSizeDisplay(file_size)}] {{:.02f}}%..."
+            status_template = f"Validating file {filename_index + 1} of {len(all_filenames)} [{PathEx.GetSizeDisplay(file_size)}] {{:.02f}}%..."
 
-        actual_hash_value = Common.CalculateHash(
-            data_store,
-            filename,
-            lambda bytes_transferred: status_func(
-                status_template.format((bytes_transferred / file_size) * 100)
-            ),
-        )
-
-        if actual_hash_value != expected_hash_value:
-            errors.append(
-                textwrap.dedent(
-                    f"""\
-                    Filename:  {filename.relative_to(contents_dir)}
-                    Expected:  {expected_hash_value}
-                    Actual:    {actual_hash_value}
-                    """,
+            actual_hash_value = Common.CalculateHash(
+                data_store,
+                filename,
+                lambda bytes_transferred: status_func(
+                    status_template.format((bytes_transferred / file_size) * 100)
                 ),
             )
 
-    if errors:
-        raise Exception(
-            textwrap.dedent(
+            if actual_hash_value != expected_hash_value:
+                errors.append(
+                    textwrap.dedent(
+                        f"""\
+                        Filename:  {filename.relative_to(contents_dir)}
+                        Expected:  {expected_hash_value}
+                        Actual:    {actual_hash_value}
+                        """,
+                    ),
+                )
+
+        if errors:
+            message = textwrap.dedent(
                 """\
                 Corrupt files were encountered in the directory '{}'.
 
@@ -1521,5 +1580,9 @@ def _VerifyRestoredFiles(
                     4,
                     skip_first_line=True,
                 ),
-            ),
-        )
+            )
+
+            if continue_on_errors:
+                verify_dm.WriteWarning(message)
+            else:
+                raise Exception(message)

{filebackup-0.4.3 → filebackup-0.5.1}/src/FileBackup/__init__.py

@@ -9,4 +9,4 @@
 # Note that this value will be overwritten by calls to `python ../../Build.py update_version` based
 # on changes observed in the git repository. The default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system as part of a commit.
-__version__ = "0.4.3"
+__version__ = "0.5.1"

{filebackup-0.4.3 → filebackup-0.5.1}/tests/CommandLine/EntryPoint_UnitTest.py

@@ -447,6 +447,7 @@ class TestOffsite:
                 kwargs = restore.call_args_list[0].kwargs
 
                 assert kwargs == {
+                    "continue_on_errors": False,
                     "ssd": False,
                     "quiet": False,
                     "dry_run": False,
@@ -483,6 +484,7 @@ class TestOffsite:
                     "--overwrite",
                     "--ssd",
                     "--quiet",
+                    "--continue-on-errors",
                 ]
 
                 result = CliRunner().invoke(app, args)
@@ -501,6 +503,7 @@ class TestOffsite:
                 kwargs = restore.call_args_list[0].kwargs
 
                 assert kwargs == {
+                    "continue_on_errors": True,
                     "ssd": True,
                     "quiet": True,
                     "dry_run": True,

{filebackup-0.4.3 → filebackup-0.5.1}/uv.lock

@@ -387,7 +387,7 @@ wheels = [
 
 [[package]]
 name = "dbrownell-common"
-version = "0.14.6"
+version = "0.15.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "inflect" },
@@ -395,8 +395,9 @@ dependencies = [
     { name = "typer" },
     { name = "typer-config" },
 ]
+sdist = { url = "https://files.pythonhosted.org/packages/75/83/785a3d7e8622f1cb805625f9cca9024c1d6985afc6626efa0946b00d2f27/dbrownell_common-0.15.0.tar.gz", hash = "sha256:6a7e2caa89e2eadef473901f35f5eab2963deb74b335c9ed8f3e05c2ba9f184f", size = 97508, upload-time = "2025-07-03T17:27:55.32Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/a5/8c/f3d2c3a6712aaf54be2f9ed37fed5515d302b9cbce0ecd589f6253efab31/dbrownell_common-0.14.6-py3-none-any.whl", hash = "sha256:6799b088c4007ab1b4cec169138aab220d86da198e383dc1a6e5c9119f3f2b35", size = 41485, upload-time = "2025-04-03T21:13:34.193Z" },
+    { url = "https://files.pythonhosted.org/packages/37/dc/b1663f95bf3582d0fd07498700f4708e71ef9c5e3bc7441d90353884908b/dbrownell_common-0.15.0-py3-none-any.whl", hash = "sha256:554238d000dfc8acc78fa6d9df778706bb4f84f5b70f35f75cf0ccdd8f0f09de", size = 43206, upload-time = "2025-07-03T17:27:54.115Z" },
 ]
 
 [[package]]
@@ -464,7 +465,7 @@ dev = [
 
 [package.metadata]
 requires-dist = [
-    { name = "dbrownell-common", specifier = ">=0.14.6" },
+    { name = "dbrownell-common", specifier = ">=0.15.0" },
     { name = "paramiko", specifier = ">=3.5.1" },
     { name = "typer", specifier = ">=0.15.3" },
 ]
@@ -524,11 +525,15 @@ wheels = [
 
 [[package]]
 name = "inflect"
-version = "4.1.1"
+version = "7.5.0"
 source = { registry = "https://pypi.org/simple" }
-sdist = { url = "https://files.pythonhosted.org/packages/c6/9f/163fbcda011f284d13261f11aa1e14daf28f68729e475c79f7d223c01a36/inflect-4.1.1.tar.gz", hash = "sha256:0527947406025991506b252620da69a5efdc72bf61aa6b4b4976e3bd71c19660", size = 71278, upload-time = "2020-11-15T01:14:15.736Z" }
+dependencies = [
+    { name = "more-itertools" },
+    { name = "typeguard" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/78/c6/943357d44a21fd995723d07ccaddd78023eace03c1846049a2645d4324a3/inflect-7.5.0.tar.gz", hash = "sha256:faf19801c3742ed5a05a8ce388e0d8fe1a07f8d095c82201eb904f5d27ad571f", size = 73751, upload-time = "2024-12-28T17:11:18.897Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/4e/9d/81e86c99531ec3dda860f04656e48304cb9dc7d2b9e0ac3e7a806ae5747f/inflect-4.1.1-py3-none-any.whl", hash = "sha256:b0d13bbb6e12313b8fc4a171c86c4f4544cf09a8498e118d25473558200bd171", size = 31507, upload-time = "2020-11-15T01:14:14.173Z" },
+    { url = "https://files.pythonhosted.org/packages/8a/eb/427ed2b20a38a4ee29f24dbe4ae2dafab198674fe9a85e3d6adf9e5f5f41/inflect-7.5.0-py3-none-any.whl", hash = "sha256:2aea70e5e70c35d8350b8097396ec155ffd68def678c7ff97f51aa69c1d92344", size = 35197, upload-time = "2024-12-28T17:11:15.931Z" },
 ]
 
 [[package]]
@@ -615,6 +620,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979, upload-time = "2022-08-14T12:40:09.779Z" },
 ]
 
+[[package]]
+name = "more-itertools"
+version = "10.7.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/ce/a0/834b0cebabbfc7e311f30b46c8188790a37f89fc8d756660346fe5abfd09/more_itertools-10.7.0.tar.gz", hash = "sha256:9fddd5403be01a94b204faadcff459ec3568cf110265d3c54323e1e866ad29d3", size = 127671, upload-time = "2025-04-22T14:17:41.838Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/2b/9f/7ba6f94fc1e9ac3d2b853fdff3035fb2fa5afbed898c4a72b8a020610594/more_itertools-10.7.0-py3-none-any.whl", hash = "sha256:d43980384673cb07d2f7d2d918c616b30c659c089ee23953f601d6609c67510e", size = 65278, upload-time = "2025-04-22T14:17:40.49Z" },
+]
+
 [[package]]
 name = "nodeenv"
 version = "1.9.1"
@@ -823,16 +837,16 @@ wheels = [
 
 [[package]]
 name = "rich"
-version = "13.9.4"
+version = "14.0.0"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
     { name = "markdown-it-py" },
     { name = "pygments" },
     { name = "typing-extensions", marker = "python_full_version < '3.11'" },
 ]
-sdist = { url = "https://files.pythonhosted.org/packages/ab/3a/0316b28d0761c6734d6bc14e770d85506c986c85ffb239e688eeaab2c2bc/rich-13.9.4.tar.gz", hash = "sha256:439594978a49a09530cff7ebc4b5c7103ef57baf48d5ea3184f21d9a2befa098", size = 223149, upload-time = "2024-11-01T16:43:57.873Z" }
+sdist = { url = "https://files.pythonhosted.org/packages/a1/53/830aa4c3066a8ab0ae9a9955976fb770fe9c6102117c8ec4ab3ea62d89e8/rich-14.0.0.tar.gz", hash = "sha256:82f1bc23a6a21ebca4ae0c45af9bdbc492ed20231dcb63f297d6d1021a9d5725", size = 224078, upload-time = "2025-03-30T14:15:14.23Z" }
 wheels = [
-    { url = "https://files.pythonhosted.org/packages/19/71/39c7c0d87f8d4e6c020a393182060eaefeeae6c01dab6a84ec346f2567df/rich-13.9.4-py3-none-any.whl", hash = "sha256:6049d5e6ec054bf2779ab3358186963bac2ea89175919d699e378b99738c2a90", size = 242424, upload-time = "2024-11-01T16:43:55.817Z" },
+    { url = "https://files.pythonhosted.org/packages/0d/9b/63f4c7ebc259242c89b3acafdb37b41d1185c07ff0011164674e9076b491/rich-14.0.0-py3-none-any.whl", hash = "sha256:1c9491e1951aac09caffd42f448ee3d04e58923ffe14993f6e83068dc395d7e0", size = 243229, upload-time = "2025-03-30T14:15:12.283Z" },
 ]
 
 [[package]]
@@ -1052,6 +1066,18 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/6e/c2/61d3e0f47e2b74ef40a68b9e6ad5984f6241a942f7cd3bbfbdbd03861ea9/tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc", size = 14257, upload-time = "2024-11-27T22:38:35.385Z" },
 ]
 
+[[package]]
+name = "typeguard"
+version = "4.4.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "typing-extensions" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/70/60/8cd6a3d78d00ceeb2193c02b7ed08f063d5341ccdfb24df88e61f383048e/typeguard-4.4.2.tar.gz", hash = "sha256:a6f1065813e32ef365bc3b3f503af8a96f9dd4e0033a02c28c4a4983de8c6c49", size = 75746, upload-time = "2025-02-16T16:28:26.205Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/cf/4b/9a77dc721aa0b7f74440a42e4ef6f9a4fae7324e17f64f88b96f4c25cc05/typeguard-4.4.2-py3-none-any.whl", hash = "sha256:77a78f11f09777aeae7fa08585f33b5f4ef0e7335af40005b0c422ed398ff48c", size = 35801, upload-time = "2025-02-16T16:28:24.793Z" },
+]
+
 [[package]]
 name = "typer"
 version = "0.15.3"