Refactor set_out_file() logic

Author: john-liu2

batch_img/border.py

@@ -40,10 +40,7 @@ def border_1_image(
                 bd_img = Image.new(img.mode, (width, height), bd_color)
                 bd_img.paste(cropped_img, (bd_width, bd_width))
 
-                if out_path == REPLACE:
-                    file = Path(f"{in_path.parent}/{in_path.stem}_tmp{in_path.suffix}")
-                else:
-                    file = Common.set_out_file(in_path, out_path, f"bw{bd_width}")
+                file = Common.set_out_file(in_path, out_path, f"bw{bd_width}")
                 if "exif" in img.info:
                     exif_dict = piexif.load(img.info["exif"])
                     exif_bytes = piexif.dump(exif_dict)
@@ -53,7 +50,7 @@ def border_1_image(
             logger.info(f"Saved image with border to {file}")
             if out_path == REPLACE:
                 os.replace(file, in_path)
-                logger.info(f"Replaced {in_path} with tmp_file")
+                logger.info(f"Replaced {in_path} with the new tmp_file")
                 file = in_path
             return True, file
         except (AttributeError, FileNotFoundError, ValueError) as e:

batch_img/common.py

@@ -334,6 +334,9 @@ def set_out_file(in_path: Path, out_path: Path, extra: str) -> Path:
         Returns:
             Path:
         """
+        if out_path == REPLACE:
+            out_file = Path(f"{in_path.parent}/{in_path.stem}_tmp{in_path.suffix}")
+            return out_file
         out_path.mkdir(parents=True, exist_ok=True)
         out_file = out_path
         if out_path.is_dir():

batch_img/resize.py

@@ -34,11 +34,8 @@ def resize_an_image(in_path: Path, out_path: Path | str, length: int) -> tuple:
                 max_size = (length, length)
                 # The thumbnail() keeps the original aspect ratio
                 img.thumbnail(max_size, Image.Resampling.LANCZOS)
-                if out_path == REPLACE:
-                    file = Path(f"{in_path.parent}/{in_path.stem}_tmp{in_path.suffix}")
-                else:
-                    file = Common.set_out_file(in_path, out_path, f"{length}")
 
+                file = Common.set_out_file(in_path, out_path, f"{length}")
                 if "exif" in img.info:
                     exif_dict = piexif.load(img.info["exif"])
                     exif_bytes = piexif.dump(exif_dict)
@@ -48,7 +45,7 @@ def resize_an_image(in_path: Path, out_path: Path | str, length: int) -> tuple:
             logger.info(f"Saved resized image to {file}")
             if out_path == REPLACE:
                 os.replace(file, in_path)
-                logger.info(f"Replaced {in_path} with tmp_file")
+                logger.info(f"Replaced {in_path} with the new tmp_file")
                 file = in_path
             return True, file
         except (AttributeError, FileNotFoundError, ValueError) as e:

batch_img/rotate.py

@@ -39,10 +39,7 @@ def rotate_1_image(in_path: Path, out_path: Path | str, angle_cw: int) -> tuple:
                 exif_dict["0th"][piexif.ImageIFD.Orientation] = 1
                 exif_bytes = piexif.dump(exif_dict)
 
-                if out_path == REPLACE:
-                    file = Path(f"{in_path.parent}/{in_path.stem}_tmp{in_path.suffix}")
-                else:
-                    file = Common.set_out_file(in_path, out_path, f"{angle_cw}cw")
+                file = Common.set_out_file(in_path, out_path, f"{angle_cw}cw")
                 # img.rotate() for any angle (slower & slight quality loss)
                 rotated_img = img
                 if angle_cw == 90:
@@ -56,7 +53,7 @@ def rotate_1_image(in_path: Path, out_path: Path | str, angle_cw: int) -> tuple:
             logger.info(f"Saved ({angle_cw}°) clockwise rotated to {file}")
             if out_path == REPLACE:
                 os.replace(file, in_path)
-                logger.info(f"Replaced {in_path} with tmp_file")
+                logger.info(f"Replaced {in_path} with the new tmp_file")
                 file = in_path
             return True, file
         except (AttributeError, FileNotFoundError, ValueError) as e:

tests/test_common.py

@@ -12,7 +12,7 @@
 import requests
 
 from batch_img.common import Common
-from batch_img.const import NAME, PKG_NAME, VER
+from batch_img.const import PKG_NAME, REPLACE
 from .helper import DotDict
 
 
@@ -299,3 +299,29 @@ def test_get_crop_box(data_get_crop_box):
     width, height, border_width, expected = data_get_crop_box
     actual = Common.get_crop_box(width, height, border_width)
     assert actual == expected
+
+
+@pytest.fixture(
+    params=[
+        (
+            Path(f"{dirname(__file__)}/data/HEIC/Cartoon.heic"),
+            Path(f"{dirname(__file__)}/.out/"),
+            "90cw",
+            Path(f"{dirname(__file__)}/.out/Cartoon_90cw.heic"),
+        ),
+        (
+            Path(f"{dirname(__file__)}/data/HEIC/Cartoon.heic"),
+            REPLACE,
+            "90cw",
+            Path(f"{dirname(__file__)}/data/HEIC/Cartoon_tmp.heic"),
+        ),
+    ]
+)
+def data_set_out_file(request):
+    return request.param
+
+
+def test_set_out_file(data_set_out_file):
+    in_path, out_path, extra, expected = data_set_out_file
+    actual = Common.set_out_file(in_path, out_path, extra)
+    assert actual == expected