Merge pull request #4 from john-liu2/task/more_upd

Add `resize.py` and related tests. Add new dependencies

Author: john-liu2

.github/workflows/pylint.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pylint ruff click loguru pillow
+          pip install pylint ruff click loguru piexif pillow pillow-heif
       - name: Analysing the code with pylint
         run: |
           pylint $(git ls-files '*.py')

.github/workflows/pytest.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest-cov click loguru pillow
+          pip install pytest-cov click loguru piexif pillow pillow-heif
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
       - name: Test with pytest
         run: |

README.md

@@ -72,9 +72,9 @@ Usage: batch_img resize [OPTIONS] SRC_PATH
   Resize image file(s)
 
 Options:
-  -w, --width INTEGER  Resize image file(s) on current aspect ratio to the
-                       width. 0 - no resize  [default: 0]
-  --help               Show this message and exit.
+  -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.
 ```
 
 #### The `rotate` sub-command CLI options:

batch_img/common.py

@@ -2,14 +2,22 @@
 Copyright © 2025 John Liu
 """
 
+import json
 import subprocess
 import tomllib
+from datetime import datetime
 from importlib.metadata import version
+from os.path import getmtime, getsize
 from pathlib import Path
 
+import piexif
+import pillow_heif
 from loguru import logger
+from PIL import Image, ImageChops
 
-from batch_img.const import PKG_NAME, VER
+from batch_img.const import PKG_NAME, TS_FORMAT, VER
+
+pillow_heif.register_heif_opener()  # allow Pillow to open HEIC files
 
 
 class Common:
@@ -51,3 +59,115 @@ def run_cmd(cmd: str) -> tuple:
         except subprocess.CalledProcessError as e:
             logger.exception(e)
             raise e
+
+    @staticmethod
+    def readable_file_size(in_bytes: int) -> str:
+        """Convert bytes to human-readable KB, MB, or GB
+
+        Args:
+            in_bytes: input bytes integer
+
+        Returns:
+            str
+        """
+        for _unit in ["B", "KB", "MB", "GB"]:
+            if in_bytes < 1024:
+                break
+            in_bytes /= 1024
+        res = f"{in_bytes} B" if _unit == "B" else f"{in_bytes:.1f} {_unit}"
+        return res
+
+    @staticmethod
+    def decode_exif(exif_data: str) -> dict:
+        """Decode the EXIF data
+
+        Args:
+            exif_data: str
+
+        Returns:
+            dict
+        """
+        exif_dict = piexif.load(exif_data)
+        _dict = {}
+        for ifd_name, val in exif_dict.items():
+            if not val:
+                continue
+            for tag_id, value in val.items():
+                tag_name = piexif.TAGS[ifd_name].get(tag_id, {}).get("name", tag_id)
+                _dict[tag_name] = value
+        for key in (
+            "FNumber",
+            "FocalLength",
+            "MakerNote",
+            "SceneType",
+            "SubjectArea",
+            "Software",
+            "HostComputer",
+        ):
+            if key in _dict:
+                _dict.pop(key)
+        keys = list(_dict.keys())
+        for keyword in (
+            "DateTime",
+            "GPS",
+            "OffsetTime",
+            "SubSecTime",
+            "Tile",
+            "Pixel",
+            "Lens",
+            "Resolution",
+            "Value",
+        ):
+            for key in keys:
+                if key.startswith(keyword) or key.endswith(keyword):
+                    _dict.pop(key)
+        _res = {
+            k: (v.decode() if isinstance(v, bytes) else v) for k, v in _dict.items()
+        }
+        logger.info(f"{_res=}")
+        return _res
+
+    @staticmethod
+    def are_images_equal(path1: Path | str, path2: Path | str) -> bool:
+        """Check if two image files are visually equal pixel-wise
+
+        Args:
+            path1: image1 file path
+            path2: image2 file path
+
+        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)}")
+        return ImageChops.difference(data1, data2).getbbox() is None

batch_img/interface.py

@@ -58,7 +58,7 @@ def border(src_path, border_width, border_color):
 )
 def defaults(src_path):
     """Do the default action on the image file(s):
-    * Resize to 1280 pixels as the max width
+    * Resize to 1280 pixels as the max length
     * Add a border: 5 pixel width, gray color
     * No rotate
     """
@@ -76,18 +76,18 @@ def defaults(src_path):
     required=True,
 )
 @click.option(
-    "-w",
-    "--width",
+    "-l",
+    "--length",
     is_flag=False,
     default=0,
     show_default=True,
     type=int,
-    help="Resize image file(s) on current aspect ratio to the width. 0 - no resize",
+    help="Resize image file(s) on current aspect ratio to the length. 0 - no resize",
 )
-def resize(src_path, width):
+def resize(src_path, length):
     options = {
         "src_path": src_path,
-        "width": width,
+        "length": length,
     }
     res = Main.resize(options)
     msg = MSG_OK if res else MSG_BAD

batch_img/main.py

@@ -5,10 +5,12 @@
 import json
 import os
 from datetime import datetime
+from pathlib import Path
 
 from loguru import logger
 
 from batch_img.const import PKG_NAME, TS_FORMAT
+from batch_img.resize import Resize
 
 
 class Main:
@@ -37,7 +39,13 @@ def resize(options: dict) -> bool:
         """
         logger.info(f"{json.dumps(options, indent=2)}")
         Main.init_log_file()
-        # To-do
+        # Resize one file
+        in_path = Path(options["src_path"])
+        length = options["length"]
+        if not length:
+            logger.warning(f"No resize due to bad {length=}")
+            return False
+        Resize.resize_an_image(in_path, Path(os.getcwd()), length)
         return True
 
     @staticmethod
@@ -73,7 +81,7 @@ def rotate(options: dict) -> bool:
     @staticmethod
     def default_run(options: dict) -> bool:
         """Do the default action on the image file(s):
-        1) Resize to 1280 pixels as the max width
+        1) Resize to 1280 pixels as the max length
         2) Add a border: 5 pixel width, gray color
         3) Not rotate
         """

batch_img/resize.py

@@ -0,0 +1,61 @@
+"""class Resize: resize the image file(s)
+Copyright © 2025 John Liu
+"""
+
+from pathlib import Path
+
+import piexif
+import pillow_heif
+from loguru import logger
+from PIL import Image
+
+pillow_heif.register_heif_opener()  # allow Pillow to open HEIC files
+
+
+class Resize:
+    @staticmethod
+    def resize_an_image(in_path: Path | str, out_path: Path | str, length: int) -> Path:
+        """Resize one image file
+
+        Args:
+            in_path: input file path
+            out_path: output dir path
+            length: max length (width or height) in pixels
+
+        Returns:
+            Path: output file path
+        """
+        try:
+            with Image.open(in_path) as img:
+                width, height = img.size
+                aspect_ratio = width / height
+
+            exif_dict = None
+            if "exif" in img.info:
+                exif_dict = piexif.load(img.info["exif"])
+
+            # Calculate max_size by max_side and aspect_ratio
+            if aspect_ratio > 1:
+                max_size = (length, int(length / aspect_ratio))
+            else:
+                max_size = (int(length * aspect_ratio), length)
+
+            # Keep the aspect ratio. Use LANCZOS for high-quality downsampling
+            img.thumbnail(max_size, Image.Resampling.LANCZOS)
+
+            # Save back to HEIC format with EXIF
+            out_path.mkdir(exist_ok=True)
+            out_file = out_path
+            if out_path.is_dir():
+                filename = f"{in_path.stem}_{length}{in_path.suffix}"
+                out_file = Path(f"{out_path}/{filename}")
+            if exif_dict:
+                exif_bytes = piexif.dump(exif_dict)
+                img.save(out_file, format="HEIF", exif=exif_bytes)
+            else:
+                img.save(out_file, format="HEIF")
+            logger.info(f"Saved {out_file}")
+            return out_file
+        except Exception as e:
+            logger.exception(e)
+            raise e

pyproject.toml

@@ -20,7 +20,9 @@ requires-python = ">=3.12"
 dependencies = [
     "click",
     "loguru",
+    "piexif",
     "pillow",
+    "pillow-heif",
 ]
 [project.scripts]
 batch_img = "batch_img.interface:cli"

pyproject_release.toml

@@ -20,7 +20,9 @@ requires-python = ">=3.12"
 dependencies = [
     "click",
     "loguru",
+    "piexif",
     "pillow",
+    "pillow-heif",
 ]
 [project.scripts]
 batch_img = "batch_img.interface:cli"