Skip to content

CHANGELOG.md

Latest commit

 

History

History
100 lines (76 loc) · 6.88 KB

CHANGELOG.md

File metadata and controls

100 lines (76 loc) · 6.88 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

No unreleased changes.

0.4.0 — 2026-06-05

Fixed

  • Root symbolic links are rejected when symbolic link traversal is disabled (follow_symlinks=False), including directory and file symlinks used as the scan root.
  • SQLite cache database and all auxiliary files (-wal, -shm, -journal) are excluded from scans.
  • Cache exclusion works correctly when the scan root is accessed through a symbolic link, using resolve(strict=False) on both sides of the comparison.
  • Internal path comparison during cache exclusion no longer raises OSError or RuntimeError on symlink loops or broken symlinks.
  • PyPI publishing workflow (publish.yml) rewritten as valid YAML — the previous file contained Markdown code fences that made it unparseable by GitHub Actions.
  • Public type annotations in ScanOptions, ScanEvent, and ScanProgress now resolve correctly on all supported Python versions via get_type_hints().

Changed

  • Cancelled CLI scans return exit status 3. Exit code 3 takes priority over --fail-on-duplicates.
  • Minimum supported Python version raised from 3.9 to 3.10. The codebase uses X | Y union syntax broadly; requiring 3.10 makes this consistent and allows get_type_hints() to resolve annotations correctly at runtime.
  • ProgressPhase values restricted to the phases actually emitted: "discovery", "hashing", and "done".

Removed

  • ScanEvent.from_cache and ScanEvent.bytes_read fields removed. These fields were added in 0.3.0 but were never populated — they always remained at their default values (False and 0). Removing them eliminates misleading API surface.

Tooling

  • CI restructured into three jobs: quality (Ruff lint + format check + Pyright on Ubuntu), tests (matrix across Ubuntu, Windows, and macOS with Python 3.10–3.13), and package (build, Twine check, py.typed verification, wheel smoke test).
  • Publishing workflow (publish.yml) now runs Ruff, Pyright, and full quality checks before building, so manual releases cannot skip linting.
  • pyyaml added to development dependencies to enable workflow YAML validation in tests.
  • Regression tests added: symlink policy, cache exclusion (including symlinked roots, symlink loops, broken symlinks), typing contracts, cancellation exit codes, version consistency, py.typed marker, workflow YAML validation.

0.3.0 — 2026-06-04

Added

  • DupeFinder class — integration-ready scan engine with typed events, cancellation, and optional hash cache.
  • ScanEvent frozen dataclass — typed events emitted during each scan phase (scan_started, file_discovered, file_hashed, duplicate_group_found, issue, scan_completed, scan_cancelled).
  • ScanEvent.from_cache and ScanEvent.bytes_read fields (reserved; removed in 0.4.0).
  • ScanProgress frozen dataclass — simplified progress snapshots delivered to the new on_progress callback. Fields: root, phase, scanned_files, hashed_files, total_candidates, duplicate_groups, elapsed_seconds, cancelled.
  • DupeFinder.on_progress parameter — optional callback that receives a ScanProgress snapshot after each file discovered or hashed, and once more at the end with phase="done".
  • ScanOptions.max_files — stop file discovery after N files.
  • ScanOptions.max_depth — limit directory recursion depth (0 = root only).
  • ScanOptions.timeout_seconds — automatically cancel scan after N seconds.
  • ScanReport.cancelled — True when the scan was cancelled early.
  • ScanReport.elapsed_seconds — wall-clock scan duration.
  • ScanReport.total_bytes_read — total bytes read during hashing.
  • ScanReport.to_dict() and ScanReport.to_json() — convenience serialization methods.
  • DuplicateGroup.to_dict() and ScanIssue.to_dict() — serialize to plain dictionary.
  • HashCache protocol — interface for pluggable hash caches.
  • SQLiteHashCache — SQLite-backed persistent hash cache; entries validated by file size and mtime.
  • grouping.candidate_files() and grouping.groups_from_hash_map() — public helpers.
  • _ScanCancelled internal exception in errors.py.
  • hash_file() and hash_files() accept should_cancel and on_bytes_read callbacks.
  • SCHEMA_VERSION = "1.1" constant; schema_version and total_bytes_read in all JSON/dict output.
  • CLI flags: --max-files, --max-depth, --timeout, --cache, --progress.
  • --progress flag prints live discovery/hashing progress to stderr.

Fixed

  • Engine now emits type="issue" events for all issues collected during discovery and hashing.
  • Cache error handling catches sqlite3.Error in addition to OSError.
  • CLI cache creation moved inside the try block so errors on cache open are caught and reported cleanly with exit code 1.
  • Engine no longer duplicates size-grouping and hash-grouping logic from grouping.py.

Changed

  • SCHEMA_VERSION bumped from "1.0" to "1.1".
  • dupefinder.__version__ updated to "0.3.0".
  • Development status classifier updated from 3 - Alpha to 4 - Beta.

0.1.0 — 2026-06-04

Added

  • scan(path, options) — returns a complete ScanReport with duplicate groups, file counts, and any issues encountered.
  • find_duplicates(path, options) — simplified function that returns only the duplicate groups.
  • ScanOptions — frozen dataclass to configure every aspect of a scan (algorithm, chunk size, size filters, hidden-file handling, symlink following, error handling).
  • ScanReport, DuplicateGroup, FileInfo, ScanIssue — typed, immutable data models for all scan results.
  • Chunked file hashing via hashlib — any algorithm available in hashlib.algorithms_available is supported.
  • Two-pass duplicate detection: group by file size first, hash only candidates.
  • format_report() — human-readable text output.
  • report_to_json() / report_to_dict() — structured JSON/dict output.
  • dupefinder CLI command with flags: --algorithm, --chunk-size, --min-size, --max-size, --include-ext, --ignore-ext, --no-ignore-hidden, --follow-symlinks, --strict, --json, --fail-on-duplicates, --version.
  • Custom exception hierarchy: DupeFinderError, InvalidPathError, UnsupportedHashAlgorithmError, InvalidOptionError, FileAccessError, FileHashError.
  • Symlink loop detection in directory traversal.
  • Unit tests for all modules using only the Python standard library.
  • Zero runtime dependencies — standard library only.