pixmatch 0.0.3__tar.gz → 0.0.5__tar.gz

{pixmatch-0.0.3 → pixmatch-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixmatch
-Version: 0.0.3
+Version: 0.0.5
 Summary: A modern VisiPics replacement.
 Author-email: Ryan Heard <ryanwheard@gmail.com>
 Project-URL: Repository, https://github.com/rheard/pixmatch

pixmatch-0.0.5/pixmatch/__init__.py

@@ -0,0 +1,585 @@
+import hashlib
+import logging
+import os
+import time
+
+from collections import defaultdict
+from dataclasses import dataclass, field
+from functools import wraps
+from multiprocessing import Manager, Pool
+from pathlib import Path
+from threading import Event
+from typing import ClassVar, Union
+from zipfile import BadZipFile, ZipFile
+
+import imagehash
+import numpy as np
+
+from PIL import Image, ImageFile, UnidentifiedImageError
+
+ImageFile.LOAD_TRUNCATED_IMAGES = True  # Allow damaged images
+
+logger = logging.getLogger(__name__)
+
+
+@dataclass(frozen=True)
+class ZipPath:
+    """
+    A general object describing a Path.
+
+    All paths in pixmatch will be one of these. `subpath` will be empty for non-zip file paths.
+
+    Attributes:
+        path (str): The path to the file.
+        subpath (str): The subpath in the zip if `path` is for a zip.
+    """
+    # TODO: At some point convert this to Path.
+    #   When I tried that last it introduced problems with inter-process communication
+    path: str
+    subpath: str
+
+    @property
+    def path_obj(self) -> Path:
+        """Get the path as as Path object"""
+        return Path(self.path)
+
+    @property
+    def is_gif(self) -> bool:
+        """Is this a path to an animated image?"""
+        movie_extensions = {'.gif', '.webp'}
+        return (not self.subpath and Path(self.path).suffix.lower() in movie_extensions) \
+            or (self.subpath and self.subpath[-4:].lower() in movie_extensions)
+
+    @property
+    def is_zip(self) -> bool:
+        """Does this point to a file located in a zip?"""
+        return bool(self.subpath)
+
+    def absolute(self):
+        """Get the absolute version of this ZipPath"""
+        return ZipPath(str(self.path_obj.absolute()), self.subpath)
+
+
+def _is_under(folder_abs: str, target: str | Path) -> bool:
+    """Return True if the ZipPath's real file (zp.path) is inside folder_abs."""
+    try:
+        Path(target).absolute().relative_to(Path(folder_abs).absolute())
+    except ValueError:
+        return False
+
+    return True
+
+
+def phash_params_for_strength(strength: int) -> tuple[int, int]:
+    """
+    Convert a 0-10 strength to settings for imagehash
+
+    Returns:
+        tuple<int, int>: The hash size (in bytes) and the high frequency factor
+    """
+    # TODO: This sucks.
+    strength = max(0, min(10, strength))
+    if strength >= 10:
+        return 16, 4
+    if strength >= 8:
+        return 15, 4
+    if strength >= 7:
+        return 13, 4
+    if strength >= 6:
+        return 11, 4
+    if strength >= 5:
+        return 9, 4
+    if strength >= 4:
+        return 8, 4
+    if strength >= 3:
+        return 8, 3
+    if strength >= 2:
+        return 7, 3
+    return 6, 3
+
+
+def calculate_hashes(f, strength=5, *, is_gif=False, exact_match=False) -> tuple[str, set[str]]:
+    """
+    Calculate hashes for a given file.
+
+    Args:
+        f (IO or str or Path): Either a file path to process, or a in-memory BytesIO object ready for reading.
+        strength (int): A number between 0 and 10 on the strength of the matches.
+        is_gif (bool): Is this gif data? Needed if passing an in-memory BytesIO object.
+        exact_match (bool): Use exact SHA256 hahes?
+            If true, strength must be 10.
+            If false, perceptual hashes will be used, even with high strength.
+
+    Returns:
+        tuple[str, set]: The first element is the primary hash,
+            the second element are any secondary hashes representing rotations, flips, etc...
+    """
+    if exact_match:
+        hasher = hashlib.sha256()
+        block_size = 65536
+        with (open(f, "rb") if isinstance(f, (str, Path)) else f) as file:  # noqa: PTH123
+            for block in iter(lambda: file.read(block_size), b""):
+                hasher.update(block)
+        return hasher.hexdigest(), set()
+
+    hash_size, highfreq_factor = phash_params_for_strength(strength)
+    with Image.open(f) as im:
+        if is_gif:
+            initial_hash = imagehash.phash(im, hash_size=hash_size, highfreq_factor=highfreq_factor)
+            # This is going to be a bit confusing but basically, imagehash produces weird hashes for some gifs
+            #   because some gifs have bad first frames consisting of nothing or only a single color...
+            # To deal with that I'm looking for these bad hashes here and if its one, we advance to the next frame
+            #   and use THAT for imagehash instead.
+            # The ones we need to be on the lookout for are:
+            #   1. The hash is all 1111...
+            #   2. The hash is all 0000...
+            #   3. The hash is of the form 100000...
+            # TODO: This is simply not good enough. I'm still getting bad matches for gifs, tho they are extremely rare
+            val = initial_hash.hash[0][0]
+            while all(all(x == val for x in r) for r in initial_hash.hash) \
+                    or all(all(x == np.False_ or (x_i == 0 and r_i == 0) for x_i, x in enumerate(r))
+                           for r_i, r in enumerate(initial_hash.hash)):
+                try:
+                    im.seek(im.tell() + 1)
+                except EOFError:  # noqa: PERF203
+                    break
+                else:
+                    initial_hash = imagehash.phash(im, hash_size=hash_size, highfreq_factor=highfreq_factor)
+                    val = initial_hash.hash[0][0]
+
+            # For GIFs we'll look for mirrored versions but thats it
+            flipped_h_image = im.transpose(Image.Transpose.FLIP_LEFT_RIGHT)
+            extras = (flipped_h_image, )
+        else:
+            initial_hash = imagehash.phash(im, hash_size=hash_size, highfreq_factor=highfreq_factor)
+
+            flipped_h_image = im.transpose(Image.Transpose.FLIP_LEFT_RIGHT)
+            flipped_v_image = im.transpose(Image.Transpose.FLIP_TOP_BOTTOM)
+            extras = (im.rotate(90), im.rotate(180), im.rotate(270),
+                      flipped_h_image, flipped_h_image.rotate(90), flipped_h_image.rotate(180),
+                      flipped_h_image.rotate(270),
+                      flipped_v_image, flipped_v_image.rotate(90), flipped_v_image.rotate(180),
+                      flipped_v_image.rotate(270))
+
+        return str(initial_hash), {
+            str(imagehash.phash(image, hash_size=hash_size, highfreq_factor=highfreq_factor)) for image in extras
+        }
+
+
+def thread_error_handler(func):
+    """An error handler for the thread to return information about where the error occurred"""
+
+    @wraps(func)
+    def wrapper(path, *args, **kwargs):  # noqa: ANN202
+        try:
+            return func(path, *args, **kwargs)
+        except Exception as e:
+            e.input_path = path
+            raise
+
+    return wrapper
+
+
+@thread_error_handler
+def _process_image(
+        path: str | Path,
+        supported_extensions: set | None = None,
+        strength: int = 5,
+        *,
+        exact_match: bool = False,
+) -> tuple[Path, tuple | dict[str, tuple]]:
+    """Get the hashes for a given path. Is multiprocessing compatible"""
+    path = Path(path)
+    if path.suffix.lower() != '.zip':
+        return path, calculate_hashes(path, is_gif=path.suffix.lower() in {".gif", ".webp"},
+                                      strength=strength, exact_match=exact_match)
+
+    if not supported_extensions:
+        supported_extensions = ImageMatcher.SUPPORTED_EXTS
+
+    results = {}
+    with ZipFile(path) as zf:
+        for f in zf.filelist:
+            f_ext = f.filename[-4:].lower()
+            if f_ext not in supported_extensions:
+                continue
+
+            if f_ext == '.zip':
+                logger.warning('Have not implemented nested zip support yet! Input file: %s (%s)', path, f)
+                continue
+
+            try:
+                with zf.open(f) as zipped_file:
+                    results[f.filename] = calculate_hashes(zipped_file, is_gif=f_ext in {".gif", ".webp"},
+                                                           strength=strength, exact_match=exact_match)
+            except BadZipFile as e:
+                logger.warning("Could not read %s in %s due to %s", f.filename, path, str(e))
+            except UnidentifiedImageError:
+                logger.warning("Could not identify image %s in %s", f.filename, path)
+
+    return path, results
+
+
+@dataclass
+class ImageMatch:
+    """A match data structure containing the matches and where this match lies in the match list"""
+    match_i: int | None = field(default=None)
+    matches: list[ZipPath] = field(default_factory=list)
+
+
+# region Events
+@dataclass(frozen=True)
+class NewGroup:
+    """A new group event"""
+    group: "ImageMatch"
+
+
+@dataclass(frozen=True)
+class NewMatch:
+    """A new match event"""
+    group: "ImageMatch"
+    path: ZipPath
+
+
+@dataclass(frozen=True)
+class Finished:
+    """A finished event"""
+
+
+MatcherEvent = Union[NewGroup, NewMatch, Finished]
+# endregion
+
+
+class ImageMatcher:
+    """
+    An image matching SDK
+
+    Args:
+        strength (int): The 0-10 strength to use for matching. Defaults to 5.
+        exact_match (bool): Should use SHA-256 hashes? If False, the default, will use perceptual hashes.
+            If True, strength must be 10.
+        processes (int): The number of processes to use. Defaults to None.
+        extensions (set): The extensions to process. Optional.
+    """
+    SUPPORTED_EXTS: ClassVar = {".jpg", ".jpeg", ".png", ".webp", ".tif", ".tiff", ".bmp", ".gif", ".zip"}
+
+    def __init__(self, strength: int = 5, processes: int | None = None, extensions: set | None = None,
+                 *, exact_match: bool = False):
+        if not (0 <= strength <= 10):
+            raise ValueError("Strength must be between 0 and 10!")
+
+        self.extensions = extensions or self.SUPPORTED_EXTS
+
+        self.strength = strength
+        self.exact_match = exact_match
+        self.processes = processes
+
+        self.found_images = 0
+        self.processed_images = 0
+        self.duplicate_images = 0
+        self.matches = []
+
+        m = Manager()
+        self.events = m.Queue()  # Events to go to higher level users
+        self._new_paths = m.Queue()  # Inbound queue for new paths that are added while processing is running
+        self._removed_paths = set()  # Paths that have been removed from processing after processing has been started
+        self._ignored_files = set()  # Files which have been ignored and should be skipped from processing if re-ran
+        self._processed_zips = {}  # Zips that have been successfully processed
+        self._hashes = defaultdict(ImageMatch)  # Hash -> Paths
+        self._reverse_hashes = {}  # Path -> Hash
+
+        # Pausing and finished signaling...
+        self._not_paused = Event()
+        self._not_paused.set()
+        self._finished = Event()
+        self._finished.set()
+
+    @property
+    def left_to_process(self):
+        """Files that are left to process"""
+        return self.found_images - self.processed_images
+
+    def add_path(self, path: str | Path):
+        """Add a path for processing"""
+        path = str(Path(path).absolute())
+        self._removed_paths.discard(path)
+        self._new_paths.put(path)
+
+    def remove_path(self, folder: str | Path):
+        """
+        Mark a folder to be skipped going forward, and remove already-indexed files
+        that live under it. Pauses briefly if not already paused to keep state sane.
+        """
+        # TODO: This works but the biggest problem with it is that it will not remove any images which are still
+        #   queue'd up for processing in the ThreadPool... I'm not sure how to fix that yet.
+        folder = str(Path(folder).absolute())
+        paused = self.conditional_pause()
+        self._removed_paths.add(folder)
+
+        # Remove anything we've already seen under that folder
+        # (iterate over a copy because remove() mutates structures)
+        to_remove = [p for p in self._reverse_hashes if _is_under(folder, p.path)]
+        for p in to_remove:
+            self.remove(p)
+
+        to_remove_zips = [p for p in self._processed_zips if _is_under(folder, p)]
+        for p in to_remove_zips:
+            self._processed_zips.pop(p)
+
+        self.conditional_resume(paused)
+
+    def conditional_pause(self) -> bool:
+        """Pause if not paused and return if was paused"""
+        _conditional_pause = self.is_paused()
+        if not _conditional_pause:
+            logger.debug('Performing conditional pause')
+            self.pause()
+
+        return _conditional_pause
+
+    def conditional_resume(self, was_paused: bool):  # noqa: FBT001
+        """Resume if not paused previous (from call to `conditional_pause`)"""
+        if not was_paused and not self.is_finished():
+            logger.debug('Performing conditional resume')
+            self.resume()
+
+    def pause(self):
+        """Pause processing"""
+        logger.debug('Performing pause')
+        self._not_paused.clear()
+
+    def is_paused(self):
+        """Is processing paused"""
+        return not self._not_paused.is_set()
+
+    def finish(self):
+        """Finish processing"""
+        logger.debug('Performing finished')
+        self._finished.set()
+
+    def is_finished(self):
+        """Is processing finished"""
+        return self._finished.is_set()
+
+    def resume(self):
+        """Resume processing"""
+        logger.debug('Performing resume')
+        self._not_paused.set()
+
+    def running(self):
+        """Currently running and loading hashes?"""
+        return not self.is_paused() and (not self.is_finished() or self.left_to_process)
+
+    def remove(self, path):
+        """Remove a loaded path completely from the image matching system. Will not delete a file."""
+        # Pause things while we remove things...
+        logger.info('Removing %s from %s', path, self.__class__.__name__)
+        paused = self.conditional_pause()
+
+        hash_ = self._reverse_hashes.pop(path)
+        self._hashes[hash_].matches.remove(path)
+        if len(self._hashes[hash_].matches) == 1:
+            match_i = self._hashes[hash_].match_i
+            logger.debug('Unmatching match group %s', match_i)
+            self._hashes[hash_].match_i = None
+
+            del self.matches[match_i]
+            self.refresh_match_indexes(match_i)
+            self.duplicate_images -= 2
+
+        elif not self._hashes[hash_].matches:
+            logger.debug('Removing empty match group')
+            del self._hashes[hash_]
+
+        else:
+            logger.debug('Simple removal performed')
+            self.duplicate_images -= 1
+
+        self.processed_images -= 1
+        self.found_images -= 1
+        self.conditional_resume(paused)
+
+    def ignore(self, path):
+        """Remove a path from the image matching service"""
+        self.remove(path)
+
+        if path.path_obj.suffix.lower() != '.zip':
+            self._ignored_files.add(path.path)
+
+    def refresh_match_indexes(self, start=0):
+        """Update the match_i value for all the matches passed a certain point"""
+        for match_i, match in enumerate(self.matches[start:], start=start):
+            match.match_i = match_i
+
+    def _process_image_callback(self, result):
+        """
+        Handle the result of hashing an image.
+
+        This needs to do quite a few things including sanitizing the results,
+            actually checking if the hash matches an existing image,
+            adding the image and any matches to the backend data structures, notify any listeners,
+            update the found and processed image counts,
+            and verify that this result wasn't added as a removed path since it was queued.
+
+        Args:
+            result: A tuple consisting of the path to the file, and the resultant hashes.
+                If the hashes are a dict, then it is assumed that the path is for a zip. In that case,
+                the individual zip files will sanitized and re-ran through this callback.
+        """
+        # TODO: This callback must return IMMEDIATELY and is currently too slow for large amounts of zips.
+        #   Perhaps create a new queue/thread and queue up processing for zip results?
+        #   I think the major slow point is adding to the data structures and I'm not sure if more threads will help
+        # Check for paused or finished signals
+        self._not_paused.wait()
+        if self.is_finished():
+            return
+
+        # region Sanitize results
+        path: Path | str | ZipPath
+        path, hashes = result
+
+        if any(_is_under(d, path.path if isinstance(path, ZipPath) else path) for d in self._removed_paths):
+            # This image was removed AFTER it was queue'd! So decrement the found images count and just leave...
+            self.found_images -= 1
+            return
+
+        if isinstance(hashes, dict):
+            self.found_images -= 1
+            subpaths = []
+            for sub_path, sub_hashes in hashes.items():
+                self.found_images += 1
+                subpaths.append(ZipPath(str(path), sub_path))
+                self._process_image_callback((subpaths[-1], sub_hashes))
+            self._processed_zips[str(path)] = subpaths
+            return
+
+        initial_hash, extra_hashes = hashes
+        extra_hashes.add(initial_hash)
+        if not isinstance(path, ZipPath):
+            # From this point on, EVERYTHING should be a ZipPath
+            path = ZipPath(str(path), "")
+        # endregion
+
+        if path in self._reverse_hashes:
+            self.found_images -= 1
+            return
+
+        self.processed_images += 1
+
+        # From testing at ~1.5m loaded images: it is ~10% faster to return a set and do this than it is to
+        #   iterate over a list and do an `is in` check for each hash
+        found_hashes = self._hashes.keys() & extra_hashes
+        if not found_hashes:
+            # This is a new image not matching any previous, so just add it to the hashmap and move on...
+            #   Just use the initial orientation
+            hash_ = initial_hash
+            self._reverse_hashes[path] = hash_
+            self._hashes[hash_].matches.append(path)
+            return
+
+        # We have found a match!
+        hash_ = next(iter(found_hashes))
+        self._reverse_hashes[path] = hash_
+        self._hashes[hash_].matches.append(path)
+
+        if self._hashes[hash_].match_i is None and len(self._hashes[hash_].matches) >= 2:
+            # This is a brand new match group!
+            self._hashes[hash_].match_i = len(self.matches)
+            self.matches.append(self._hashes[hash_])
+            self.duplicate_images += 2
+            self.events.put(NewGroup(self._hashes[hash_]))
+            logger.debug('New match group found: %s', self._hashes[hash_].matches)
+        else:
+            # Just another match for an existing group...
+            self.duplicate_images += 1
+            self.events.put(NewMatch(self._hashes[hash_], path))
+            logger.debug('New match found for group #%s: %s',
+                         self._hashes[hash_].match_i,
+                         self._hashes[hash_].matches)
+
+    def _process_image_error_callback(self, e):
+        """Temporary for testing"""
+        self.processed_images += 1
+        logger.error("%s: %s (input path %s)", type(e), e, e.input_path)
+
+    def _root_stream(self):
+        """This is to yield any paths for processing, then wait until processing is finished for any new paths"""
+        while not self._new_paths.empty() or self.left_to_process:
+            if self._new_paths.empty():
+                time.sleep(0.05)
+                continue
+
+            yield self._new_paths.get_nowait()
+
+    def run(self, paths: list[str | Path]):
+        """Do the work of matching!"""
+        self._not_paused.set()
+        self._finished.clear()
+
+        for path in paths:
+            self.add_path(path)
+
+        with Pool(self.processes) as tp:
+            for path in self._root_stream():
+                path = Path(path)
+                if not path.is_dir():
+                    logger.warning('A path was entered that was not a directory : %s', path)
+                    continue
+
+                path = str(path.absolute())
+                if path in self._removed_paths:
+                    continue
+
+                for root, dirs, files in os.walk(path):
+                    if self.is_finished():
+                        break
+
+                    dirs.sort()  # This actually works to ensure that os.walk goes in alphabetical order!
+                    root = Path(root)
+
+                    if any(_is_under(d, root) for d in self._removed_paths):
+                        continue
+
+                    for f in files:
+                        self._not_paused.wait()
+                        if self.is_finished():
+                            break
+
+                        f = root / f
+
+                        if f.suffix.lower() not in self.extensions:
+                            continue
+
+                        if any(_is_under(d, f) for d in self._removed_paths):
+                            continue
+
+                        if str(f) in self._ignored_files:
+                            continue
+
+                        if f.suffix.lower() == '.zip':
+                            if str(f.absolute()) in self._processed_zips:
+                                continue
+                        elif ZipPath(str(f), "") in self._reverse_hashes:
+                            continue
+
+                        self.found_images += 1
+                        tp.apply_async(
+                            _process_image,
+                            args=(f, ),
+                            kwds={
+                                'strength': self.strength,
+                                'supported_extensions': self.extensions,
+                                'exact_match': self.exact_match,
+                            },
+                            callback=self._process_image_callback,
+                            error_callback=self._process_image_error_callback,
+                        )
+
+            tp.close()
+
+            if not self.is_finished():
+                tp.join()
+
+        if not self.is_finished():
+            self._finished.set()
+            self.events.put(Finished())

{pixmatch-0.0.3 → pixmatch-0.0.5}/pixmatch/__main__.py

@@ -8,10 +8,9 @@ from PySide6 import QtWidgets
 
 from pixmatch.gui import MainWindow
 
-
 if __name__ == "__main__":
     parser = argparse.ArgumentParser(
-        description="Process zero or more file paths."
+        description="Process zero or more file paths.",
     )
     parser.add_argument(
         "folders",
@@ -41,7 +40,7 @@ if __name__ == "__main__":
         QToolBar { spacing: 8px; }
         QLabel#GroupTitle { padding: 4px 0; }
         QFrame#ImageTile { border: 1px solid #444; border-radius: 6px; padding: 6px; }
-        """
+        """,
     )
     w = MainWindow(args.folders)
     w.show()

{pixmatch-0.0.3 → pixmatch-0.0.5}/pixmatch/utils.py

@@ -1,12 +1,11 @@
 from typing import Iterable
 
-
 def human_bytes(
         n: int,
         *,
         base: int = 1000,
         decimals: int = 0,
-        units: Iterable[str] = ("b", "kb", "mb", "gb", "tb", "pb", "eb", "zb", "yb")
+        units: Iterable[str] = ("b", "kb", "mb", "gb", "tb", "pb", "eb", "zb", "yb"),
 ) -> str:
     """
     Convert a byte count to a human-readable string.
@@ -19,6 +18,9 @@ def human_bytes(
 
     Returns:
         A compact string like '66kb', '1mb', '1.5gb', or '999b'.
+
+    Raises:
+        ValueError: If n < 0
     """
     if n < 0:
         raise ValueError("Byte size cannot be negative")
@@ -31,6 +33,6 @@ def human_bytes(
 
     if i == 0 or decimals == 0:
         # Bytes or integer formatting requested
-        return f"{int(n if i else n)}{tuple(units)[i]}"
+        return f"{int(n)}{tuple(units)[i]}"
 
     return f"{n:.{decimals}f}{tuple(units)[i]}".rstrip("0").rstrip(".")

{pixmatch-0.0.3 → pixmatch-0.0.5}/pixmatch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pixmatch
-Version: 0.0.3
+Version: 0.0.5
 Summary: A modern VisiPics replacement.
 Author-email: Ryan Heard <ryanwheard@gmail.com>
 Project-URL: Repository, https://github.com/rheard/pixmatch

{pixmatch-0.0.3 → pixmatch-0.0.5}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 
 [project]
 name = "pixmatch"
-version = "0.0.3"
+version = "0.0.5"
 #dynamic = ["license"]
 authors = [
   { name="Ryan Heard", email="ryanwheard@gmail.com" },
@@ -87,16 +87,23 @@ extend-select = [
     "YTT",    # flake8-2020
 ]
 ignore=[
+    "ANN001",  # Missing type annotation for function argument X
+    "ANN002",  # Missing type annotation for *arg
+    "ANN003",  # Missing type annotation for arg
     "ANN201",  # Missing return type
     "D100",    # Missing docstring in public module
     "D104",    # Missing docstring in public package
     "D105",    # Missing docstring in magic method
+    "D107",    # Missing docstring in __init__ method
     "D202",    # Blank line after function docstring
+    "D205",    # 1 blank line required between summary line and description
     "D212",    # Multi-line docstring summary should start at the first line
     "D415",    # Closing punctuation on docstrings
     "PT013",   # Incorrect import of pytest
     "RUF023",  # __slots__ is not sorted
+    "RUF052",  # Local dummy variable X is accessed
     "TRY003",  # Avoid specifying long messages outside the exception class
+    "UP035",   # Import from `collections.abc` instead: `Iterable`
 ]
 
 [tool.ruff.lint.pydocstyle]

pixmatch-0.0.3/pixmatch/__init__.py

@@ -1,444 +0,0 @@
-import hashlib
-import logging
-import os
-import time
-
-from collections import defaultdict
-from dataclasses import dataclass, field
-from multiprocessing import Pool, Manager
-from pathlib import Path
-from threading import Event
-from typing import Union
-from zipfile import ZipFile
-
-import imagehash
-import numpy as np
-
-from PIL import Image
-
-logger = logging.getLogger(__name__)
-
-
-@dataclass(frozen=True)
-class ZipPath:
-    path: str
-    subpath: str
-
-    @property
-    def path_obj(self):
-        return Path(self.path)
-
-    @property
-    def is_gif(self) -> bool:
-        movie_extensions = {'.gif', '.webp'}
-        return (not self.subpath and Path(self.path).suffix.lower() in movie_extensions) \
-            or (self.subpath and self.subpath[-4:].lower() in movie_extensions)
-
-    def absolute(self):
-        return ZipPath(str(self.path_obj.absolute()), self.subpath)
-
-
-def _is_under(folder_abs: str, target: str | Path) -> bool:
-    """Return True if the ZipPath's real file (zp.path) is inside folder_abs."""
-    try:
-        Path(target).absolute().relative_to(Path(folder_abs).absolute())
-        return True
-    except ValueError:
-        return False
-
-
-def phash_params_for_strength(strength: int) -> tuple[int, int]:
-    # TODO: This sucks.
-    strength = max(0, min(10, strength))
-    if strength >= 10:
-        return 16, 4    # 256-bit hash, strict
-    elif strength >= 8:
-        return 15, 4
-    elif strength >= 7:
-        return 13, 4
-    elif strength >= 6:
-        return 11, 4
-    elif strength >= 5:
-        return 9, 4
-    elif strength >= 4:
-        return 8, 4
-    elif strength >= 3:
-        return 8, 3
-    elif strength >= 2:
-        return 7, 3
-    else:
-        return 6, 3
-
-
-def calculate_hashes(f, is_gif=False, strength=5, exact_match=False):
-    """
-    Calculate hashes for a given file.
-
-    Args:
-        f (IO or str or Path): Either a file path to process, or a in-memory BytesIO object ready for reading.
-        is_gif (bool): Is this gif data? Needed if passing an in-memory BytesIO object.
-        strength (int): A number between 0 and 10 on the strength of the matches.
-        exact_match (bool): Use exact SHA256 hahes?
-            If true, strength must be 10.
-            If false, perceptual hashes will be used, even with high strength.
-
-    Returns:
-        list: The found hashes.
-    """
-    if exact_match:
-        hasher = hashlib.sha256()
-        block_size = 65536
-        with (open(f, "rb") if isinstance(f, (str, Path)) else f) as file:
-            for block in iter(lambda: file.read(block_size), b""):
-                hasher.update(block)
-        return [hasher.hexdigest()]
-
-    hash_size, highfreq_factor = phash_params_for_strength(strength)
-    with (Image.open(f) as im):
-        if is_gif:
-            initial_hash = imagehash.phash(im, hash_size=hash_size, highfreq_factor=highfreq_factor)
-            # This is going to be a bit confusing but basically, imagehash produces weird hashes for some gifs
-            #   because some gifs have bad first frames consisting of nothing or only a single color...
-            # To deal with that I'm looking for these bad hashes here and if its one, we advance to the next frame
-            #   and use THAT for imagehash instead.
-            # The ones we need to be on the lookout for are:
-            #   1. The hash is all 1111...
-            #   2. The hash is all 0000...
-            #   3. The hash is of the form 100000...
-            # TODO: This is simply not good enough. I'm still getting bad matches for gifs, tho they are extremely rare
-            val = initial_hash.hash[0][0]
-            while all(all(x == val for x in r) for r in initial_hash.hash) \
-                    or all(all(x == np.False_ or (x_i == 0 and r_i == 0) for x_i, x in enumerate(r))
-                           for r_i, r in enumerate(initial_hash.hash)):
-                try:
-                    im.seek(im.tell() + 1)
-                except EOFError:
-                    break
-                else:
-                    initial_hash = imagehash.phash(im, hash_size=hash_size, highfreq_factor=highfreq_factor)
-                    val = initial_hash.hash[0][0]
-
-            # For GIFs we'll look for mirrored versions but thats it
-            flipped_h_image = im.transpose(Image.Transpose.FLIP_LEFT_RIGHT)
-            return [initial_hash, imagehash.phash(flipped_h_image, hash_size=hash_size, highfreq_factor=highfreq_factor)]
-
-        flipped_h_image = im.transpose(Image.Transpose.FLIP_LEFT_RIGHT)
-        flipped_v_image = im.transpose(Image.Transpose.FLIP_LEFT_RIGHT)
-        images = (im, im.rotate(90), im.rotate(180), im.rotate(270),
-                  flipped_h_image, flipped_h_image.rotate(90), flipped_h_image.rotate(180), flipped_h_image.rotate(270),
-                  flipped_v_image, flipped_v_image.rotate(90), flipped_v_image.rotate(180), flipped_v_image.rotate(270))
-        return [imagehash.phash(image, hash_size=hash_size, highfreq_factor=highfreq_factor) for image in images]
-
-
-def _process_image(path: str | Path, strength=5, exact_match=False):
-    path = Path(path)
-    if path.suffix.lower() != '.zip':
-        return path, calculate_hashes(path, is_gif=path.suffix.lower() in {".gif", ".webp"},
-                                      strength=strength, exact_match=exact_match)
-
-    results = dict()
-    with ZipFile(path) as zf:
-        for f in zf.filelist:
-            with zf.open(f) as zipped_file:
-                results[f.filename] = calculate_hashes(zipped_file, is_gif=f.filename[-4:].lower() in {".gif", ".webp"},
-                                                       strength=strength, exact_match=exact_match)
-
-    return path, results
-
-
-@dataclass
-class ImageMatch:
-    match_i: int | None = field(default=None)
-    matches: list[ZipPath] = field(default_factory=list)
-
-
-@dataclass(frozen=True)
-class NewGroup:
-    group: "ImageMatch"  # forward-ref to your class
-
-
-@dataclass(frozen=True)
-class NewMatch:
-    group: "ImageMatch"
-    path: ZipPath
-
-
-@dataclass(frozen=True)
-class Finished:
-    pass
-
-
-MatcherEvent = Union[NewGroup, NewMatch, Finished]
-
-
-# TODO: FINISHED signal?
-class ImageMatcher:
-    SUPPORTED_EXTS = {".jpg", ".jpeg", ".png", ".webp", ".tif", ".tiff", ".bmp", ".gif", ".zip"}
-
-    def __init__(self, strength: int = 5, exact_match: bool = False, processes: int | None = None,
-                 extensions: set | None = None):
-        if not (0 <= strength <= 10):
-            raise ValueError("Strength must be between 0 and 10!")
-
-        self.extensions = extensions or self.SUPPORTED_EXTS
-
-        self.strength = strength
-        self.exact_match = exact_match
-        self.processes = processes
-        self.found_images = 0
-        self.processed_images = 0
-        self.duplicate_images = 0
-
-        m = Manager()
-        self.events = m.Queue()
-        self._new_paths = m.Queue()
-        self._removed_paths = set()
-        self._processed_paths = set()
-        self._hashes = defaultdict(ImageMatch)
-        self._reverse_hashes = dict()
-
-        self._not_paused = Event()
-        self._not_paused.set()
-        self._finished = Event()
-        self._finished.set()
-
-        self.matches = []
-
-    def add_path(self, path: str | Path):
-        path = str(Path(path).absolute())
-        self._removed_paths.discard(path)
-        self._new_paths.put(path)
-
-    def remove_path(self, folder: str | Path) -> None:
-        """
-        Mark a folder to be skipped going forward, and remove already-indexed files
-        that live under it. Pauses briefly if not already paused to keep state sane.
-        """
-        folder = str(Path(folder).absolute())
-        paused = self.conditional_pause()
-        self._removed_paths.add(folder)
-        self._processed_paths.discard(folder)
-
-        # Remove anything we've already seen under that folder
-        # (iterate over a copy because remove() mutates structures)
-        to_remove = [p for p in self._reverse_hashes.keys() if _is_under(folder, p.path)]
-        for p in to_remove:
-            self.remove(p)
-
-        self.conditional_resume(paused)
-
-    @property
-    def left_to_process(self):
-        return self.found_images - self.processed_images
-
-    def pause(self):
-        logger.debug('Performing pause')
-        self._not_paused.clear()
-
-    def conditional_pause(self):
-        _conditional_pause = self.is_paused()
-        if not _conditional_pause:
-            logger.debug('Performing conditional pause')
-            self.pause()
-
-        return _conditional_pause
-
-    def conditional_resume(self, was_paused):
-        if not was_paused and not self.is_finished():
-            logger.debug('Performing conditional resume')
-            self.resume()
-
-    def is_paused(self):
-        return not self._not_paused.is_set()
-
-    def finish(self):
-        logger.debug('Performing finished')
-        self._finished.set()
-
-    def is_finished(self):
-        return self._finished.is_set()
-
-    def resume(self):
-        logger.debug('Performing resume')
-        self._not_paused.set()
-
-    def running(self):
-        return not self.is_paused() and (not self.is_finished() or self.left_to_process)
-
-    def remove(self, path):
-        # Pause things while we remove things...
-        logger.info('Removing %s from %s', path, self.__class__.__name__)
-        paused = self.conditional_pause()
-
-        hash = self._reverse_hashes.pop(path)
-        self._hashes[hash].matches.remove(path)
-        if len(self._hashes[hash].matches) == 1:
-            match_i = self._hashes[hash].match_i
-            logger.debug('Unmatching match group %s', match_i)
-            self._hashes[hash].match_i = None
-
-            del self.matches[match_i]
-            self.refresh_match_indexes(match_i)
-            self.duplicate_images -= 2
-
-        elif not self._hashes[hash].matches:
-            logger.debug('Removing empty match group')
-            del self._hashes[hash]
-
-        else:
-            logger.debug('Simple removal performed')
-            self.duplicate_images -= 1
-
-        self.processed_images -= 1
-        self.found_images -= 1
-        self.conditional_resume(paused)
-
-    def refresh_match_indexes(self, start=0):
-        for match_i, match in enumerate(self.matches[start:], start=start):
-            match.match_i = match_i
-
-    def _process_image_callback(self, result):
-        self._not_paused.wait()
-        if self.is_finished():
-            return
-
-        path: Path | str | ZipPath
-        path, hashes = result
-
-        if any(_is_under(d, path.path if isinstance(path, ZipPath) else path) for d in self._removed_paths):
-            self.found_images -= 1
-            return
-
-        if isinstance(hashes, dict):
-            for sub_path, sub_hashes in hashes.items():
-                self._process_image_callback((ZipPath(str(path), sub_path), sub_hashes))
-            return
-
-        if not isinstance(path, ZipPath):
-            path = ZipPath(str(path), "")
-
-        if path in self._reverse_hashes:
-            self.found_images -= 1
-            return
-
-        self.processed_images += 1
-        for hash_ in hashes:
-            if hash_ not in self._hashes:
-                continue
-
-            self._reverse_hashes[path] = hash_
-
-            # This appears to be a new match!
-            for match in self._hashes[hash_].matches:
-                if path.absolute() == match.absolute():
-                    # This appears to be a duplicate PATH...
-                    logger.warning('Duplicate files entered! %s, %s', path, match)
-                    return
-
-            self._hashes[hash_].matches.append(path)
-            if self._hashes[hash_].match_i is None and len(self._hashes[hash_].matches) >= 2:
-                # This is a brand new match group!
-                self._hashes[hash_].match_i = len(self.matches)
-                self.matches.append(self._hashes[hash_])
-                self.duplicate_images += 2
-                self.events.put(NewGroup(self._hashes[hash_]))
-                logger.debug('New match group found: %s', self._hashes[hash_].matches)
-            else:
-                # Just another match for an existing group...
-                self.duplicate_images += 1
-                self.events.put(NewMatch(self._hashes[hash_], path))
-                logger.debug('New match found for group #%s: %s',
-                             self._hashes[hash_].match_i,
-                             self._hashes[hash_].matches)
-
-            break
-        else:
-            # This is a new hash, so just add it to the hashmap and move on...
-            #   Just use the initial orientation
-            hash_ = hashes[0]
-            self._reverse_hashes[path] = hash_
-            self._hashes[hash_].matches.append(path)
-            return
-
-    def _process_image_error_callback(self, e):
-        self.processed_images += 1
-        print(str(e))
-
-    def _root_stream(self):
-        # Yield any paths that come up for processing, then wait until processing is finished for any new paths
-        while not self._new_paths.empty() or self.left_to_process:
-            if self._new_paths.empty():
-                time.sleep(0.05)
-                continue
-
-            yield self._new_paths.get_nowait()
-
-    def run(self, paths: list[str | Path]):
-        # TODO: Verify none of the paths overlap
-        # TODO: Verify none of the dirs have been deleted after we started
-
-        self._not_paused.set()
-        self._finished.clear()
-
-        for path in paths:
-            self.add_path(path)
-
-        with Pool(self.processes) as tp:
-            for path in self._root_stream():
-                path = Path(path)
-                if not path.is_dir():
-                    logger.warning('A path was entered that was not a directory : %s', path)
-                    continue
-
-                path = str(path.absolute())
-                if path in self._removed_paths or path in self._processed_paths:
-                    continue
-
-                for root, dirs, files in os.walk(path):
-                    if self.is_finished():
-                        break
-
-                    root = Path(root)
-
-                    if any(_is_under(d, root) for d in self._removed_paths):
-                        continue
-
-                    for f in files:
-                        self._not_paused.wait()
-                        if self.is_finished():
-                            break
-
-                        f = root / f
-
-                        if f.suffix.lower() not in self.extensions:
-                            continue
-
-                        if any(_is_under(d, f) for d in self._removed_paths):
-                            continue
-
-                        # TODO: This sucks (for zips at least), but I can't iterate over the dict while its changing...
-                        if ZipPath(str(f), "") in self._reverse_hashes:
-                            continue
-
-                        self.found_images += 1
-                        tp.apply_async(
-                            _process_image,
-                            args=(f, ),
-                            kwds={
-                                'strength': self.strength,
-                                'exact_match': self.exact_match,
-                            },
-                            callback=self._process_image_callback,
-                            error_callback=self._process_image_error_callback,
-                        )
-
-                self._processed_paths.add(path)
-
-            tp.close()
-
-            if not self.is_finished():
-                tp.join()
-
-        if not self.is_finished():
-            self._finished.set()
-            self.events.put(Finished())