Fixed history, interal updates

Author: kins-dev

.vscode/settings.json

@@ -34,5 +34,6 @@
     "esbonio.sphinx.confDir": "${workspaceFolder}/docs",
     "python.linting.pylintEnabled": true,
     "python.linting.enabled": true,
-    "python.linting.flake8Enabled": false
+    "python.linting.flake8Enabled": false,
+    "pre-commit-helper.runOnSave": "fixes"
 }

HISTORY.rst

@@ -2,6 +2,17 @@
 History
 =======
 
+1.2.1 (2022-04-26)
+------------------
+
+* Fixed history
+* Callback class to make life easier internally
+
+1.2.0 (2022-04-21)
+------------------
+
+* Added overwrite handling in the GUI
+
 1.1.1 (2022-04-18)
 ------------------
 

docs/rpgmaker_mv_decoder.rst

@@ -4,6 +4,14 @@ rpgmaker\_mv\_decoder package
 Submodules
 ----------
 
+rpgmaker\_mv\_decoder.callback module
+-------------------------------------
+
+.. automodule:: rpgmaker_mv_decoder.callback
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 rpgmaker\_mv\_decoder.exceptions module
 ---------------------------------------
 

gui.py

@@ -13,6 +13,7 @@
 
 import rpgmaker_mv_decoder
 from icon_data import ABOUT_ICON, TITLE_BAR_ICON
+from rpgmaker_mv_decoder.callback import Callback
 from rpgmaker_mv_decoder.exceptions import NoValidFilesFound
 from rpgmaker_mv_decoder.utils import decode_files, encode_files, guess_at_key
 
@@ -244,7 +245,7 @@ def __init__(self, master=None):
         self.window.title(f"RPGMaker MV Decoder / Encoder v{rpgmaker_mv_decoder.__version__}")
         self.window.configure(height="200", padx="10", pady="5", width="500")
         self.window.resizable(0, 0)
-        self.dialog = _ProgressUI(self.window)
+        self.progress = _ProgressUI(self.window)
         self.about = _AboutUI(self.window)
 
         # Main widget
@@ -253,6 +254,7 @@ def __init__(self, master=None):
         self.src_path = ""
         self.dst_path = ""
         self.gui_key = ""
+        self.callbacks = Callback(self.progress.set_progress, self._overwrite_cb)
 
     def _build_frame_act(self):
         self.frame_action = ttk.Frame(self.window)
@@ -369,20 +371,20 @@ def _show_about(self):
 
     def _show_dialog(self, title: str, text: str):
         self.dialog_shown = True
-        if self.dialog is None:
-            self.dialog = _ProgressUI(self.window)
-            self.dialog.set_title(title)
-            self.dialog.set_label(text)
-            self.dialog.run()
+        if self.progress is None:
+            self.progress = _ProgressUI(self.window)
+            self.progress.set_title(title)
+            self.progress.set_label(text)
+            self.progress.run()
         else:
-            self.dialog.set_title(title)
-            self.dialog.set_label(text)
-            self.dialog.show()
+            self.progress.set_title(title)
+            self.progress.set_label(text)
+            self.progress.show()
 
     def _hide_dialog(self):
-        if self.dialog is not None:
+        if self.progress is not None:
             if self.dialog_shown:
-                self.dialog.close()
+                self.progress.close()
         self.dialog_shown = False
 
     def _validate_text(self, new_text: str) -> bool:
@@ -410,7 +412,7 @@ def _show_dialog():
 
             threading.Thread(target=_show_dialog).start()
             try:
-                self.gui_key = guess_at_key(self.src_path, self.dialog.set_progress)
+                self.gui_key = guess_at_key(self.src_path, self.callbacks)
                 self.entry_key.delete(0, tk.END)
                 self.entry_key.insert(0, self.gui_key)
             except NoValidFilesFound:
@@ -439,8 +441,7 @@ def _decode_files():
                 self.dst_path,
                 self.entry_key.get(),
                 self.detect_file_ext.get() == "1",
-                self.dialog.set_progress,
-                self._overwrite_cb,
+                self.callbacks,
             )
             self._hide_dialog()
             self._set_button_state()
@@ -459,8 +460,7 @@ def _encode_files():
                 self.src_path,
                 self.dst_path,
                 self.entry_key.get(),
