Rename test data. Update common.py with tests

Author: john-liu2

README.md

@@ -1,6 +1,8 @@
 ## batch_img
 
 Batch processing image files by utilizing **[Pillow / PIL](https://github.com/python-pillow/Pillow)** library.
+Resize, rotate, add border or do default actions on a single image file or all image files in a folder.
+Tested these image file formats (**HEIC, JPG, PNG**) on macOS.
 
 ### Usage
 
@@ -43,11 +45,13 @@ Usage: batch_img border [OPTIONS] SRC_PATH
   Add border to image file(s)
 
 Options:
-  -bw, --border_width INTEGER  Add border to image file(s) with the
-                               border_width. 0 - no border  [default: 5]
-  -bc, --border_color TEXT     Add border to image file(s) with the
-                               border_color string  [default: gray]
-  --help                       Show this message and exit.
+  -bw, --border_width INTEGER RANGE
+                                  Add border to image file(s) with the
+                                  border_width. 0 - no border  [default: 5;
+                                  x>=0]
+  -bc, --border_color TEXT        Add border to image file(s) with the
+                                  border_color string  [default: gray]
+  --help                          Show this message and exit.
 ```
 
 #### The `defaults` sub-command CLI options:
@@ -72,9 +76,9 @@ Usage: batch_img resize [OPTIONS] SRC_PATH
   Resize image file(s)
 
 Options:
-  -l, --length INTEGER  Resize image file(s) on current aspect ratio to the
-                        length. 0 - no resize  [default: 0]
-  --help                Show this message and exit.
+  -l, --length INTEGER RANGE  Resize image file(s) on original aspect ratio to
+                              the length. 0 - no resize  [default: 0; x>=0]
+  --help                      Show this message and exit.
 ```
 
 #### The `rotate` sub-command CLI options:
@@ -86,7 +90,7 @@ Usage: batch_img rotate [OPTIONS] SRC_PATH
   Rotate image file(s)
 
 Options:
-  -d, --degree INTEGER  Rotate image file(s) to the degree clock-wise. 0 - no
-                        rotate  [default: 0]
-  --help                Show this message and exit.
+  -d, --degree INTEGER RANGE  Rotate image file(s) to the degree clock-wise. 0
+                              - no rotate  [default: 0; x>=0]
+  --help                      Show this message and exit.
 ```

batch_img/common.py

@@ -14,6 +14,7 @@
 import pillow_heif
 from loguru import logger
 from PIL import Image, ImageChops
+from PIL.TiffImagePlugin import IFDRational
 
 from batch_img.const import PKG_NAME, TS_FORMAT, VER
 
@@ -90,7 +91,9 @@ def decode_exif(exif_data: str) -> dict:
         exif_dict = piexif.load(exif_data)
         _dict = {}
         for ifd_name, val in exif_dict.items():
-            if not val:
+            # Canon EOS 5D Mark II 'thumbnail': : b'\xff\xd8\xff\xdb...
+            # 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte
+            if not val or ifd_name == "thumbnail":
                 continue
             for tag_id, value in val.items():
                 tag_name = piexif.TAGS[ifd_name].get(tag_id, {}).get("name", tag_id)
@@ -103,6 +106,7 @@ def decode_exif(exif_data: str) -> dict:
             "SubjectArea",
             "Software",
             "HostComputer",
+            "UserComment",
         ):
             if key in _dict:
                 _dict.pop(key)
@@ -128,7 +132,49 @@ def decode_exif(exif_data: str) -> dict:
         return _res
 
     @staticmethod
-    def are_images_equal(path1: Path | str, path2: Path | str) -> bool:
+    def get_image_data(file: Path) -> tuple:
+        """Get image file data
+
+        Args:
+            file: image file path
+
+        Returns:
+            tuple: data, info
+        """
+        size = getsize(file)
+        m_ts = datetime.fromtimestamp(getmtime(file)).strftime(TS_FORMAT)
+        with Image.open(file) as img:
+            data = img.convert("RGB")
+            d_info = {
+                "file_size": Common.readable_file_size(size),
+                "file_ts": m_ts,
+                "format": img.format,
+                "mode": img.mode,
+                "size": img.size,
+                "info": img.info,
+            }
+            for key in ("icc_profile", "xmp"):
+                if key in img.info:
+                    img.info.pop(key)
+            if "exif" in img.info:
+                exif_data = img.info.pop("exif")
+                d_info["exif"] = Common.decode_exif(exif_data)
+
+        return data, d_info
+
+    @staticmethod
+    def jsn_serial(obj):
+        """JSON serializer for objects not serializable by default json code"""
+        if isinstance(obj, IFDRational):
+            return float(obj)
+        if isinstance(obj, bytes):
+            return obj.decode()
+        raise TypeError(
+            f"Object of type {obj.__class__.__name__} is not JSON serializable"
+        )
+
+    @staticmethod
+    def are_images_equal(path1: Path, path2: Path) -> bool:
         """Check if two image files are visually equal pixel-wise
 
         Args:
@@ -138,36 +184,13 @@ def are_images_equal(path1: Path | str, path2: Path | str) -> bool:
         Returns:
             bool: True - visually equal, False - not visually equal
         """
-        size1 = getsize(path1)
-        m_ts1 = datetime.fromtimestamp(getmtime(path1)).strftime(TS_FORMAT)
-        with Image.open(path1) as img1:
-            data1 = img1.convert("RGB")
-            meta1 = {
-                "file_size": Common.readable_file_size(size1),
-                "file_ts": m_ts1,
-                "format": img1.format,
-                "size": img1.size,
-                "mode": img1.mode,
-                "info": img1.info,
-            }
-            if "exif" in img1.info:
-                meta1["info"] = Common.decode_exif(img1.info["exif"])
-
-        size2 = getsize(path2)
-        m_ts2 = datetime.fromtimestamp(getmtime(path2)).strftime(TS_FORMAT)
-        with Image.open(path2) as img2:
-            data2 = img2.convert("RGB")
-            meta2 = {
-                "file_size": Common.readable_file_size(size2),
-                "file_ts": m_ts2,
-                "format": img2.format,
-                "size": img2.size,
-                "mode": img2.mode,
-                "info": img2.info,
-            }
-            if "exif" in img2.info:
-                meta2["info"] = Common.decode_exif(img2.info["exif"])
-
-        logger.info(f"Meta of {path1}:\n{json.dumps(meta1, indent=2)}")
-        logger.info(f"Meta of {path2}:\n{json.dumps(meta2, indent=2)}")
+        data1, meta1 = Common.get_image_data(path1)
+        data2, meta2 = Common.get_image_data(path2)
+
+        logger.info(
+            f"{path1}:\n{json.dumps(meta1, indent=2, default=Common.jsn_serial)}"
+        )
+        logger.info(
+            f"{path2}:\n{json.dumps(meta2, indent=2, default=Common.jsn_serial)}"
+        )
         return ImageChops.difference(data1, data2).getbbox() is None

batch_img/interface.py

@@ -28,6 +28,7 @@ def cli(ctx, version):  # pragma: no cover
     "--border_width",
     default=5,
     show_default=True,
+    type=click.IntRange(min=0),
     help="Add border to image file(s) with the border_width. 0 - no border",
 )
 @click.option(
@@ -81,8 +82,8 @@ def defaults(src_path):
     is_flag=False,
     default=0,
     show_default=True,
-    type=int,
-    help="Resize image file(s) on current aspect ratio to the length. 0 - no resize",
+    type=click.IntRange(min=0),
+    help="Resize image file(s) on original aspect ratio to the length. 0 - no resize",
 )
 def resize(src_path, length):
     options = {
@@ -105,7 +106,7 @@ def resize(src_path, length):
     is_flag=False,
     default=0,
     show_default=True,
-    type=int,
+    type=click.IntRange(min=0),
     help="Rotate image file(s) to the degree clock-wise. 0 - no rotate",
 )
 def rotate(src_path, degree):

batch_img/resize.py

@@ -46,9 +46,9 @@ def resize_an_image(in_path: Path, out_path: Path, length: int) -> tuple:
                 # Save to the same format: HEIF, JPEG, PNG, etc.
                 if exif_dict:
                     exif_bytes = piexif.dump(exif_dict)
-                    img.save(out_file, format=img.format, exif=exif_bytes)
+                    img.save(out_file, img.format, optimize=True, exif=exif_bytes)
                 else:
-                    img.save(out_file, format=img.format)
+                    img.save(out_file, img.format, optimize=True)
             logger.info(f"Saved {out_file}")
             return True, out_file
         except (AttributeError, FileNotFoundError, ValueError) as e:

tests/data/mixed/Playground.heic tests/data/HEIC/Cartoon.heictests/data/mixed/Playground.heic renamed to tests/data/HEIC/Cartoon.heic

@@ -4,6 +4,8 @@
 """
 
 import json
+from os.path import dirname
+from pathlib import Path
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -144,7 +146,7 @@ def test_json_dump():
                 "WhiteBalance": 0,
                 "FocalLengthIn35mmFilm": 24,
             },
-        )
+        ),
     ]
 )
 def data_decode_exif(request):
@@ -155,3 +157,68 @@ def test_decode_exif(data_decode_exif):
     exif_data, expected = data_decode_exif
     actual = Common.decode_exif(exif_data)
     assert actual == expected
+
+
+@pytest.fixture(
+    params=[
+        (
+            Path(f"{dirname(__file__)}/data/HEIC/Cartoon.heic"),
+            {
+                "file_size": "44.6 KB",
+                "file_ts": "2025-08-16_23-44-21",
+                "format": "HEIF",
+                "mode": "RGB",
+                "size": (758, 758),
+                "info": {
+                    "aux": {},
+                    "bit_depth": 8,
+                    "chroma": 420,
+                    "depth_images": [],
+                    "icc_profile_type": "prof",
+                    "metadata": [],
+                    "original_orientation": None,
+                    "primary": True,
+                    "thumbnails": [],
+                },
+                "exif": {"ExifTag": 90, "Orientation": 1},
+            },
+        )
+    ]
+)
+def data_get_image(request):
+    return request.param
+
+
+def test_get_image_data(data_get_image):
+    file, expected = data_get_image
+    actual = Common.get_image_data(file)
+    assert actual[1] == expected
+
+
+@pytest.fixture(
+    params=[
+        (
+            Path(f"{dirname(__file__)}/data/HEIC/IMG_0070.HEIC"),
+            Path(f"{dirname(__file__)}/data/HEIC/IMG_0070.HEIC"),
+            True,
+        ),
+        (
+            Path(f"{dirname(__file__)}/data/PNG/Checkmark.PNG"),
+            Path(f"{dirname(__file__)}/data/PNG/LagrangePoints.png"),
+            False,
+        ),
+        (
+            Path(f"{dirname(__file__)}/data/JPG/152.JPG"),
+            Path(f"{dirname(__file__)}/data/JPG/P1040566.jpeg"),
+            False,
+        ),
+    ]
+)
+def data_are_images_equal(request):
+    return request.param
+
+
+def test_are_images_equal(data_are_images_equal):
+    path1, path2, expected = data_are_images_equal
+    actual = Common.are_images_equal(path1, path2)
+    assert actual == expected

tests/data/mixed/Cartoon.heic

@@ -78,6 +78,16 @@ def test_resize(mock_resize, data_resize):
     assert result.output == expected
 
 
+@patch("batch_img.main.Main.resize")
+def test_error_resize(mock_resize):
+    _input = "img/file --length -9"
+    mock_resize.return_value = True
+    runner = CliRunner()
+    result = runner.invoke(resize, args=_input.split())
+    print(result.output)
+    assert result.exception
+
+
 @pytest.fixture(
     params=[
         ("src_path -d 90", True, MSG_OK),
@@ -98,3 +108,13 @@ def test_rotate(mock_rotate, data_rotate):
     print(result.output)
     assert not result.exception
     assert result.output == expected
+
+
+@patch("batch_img.main.Main.rotate")
+def test_error_rotate(mock_rotate):
+    _input = "img/file --degree -90"
+    mock_rotate.return_value = True
+    runner = CliRunner()
+    result = runner.invoke(rotate, args=_input.split())
+    print(result.output)
+    assert result.exception