Major changes on the imgedit structure, added threads etc

dn0z · dn0z · commit b8d82cb7069a · 2016-11-10T07:25:15.000+02:00
diff --git a/bir.py b/bir.py
@@ -5,7 +5,9 @@
 # https://github.com/dn0z/Batch-Image-Resize
 
 import imgedit
+
 import os
+import threading, queue
 
 from enum import Enum
 from tkinter import *
@@ -62,13 +64,57 @@ def confirm_settings(self):
 
         return messagebox.askyesno("Export confirmation", confirm_msg)
 
-    def increase_progress_bar_value(self):
+    def exporting_interval(self, q):
+        """
+        Run @ a 100 ms interval using tkinter's `.after()` while the exporting thread is running
+
+        In order to keep tkinter's event loop running, our image editing code runs
+        on a different thread. We look at `num_of_exported_images`, `images_to_export`
+        and the result of our `q` queue (which represents if our code failed to
+        open, resize and/or save any images) to check the status of the thread
+
+        Once everything is done, we will get the operation's result using `q.get()`
+        and we will call the `self.exported()` (passing the result) to handle the rest
+
+        :param q: our `Queue` instance
         """
-        Increase the progress bar value by one
+
+        run_the_interval = True
+
+        if self.img_edit.num_of_images_to_export is not None:
+            exported_images = self.img_edit.num_of_exported_images
+            images_to_export = self.img_edit.num_of_images_to_export
+
+            # update progress bar
+            self.progress_bar["value"] = exported_images
+            self.progress_bar["maximum"] = images_to_export
+
+            # check if we are done
+            if exported_images >= images_to_export:
+                run_the_interval = False
+                self.exported(q.get())
+
+        if run_the_interval:
+            self.after(100, self.exporting_interval, q)
+
+    def exported(self, result):
         """
+        Display a success or an error message depending on the operation's result
 
-        self.progress_bar["value"] += 1
-        print("Increased progress bar value by one")
+        Close the progress window first, then display the message box
+
+        :param result:  the result of the exports (`True` if everything is okay,
+                        or `False` if there was an error)
+        """
+
+        self.clear_progress_window()
+
+        if result:
+            messagebox.showinfo("Exports completed",
+                                "All images were exported successfully")
+        else:
+            messagebox.showwarning("Exports failed",
+                                   "One or more images failed to export")
 
     def clear_progress_window(self):
         """
@@ -78,11 +124,9 @@ def clear_progress_window(self):
         if self.progress_window is not None:
             self.progress_window.destroy()
 
-    def display_progress_window(self, progress_maximum=100):
+    def display_progress_window(self):
         """
         Display the progress window
-
-        :param progress_maximum: The maximum value of the progress bar (default is 100)
         """
 
         self.clear_progress_window()
@@ -101,9 +145,6 @@ def display_progress_window(self, progress_maximum=100):
                                             mode="determinate")
         self.progress_bar.pack(expand=True, fill="both", side="bottom")
         self.progress_bar["value"] = 0
-        self.progress_bar["maximum"] = progress_maximum
-
-        self.progress_window.update()
 
     def get_settings_status(self):
         """
@@ -157,31 +198,22 @@ def export_button_handler(self):
         else:
             # Valid settings, confirm settings with the user and export
             if self.confirm_settings():
-                num_of_images = imgedit.image_files_in_dir(self.selected_directory.get())
-                self.display_progress_window(num_of_images)
+                # num_of_images = imgedit.image_files_in_dir(self.selected_directory.get())
+
+                self.display_progress_window()
                 print("Progress window is on screen")
 