-                self.dialog.set_progress,
-                self._overwrite_cb,
+                self.callbacks,
             )
             self._hide_dialog()
             self._set_button_state()

rpgmaker_mv_decoder/callback.py

@@ -0,0 +1,65 @@
+"""`callback` module
+
+Used to handle callbacks in a single object rather than multiple parameters
+"""
+from typing import Callable
+
+from click._termui_impl import ProgressBar
+
+
+def _default_progressbar_callback(_: ProgressBar) -> bool:
+    return False
+
+
+def _default_overwrite_callback(_: str) -> bool:
+    return True
+
+
+def _default_error_callback(_: str) -> bool:
+    return False
+
+
+class Callback:
+    """`Callback` encapsulates all the callbacks that might be used during execution"""
+
+    def __init__(
+        self,
+        progressbar_callback: Callable[[ProgressBar], bool] = _default_progressbar_callback,
+        overwrite_callback: Callable[[str], bool] = _default_overwrite_callback,
+        error_callback: Callable[[str], bool] = _default_error_callback,
+    ):
+        self._progressbar_callback = progressbar_callback
+        self._overwrite_callback = overwrite_callback
+        self._error_callback = error_callback
+
+    @property
+    def progressbar(self):
+        """`progressbar` callback for updating the progress of the operation
+
+        Returns:
+        - `Callable[[ProgressBar], bool]`: Function to call. Progress data should \
+          be specified via the parameter. If the user cancels the operation, this \
+          should return `True`
+        """
+        return self._progressbar_callback
+
+    @property
+    def overwrite(self):
+        """`overwrite` callback executed when a file is about to be overwitten
+
+        Returns:
+        - `Callable[[str], bool]`: Function to call. Path to overwite should be specified \
+          as the string. If the function returns `True` the file should be overwritten. If the \
+          user cancels the operation this function should return None
+        """
+        return self._overwrite_callback
+
+    @property
+    def error(self):
+        """`error` callback executed when an error occurs
+
+        Returns:
+        - `Callable[[str], bool]`: Function to call. Error message should be specified via \
+          the parameter. If the user cancels the operation, this should return `True`
+        """
+        return self._error_callback

rpgmaker_mv_decoder/utils.py

@@ -6,14 +6,14 @@
 from binascii import crc32
 from pathlib import Path, PurePath
 from time import sleep
-from tkinter.ttk import Progressbar
 from typing import Callable, Dict, List, Tuple
 from uuid import UUID, uuid4
 
 import click
 import magic
 from click._termui_impl import ProgressBar
 
