Ability to recover window

Fixed regressions:
Fix crash on clising window mid-run
Forgot to migrate split_delay to image.delay
Removed dead load_pyqt_settings code
Fixed dummy groups
Pause time from filename not set correctly
Setting hotkeys on load

Author: Avasam

.flake8

@@ -12,6 +12,7 @@ per-file-ignores=
     __init__.pyi:Q000
 ; PyQt methods
 ignore-names=closeEvent,paintEvent,keyPressEvent,mousePressEvent,mouseMoveEvent,mouseReleaseEvent
-; TODO: Bring down to 15, same as SonarLint
-max-complexity=55
+; McCabe max-complexity is also taken care of by Pylint and doesn't fail teh build there
+; So this is the hard limit
+max-complexity=32
 inline-quotes="

pyproject.toml

@@ -18,6 +18,7 @@ typeCheckingMode = "strict"
 ignore = [
   # Auto generated
   "src/gen/",
+  # We expect stub files to be incomplete or contain useless statements as they're external
   "typings/",
 ]
 reportMissingTypeStubs = "information"
@@ -36,7 +37,7 @@ reportUnknownMemberType = "none"
 # https://pylint.pycqa.org/en/latest/technical_reference/features.html
 [tool.pylint.REPORTS]
 # Just like default but any error will make drop to 9 or less
-evaluation = "10.0 - error - ((float(warning + refactor + convention) / statement) * 10)"
+evaluation = "10.0 - error - ((float(warning * 10 + refactor + convention) / statement) * 10)"
 [tool.pylint.MASTER]
 fail-under = 9.0
 # https://pylint.pycqa.org/en/latest/technical_reference/extensions.html
@@ -65,10 +66,10 @@ load-plugins = [
   # "pylint.extensions.for_any_all",
 ]
 ignore-paths = [
-  # Haven't looked into disabling specific rules per file
-  "^typings/.*$",
   # Auto generated
   "^src/gen/.*$",
+  # We expect stub files to be incomplete or contain useless statements as they're external
+  "^typings/.*$",
 ]
 # No need to mention the fixmes
 disable = ["fixme"]

scripts/lint.ps1

@@ -6,18 +6,39 @@ $exitCodes = 0
 Write-Host "`nRunning Pyright..."
 pyright --warnings
 $exitCodes += $LastExitCode
+if ($LastExitCode -gt 0) {
+  Write-Host "`Pyright failed ($LastExitCode)" -ForegroundColor Red
+} else {
+  Write-Host "`Pyright passed" -ForegroundColor Green
+}
 
 Write-Host "`nRunning Pylint..."
 pylint --score=n --output-format=colorized $(git ls-files '**/*.py*')
 $exitCodes += $LastExitCode
+if ($LastExitCode -gt 0) {
+  Write-Host "`Pylint failed ($LastExitCode)" -ForegroundColor Red
+} else {
+  Write-Host "`Pylint passed" -ForegroundColor Green
+}
 
 Write-Host "`nRunning Flake8..."
 flake8
 $exitCodes += $LastExitCode
+if ($LastExitCode -gt 0) {
+  Write-Host "`Flake8 failed ($LastExitCode)" -ForegroundColor Red
+} else {
+  Write-Host "`Flake8 passed" -ForegroundColor Green
+}
 
 Write-Host "`nRunning Bandit..."
 bandit -f custom --silent --recursive src
 # $exitCodes += $LastExitCode # Returns 1 on low
+if ($LastExitCode -gt 0) {
+  Write-Host "`Bandit warning ($LastExitCode)" -ForegroundColor Yellow
+} else {
+  Write-Host "`Bandit passed" -ForegroundColor Green
+}
+
 
 if ($exitCodes -gt 0) {
   Write-Host "`nLinting failed ($exitCodes)" -ForegroundColor Red

src/AutoSplit.py

@@ -98,6 +98,7 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow):
     split_image_directory = ""
     hwnd = 0
     """Window Handle used for Capture Region"""
+    window_text = ""
     selection = Rect()
     last_saved_settings: list[Union[str, float, int, bool]] = []
     save_settings_file_path = ""
@@ -116,13 +117,11 @@ class AutoSplit(QMainWindow, design.Ui_MainWindow):
     check_start_image_timestamp = 0.0
 
     # Define all other attributes
-    setting_check_for_updates_on_open: QtCore.QSettings
     start_image_split_below_threshold: bool
     waiting_for_split_delay: bool
     split_below_threshold: bool
     run_start_time: float
     similarity: float
-    split_delay: float
     start_image: Optional[AutoSplitImage] = None
     reset_image: Optional[AutoSplitImage] = None
     split_images: list[AutoSplitImage] = []
@@ -138,7 +137,7 @@ def __init__(self, parent: Optional[QWidget] = None):
 
         self.setupUi(self)
 
