Fix issues with saving and reading images w/ non-english filepaths

Author: Avasam

pyproject.toml

@@ -126,6 +126,14 @@ max-args = 7
 # At least same as max-complexity
 max-branches = 15
 
+[tool.ruff.lint.flake8-tidy-imports.banned-api]
+"cv2.imread".msg = """\
+it doesn't support special characters. Use `utils.imread` instead.
+https://github.com/opencv/opencv/issues/4292#issuecomment-2266019697"""
+"cv2.imwrite".msg = """\
+it doesn't support special characters. . Use `utils.imwrite` instead.
+https://github.com/opencv/opencv/issues/4292#issuecomment-2266019697"""
+
 # https://github.com/hhatto/autopep8#usage
 # https://github.com/hhatto/autopep8#more-advanced-usage
 [tool.autopep8]

src/AutoSplit.py

@@ -64,6 +64,7 @@
     auto_split_directory,
     decimal,
     flatten,
+    imwrite,
     is_valid_image,
     open_file,
 )
@@ -429,7 +430,7 @@ def __take_screenshot(self):
             return
 
         # Save and open image
-        cv2.imwrite(screenshot_path, capture)
+        imwrite(screenshot_path, capture)
         if self.settings_dict["open_screenshot"]:
             open_file(screenshot_path)
 

src/AutoSplitImage.py

@@ -10,7 +10,7 @@
 
 import error_messages
 from compare import check_if_image_has_transparency, extract_and_compare_text, get_comparison_method_by_index
-from utils import BGR_CHANNEL_COUNT, MAXBYTE, TESSERACT_PATH, ColorChannel, ImageShape, is_valid_image
+from utils import BGR_CHANNEL_COUNT, MAXBYTE, TESSERACT_PATH, ColorChannel, ImageShape, imread, is_valid_image
 
 if TYPE_CHECKING:
     from AutoSplit import AutoSplit
@@ -142,7 +142,7 @@ def __validate_ocr(self):
         )
 
     def __read_image_bytes(self, path: str):
-        image = cv2.imread(path, cv2.IMREAD_UNCHANGED)
+        image = imread(path, cv2.IMREAD_UNCHANGED)
         if not is_valid_image(image):
             self.byte_array = None
             error_messages.image_type(path)

src/region_selection.py

@@ -18,6 +18,7 @@
     ImageShape,
     auto_split_directory,
     get_window_bounds,
+    imread,
     is_valid_hwnd,
     is_valid_image,
 )
@@ -211,7 +212,7 @@ def align_region(autosplit: "AutoSplit"):
     if not template_filename:
         return
 
-    template = cv2.imread(template_filename, cv2.IMREAD_UNCHANGED)
+    template = imread(template_filename, cv2.IMREAD_UNCHANGED)
     # Add alpha channel to template if it's missing.
     if template.shape[ImageShape.Channels] == BGR_CHANNEL_COUNT:
         template = cv2.cvtColor(template, cv2.COLOR_BGR2BGRA)

src/utils.py

@@ -3,14 +3,16 @@
 import shutil
 import subprocess  # noqa: S404
 import sys
-from collections.abc import Callable, Iterable
+from collections.abc import Callable, Iterable, Sequence
 from enum import IntEnum
 from functools import partial
 from itertools import chain
 from platform import version
 from threading import Thread
 from typing import TYPE_CHECKING, Any, TypeAlias, TypedDict, TypeGuard, TypeVar
 
+import cv2
+import numpy as np
 from cv2.typing import MatLike
 
 from gen.build_vars import AUTOSPLIT_BUILD_NUMBER, AUTOSPLIT_GITHUB_REPOSITORY
@@ -260,6 +262,17 @@ def flatten(nested_iterable: Iterable[Iterable[T]]) -> chain[T]:
     return chain.from_iterable(nested_iterable)
 
 
+def imread(filename: str, flags: int = cv2.IMREAD_COLOR):
+    return cv2.imdecode(np.fromfile(filename, dtype=np.uint8), flags)
+
+
+def imwrite(filename: str, img: MatLike, params: Sequence[int] = ()):
+    success, encoded_img = cv2.imencode(os.path.splitext(filename)[1], img, params)
+    if not success:
+        raise OSError(f"cv2 could not write to path {filename}")
+    encoded_img.tofile(filename)
+
+
 def subprocess_kwargs():
     """
     Create a set of arguments which make a ``subprocess.Popen`` (and