PyHardLinkBackup 1.0.0__tar.gz → 1.0.0rc0__tar.gz

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyHardLinkBackup
-Version: 1.0.0
+Version: 1.0.0rc0
 Summary: HardLink/Deduplication Backups with Python
 Project-URL: Documentation, https://github.com/jedie/PyHardLinkBackup
 Project-URL: Source, https://github.com/jedie/PyHardLinkBackup
@@ -23,71 +23,7 @@ Description-Content-Type: text/markdown
 
 HardLink/Deduplication Backups with Python
 
-**WIP:** v1.0.0 is a complete rewrite of PyHardLinkBackup.
-
-## installation
-
-You can use [pipx](https://pipx.pypa.io/stable/installation/) to install and use PyHardLinkBackup, e.g.:
-
-```bash
-sudo apt install pipx
-
-pipx install PyHardLinkBackup
-```
-
-After this you can call the CLI via `phlb` command.
-The main command is `phlb backup <source> <destination>`:
-
-[comment]: <> (✂✂✂ auto generated backup help start ✂✂✂)
-```
-usage: phlb backup [-h] source destination [--excludes [STR [STR ...]]] [-v]
-
-Backup the source directory to the destination directory using hard links for deduplication.
-
-╭─ positional arguments ───────────────────────────────────────────────────────────────────────────────────────────────╮
-│ source       Source directory to back up. (required)                                                                 │
-│ destination  Destination directory for the backup. (required)                                                        │
-╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ -h, --help   show this help message and exit                                                                         │
-│ --excludes [STR [STR ...]]                                                                                           │
-│              List of directory or file names to exclude from backup. (default: __pycache__ .cache .temp .tmp .tox    │
-│              .nox)                                                                                                   │
-│ -v, --verbosity                                                                                                      │
-│              Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable)                                                 │
-╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-```
-[comment]: <> (✂✂✂ auto generated backup help end ✂✂✂)
-
-
-
-complete help for main CLI app:
-
-[comment]: <> (✂✂✂ auto generated main help start ✂✂✂)
-```
-usage: phlb [-h] {backup,version}
-
-
-
-╭─ options ─────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ -h, --help   show this help message and exit                                                              │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-╭─ subcommands ─────────────────────────────────────────────────────────────────────────────────────────────╮
-│ (required)                                                                                                │
-│   • backup   Backup the source directory to the destination directory using hard links for deduplication. │
-│   • version  Print version and exit                                                                       │
-╰───────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-```
-[comment]: <> (✂✂✂ auto generated main help end ✂✂✂)
-
-
-### update
-
-If you use pipx, just call:
-```bash
-pipx upgrade PyHardLinkBackup
-```
-see: https://pipx.pypa.io/stable/docs/#pipx-upgrade
+**WIP:** v1.0.0 is a complete rewrite of PyHardLinkBackup. The new version is not usable, yet!
 
 
 ## concept
@@ -147,18 +83,70 @@ e.g.: hash like `abcdef123...` stored in: `{destination}/.phlb/hash-lookup/ab/cd
 The file contains only the relative path to the first hardlink of this file content.
 
 
-## start development
+## CLI - backup command
+
+The main command is `backup`:
+
+[comment]: <> (✂✂✂ auto generated backup help start ✂✂✂)
+```
+usage: ./cli.py backup [-h] source destination [--excludes STR|{[STR [STR ...]]}] [-v]
+
+Backup the source directory to the destination directory using hard links for deduplication.
 
-```bash
-~$ git clone https://github.com/jedie/PyHardLinkBackup.git
-~$ cd PyHardLinkBackup
-~/PyHardLinkBackup$ ./cli.py --help
-~/PyHardLinkBackup$ ./dev-cli.py --help
+╭─ positional arguments ───────────────────────────────────────────────────────────────────────────────────────────────╮
+│ source       Source directory to back up. (required)                                                                 │
+│ destination  Destination directory for the backup. (required)                                                        │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ -h, --help   show this help message and exit                                                                         │
+│ --excludes STR|{[STR [STR ...]]}                                                                                     │
+│              List of directory or file names to exclude from backup. (default: __pycache__ .cache .temp .tmp .tox    │
+│              .nox)                                                                                                   │
+│ -v, --verbosity                                                                                                      │
+│              Verbosity level; e.g.: -v, -vv, -vvv, etc. (repeatable)                                                 │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
+[comment]: <> (✂✂✂ auto generated backup help end ✂✂✂)
+
+
+## CLI - main app help
+
+[comment]: <> (✂✂✂ auto generated main help start ✂✂✂)
+```
+usage: ./cli.py [-h] {backup,benchmark-hashes,version}
+
+
+
+╭─ options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ -h, --help            show this help message and exit                                                                │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ subcommands ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ (required)                                                                                                           │
+│   • backup            Backup the source directory to the destination directory using hard links for deduplication.   │
+│   • benchmark-hashes  Benchmark different file hashing algorithms on the given path Example output:                  │
+│                                                                                                                      │
+│                       Total files hashed: 220, total size: 1187.7 MiB                                                │
+│                                                                                                                      │
+│                       Results: Total file content read time: 1.7817s                                                 │
+│                                                                                                                      │
+│                       sha1       | Total: 0.6827s | 0.4x hash/read sha256     | Total: 0.7189s | 0.4x hash/read      │
+│                       sha224     | Total: 0.7375s | 0.4x hash/read sha384     | Total: 1.6552s | 0.9x hash/read      │
+│                       blake2b    | Total: 1.6708s | 0.9x hash/read md5        | Total: 1.6870s | 0.9x hash/read      │
+│                       sha512     | Total: 1.7269s | 1.0x hash/read shake_128  | Total: 1.9834s | 1.1x hash/read      │
+│                       sha3_224   | Total: 2.3006s | 1.3x hash/read sha3_256   | Total: 2.3856s | 1.3x hash/read      │
+│                       shake_256  | Total: 2.4375s | 1.4x hash/read blake2s    | Total: 2.5219s | 1.4x hash/read      │
+│                       sha3_384   | Total: 3.2596s | 1.8x hash/read sha3_512   | Total: 4.5328s | 2.5x hash/read      │
+│   • version           Print version and exit                                                                         │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+[comment]: <> (✂✂✂ auto generated main help end ✂✂✂)
+
+
+## dev CLI
 
 [comment]: <> (✂✂✂ auto generated dev help start ✂✂✂)
 ```
-usage: ./dev-cli.py [-h] {benchmark-hashes,coverage,install,lint,mypy,nox,pip-audit,publish,shell-completion,test,update,update-readme-history,update-test-snapshot-files,version}
+usage: ./dev-cli.py [-h] {coverage,install,lint,mypy,nox,pip-audit,publish,shell-completion,test,update,update-readme-history,update-test-snapshot-files,version}
 
 
 
@@ -167,8 +155,6 @@ usage: ./dev-cli.py [-h] {benchmark-hashes,coverage,install,lint,mypy,nox,pip-au
 ╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ subcommands ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
 │ (required)                                                                                                           │
-│   • benchmark-hashes                                                                                                 │
-│                Benchmark different file hashing algorithms on the given path.                                        │
 │   • coverage   Run tests and show coverage report.                                                                   │
 │   • install    Install requirements and 'PyHardLinkBackup' via pip as editable.                                      │
 │   • lint       Check/fix code style by run: "ruff check --fix"                                                       │
@@ -204,14 +190,7 @@ v1 is a complete rewrite of PyHardLinkBackup.
 
 [comment]: <> (✂✂✂ auto generated history start ✂✂✂)
 
-* [v1.0.0](https://github.com/jedie/PyHardLinkBackup/compare/v0.13.0...v1.0.0)
-  * 2026-01-13 - Change "./cli.py" to "phlb" (because it's the name installed via pipx)
-  * 2026-01-13 - Update README
-  * 2026-01-13 - Fix benchmark moved to dev CLI ;)
-  * 2026-01-13 - Remove tyro warning
-  * 2026-01-13 - Move "benchmark_hashes" from app to dev cli (It's more for testing)
-  * 2026-01-13 - Rename [project.scripts] hooks
-  * 2026-01-13 - Add DocWrite, handle broken symlinks, keep file meta, handle missing hardlink sources
+* [v1.0.0rc0](https://github.com/jedie/PyHardLinkBackup/compare/v0.13.0...v1.0.0rc0)
   * 2026-01-12 - First working iteration with rich progess bar
   * 2026-01-08 - Rewrite everything
 * [v0.13.0](https://github.com/jedie/PyHardLinkBackup/compare/v0.12.3...v0.13.0)

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/__init__.py

@@ -1,7 +1,8 @@
-"""DocWrite: README.md # PyHardLinkBackup
+"""
+    PyHardLinkBackup
     HardLink/Deduplication Backups with Python
 """
 
 # See https://packaging.python.org/en/latest/specifications/version-specifiers/
-__version__ = '1.0.0'
+__version__ = '1.0.0rc0'
 __author__ = 'Jens Diemer <PyHardLinkBackup@jensdiemer.de>'

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/backup.py

@@ -84,22 +84,7 @@ def backup_tree(*, src_root: Path, backup_root: Path, excludes: set[str]) -> Bac
         next_update = 0
         for entry in iter_scandir_files(src_root, excludes=excludes):
             backup_count += 1
-            src_path = Path(entry.path)
-
-            dst_path = backup_dir / src_path.relative_to(src_root)
-            dst_dir_path = dst_path.parent
-            if not dst_dir_path.exists():
-                dst_dir_path.mkdir(parents=True, exist_ok=False)
-
-            try:
-                size = entry.stat().st_size
-            except FileNotFoundError:
-                # e.g.: Handle broken symlink
-                target = os.readlink(src_path)
-                dst_path.symlink_to(target)
-                symlink_files += 1
-                continue
-
+            size = entry.stat().st_size
             backup_size += size
 
             now = time.monotonic()
@@ -107,8 +92,14 @@ def backup_tree(*, src_root: Path, backup_root: Path, excludes: set[str]) -> Bac
                 progress.update(backup_count=backup_count, backup_size=backup_size)
                 next_update = now + 0.5
 
+            src_path = Path(entry.path)
+            dst_path = backup_dir / src_path.relative_to(src_root)
+
+            dst_path.parent.mkdir(parents=True, exist_ok=True)
+
             if entry.is_symlink():
                 logger.debug('Copy symlink: %s to %s', src_path, dst_path)
+                # Copy symlinks as-is
                 target = os.readlink(src_path)
                 dst_path.symlink_to(target)
                 symlink_files += 1
@@ -161,12 +152,10 @@ def backup_tree(*, src_root: Path, backup_root: Path, excludes: set[str]) -> Bac
                         hardlinked_size += size
                     else:
                         logger.info('Copy unique file: %s to %s', src_path, dst_path)
+                        shutil.copy2(src_path, dst_path)
                         hash_db[file_hash] = dst_path
                         copied_files += 1
                         copied_size += size
-
-                # Keep original file metadata (permission bits, time stamps, and flags)
-                shutil.copy2(src_path, dst_path)
             else:
                 # A file with this size not backuped before -> Can't be duplicate -> copy and hash
                 file_hash = copy_and_hash(src_path, dst_path)
@@ -175,7 +164,6 @@ def backup_tree(*, src_root: Path, backup_root: Path, excludes: set[str]) -> Bac
                 copied_files += 1
                 copied_size += size
 
-        # Finalize progress indicator values:
         progress.update(backup_count=backup_count, backup_size=backup_size)
 
     print(f'\nBackup complete: {backup_dir} (total size {human_filesize(backup_size)})\n')

{pyhardlinkbackup-1.0.0/PyHardLinkBackup/cli_dev → pyhardlinkbackup-1.0.0rc0/PyHardLinkBackup/cli_app}/benchmark.py

@@ -9,7 +9,7 @@ from cli_base.cli_tools.verbosity import setup_logging
 from cli_base.tyro_commands import TyroVerbosityArgType
 from rich import print  # noqa
 
-from PyHardLinkBackup.cli_dev import app
+from PyHardLinkBackup.cli_app import app
 from PyHardLinkBackup.utilities.filesystem import iter_scandir_files
 
 
@@ -26,29 +26,30 @@ def benchmark_hashes(
     verbosity: TyroVerbosityArgType = 1,
 ) -> None:
     """
-    Benchmark different file hashing algorithms on the given path.
+    Benchmark different file hashing algorithms on the given path
+
+    Example output:
+
+    Total files hashed: 220, total size: 1187.7 MiB
+
+    Results:
+    Total file content read time: 1.7817s
+
+    sha1       | Total: 0.6827s | 0.4x hash/read
+    sha256     | Total: 0.7189s | 0.4x hash/read
+    sha224     | Total: 0.7375s | 0.4x hash/read
+    sha384     | Total: 1.6552s | 0.9x hash/read
+    blake2b    | Total: 1.6708s | 0.9x hash/read
+    md5        | Total: 1.6870s | 0.9x hash/read
+    sha512     | Total: 1.7269s | 1.0x hash/read
+    shake_128  | Total: 1.9834s | 1.1x hash/read
+    sha3_224   | Total: 2.3006s | 1.3x hash/read
+    sha3_256   | Total: 2.3856s | 1.3x hash/read
+    shake_256  | Total: 2.4375s | 1.4x hash/read
+    blake2s    | Total: 2.5219s | 1.4x hash/read
+    sha3_384   | Total: 3.2596s | 1.8x hash/read
+    sha3_512   | Total: 4.5328s | 2.5x hash/read
     """
-    # Example output:
-    #
-    # Total files hashed: 220, total size: 1187.7 MiB
-    #
-    # Results:
-    # Total file content read time: 1.7817s
-    #
-    # sha1       | Total: 0.6827s | 0.4x hash/read
-    # sha256     | Total: 0.7189s | 0.4x hash/read
-    # sha224     | Total: 0.7375s | 0.4x hash/read
-    # sha384     | Total: 1.6552s | 0.9x hash/read
-    # blake2b    | Total: 1.6708s | 0.9x hash/read
-    # md5        | Total: 1.6870s | 0.9x hash/read
-    # sha512     | Total: 1.7269s | 1.0x hash/read
-    # shake_128  | Total: 1.9834s | 1.1x hash/read
-    # sha3_224   | Total: 2.3006s | 1.3x hash/read
-    # sha3_256   | Total: 2.3856s | 1.3x hash/read
-    # shake_256  | Total: 2.4375s | 1.4x hash/read
-    # blake2s    | Total: 2.5219s | 1.4x hash/read
-    # sha3_384   | Total: 3.2596s | 1.8x hash/read
-    # sha3_512   | Total: 4.5328s | 2.5x hash/read
     setup_logging(verbosity=verbosity)
     assert_is_dir(base_path)
     print(f'Benchmarking file hashes under: {base_path}')

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/cli_app/phlb.py

@@ -32,7 +32,7 @@ def backup(
     ],
     /,
     excludes: Annotated[
-        tuple,
+        tuple[str],
         tyro.conf.arg(
             help='List of directory or file names to exclude from backup.',
         ),

pyhardlinkbackup-1.0.0rc0/PyHardLinkBackup/tests/test_backup.py

@@ -0,0 +1,188 @@
+import os
+import tempfile
+import textwrap
+import zlib
+from pathlib import Path
+from unittest import TestCase
+
+from bx_py_utils.test_utils.assertion import assert_text_equal
+from freezegun import freeze_time
+
+from PyHardLinkBackup.backup import BackupResult, backup_tree
+from PyHardLinkBackup.constants import CHUNK_SIZE
+from PyHardLinkBackup.utilities.file_size_database import FileSizeDatabase
+from PyHardLinkBackup.utilities.filesystem import iter_scandir_files
+
+
+def fs_tree_overview(root: Path) -> str:
+    lines = []
+    for entry in iter_scandir_files(root, excludes=set()):
+        file_path = Path(entry.path)
+        crc32 = zlib.crc32(file_path.read_bytes())
+        rel_path = file_path.relative_to(root)
+
+        nlink = entry.stat().st_nlink
+        if entry.is_symlink():
+            file_type = 'symlink'
+        elif nlink > 1:
+            file_type = 'hardlink'
+        else:
+            file_type = 'file'
+
+        lines.append(
+            f'{str(rel_path):<20} | {file_type:<8} | {nlink=} | {entry.stat().st_size:>8} Bytes | crc32: {crc32:08x}'
+        )
+    return '\n'.join(sorted(lines))
+
+
+def assert_fs_tree_overview(root: Path, expected_overview: str):
+    expected_overview = textwrap.dedent(expected_overview).strip()
+    actual_overview = fs_tree_overview(root)
+    assert_text_equal(
+        actual_overview,
+        expected_overview,
+        msg=f'Filesystem tree overview does not match expected overview.\n\n{actual_overview}\n\n',
+    )
+
+
+class BackupTreeTestCase(TestCase):
+    def test_happy_path(self):
+        with tempfile.TemporaryDirectory() as temp_dir:
+            temp_path = Path(temp_dir)
+
+            src_root = temp_path / 'source'
+            backup_root = temp_path / 'backup'
+
+            src_root.mkdir()
+            backup_root.mkdir()
+
+            file1_path = src_root / 'file2.txt'
+            file1_path.write_text('This is file 1')
+
+            (src_root / 'symlink2file1').symlink_to(file1_path)
+            os.link(file1_path, src_root / 'hardlink2file1')
+
+            sub_dir = src_root / 'subdir'
+            sub_dir.mkdir()
+            (sub_dir / 'file.txt').write_text('This is file in subdir')
+
+            # Only files bigger than MIN_SIZE will be considered for hardlinking:
+            size_db_min_file = src_root / 'min_sized_file1.bin'
+            size_db_min_file.write_bytes(b'X' * FileSizeDatabase.MIN_SIZE)
+
+            # Same content and big enough to be considered for hardlinking:
+            size_db_min_file = src_root / 'min_sized_file2.bin'
+            size_db_min_file.write_bytes(b'X' * FileSizeDatabase.MIN_SIZE)
+
+            # Larger then CHUNK_SIZE file will be handled differently:
+            large_file = src_root / 'large_file.bin'
+            large_file.write_bytes(b'Y' * (CHUNK_SIZE + 1))
+
+            excluded_dir = src_root / '.cache'
+            excluded_dir.mkdir()
+            (excluded_dir / 'tempfile.tmp').write_text('Temporary file that should be excluded')
+
+            #######################################################################################
+            # Create first backup:
+
+            with freeze_time('2026-01-01T12:34:56Z', auto_tick_seconds=0):
+                result = backup_tree(
+                    src_root=src_root,
+                    backup_root=backup_root,
+                    excludes={'.cache'},
+                )
+            backup_dir = result.backup_dir
+            self.assertEqual(
+                str(Path(backup_dir).relative_to(temp_path)),
+                'backup/source/20260101_123456',
+            )
+            self.assertEqual(
+                result,
+                BackupResult(
+                    backup_dir=backup_dir,
+                    backup_count=7,
+                    backup_size=67110929,
+                    symlink_files=1,
+                    hardlinked_files=1,
+                    hardlinked_size=1000,
+                    copied_files=5,
+                    copied_size=67109915,
+                    copied_small_files=3,
+                    copied_small_size=50,
+                ),
+            )
+
+            # The sources:
+            assert_fs_tree_overview(
+                root=src_root,
+                expected_overview="""
+                    .cache/tempfile.tmp  | file     | nlink=1 |       38 Bytes | crc32: 41d7a2c9
+                    file2.txt            | hardlink | nlink=2 |       14 Bytes | crc32: 8a11514a
+                    hardlink2file1       | hardlink | nlink=2 |       14 Bytes | crc32: 8a11514a
+                    large_file.bin       | file     | nlink=1 | 67108865 Bytes | crc32: 9671eaac
+                    min_sized_file1.bin  | file     | nlink=1 |     1000 Bytes | crc32: f0d93de4
+                    min_sized_file2.bin  | file     | nlink=1 |     1000 Bytes | crc32: f0d93de4
+                    subdir/file.txt      | file     | nlink=1 |       22 Bytes | crc32: c0167e63
+                    symlink2file1        | symlink  | nlink=2 |       14 Bytes | crc32: 8a11514a
+                """,
+            )
+            # The backup:
+            # * /.cache/ -> excluded
+            # * min_sized_file1.bin and min_sized_file2.bin -> hardlinked
+            assert_fs_tree_overview(
+                root=backup_dir,
+                expected_overview="""
+                    file2.txt            | file     | nlink=1 |       14 Bytes | crc32: 8a11514a
+                    hardlink2file1       | file     | nlink=1 |       14 Bytes | crc32: 8a11514a
+                    large_file.bin       | file     | nlink=1 | 67108865 Bytes | crc32: 9671eaac
+                    min_sized_file1.bin  | hardlink | nlink=2 |     1000 Bytes | crc32: f0d93de4
+                    min_sized_file2.bin  | hardlink | nlink=2 |     1000 Bytes | crc32: f0d93de4
+                    subdir/file.txt      | file     | nlink=1 |       22 Bytes | crc32: c0167e63
+                    symlink2file1        | symlink  | nlink=2 |       14 Bytes | crc32: 8a11514a
+                """,
+            )
+
+            #######################################################################################
+            # Just backup again:
+
+            with freeze_time('2026-01-02T12:34:56Z', auto_tick_seconds=0):
+                result = backup_tree(
+                    src_root=src_root,
+                    backup_root=backup_root,
+                    excludes={'.cache'},
+                )
+            backup_dir = result.backup_dir
+            self.assertEqual(
+                str(Path(backup_dir).relative_to(temp_path)),
+                'backup/source/20260102_123456',
+            )
+            self.assertEqual(
+                result,
+                BackupResult(
+                    backup_dir=backup_dir,
+                    backup_count=7,
+                    backup_size=67110929,
+                    symlink_files=1,
+                    hardlinked_files=3,  # <<< More hardlinks this time!
+                    hardlinked_size=67110865,
+                    copied_files=3,
+                    copied_size=50,
+                    copied_small_files=3,
+                    copied_small_size=50,
+                ),
+            )
+            # The second backup:
+            # * /.cache/ -> excluded
+            # * min_sized_file1.bin and min_sized_file2.bin -> hardlinked
+            assert_fs_tree_overview(
+                root=backup_dir,
+                expected_overview="""
+                    file2.txt            | file     | nlink=1 |       14 Bytes | crc32: 8a11514a
+                    hardlink2file1       | file     | nlink=1 |       14 Bytes | crc32: 8a11514a
+                    large_file.bin       | hardlink | nlink=2 | 67108865 Bytes | crc32: 9671eaac
+                    min_sized_file1.bin  | hardlink | nlink=4 |     1000 Bytes | crc32: f0d93de4
+                    min_sized_file2.bin  | hardlink | nlink=4 |     1000 Bytes | crc32: f0d93de4
+                    subdir/file.txt      | file     | nlink=1 |       22 Bytes | crc32: c0167e63
+                    symlink2file1        | symlink  | nlink=2 |       14 Bytes | crc32: 8a11514a
+                """,
+            )

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/tests/test_readme.py

@@ -26,7 +26,6 @@ class ReadmeTestCase(BaseTestCase):
     def test_main_help(self):
         with NoColorEnvRich():
             stdout = invoke(cli_bin=PACKAGE_ROOT / 'cli.py', args=['--help'], strip_line_prefix='usage: ')
-
         self.assert_in_content(
             got=stdout,
             parts=(
@@ -36,10 +35,6 @@ class ReadmeTestCase(BaseTestCase):
                 constants.CLI_EPILOG,
             ),
         )
-
-        # Installed via pipx is called 'phlb', not 'cli.py':
-        stdout = stdout.replace('./cli.py', 'phlb')
-
         assert_cli_help_in_readme(text_block=stdout, marker='main help')
 
     def test_backup_help(self):
@@ -52,10 +47,6 @@ class ReadmeTestCase(BaseTestCase):
                 'Backup the source directory to the destination',
             ),
         )
-
-        # Installed via pipx is called 'phlb', not 'cli.py':
-        stdout = stdout.replace('./cli.py', 'phlb')
-
         assert_cli_help_in_readme(text_block=stdout, marker='backup help')
 
     def test_dev_help(self):

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/utilities/file_hash_database.py

@@ -1,4 +1,3 @@
-import logging
 from pathlib import Path
 
 
@@ -7,8 +6,8 @@ class HashAlreadyExistsError(ValueError):
 
 
 class FileHashDatabase:
-    """DocWrite: README.md ## FileHashDatabase
-    A simple "database" to store file content hash <-> relative path mappings.
+    """
+    A simple database to store file content hash <-> relative path mappings.
     Uses a directory structure to avoid too many files in a single directory.
     Path structure:
             {base_dst}/.phlb/hash-lookup/{XX}/{YY}/{hash}
@@ -40,10 +39,6 @@ class FileHashDatabase:
             return None
         else:
             abs_file_path = self.backup_root / rel_file_path
-            if not abs_file_path.is_file():
-                logging.warning('Hash database entry found, but file does not exist: %s', abs_file_path)
-                hash_path.unlink()
-                return None
             return abs_file_path
 
     def __setitem__(self, hash: str, abs_file_path: Path):

{pyhardlinkbackup-1.0.0 → pyhardlinkbackup-1.0.0rc0}/PyHardLinkBackup/utilities/file_size_database.py

@@ -2,11 +2,17 @@ from pathlib import Path
 
 
 class FileSizeDatabase:
-    """DocWrite: README.md ## FileSizeDatabase
-    A simple "database" to track which file sizes have been seen.
-
+    """
+    A simple database to track which file sizes have been seen.
     Uses a directory structure to avoid too many files in a single directory.
-    We don't "cache" anything in Memory, to avoid high memory consumption for large datasets.
+
+    Path structure:
+         {base_dst}/.phlb/size-lookup/{XX}/{YY}/{size}
+    e.g.:
+        1234567890 results in: {base_dst}/.phlb/size-lookup/12/34/1234567890
+
+    Notes:
+      * We don't "cache" anything in Memory, to avoid high memory consumption for large datasets.
     """
 
     MIN_SIZE = 1000  # no padding is made, so the min size is 1000 bytes!
@@ -18,15 +24,6 @@ class FileSizeDatabase:
     def _get_size_path(self, size: int) -> Path:
         assert size >= self.MIN_SIZE, f'Size must be at least {self.MIN_SIZE} bytes'
         size_str = str(size)
-
-        """DocWrite: README.md ## FileSizeDatabase
-        Path structure:
-         * `{base_dst}/.phlb/size-lookup/{XX}/{YY}/{size}`
-
-        e.g.:
-
-         * `1234567890` results in: `{base_dst}/.phlb/size-lookup/12/34/1234567890`
-        """
         first_dir_name = size_str[:2]
         second_dir_name = size_str[2:4]
         size_path = self.base_path / first_dir_name / second_dir_name / size_str
@@ -40,7 +37,4 @@ class FileSizeDatabase:
         size_path = self._get_size_path(size)
         if not size_path.exists():
             size_path.parent.mkdir(parents=True, exist_ok=True)
-
-            """DocWrite: README.md ## FileSizeDatabase
-            All files are created empty, as we only care about their existence."""
             size_path.touch(exist_ok=False)