+from rpgmaker_mv_decoder.callback import Callback
 from rpgmaker_mv_decoder.exceptions import (
     FileFormatError,
     NoValidFilesFound,
@@ -151,17 +151,16 @@ def __get_likely_key(keys: Dict[str, int], count) -> str:
     return main_key
 
 
-def guess_at_key(src: Path, pb_cb: Callable[[Progressbar], bool] = None) -> str:
+def guess_at_key(src: Path, callbacks: Callback = Callback()) -> str:
     """`guess_at_key` Check the path for PNG images and return the decoding key
 
     Finds image files under the specified path and looks for a key to decode all the files.
     This can fail if only a small number (less than 3) of the .rpgmvp files are .png images.
 
     Args:
     - `src` (`Path`): Path to search for .rpgmvp files
-    - `pb_cb` (`Callable[[click._termui_impl.Progressbar], bool]`, optional): Callback to\
-    display current progress. Call with `None` when bar is complete. Returns `True` if the\
-    user has canceled the operation. Defaults to `None`.
+    - `callbacks` (`Callback`, optional): Callbacks to use for the UI. Defaults to an empty\
+      set of callbacks
 
     Raises:
     - `NoValidFilesFound`: If no valid PNG images are found
@@ -174,9 +173,8 @@ def guess_at_key(src: Path, pb_cb: Callable[[Progressbar], bool] = None) -> str:
     keys: Dict[str, int] = {}
     count: int
     with click.progressbar(files, label="Finding key") as all_files:
-        count = _handle_files(pb_cb, keys, all_files)
-    if pb_cb is not None:
-        pb_cb(None)
+        count = _handle_files(callbacks.progressbar, keys, all_files)
+    callbacks.progressbar(None)
 
     if count == 0:
         raise NoValidFilesFound(f"No png files found under: '{Path}'")
@@ -290,14 +288,12 @@ def get_file_ext(data: bytes) -> str:
     return "." + filetype.split("/")[-1]
 
 
-# pylint: disable=too-many-arguments
 def decode_files(
     src: str,
     dst: str,
     key: str,
     detect_type: bool,
-    pb_cb: Callable[[Progressbar], bool] = None,
-    overwrite_callback: Callable[[str], bool] = None,
+    callbacks: Callback = Callback(),
 ) -> None:
     """`decode_files` Decodes the files
 
@@ -308,12 +304,8 @@ def decode_files(
     - `dst` (`str`): Destination directory for output
     - `key` (`str`): Key to use for decoding
     - `detect_type` (`bool`): If file extensions should be detected from the file contents
-    - `pb_cb` (`Callable[[click._termui_impl.Progressbar], bool]`, optional): Callback to\
-    display current progress. Call with `None` when bar is complete. Returns `True` if the\
-    user has canceled the operation. Defaults to `None`.
-    - `overwrite_callback` (`Callable[[str], bool`, optional): Callback to use if files are\
-    about to be overwritten. Call with the filename in question. `None` indicates user has\
-    canceled the operation. Returns if the file should be overwritten. Defaults to `None`.
+    - `callbacks` (`Callback`, optional): Callbacks to use for the UI. Defaults to an empty\
+      set of callbacks
     """
     # pylint: disable=too-many-locals
     source_dir = Path(src).resolve()
@@ -328,7 +320,7 @@ def decode_files(
     with click.progressbar(files, label="Decoding files") as all_files:
         filename: Path
         for filename in all_files:
-            if pb_cb and pb_cb(all_files):
+            if callbacks.progressbar(all_files):
                 break
             output_file: PurePath = destination.joinpath(PurePath(filename).relative_to(source))
             result: bytes
@@ -352,18 +344,16 @@ def decode_files(
                     continue
             else:
                 output_file = _get_std_ext(output_file)
-            if not _save_file(output_file, result, overwrite_callback):
+            if not _save_file(output_file, result, callbacks.overwrite):
                 break
-    if pb_cb:
-        pb_cb(None)
+    callbacks.progressbar(None)
 
 
 def encode_files(
     src: str,
     dst: str,
     key: str,
-    pb_cb: Callable[[Progressbar], bool] = None,
-    overwrite_callback: Callable[[str], bool] = None,
+    callbacks: Callback = Callback(),
 ) -> None:
     """`encode_files` Encodes the files
 
@@ -373,12 +363,8 @@ def encode_files(
     - `src` (`str`): Source directory to search
     - `dst` (`str`): Destination directory for output
     - `key` (`str`): Key to use for encoding
-    - `pb_cb` (`Callable[[click._termui_impl.Progressbar], bool]`, optional): Callback to\
-    display current progress. Call with `None` when bar is complete. Returns `True` if the\
-    user has canceled the operation. Defaults to `None`.
-    - `overwrite_callback` (`Callable[[str], bool`, optional): Callback to use if files are\
-    about to be overwritten. Call with the filename in question. `None` indicates user has\
-    canceled the operation. Returns if the file should be overwritten. Defaults to `None`.
+    - `callbacks` (`Callback`, optional): Callbacks to use for the UI. Defaults to an empty\
+      set of callbacks
     """
     # pylint: disable=too-many-locals
     source_dir = Path(src).resolve()
@@ -393,9 +379,8 @@ def encode_files(
     with click.progressbar(files, label="Encoding files") as all_files:
         filename: Path
         for filename in all_files:
-            if pb_cb is not None:
-                if pb_cb(all_files):
-                    break
+            if callbacks.progress(all_files):
+                break
             output_file: PurePath = destination.joinpath(PurePath(filename).relative_to(source))
             filetype: str
             with click.open_file(filename, "rb") as file:
@@ -408,10 +393,9 @@ def encode_files(
                 output_file = output_file.with_suffix(".rpgmvp")
             elif filetype.startswith("audio"):
                 output_file = output_file.with_suffix(".rpgmvp")
-            if not _save_file(output_file, data, overwrite_callback):
+            if not _save_file(output_file, data, callbacks.overwrite):
                 break
-    if pb_cb is not None:
-        pb_cb(None)
+    callbacks.progressbar(None)
 
 
 def _get_std_ext(output_file):