-        settings.load_pyqt_settings(self)
+        settings.load_check_for_updates_on_open(self)
 
         # close all processes when closing window
         self.action_view_help.triggered.connect(view_help)
@@ -255,18 +254,17 @@ def check_live_image(self):
 
     def __live_image_function(self):
         try:
-            window_text = win32gui.GetWindowText(self.hwnd)
-            self.capture_region_window_label.setText(window_text)
-            if not window_text:
+            self.capture_region_window_label.setText(self.window_text)
+            if not self.window_text:
                 self.timer_live_image.stop()
                 self.live_image.clear()
                 if self.live_image_function_on_open:
                     self.live_image_function_on_open = False
                 return
-
             # Set live image in UI
-            capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked())
-            set_ui_image(self.live_image, capture, False)
+            if self.hwnd:
+                capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked())
+                set_ui_image(self.live_image, capture, False)
 
         except AttributeError:
             pass
@@ -376,7 +374,7 @@ def __start_image_function(self):
             self.start_image_label.setText(f"{START_IMAGE_TEXT}: started")
             send_command(self, "start")
             # Email sent to [email protected]
-            QtTest.QTest.qWait(1 / self.fps_limit_spinbox.value())  # type: ignore
+            QtTest.QTest.qWait(int(1 / self.fps_limit_spinbox.value()))  # type: ignore
             self.start_auto_splitter()
 
     # update x, y, width, height when spinbox values are changed
@@ -554,10 +552,10 @@ def __auto_splitter(self):
             current_group: list[int] = []
             self.split_groups.append(current_group)
 
-            for i, image in enumerate(self.split_images):
+            for i, image in enumerate(self.split_images_and_loop_number):
                 current_group.append(i)
 
-                if not image.check_flag(DUMMY_FLAG) and i < len(self.split_images) - 1:
+                if not image[0].check_flag(DUMMY_FLAG) and i < len(self.split_images_and_loop_number) - 1:
                     current_group = []
                     self.split_groups.append(current_group)
         self.gui_changes_on_start()
@@ -654,16 +652,16 @@ def __auto_splitter(self):
             if not self.split_image.check_flag(DUMMY_FLAG):
                 # If it's a delayed split, check if the delay has passed
                 # Otherwise calculate the split time for the key press
-                if self.split_delay > 0 and not self.waiting_for_split_delay:
-                    split_time = int(round(time() * 1000) + self.split_delay)
+                split_delay = self.split_image.delay / 1000
+                if split_delay > 0 and not self.waiting_for_split_delay:
+                    split_time = round(time() + split_delay * 1000)
                     self.waiting_for_split_delay = True
                     self.undo_split_button.setEnabled(False)
                     self.skip_split_button.setEnabled(False)
                     self.current_split_image_file_label.setText(" ")
 
                     # check for reset while delayed and display a counter of the remaining split delay time
                     delay_start_time = time()
-                    split_delay = self.split_delay / 1000
                     while time() - delay_start_time < split_delay:
                         delay_time_left = round(split_delay - (time() - delay_start_time), 1)
                         self.current_split_image.setText(f"Delayed Split: {delay_time_left} sec remaining")
@@ -711,8 +709,6 @@ def __auto_splitter(self):
             # Also updates the current split image text, counting down the time until the next split image
             pause_time = self.split_image.get_pause_time(self)
             if pause_time > 0:
-                self.current_split_image_file_label.setText(" ")
-                self.image_loop_label.setText("Image Loop: -")
                 pause_start_time = time()
                 while time() - pause_start_time < pause_time:
                     pause_time_left = round(pause_time - (time() - pause_start_time), 1)