-                print("Exporting images")
-                result = imgedit.export_all_in_dir(
-                    self.selected_directory.get(),
-                    int(self.export_properties["width"].get()),
-                    int(self.export_properties["height"].get()),
-                    self.export_properties["type"].get(),
-                    self.overwrite_original.get(),
-                    self.increase_progress_bar_value
-                )
-
-                self.clear_progress_window()
-                print("Progress window is cleared")
-
-                if result:
-                    # at this point, we are done with our exports, display a success message
-                    messagebox.showinfo("Exports completed",
-                                        "All images were exported successfully")
-                else:
-                    # one or more images failed to export, display a warning
-                    messagebox.showwarning("Exports failed",
-                                           "One or more images failed to export")
+                q = queue.Queue()
+                my_thread = threading.Thread(target=self.img_edit.export_all_in_dir,
+                                             args=(self.selected_directory.get(),
+                                                   int(self.export_properties["width"].get()),
+                                                   int(self.export_properties["height"].get()),
+                                                   self.export_properties["type"].get(),
+                                                   self.overwrite_original.get(),
+                                                   q)
+                                             )
+                my_thread.start()
+                self.exporting_interval(q)
 
     def browse_for_directory(self):
         """
@@ -290,6 +322,8 @@ def __init__(self, parent=None):
         self.progress_window = None
         self.progress_bar = None
 
+        self.img_edit = imgedit.ImgEdit()
+
         self.selected_directory = StringVar(self)
         self.overwrite_original = BooleanVar(self)
         self.export_properties = {
diff --git a/imgedit.py b/imgedit.py
@@ -8,107 +8,108 @@
 import PIL.Image
 
 
-def is_image(filename):
-    """
-    Checks if a filename is an image (png, jpg or jpeg, case insensitive)
-
-    :param filename: The filename (as a string)
-    :return: `True` if the given filename is an image, or `False` if it's not
-    """
-
-    file = filename.lower()
-    return file.endswith(".png") or file.endswith(".jpg") or file.endswith(".jpeg")
-
-
-def get_filename_with_type(filename, file_type, suffix=""):
-    """
-    Get a filename and return it with the given suffix and the correct file extension for the given type
-
-    :param filename: The filename (e.g. "image_file.jpg")
-    :param file_type: The file type (e.g. "PNG")
-    :param suffix: An optional string to place between the name and the extension of the file (default is "")
-    :return: the filename with the correct extension for the given type (e.g. "image_file.png")
-    """
-
-    extension = filename.split(".")[-1]
-    return filename[:-(len(extension) + 1)] + suffix + "." + file_type.lower()
-
-
-def export_file(path, name, width, height, export_type, overwrite):
-    """
-    Open, resize and save an image with the given properties
-
-    :param path: The path to the directory where the image is located (without the image filename)
-    :param name: The filename of the image we want to export
-    :param width: The new width we want to resize to
-    :param height: The new height we want to resize to
-    :param export_type: The file type we want to save to (we ignore it if `overwrite` is `True`)
-    :param overwrite: Whether we want to overwrite the original files or not
-    """
-
-    img_path = os.path.join(path, name)
-
-    # set the destination image file we want to save
-    dest_img_name = get_filename_with_type(name, export_type, "_resize")
-    if overwrite:
-        dest_img_name = name
-
-    try:
-        # open the given image, resize and save it
-        img = PIL.Image.open(img_path)
-        img = img.resize((width, height), PIL.Image.ANTIALIAS)
-        img.save(os.path.join(path, dest_img_name))
-    except IOError:
-        return False
-
-    return True
-
-
-def image_files_in_dir(selected_dir):
-    """
-    Returns the number of image files in the given directory
-
-    :param selected_dir: The directory containing the images
-    :return: the number of image files the directory contains
-    """
-    images = 0
-
-    for path, subdirs, files in os.walk(selected_dir):
-        for name in files:
-            if is_image(name):
-                images += 1
-
-    return images
-
-
-def export_all_in_dir(selected_dir, width, height, export_type, overwrite, progress_bar_callback=None):
-    """
-    Export all the images in the selected directory
-
-    When `self.init_export()` is called, everything is ready to resize and export images
-    This loops through all the files in the given directory and calls `self.export_file()`
-    for the actual opening, resizing and saving of the files
-
-    :param selected_dir: The path to the directory containing all the images to resize
-    :param width: The new width we want to resize to
-    :param height: The new height we want to resize to
-    :param export_type: The file type we want to save to (we ignore it if `overwrite` is `True`)
-    :param overwrite: Whether we want to overwrite the original files or not
-    :return: `True` if all images were exported successfully or `False` if there was an error
-    """
-
-    all_exported_successfully = True
-
-    for path, subdirs, files in os.walk(selected_dir):
-        for name in files:
-            if is_image(name):
-                # export and check if everything went okay
-                exported_successfully = export_file(path, name, width, height, export_type, overwrite)
-                if not exported_successfully:
-                    all_exported_successfully = False
-
-                # update the progress bar
-                if progress_bar_callback is not None:
-                    progress_bar_callback()
-
-    return all_exported_successfully
+class HelpingMethods(object):
+    @staticmethod
+    def is_image(filename):
+        """
+        Checks if a filename is an image (png, jpg or jpeg, case insensitive)
+
+        :param filename: The filename (as a string)
+        :return: `True` if the given filename is an image, or `False` if it's not
+        """
+
+        file = filename.lower()
+        return file.endswith(".png") or file.endswith(".jpg") or file.endswith(".jpeg")
+
+    @staticmethod
+    def get_filename_with_type(filename, file_type, suffix=""):
+        """
+        Get a filename and return it with the given suffix and the correct file extension for the given type
+
+        :param filename: The filename (e.g. "image_file.jpg")
+        :param file_type: The file type (e.g. "PNG")
+        :param suffix: An optional string to place between the name and the extension of the file (default is "")
+        :return: the filename with the correct extension for the given type (e.g. "image_file.png")
+        """
+
+        extension = filename.split(".")[-1]
+        return filename[:-(len(extension) + 1)] + suffix + "." + file_type.lower()
+
+
+class ImgEdit(object):
+    def export_file(self, path, name, width, height, export_type, overwrite):
+        """
+        Open, resize and save an image with the given properties
+
+        :param path: The path to the directory where the image is located (without the image filename)
+        :param name: The filename of the image we want to export
+        :param width: The new width we want to resize to
+        :param height: The new height we want to resize to
+        :param export_type: The file type we want to save to (we ignore it if `overwrite` is `True`)
+        :param overwrite: Whether we want to overwrite the original files or not
+        """
+
+        img_path = os.path.join(path, name)
+
+        # set the destination image file we want to save
+        dest_img_name = HelpingMethods.get_filename_with_type(name, export_type, "_resize")
+        if overwrite:
+            dest_img_name = name
+
+        try:
+            # open the given image, resize and save it
+            img = PIL.Image.open(img_path)
+            img = img.resize((width, height), PIL.Image.ANTIALIAS)
+            img.save(os.path.join(path, dest_img_name))
+        except IOError:
+            return False
+
+        return True
+
+    def export_all_in_dir(self, selected_dir, width, height, export_type, overwrite, q):
+        """
+        Export all the images in the selected directory
+
+        When `self.init_export()` is called, everything is ready to resize and export images
+        This loops through all the files in the given directory and calls `self.export_file()`
+        for the actual opening, resizing and saving of the files
+
+        :param selected_dir: The path to the directory containing all the images to resize
+        :param width: The new width we want to resize to
+        :param height: The new height we want to resize to
+        :param export_type: The file type we want to save to (we ignore it if `overwrite` is `True`)
+        :param overwrite: Whether we want to overwrite the original files or not
+        :return: `True` if all images were exported successfully or `False` if there was an error
+        """
+
+        # reset default values
+        self.num_of_exported_images = 0
+        self.num_of_images_to_export = None
+
+        # loop through all the files in the given directory and store the
+        # path and the filename of image files in a list
+        images = []
+        for path, subdirs, files in os.walk(selected_dir):
+            for name in files:
+                if HelpingMethods.is_image(name):
+                    images.append({
+                        "path": path,
+                        "name": name
+                    })
+        self.num_of_images_to_export = len(images)
+
+        # loop through the images list to open, resize and save them
+        all_exported_successfully = True
+        for img in images:
+            # export and check if everything went okay
+            exported_successfully = self.export_file(img["path"], img["name"], width, height, export_type, overwrite)
+            if not exported_successfully:
+                all_exported_successfully = False
+
+            self.num_of_exported_images += 1
+
+        q.put(all_exported_successfully)
+
+    def __init__(self):
+        self.num_of_exported_images = 0
+        self.num_of_images_to_export = None
