SwipeLocal.py

# Image Swipe 3: Local Image Swipe
# Image Swipe 3 implementation for local image sorting.

# Imports
import os
import argparse
from typing import Union, Any
import dearpygui.dearpygui as dpg

from .SwiperImplementation import SwiperImplementation
from ..ImageSwipeShared import VALID_IMAGE_EXTS, fullpath, loadImagesFromDir, corePaths
from ..ImageSwipeCore import ImageSwipeCore

# Classes
class SwipeLocal(SwiperImplementation):
    """
    Image Swipe 3 implementation for local image sorting.
    """
    # Constants
    CLI_PROG = "local"
    CLI_DESC = "Sort images from a local directory."

    SIZE_FILESELECT = (800, 600)

    # Constructor
    def __init__(self,
        outputDir: str,
        rootDir: str = "",
        extensions: list[str] = VALID_IMAGE_EXTS,
        debug: bool = False
    ):
        """
        outputDir: The directory to place output directories in.
        rootDir: The directory to start the directory selector dialog in.
        extensions: A list of valid image extensions.
        debug: If `True`, debug features will be enabled.
        """
        # Record info
        self.extensions = extensions
        self.debug = debug

        # Get the paths
        outputDir, self.rootDir = corePaths(outputDir, rootDir)

        # Prepare the core
        self.core = ImageSwipeCore(
            outputDir,
            debug=debug
        )

    # Functions
    def display(self):
        """
        Displays the local image swipe interface.
        """
        # Display the core
        self.core.display(onFirstFrame=self.__onFirstFrame)

    # Static Functions
    @classmethod
    def fromArgs(cls, args: argparse.Namespace) -> 'SwipeLocal':
        """
        Creates a new instance of this implementation using the given command line arguments.

        args: The command line arguments to use.

        Returns the new instance.
        """
        return cls(
            args.output,
            rootDir=args.root,
            extensions=args.extensions,
            debug=args.debug
        )

    @staticmethod
    def buildParser(parser: argparse.ArgumentParser):
        """
        Sets up the given command line parser with the required arguments for this implementation.

        parser: The parser to setup.
        """
        # Add required arguments
        parser.add_argument("output", type=str, help="The directory to place output directories in.")

        # Add optional arguments
        parser.add_argument("-r", "--root", help="The directory to start the directory selector dialog in.", type=str, default="")
        parser.add_argument("-e", "--extensions", help=f"A list of valid image extensions. (Default: {', '.join(VALID_IMAGE_EXTS)})", metavar="EXT", nargs='+', default=VALID_IMAGE_EXTS)
        parser.add_argument("--debug", help="If provided, enables debug mode.", action="store_true")

    # Private Functions
    def __onFirstFrame(self):
        """
        Triggered by `core` on the first frame after starting the interface.
        """
        # Show the input directory file selector
        dpg.add_file_dialog(
            label="Select Image Directory",
            width=self.SIZE_FILESELECT[0],
            height=self.SIZE_FILESELECT[1],
            callback=self.__inputDirSelectedCallback,
            cancel_callback=(lambda : dpg.stop_dearpygui()),
            directory_selector=True,
            default_path=self.rootDir
        )

    # Callback Functions
    def __inputDirSelectedCallback(self, sender: Union[int, str], selection: dict[str, Any]):
        """
        Callback for handling when the input directory is selected.

        sender: The tag of the sender.
        selection: The file selection data as returned by the file dialog.
        """
        # Check if the user selected a file
        if "file_path_name" not in selection:
            raise FileNotFoundError("No directory was selected.")

        # Get the full input path
        inputDir = fullpath(selection["file_path_name"])

        # Validate the path
        if not os.path.isdir(inputDir):
            raise FileNotFoundError(f"Invalid directory selected: {inputDir}")

        # Load the images from the input directory
        images = loadImagesFromDir(inputDir, debug=self.debug)

        # Add the images to the core
        self.core.addImagesToQueue(images)

        # Start the queue
        self.core.startQueue()

# Command Line
if __name__ == "__main__":
    print("This file does not contain a command line interface.")