@@ -788,6 +784,17 @@ def __get_capture_for_comparison(self):
         Grab capture region and resize for comparison
         """
         capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked())
+
+        # This most likely means we lost capture (ie the captured window was closed, crashed, etc.)
+        if capture is None:
+            # Try to recover by using the window name
+            self.live_image.setText("Trying to recover window...")
+            # https://github.com/kaluluosi/pywin32-stubs/issues/7
+            hwnd = win32gui.FindWindow(None, self.window_text)  # type: ignore
+            # Don't fallback to desktop
+            if hwnd:
+                self.hwnd = hwnd
+                capture = capture_region(self.hwnd, self.selection, self.force_print_window_checkbox.isChecked())
         return None if capture is None else cv2.resize(capture, COMPARISON_RESIZE, interpolation=cv2.INTER_NEAREST)
 
     def __reset_if_should(self, capture: Optional[cv2.ndarray]):
@@ -872,7 +879,7 @@ def exit_program():
 
             if warning is QMessageBox.StandardButton.Yes:
                 # TODO: Don't close if user cancelled the save
-                self.save_settings_as()
+                settings.save_settings_as(self)
                 exit_program()
             if warning is QMessageBox.StandardButton.No:
                 exit_program()
@@ -902,7 +909,6 @@ def main():
         if FROZEN:
             error_messages.exception_traceback(message, exception)
         else:
-            print(message)
             traceback.print_exception(type(exception), exception, exception.__traceback__)
         sys.exit(1)
 

src/AutoSplitImage.py

@@ -36,7 +36,7 @@ class AutoSplitImage():
     mask: Optional[cv2.ndarray] = None
     # This value is internal, check for mask instead
     _has_transparency: bool
-    # These values should be overriden by defaults if null, use getters instead
+    # These values should be overriden by Defaults if None. Use getters instead
     __pause_time: Optional[float] = None
     __similarity_threshold: Optional[float] = None
 
@@ -64,7 +64,7 @@ def __init__(self, path: str):
         self.flags = flags_from_filename(self.filename)
         self.loops = loop_from_filename(self.filename)
         self.delay = delay_from_filename(self.filename)
-        self._pause_time = pause_from_filename(self.filename)
+        self.__pause_time = pause_from_filename(self.filename)
         self.__similarity_threshold = threshold_from_filename(self.filename)
         self.__read_image_bytes(path)
 

src/capture_windows.py

@@ -3,7 +3,6 @@
 
 import ctypes
 import ctypes.wintypes
-import platform
 from dataclasses import dataclass
 from PyQt6 import QtCore, QtGui
 from PyQt6.QtWidgets import QLabel
@@ -13,26 +12,25 @@
 import win32con
 import win32ui
 import pywintypes
-from packaging import version
 from win32 import win32gui
 from win32typing import PyCBitmap, PyCDC
 
 # This is an undocumented nFlag value for PrintWindow
 PW_RENDERFULLCONTENT = 0x00000002
-accelerated_windows: dict[int, bool] = {}
-is_windows_11 = version.parse(platform.version()) >= version.parse("10.0.22000")
 
 
-# ctypes.wintypes.RECT has c_long which doesn't have math operators implemented
 @dataclass
 class Rect(ctypes.wintypes.RECT):
+    """
+    Overrides `ctypes.wintypes.RECT` to replace c_long with int for math operators
+    """
     left: int = -1  # type: ignore
     top: int = -1  # type: ignore
     right: int = -1  # type: ignore
     bottom: int = -1  # type: ignore
 
 
-def capture_region(hwnd: int, selection: Rect, force_print_window: bool):
+def capture_region(hwnd: int, selection: Rect, print_window: bool):
     """
     Captures an image of the region for a window matching the given
     parameters of the bounding box
@@ -42,26 +40,6 @@ def capture_region(hwnd: int, selection: Rect, force_print_window: bool):
     @return: The image of the region in the window in BGRA format
     """
 
-    # Windows 11 has some jank, and we're not ready to fully investigate it
-    # for now let's ensure it works at the cost of performance
-    is_accelerated_window = force_print_window or is_windows_11 or accelerated_windows.get(hwnd)
-
-    # The window type is not yet known, let's find out!
-    if is_accelerated_window is None:
-        # We need to get the image at least once to check if it's full black
-        image = __get_capture_image(hwnd, selection, False)
-        # TODO check for first non-black pixel, no need to iterate through the whole image
-        is_accelerated_window = not np.count_nonzero(image)
-        accelerated_windows[hwnd] = is_accelerated_window
-        if is_accelerated_window:
-            image = __get_capture_image(hwnd, selection, True)
-    else:
-        image = __get_capture_image(hwnd, selection, is_accelerated_window)
-
-    return None if image.size == 0 else image
-
-
-def __get_capture_image(hwnd: int, selection: Rect, print_window: bool = False):
     width: int = selection.right - selection.left
     height: int = selection.bottom - selection.top
     # If the window closes while it's being manipulated, it could cause a crash
@@ -82,7 +60,7 @@ def __get_capture_image(hwnd: int, selection: Rect, print_window: bool = False):
     # https://github.com/kaluluosi/pywin32-stubs/issues/5
     # pylint: disable=no-member
     except (win32ui.error, pywintypes.error):  # type: ignore
-        return np.array([0, 0, 0, 1], dtype="uint8")
+        return None
 
     image = np.frombuffer(cast(bytes, bitmap.GetBitmapBits(True)), dtype="uint8")
     image.shape = (height, width, 4)
@@ -101,7 +79,9 @@ def __get_capture_image(hwnd: int, selection: Rect, print_window: bool = False):
 
 def set_ui_image(qlabel: QLabel, image: Optional[cv2.ndarray], transparency: bool):
     if image is None:
-        qlabel.clear()
+        # Clear current pixmap if image is None. But don't clear text
+        if not qlabel.text():
+            qlabel.clear()
     else:
         if transparency:
             color_code = cv2.COLOR_BGRA2RGBA