fotolab 0.30.0__tar.gz → 0.31.1__tar.gz

{fotolab-0.30.0 → fotolab-0.31.1}/.gitignore

@@ -162,5 +162,6 @@ cython_debug/
 # heatmaps
 *.png
 .aider*
+.opencode
 TODO
 output

{fotolab-0.30.0 → fotolab-0.31.1}/CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 
 ## [Unreleased]
 
+## v0.31.1 (2025-06-01)
+
+- Code format
+- Fix incorrect function name due to refactoring
+- Fix missing option in `auto` subcommand
+- Refactor `info` subcommand and improve EXIF extraction
+- Remove unused type
+- Update help message in readme
+
+## v0.31.0 (2025-05-25)
+
+- Add basic tests for several CLI subcommands
+- Add test for auto subcommand and image fixture
+- Add watermark transparency option and improve error handling
+- Fix markdown in changelog
+- Refine `env` subcommand test assertions
+- Standardize border dimension return as a tuple
+
 ## v0.30.0 (2025-05-18)
 
 - Add WEBP `quality`, `lossless`, and `method` args
@@ -14,14 +32,14 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 - Close image files after creating animation
 - Update help message generated by latest Python to readme
 - Update help message in readme
-- Validate duration for animate command
+- Validate duration for `animate` subcommand
 
 ## v0.29.2 (2025-05-11)
 
 - Bump deps
 - Code format
 - Improve info subcommand by adding error handling for missing keys
-- Remove default value for image filename argument in info subcommand
+- Remove default value for image filename argument in `info` subcommand
 - Use context manager to open image and remove redundant image close.
 
 ## v0.29.1 (2025-05-04)
@@ -34,8 +52,8 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 
 ## v0.29.0 (2025-04-27)
 
-- Add `cells` argument to halftone subcommand and function
-- Add grayscale option to halftone subcommand for grayscale conversion
+- Add `cells` argument to `halftone` subcommand and function
+- Add `grayscale` option to `halftone` subcommand for grayscale conversion
 - Bump deps
 - Calculate dot radius relative to cell size based on brightness.
 - Refactor CLI to handle missing subcommand execution function gracefully
@@ -51,22 +69,22 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 ## v0.28.5 (2025-04-13)
 
 - Group build and publish package commands together
-- Improve contrast subcommand and add pylint disable
-- Prompt to publish package in release nox job
-- Resolve pylint raised issue
-- Validate cutoff value is between 0 and 50 in contrast subcommand
+- Improve `contrast` subcommand and add `pylint` disable
+- Prompt to publish package in release `nox` job
+- Resolve `pylint` raised issue
+- Validate `cutoff` value is between 0 and 50 in `contrast` subcommand
 
 ## v0.28.4 (2025-04-06)
 
 - Build the release after release `nox` job
 - Bump `pre-commit` for `flake8`
 - Fix incorrect git options
-- Install flit as deps for dev environment
+- Install `flit` as deps for dev environment
 - Update help message in readme
 
 ## v0.28.3 (2025-03-30)
 
-- Bump `pre-commit` hook for validate-project
+- Bump `pre-commit` hook for `validate-project`
 - Commit changes after bump release
 - Remove exception handling as it's handled in parent calling function
 - Resolve W0718: Catching too general exception Exception
@@ -76,7 +94,7 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 ## v0.28.2 (2025-03-23)
 
 - Accept width in integer instead of string
-- Bump pre-commit hook for validate-project
+- Bump `pre-commit` hook for `validate-project`
 - Handle file not found and other exceptions when opening/processing images
 - Remove all unnecessary exceptions handling
 - Use Union for border width return type to allow int or tuple
@@ -97,7 +115,7 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 - Refactor getting output filename when saving image
 - Remove `--output-dir` and `--open` args from main cli
 - Update help message in readme
-- Use single `save_gif_image` function in sharpen and halftone subcommand
+- Use single `save_gif_image` function in sharpen and `halftone` subcommand
 
 ## v0.27.2 (2025-03-02)
 

