Add do-effect CLI option

Author: john-liu2

README.md

@@ -88,6 +88,7 @@ Options:
 Commands:
   auto         Auto process (resize to 1920, remove GPS, add border)...
   border       Add internal border to image file(s), not expand the size.
+  do-effect    Do special effect to image file(s).
   no-gps       Remove GPS location info in image file(s).
   resize       Resize image file(s).
   rotate       Rotate image file(s).
@@ -143,6 +144,23 @@ Options:
   --help             Show this message and exit.
 ```
 
+#### The `do-effect` sub-command CLI options:
+
+```
+✗ batch_img do-effect --help
+Usage: batch_img do-effect [OPTIONS] SRC_PATH
+
+  Do special effect to image file(s).
+
+Options:
+  -e, --effect [blur|hdr|neon]  Do special effect to image file(s): blur, hdr,
+                                neon.  [default: neon]
+  -o, --output TEXT             Output dir path. If not specified, add special
+                                effect image file(s) to the same path as the
+                                input file(s).  [default: ""]
+  --help                        Show this message and exit.
+```
+
 #### The `resize` sub-command CLI options:
 
 ```

batch_img/common.py

@@ -382,7 +382,7 @@ def prepare_all_files(in_path: Path, out_path: Path | str):
         Returns:
             iterable: files list generator
         """
-        if out_path != REPLACE:
+        if out_path and out_path != REPLACE:
             out_path.mkdir(parents=True, exist_ok=True)
         # Fix Path.glob() got 2x count on Windows 10
         tmp = [in_path.glob(p, case_sensitive=True) for p in PATTERNS]
@@ -416,7 +416,7 @@ def multiprocess_progress_bar(func, desc: str, tasks: list) -> int:
         return success_cnt
 
     @staticmethod
-    def set_out_file(in_path: Path, out_path: Path, extra: str = "") -> Path:
+    def set_out_file(in_path: Path, out_path: Path | str, extra: str = "") -> Path:
         """Set the output file path
 
         Args:

batch_img/do_effect.py

@@ -1,5 +1,4 @@
 """class DoEffect: apply OpenCV advanced image effects to image file(s).
-Must separate this file from effect.py to avoid HEIC image saving error due to cv2.
 Copyright © 2025 John Liu
 """
 

batch_img/interface.py

@@ -91,6 +91,36 @@ def border(src_path, border_width, border_color, output):
     click.secho(msg)
 
 
