Merge pull request #9 from john-liu2/task/random

Add `orientation.py` and related tests. Move multiprocess feature into `common.py`. Finish `rotate.py`

Author: john-liu2

Makefile

@@ -7,7 +7,7 @@ clean:
 	rm -fr build .eggs batch_img.egg-info run_*.log .out dist wheels tests/data/.DS_Store
 	find . -name '*.pyc' -exec rm -f {} +
 	find . -name '__pycache__' -exec rm -fr {} +
-	rm -fr tests/.out tests/.DS_Store .coverage htmlcov .pytest_cache uv.lock
+	rm -fr tests/.out tests/.DS_Store .coverage* htmlcov .pytest_cache uv.lock
 	rm -fr docs/build out_*.yaml tmp_*
 
 lint: clean

README.md

@@ -51,6 +51,8 @@ Options:
                                   x>=0]
   -bc, --border_color TEXT        Add border to image file(s) with the
                                   border_color string  [default: gray]
+  -o, --output TEXT               Output file path. If skipped, use the
+                                  current dir path  [default: ""]
   --help                          Show this message and exit.
 ```
 
@@ -64,7 +66,9 @@ Usage: batch_img defaults [OPTIONS] SRC_PATH
   5-pixel gray color border; 3) auto-rotate if needed
 
 Options:
-  --help  Show this message and exit.
+  -o, --output TEXT  Output file path. If skipped, use the current dir path
+                     [default: ""]
+  --help             Show this message and exit.
 ```
 
 #### The `resize` sub-command CLI options:
@@ -78,6 +82,8 @@ Usage: batch_img resize [OPTIONS] SRC_PATH
 Options:
   -l, --length INTEGER RANGE  Resize image file(s) on original aspect ratio to
                               the length. 0 - no resize  [default: 0; x>=0]
+  -o, --output TEXT           Output file path. If skipped, use the current
+                              dir path  [default: ""]
   --help                      Show this message and exit.
 ```
 
@@ -90,7 +96,9 @@ Usage: batch_img rotate [OPTIONS] SRC_PATH
   Rotate image file(s)
 
 Options:
-  -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.
+  -a, --angle INTEGER RANGE  Rotate image file(s) to the clockwise angle. 0 -
+                             no rotate  [default: 0; x>=0]
+  -o, --output TEXT          Output file path. If skipped, use the current dir
+                             path  [default: ""]
+  --help                     Show this message and exit.
 ```

batch_img/common.py