{fotolab-0.30.0 → fotolab-0.31.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.30.0
+Version: 0.31.1
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -371,7 +371,8 @@ fotolab watermark -h
 usage: fotolab watermark [-h] [-t WATERMARK_TEXT]
                          [-p {top-left,top-right,bottom-left,bottom-right}]
                          [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]
-                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR] [--camera]
+                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR]
+                         [-a ALPHA_VALUE] [--camera]
                          [-l | --lowercase | --no-lowercase] [-op]
                          [-od OUTPUT_DIR]
                          IMAGE_FILENAMES [IMAGE_FILENAMES ...]
@@ -400,6 +401,10 @@ options:
   -oc, --outline-color OUTLINE_COLOR
                         set the outline color of the watermark text (default:
                         'black')
+  -a, --alpha ALPHA_VALUE
+                        set the transparency of the watermark text (0-255,
+                        where 0 is fully transparent and 255 is fully opaque;
+                        default: '128')
   --camera              use camera metadata as watermark
   -l, --lowercase, --no-lowercase
                         lowercase the watermark text

{fotolab-0.30.0 → fotolab-0.31.1}/README.md

@@ -348,7 +348,8 @@ fotolab watermark -h
 usage: fotolab watermark [-h] [-t WATERMARK_TEXT]
                          [-p {top-left,top-right,bottom-left,bottom-right}]
                          [-pd PADDING] [-fs FONT_SIZE] [-fc FONT_COLOR]
-                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR] [--camera]
+                         [-ow OUTLINE_WIDTH] [-oc OUTLINE_COLOR]
+                         [-a ALPHA_VALUE] [--camera]
                          [-l | --lowercase | --no-lowercase] [-op]
                          [-od OUTPUT_DIR]
                          IMAGE_FILENAMES [IMAGE_FILENAMES ...]
@@ -377,6 +378,10 @@ options:
   -oc, --outline-color OUTLINE_COLOR
                         set the outline color of the watermark text (default:
                         'black')
+  -a, --alpha ALPHA_VALUE
+                        set the transparency of the watermark text (0-255,
+                        where 0 is fully transparent and 255 is fully opaque;
+                        default: '128')
   --camera              use camera metadata as watermark
   -l, --lowercase, --no-lowercase
                         lowercase the watermark text

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/__init__.py

@@ -24,7 +24,7 @@ from pathlib import Path
 
 from PIL import Image
 
-__version__ = "0.30.0"
+__version__ = "0.31.1"
 
 log = logging.getLogger(__name__)
 
@@ -59,15 +59,14 @@ def save_gif_image(
         _open_image(new_filename)
 
 
-def save_image(args, new_image, output_filename, subcommand):
+def save_image(
+    args: argparse.Namespace,
+    new_image: Image.Image,
+    output_filename: str,
+    subcommand: str,
+) -> None:
     """Save image after image operation.
 
-    Args:
-        args (argparse.Namespace): Config from command line arguments
-        new_image(PIL.Image.Image): Modified image
-        output_filename(str): Save filename image
-        subcommand(str): Subcommand used to call this function
-
     Returns:
         None
     """

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/subcommands/animate.py

@@ -73,7 +73,10 @@ def build_subparser(subparsers) -> None:
         dest="duration",
         type=_validate_duration,
         default=2500,
-        help="set the duration in milliseconds (must be a positive integer, default: '%(default)s')",
+        help=(
+            "set the duration in milliseconds "
+            "(must be a positive integer, default: '%(default)s')"
+        ),
         metavar="DURATION",
     )
 
@@ -120,7 +123,10 @@ def build_subparser(subparsers) -> None:
         type=int,
         default=4,
         choices=range(0, 7),
-        help="set WEBP encoding method (0=fast, 6=slow/best, default: '%(default)s')",
+        help=(
+            "set WEBP encoding method "
+            "(0=fast, 6=slow/best, default: '%(default)s')"
+        ),
         metavar="METHOD",
     )
 
@@ -170,17 +176,17 @@ def run(args: argparse.Namespace) -> None:
             "save_all": True,
             "duration": args.duration,
             "loop": args.loop,