+@cli.command(help="Do special effect to image file(s).")
+@click.argument(
+    "src_path",
+    required=True,
+)
+@click.option(
+    "-e",
+    "--effect",
+    is_flag=False,
+    default="neon",
+    show_default=True,
+    type=click.Choice(["blur", "hdr", "neon"]),
+    help="Do special effect to image file(s): blur, hdr, neon.",
+)
+@click.option(
+    "-o",
+    "--output",
+    default="",
+    show_default=True,
+    type=str,
+    help="Output dir path. If not specified, add special effect image file(s)"
+    " to the same path as the input file(s).",
+)
+def do_effect(src_path, effect, output):
+    options = {"src_path": src_path, "effect": effect, "output": output}
+    res = Main.do_effect(options)
+    msg = MSG_OK if res else MSG_BAD
+    click.secho(msg)
+
+
 @cli.command(help="Remove GPS location info in image file(s).")
 @click.argument(
     "src_path",

batch_img/main.py

@@ -11,6 +11,7 @@
 from batch_img.border import Border
 from batch_img.common import Common
 from batch_img.const import PKG_NAME, REPLACE
+from batch_img.do_effect import DoEffect
 from batch_img.log import Log
 from batch_img.no_gps import NoGps
 from batch_img.resize import Resize
@@ -79,6 +80,32 @@ def border(options: dict) -> bool:
         Common.check_latest_version(PKG_NAME)
         return ok
 
+    @staticmethod
+    def do_effect(options: dict) -> bool:
+        """Add a special effect to the image file(s)
+
+        Args:
+            options: input options dict
+
+        Returns:
+            bool: True - Success. False - Error
+        """
+        Log.init_log_file()
+        log.debug(f"{json.dumps(options, indent=2)}")
+        in_path = Path(options["src_path"])
+        effect = options.get("effect")
+        if not effect:
+            log.error(f"Bad border width: {effect=}")
+            return False
+        output = options.get("output")
+        out = Path(output) if output else ""
+        if in_path.is_file():
+            ok, _ = DoEffect.apply_1_image((in_path, out, effect))
+        else:
+            ok = DoEffect.apply_all_in_dir(in_path, out, effect)
+        Common.check_latest_version(PKG_NAME)
+        return ok
+
     @staticmethod
     def no_gps(options) -> bool:
         """Remove GPS location info in image file(s)

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools>=80.0"]
 
 [project]
 name = "batch_img"
-version = "0.2.9"
+version = "0.3.0"
 description = "Batch process (resize, rotate, remove GPS, add border, set transparency, auto do all) image files (HEIC, JPG, PNG)"
 readme = "README.md"
 authors = [{ name = "John Liu", email = "rim2rim@gmail.com" }]

tests/test_common.py

@@ -18,7 +18,7 @@
 from .helper import DotDict
 
 
-@pytest.fixture(params=[(PKG_NAME, "0.2.9"), ("", "0.2.9")])
+@pytest.fixture(params=[(PKG_NAME, "0.3.0"), ("", "0.3.0")])
 def ver_data(request):
     return request.param
 
@@ -34,7 +34,7 @@ def test_get_version(ver_data):
         (
             "0.9.9",
             PKG_NAME,
-            f"🔔 Update available: 0.2.9  →  0.9.9\nRun '{PKG_NAME} --update'",
+            f"🔔 Update available: 0.3.0  →  0.9.9\nRun '{PKG_NAME} --update'",
         ),
     ]
 )
@@ -52,7 +52,7 @@ def test_check_latest_version(mock_get_latest_pypi, data_check_latest_version):
 
 @pytest.fixture(
     params=[
-        (PKG_NAME, 0, "0.2.8"),
+        (PKG_NAME, 0, "0.2.9"),
         ("bad_bogus", 1, UNKNOWN),
     ]
 )

tests/test_interface.py

@@ -9,7 +9,15 @@
 from click.testing import CliRunner
 
 from batch_img.const import MSG_BAD, MSG_OK
-from batch_img.interface import auto, border, no_gps, resize, rotate, transparent
+from batch_img.interface import (
+    auto,
+    border,
+    do_effect,
+    no_gps,
+    resize,
+    rotate,
+    transparent,
+)
 
 
 @pytest.fixture(
@@ -73,6 +81,29 @@ def test_error_border(mock_border, data_error_border):
     assert result.exception
 
 
+@pytest.fixture(
+    params=[
+        ("src_path -e blur", True, MSG_OK),
+        ("img/file --effect hdr", False, MSG_BAD),
+        ("src_path -e neon", True, MSG_OK),
+    ]
+)
+def data_effect(request):
+    return request.param
+
+
+@patch("batch_img.main.Main.do_effect")
+def test_do_effect(mock_border, data_effect):
+    _input, res, expected = data_effect
+    mock_border.return_value = res
+    expected += "\n"
+    runner = CliRunner()
+    result = runner.invoke(do_effect, args=_input.split())
+    print(result.output)
+    assert not result.exception
+    assert result.output == expected
+
+
 @pytest.fixture(
     params=[
         ("src_path -o out/dir", True, MSG_OK),

tests/test_main.py

@@ -118,6 +118,47 @@ def test_border_all_in_dir(data_border_all):
     assert actual == expected
 
 
+@pytest.fixture(
+    params=[
+        (
+            "v_1",
+            "v_2",
+            {
+                "src_path": "src/file",
+                "effect": "blur",
+                "output": f"{dirname(__file__)}/.out/",
+            },
+            "v_2",
+        ),
+        (
+            "v_1",
+            "v_2",
+            {
+                "src_path": "src/file",
+                "effect": "neon",
+            },
+            "v_2",
+        ),
+    ]
+)
+def data_do_effect(request):
+    return request.param
+
+
+@patch("batch_img.common.Common.check_latest_version")
+@patch("batch_img.do_effect.DoEffect.apply_all_in_dir")
+@patch("batch_img.do_effect.DoEffect.apply_1_image")
+def test_do_effect(
+    mock_apply_1_image, mock_apply_all_in_dir, mock_check_latest_version, data_do_effect
+):
+    v_1, v_2, options, expected = data_do_effect
+    mock_apply_1_image.return_value = v_1
+    mock_apply_all_in_dir.return_value = v_2
+    mock_check_latest_version.return_value = "ok"
+    actual = Main.do_effect(options)
+    assert actual == expected
+
+
 @pytest.fixture(
     params=[
         (