@@ -2,11 +2,13 @@
 Copyright © 2025 John Liu
 """
 
+import itertools
 import json
 import subprocess
 import tomllib
 from datetime import datetime
 from importlib.metadata import version
+from multiprocessing import Pool, cpu_count
 from os.path import getmtime, getsize
 from pathlib import Path
 
@@ -15,8 +17,9 @@
 from loguru import logger
 from PIL import Image, ImageChops
 from PIL.TiffImagePlugin import IFDRational
+from tqdm import tqdm
 
-from batch_img.const import PKG_NAME, TS_FORMAT, VER
+from batch_img.const import PATTERNS, PKG_NAME, TS_FORMAT, VER
 
 pillow_heif.register_heif_opener()  # allow Pillow to open HEIC files
 
@@ -194,3 +197,45 @@ def are_images_equal(path1: Path, path2: Path) -> bool:
             f"{path2}:\n{json.dumps(meta2, indent=2, default=Common.jsn_serial)}"
         )
         return ImageChops.difference(data1, data2).getbbox() is None
+
+    @staticmethod
+    def prepare_all_files(in_path: Path, out_path: Path):
+        """
+
+        Args:
+            in_path: input dir path
+            out_path: output dir path
+
+        Returns:
+            iterable: files list generator
+        """
+        out_path.mkdir(parents=True, exist_ok=True)
+        _files = itertools.chain.from_iterable(in_path.glob(p) for p in PATTERNS)
+        return _files
+
+    @staticmethod
+    def multiprocess_progress_bar(func, desc, tasks: list) -> int:
+        """Run task in multiprocess with progress bar
+
+        Args:
+            func: function to be run in multiprocess
+            desc: description str
+            tasks: tasks list for multiprocess pool
+
+        Returns:
+            int: success_cnt
+        """
+        success_cnt = 0
+        files_cnt = len(tasks)
+        # Limit to 4 workers if cpu cores cnt > 4
+        workers = min(cpu_count(), 4)
+
+        with Pool(workers) as pool:
+            with tqdm(total=files_cnt, desc=desc) as pbar:
+                for ok, res in pool.starmap(func, tasks):
+                    if ok:
+                        success_cnt += 1
+                    else:
+                        tqdm.write(f"Error: {res}")
+                    pbar.update()
+        return success_cnt

batch_img/const.py

@@ -11,3 +11,13 @@
 MSG_BAD = "❌ Failed to process the image file(s)."
 
 TS_FORMAT = "%Y-%m-%d_%H-%M-%S"
+PATTERNS = (
+    "*.HEIC",
+    "*.heic",
+    "*.JPG",
+    "*.jpg",
+    "*.JPEG",
+    "*.jpeg",
+    "*.PNG",
+    "*.png",
+)

batch_img/interface.py

@@ -38,13 +38,22 @@ def cli(ctx, version):  # pragma: no cover
     show_default=True,
     help="Add border to image file(s) with the border_color string",
 )
-def border(src_path, border_width, border_color):
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    show_default=True,
+    type=str,
+    help="Output file path. If skipped, use the current dir path",
+)
+def border(src_path, border_width, border_color, output):
     options = {
         "src_path": src_path,
         "border_width": border_width,
         "border_color": border_color,
+        "output": output,
     }
-    res = Main.add_border(options)
+    res = Main.border(options)
     msg = MSG_OK if res else MSG_BAD
     click.secho(msg)
 
@@ -57,15 +66,21 @@ def border(src_path, border_width, border_color):
     "src_path",
     required=True,
 )
-def defaults(src_path):
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    show_default=True,
+    type=str,
+    help="Output file path. If skipped, use the current dir path",
+)
+def defaults(src_path, output):
     """Do the default action on the image file(s):
     * Resize to 1280 pixels as the max length
     * Add a border: 5 pixel width, gray color
     * Auto-rotate if upside down or sideways
     """
-    options = {
-        "src_path": src_path,
-    }
+    options = {"src_path": src_path, "output": output}
     res = Main.default_run(options)
     msg = MSG_OK if res else MSG_BAD
     click.secho(msg)
@@ -85,11 +100,16 @@ def defaults(src_path):
     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 = {
-        "src_path": src_path,
-        "length": length,
-    }
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    show_default=True,
+    type=str,
+    help="Output file path. If skipped, use the current dir path",
+)
+def resize(src_path, length, output):
+    options = {"src_path": src_path, "length": length, "output": output}
     res = Main.resize(options)
     msg = MSG_OK if res else MSG_BAD
     click.secho(msg)
@@ -101,18 +121,27 @@ def resize(src_path, length):
     required=True,
 )
 @click.option(
-    "-d",
-    "--degree",
+    "-a",
+    "--angle",
     is_flag=False,
     default=0,
     show_default=True,
     type=click.IntRange(min=0),
-    help="Rotate image file(s) to the degree clock-wise. 0 - no rotate",
+    help="Rotate image file(s) to the clockwise angle. 0 - no rotate",
+)
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    show_default=True,
+    type=str,
+    help="Output file path. If skipped, use the current dir path",
 )
-def rotate(src_path, degree):
+def rotate(src_path, angle, output):
     options = {
         "src_path": src_path,
-        "degree": degree,
+        "angle": angle,
+        "output": output,
     }
     res = Main.rotate(options)
     msg = MSG_OK if res else MSG_BAD

batch_img/main.py

@@ -11,6 +11,7 @@
 
 from batch_img.const import PKG_NAME, TS_FORMAT
 from batch_img.resize import Resize
+from batch_img.rotate import Rotate
 
 
 class Main:
@@ -39,18 +40,25 @@ def resize(options: dict) -> bool:
         """
         logger.info(f"{json.dumps(options, indent=2)}")
         Main.init_log_file()
-        # Resize one file
         in_path = Path(options["src_path"])
         length = options.get("length")
-        if not length:
+        output = options.get("output")
+        if not length or length == 0:
             logger.warning(f"No resize due to bad {length=}")
             return False
-        ok, _ = Resize.resize_an_image(in_path, Path(os.getcwd()), length)
+        if not output:
+            output = Path(os.getcwd())
+        else:
+            output = Path(output)
+        if in_path.is_file():
+            ok, _ = Resize.resize_an_image(in_path, output, length)
+        else:
+            ok = Resize.resize_all_progress_bar(in_path, output, length)
         return ok
 
     @staticmethod
-    def add_border(options: dict) -> bool:
-        """Add border to the image file(s)
+    def rotate(options: dict) -> bool:
+        """Rotate the image file(s)
 
         Args:
             options: input options dict
@@ -60,12 +68,25 @@ def add_border(options: dict) -> bool:
         """
         logger.info(f"{json.dumps(options, indent=2)}")
         Main.init_log_file()
-        # To-do
-        return True
+        in_path = Path(options["src_path"])
+        angle = options.get("angle")
+        output = options.get("output")
+        if not angle or angle == 0:
+            logger.warning(f"No rotate due to bad {angle=}")
+            return False
+        if not output:
+            output = Path(os.getcwd())
+        else:
+            output = Path(output)
+        if in_path.is_file():
+            ok, _ = Rotate.rotate_1_image_file(in_path, output, angle)
+        else:
+            ok = Rotate.rotate_all_in_dir(in_path, output, angle)
+        return ok
 
     @staticmethod
-    def rotate(options: dict) -> bool:
-        """Rotate the image file(s)
+    def border(options: dict) -> bool:
+        """Add border to the image file(s)
 
         Args:
             options: input options dict