-            "optimize": True,  # General optimization, good for GIF
+            "optimize": True,
         }
 
+        # Pillow's WEBP save doesn't use a general 'optimize' like GIF.
+        # Specific WEBP params like 'method' and 'quality' control this.  We
+        # can remove 'optimize' if it causes issues or is ignored for WEBP.
+        # For now, let's keep it, Pillow might handle it or ignore it.
         if args.format == "webp":
             save_kwargs["quality"] = args.webp_quality
             save_kwargs["lossless"] = args.webp_lossless
             save_kwargs["method"] = args.webp_method
-            # Pillow's WEBP save doesn't use a general 'optimize' like GIF.
-            # Specific WEBP params like 'method' and 'quality' control this.
-            # We can remove 'optimize' if it causes issues or is ignored for WEBP.
-            # For now, let's keep it, Pillow might handle it or ignore it.
 
         main_frame.save(new_filename, **save_kwargs)
     finally:

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/subcommands/auto.py

@@ -71,6 +71,7 @@ def run(args: argparse.Namespace) -> None:
         "canvas": False,
         "lowercase": False,
         "before_after": False,
+        "alpha": 128,
     }
     combined_args = argparse.Namespace(**vars(args), **extra_args)
     combined_args.overwrite = True

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/subcommands/border.py

@@ -17,7 +17,7 @@
 
 import argparse
 import logging
-from typing import Tuple, Union
+from typing import Tuple
 
 from PIL import Image, ImageColor, ImageOps
 
@@ -26,7 +26,7 @@ from fotolab import save_image
 log = logging.getLogger(__name__)
 
 
-def build_subparser(subparsers) -> None:
+def build_subparser(subparsers: argparse._SubParsersAction) -> None:
     """Build the subparser."""
     border_parser = subparsers.add_parser("border", help="add border to image")
 
@@ -150,17 +150,16 @@ def run(args: argparse.Namespace) -> None:
 
 def get_border(
     args: argparse.Namespace,
-) -> Union[Tuple[int, int, int, int], int]:
+) -> Tuple[int, int, int, int]:
     """Calculate the border dimensions.
 
     Args:
         args (argparse.Namespace): Command line arguments
 
     Returns:
-        Union[Tuple[int, int, int, int], int]: Border dimensions in pixels.
-        If individual widths are specified, returns a tuple of (left, top,
-        right, bottom) widths.  Otherwise, returns a uniform width for all
-        sides.
+        Tuple[int, int, int, int]: Border dimensions in pixels as (left, top,
+        right, bottom) widths. If individual widths are not specified,
+        a uniform width is returned for all sides.
     """
     if any(
         [
@@ -176,4 +175,5 @@ def get_border(
             args.width_right,
             args.width_bottom,
         )
-    return args.width
+    # If no individual widths are specified, use the general width for all sides
+    return (args.width, args.width, args.width, args.width)

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/subcommands/info.py

@@ -81,31 +81,25 @@ def run(args: argparse.Namespace) -> None:
             return
 
         output_info = []
-    specific_info_requested = False
 
-    if args.camera:
-        specific_info_requested = True
-        output_info.append(camera_metadata(exif_tags))
+        if args.camera:
+            output_info.append(get_formatted_camera_info(exif_tags))
 
-    if args.datetime:
-        specific_info_requested = True
-        output_info.append(datetime(exif_tags))
+        if args.datetime:
+            output_info.append(get_formatted_datetime_info(exif_tags))
 
-    if specific_info_requested:
-        print("\n".join(output_info))
-    else:
-        # Print all tags if no specific info was requested
-        tag_name_width = max(map(len, exif_tags))
-        for tag_name, tag_value in exif_tags.items():
-            print(f"{tag_name:<{tag_name_width}}: {tag_value}")
+        if output_info:  # Check if any specific info was added
+            print("\n".join(output_info))
+        else:
+            # Print all tags if no specific info was requested
+            tag_name_width = max(map(len, exif_tags))
+            for tag_name, tag_value in exif_tags.items():
+                print(f"{tag_name:<{tag_name_width}}: {tag_value}")
 
 
 def extract_exif_tags(image: Image.Image, sort: bool = False) -> dict:
     """Extract Exif metadata from image."""
-    try:
-        exif = image._getexif()
-    except AttributeError:
-        exif = None
+    exif = image.getexif()
 
     log.debug(exif)
 
@@ -122,13 +116,13 @@ def extract_exif_tags(image: Image.Image, sort: bool = False) -> dict:
     return filtered_info
 
 
-def datetime(exif_tags: dict):
-    """Extract datetime metadata."""
+def get_formatted_datetime_info(exif_tags: dict):
+    """Extract and format datetime metadata."""
     return exif_tags.get("DateTime", "Not available")
 
 
-def camera_metadata(exif_tags: dict):
-    """Extract camera and model metadata."""
+def get_formatted_camera_info(exif_tags: dict):
+    """Extract and format camera make and model metadata."""
     make = exif_tags.get("Make", "")
     model = exif_tags.get("Model", "")
     metadata = f"{make} {model}"

{fotolab-0.30.0 → fotolab-0.31.1}/fotolab/subcommands/watermark.py

@@ -24,7 +24,7 @@ from typing import Tuple
 from PIL import Image, ImageColor, ImageDraw, ImageFont, ImageSequence
 
 from fotolab import save_image
-from fotolab.subcommands.info import camera_metadata
+from fotolab.subcommands.info import get_formatted_camera_info
 
 log: logging.Logger = logging.getLogger(__name__)
 
@@ -129,6 +129,21 @@ def build_subparser(subparsers: argparse._SubParsersAction) -> None:
         metavar="OUTLINE_COLOR",
     )
 
+    watermark_parser.add_argument(
+        "-a",
+        "--alpha",
+        dest="alpha",
+        type=int,
+        default=128,
+        choices=range(0, 256),
+        metavar="ALPHA_VALUE",
+        help=(
+            "set the transparency of the watermark text (0-255, "
+            "where 0 is fully transparent and 255 is fully opaque; "
+            "default: '%(default)s')"
+        ),
+    )
+
     watermark_parser.add_argument(
         "--camera",
         default=False,
@@ -176,7 +191,15 @@ def run(args: argparse.Namespace) -> None:
     log.debug(args)
 
     for image_filename in args.image_filenames:
-        image: Image.Image = Image.open(image_filename)
+        try:
+            image: Image.Image = Image.open(image_filename)
+        except FileNotFoundError:
+            log.error("Image file not found: %s", image_filename)
+            continue
+        except Exception as e:
+            log.error("Could not open image %s: %s", image_filename, e)
+            continue
+
         if image.format == "GIF":
             watermark_gif_image(image, image_filename, args)
         else:
@@ -202,7 +225,7 @@ def watermark_gif_image(
     frames: list[Image.Image] = []
     for frame in ImageSequence.Iterator(original_image):
         watermarked_frame: Image.Image = watermark_image(
-            args, frame.convert("RGBA")
+            args, frame.convert("RGBA"), args.alpha
         )
         frames.append(watermarked_frame)
 
@@ -241,11 +264,11 @@ def watermark_non_gif_image(
     Returns:
         Image.Image: The watermarked image
     """
-    return watermark_image(args, original_image)
+    return watermark_image(args, original_image, args.alpha)
 
 
 def watermark_image(
-    args: argparse.Namespace, original_image: Image.Image
+    args: argparse.Namespace, original_image: Image.Image, alpha: int
 ) -> Image.Image:
     """Watermark an image."""
     watermarked_image: Image.Image = original_image.copy()
@@ -268,23 +291,31 @@ def watermark_image(
         calc_padding(original_image, args),
     )
 
+    try:
+        font_fill_color = ImageColor.getrgb(args.font_color)
+        stroke_fill_color = ImageColor.getrgb(args.outline_color)
+    except ValueError:
+        log.error("Invalid font or outline color specified. Using defaults.")
+        font_fill_color = ImageColor.getrgb("white")
+        stroke_fill_color = ImageColor.getrgb("black")
+
     draw.text(
         (position_x, position_y),
         text,
         font=font,
-        fill=(*ImageColor.getrgb(args.font_color), 128),
+        fill=(*font_fill_color, alpha),
         stroke_width=calc_font_outline_width(original_image, args),
-        stroke_fill=(*ImageColor.getrgb(args.outline_color), 128),
+        stroke_fill=(*stroke_fill_color, alpha),
     )
     return watermarked_image
 
 
 def prepare_text(args: argparse.Namespace, image: Image.Image) -> str:
     """Prepare the watermark text."""
-    text: str = args.text  # Default text
+    text = args.text
     if args.camera:
-        metadata_text: str | None = camera_metadata(image)
-        if metadata_text:  # Use metadata only if it's not None or empty
+        metadata_text = get_formatted_camera_info(image)
+        if metadata_text:
             text = metadata_text
         else:
             log.warning(

{fotolab-0.30.0 → fotolab-0.31.1}/tests/conftest.py

@@ -27,6 +27,17 @@ def fixture_csv_file(tmpdir):
     return csv_file
 
 
+@pytest.fixture(autouse=True, name="image_file")
+def fixture_image_file(tmpdir):
+    def image_file(filename):
+        src = Path(FIXTURE_PATH, filename)
+        des = Path(tmpdir, src.name)
+        copyfile(src, des)
+        return des
+
+    return image_file
+
+
 @pytest.fixture(autouse=True, name="cli_runner")
 def fixture_cli_runner(tmpdir):
     def cli_runner(*args, **kwargs):

fotolab-0.31.1/tests/test_animate_subcommand.py

@@ -0,0 +1,7 @@
+# pylint: disable=C0114,C0116
+
+def test_animate_subcommand(cli_runner, image_file):
+    img_path1 = image_file("sample.png")
+    img_path2 = image_file("sample.png")
+    ret = cli_runner('animate', str(img_path1), str(img_path2))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_auto_subcommand.py

@@ -0,0 +1,7 @@
+# pylint: disable=C0114,C0116
+
+def test_auto_subcommand(cli_runner, image_file):
+    """Test auto subcommand."""
+    img_path = image_file("sample.png")
+    ret = cli_runner("auto", str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_border_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_border_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('border', str(img_path), '--width', '10')
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_contrast_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_contrast_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('contrast', str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_env_subcommand.py

@@ -0,0 +1,23 @@
+# pylint: disable=C0114,C0116
+
+import platform
+import sys
+
+from fotolab import __version__
+
+
+def test_env_output(cli_runner):
+    ret = cli_runner("env")
+
+    actual_sys_version = sys.version.replace("\n", "")
+    actual_platform = platform.platform()
+
+    expected_output = (
+        f"fotolab: {__version__}\n"
+        f"python: {actual_sys_version}\n"
+        f"platform: {actual_platform}\n"
+    )
+
+    assert ret.stdout == expected_output
+    assert ret.stderr == ""
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_halftone_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_halftone_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('halftone', str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_info_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_info_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('info', str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_montage_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_montage_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('montage', str(img_path), str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_resize_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_resize_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('resize', str(img_path), '--width', '200')
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_rotate_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_rotate_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('rotate', str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_sharpen_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_sharpen_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('sharpen', str(img_path))
+    assert ret.returncode == 0

fotolab-0.31.1/tests/test_watermark_subcommand.py

@@ -0,0 +1,6 @@
+# pylint: disable=C0114,C0116
+
+def test_watermark_subcommand(cli_runner, image_file):
+    img_path = image_file("sample.png")
+    ret = cli_runner('watermark', str(img_path), '--text', 'Test')
+    assert ret.returncode == 0

fotolab-0.30.0/tests/test_env_subcommand.py

@@ -1,10 +0,0 @@
-# pylint: disable=C0114,C0116
-
-from fotolab import __version__
-
-
-def test_env_output(cli_runner):
-    ret = cli_runner("env")
-    assert f"fotolab: {__version__}" in ret.stdout
-    assert "python: " in ret.stdout
-    assert "platform: " in ret.stdout