fotolab 0.21.1__py3-none-any.whl → 0.24.0__py3-none-any.whl

fotolab/__init__.py

@@ -21,7 +21,7 @@ import subprocess
 import sys
 from pathlib import Path
 
-__version__ = "0.21.1"
+__version__ = "0.24.0"
 
 log = logging.getLogger(__name__)
 

fotolab/cli.py

@@ -23,46 +23,40 @@
 import argparse
 import logging
 import sys
-from typing import Dict, Optional, Sequence
-
-import fotolab.animate
-import fotolab.auto
-import fotolab.border
-import fotolab.contrast
-import fotolab.env
-import fotolab.info
-import fotolab.montage
-import fotolab.resize
-import fotolab.rotate
-import fotolab.sharpen
-import fotolab.watermark
+from typing import Optional, Sequence
+
+import fotolab.subcommands
 from fotolab import __version__
 
 log = logging.getLogger(__name__)
 
 
 def setup_logging(args: argparse.Namespace) -> None:
-    """Set up logging by level."""
-    if args.verbose == 0:
-        logging.getLogger("PIL").setLevel(logging.ERROR)
+    """Sets up logging configuration based on command-line arguments.
 
+    Args:
+        args (argparse.Namespace): Namespace containing parsed arguments.
+    """
     if args.quiet:
         logging.disable(logging.NOTSET)
-    else:
-        conf: Dict = {
-            True: {
-                "level": logging.DEBUG,
-                "msg": "[%(asctime)s] %(levelname)s: %(name)s: %(message)s",
-            },
-            False: {"level": logging.INFO, "msg": "%(message)s"},
-        }
-
-        logging.basicConfig(
-            level=conf[args.debug]["level"],
-            stream=sys.stdout,
-            format=conf[args.debug]["msg"],
-            datefmt="%Y-%m-%d %H:%M:%S",
-        )
+        return
+
+    if args.verbose == 0:
+        logging.getLogger("PIL").setLevel(logging.ERROR)
+
+    level = logging.DEBUG if args.debug else logging.INFO
+    format_string = (
+        "[%(asctime)s] %(levelname)s: %(name)s: %(message)s"
+        if args.debug
+        else "%(message)s"
+    )
+
+    logging.basicConfig(
+        level=level,
+        format=format_string,
+        stream=sys.stdout,
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
 
 
 def build_parser() -> argparse.ArgumentParser:
@@ -136,17 +130,7 @@ def build_parser() -> argparse.ArgumentParser:
     )
 
     subparsers = parser.add_subparsers(help="sub-command help")
-    fotolab.animate.build_subparser(subparsers)
-    fotolab.auto.build_subparser(subparsers)
-    fotolab.border.build_subparser(subparsers)
-    fotolab.contrast.build_subparser(subparsers)
-    fotolab.info.build_subparser(subparsers)
-    fotolab.resize.build_subparser(subparsers)
-    fotolab.rotate.build_subparser(subparsers)
-    fotolab.montage.build_subparser(subparsers)
-    fotolab.sharpen.build_subparser(subparsers)
-    fotolab.watermark.build_subparser(subparsers)
-    fotolab.env.build_subparser(subparsers)
+    fotolab.subcommands.build_subparser(subparsers)
 
     return parser
 

fotolab/subcommands/__init__.py

@@ -0,0 +1,32 @@
+# Copyright (C) 2024 Kian-Meng Ang
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU Affero General Public License as published by the Free
+# Software Foundation, either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+"""Common utils for subcommand."""
+
+import importlib
+import pkgutil
+
+
+def build_subparser(subparsers):
+    """Build subparser for each subcommands."""
+    iter_namespace = pkgutil.iter_modules(__path__, __name__ + ".")
+
+    subcommands = {
+        name: importlib.import_module(name)
+        for finder, name, ispkg in iter_namespace
+    }
+
+    for subcommand in subcommands.values():
+        subcommand.build_subparser(subparsers)

fotolab/{auto.py → subcommands/auto.py}

@@ -18,10 +18,10 @@
 import argparse
 import logging
 
-import fotolab.contrast
-import fotolab.resize
-import fotolab.sharpen
-import fotolab.watermark
+import fotolab.subcommands.contrast
+import fotolab.subcommands.resize
+import fotolab.subcommands.sharpen
+import fotolab.subcommands.watermark
 
 log = logging.getLogger(__name__)
 
@@ -77,7 +77,7 @@ def run(args: argparse.Namespace) -> None:
     log.debug(args)
     log.debug(combined_args)
 
-    fotolab.resize.run(combined_args)
-    fotolab.contrast.run(combined_args)
-    fotolab.sharpen.run(combined_args)
-    fotolab.watermark.run(combined_args)
+    fotolab.subcommands.resize.run(combined_args)
+    fotolab.subcommands.contrast.run(combined_args)
+    fotolab.subcommands.sharpen.run(combined_args)
+    fotolab.subcommands.watermark.run(combined_args)

fotolab/{env.py → subcommands/env.py}

@@ -44,9 +44,9 @@ def run(_args: argparse.Namespace) -> None:
         None
     """
     sys_version = sys.version.replace("\n", "")
-    print(
+    env = [
         f"fotolab: {__version__}",
         f"python: {sys_version}",
         f"platform: {platform.platform()}",
-        sep="\n",
-    )
+    ]
+    print(*env, sep="\n")

fotolab/{info.py → subcommands/info.py}

@@ -54,6 +54,14 @@ def build_subparser(subparsers) -> None:
         help="show the camera maker details",
     )
 
+    info_parser.add_argument(
+        "--datetime",
+        default=False,
+        action="store_true",
+        dest="datetime",
+        help="show the datetime",
+    )
+
 
 def run(args: argparse.Namespace) -> None:
     """Run info subcommand.
@@ -65,10 +73,20 @@ def run(args: argparse.Namespace) -> None:
         None
     """
     log.debug(args)
+
+    info = []
+    image = Image.open(args.image_filename)
+
     if args.camera:
-        print(camera_metadata(args.image_filename))
+        info.append(camera_metadata(image))
+
+    if args.datetime:
+        info.append(datetime(image))
+
+    if info:
+        print("\n".join(info))
     else:
-        exif_tags = extract_exif_tags(args.image_filename)
+        exif_tags = extract_exif_tags(image)
         if exif_tags:
             tag_name_width = max(map(len, exif_tags))
             for tag_name, tag_value in exif_tags.items():
@@ -77,9 +95,9 @@ def run(args: argparse.Namespace) -> None:
             print("No metadata found!")
 
 
-def extract_exif_tags(image_filename: str, sort: bool = False) -> dict:
+def extract_exif_tags(image: Image.Image, sort: bool = False) -> dict:
     """Extract Exif metadata from image."""
-    image = Image.open(image_filename)
+    print(type(image))
     exif = image._getexif()
     log.debug(exif)
 
@@ -96,8 +114,14 @@ def extract_exif_tags(image_filename: str, sort: bool = False) -> dict:
     return filtered_info
 
 
-def camera_metadata(image_filename):
+def datetime(image: Image.Image):
+    """Extract datetime metadata."""
+    exif_tags = extract_exif_tags(image)
+    return exif_tags["DateTime"]
+
+
+def camera_metadata(image: Image.Image):
     """Extract camera and model metadata."""
-    exif_tags = extract_exif_tags(image_filename)
+    exif_tags = extract_exif_tags(image)
     metadata = f'{exif_tags["Make"]} {exif_tags["Model"]}'
     return metadata.strip()

fotolab/{rotate.py → subcommands/rotate.py}

@@ -40,6 +40,21 @@ def build_subparser(subparsers) -> None:
         metavar="IMAGE_FILENAMES",
     )
 
+    rotate_parser.add_argument(
+        "-r",
+        "--rotation",
+        type=int,
+        default=0,
+        help="Rotation angle in degrees (default: '%(default)s')",
+    )
+
+    rotate_parser.add_argument(
+        "-cw",
+        "--clockwise",
+        action="store_true",
+        help="Rotate clockwise (default: '%(default)s)",
+    )
+
 
 def run(args: argparse.Namespace) -> None:
     """Run rotate subcommand.
@@ -52,10 +67,14 @@ def run(args: argparse.Namespace) -> None:
     """
     log.debug(args)
 
+    rotation = args.rotation
+    if args.clockwise:
+        rotation = -rotation
+
     for image_filename in args.image_filenames:
         original_image = Image.open(image_filename)
         rotated_image = original_image.rotate(
-            180,
+            rotation,
             expand=True,
         )
         save_image(args, rotated_image, image_filename, "rotate")

fotolab/{watermark.py → subcommands/watermark.py}

@@ -19,10 +19,10 @@ import argparse
 import logging
 import math
 
-from PIL import Image, ImageColor, ImageDraw, ImageFont
+from PIL import Image, ImageColor, ImageDraw, ImageFont, ImageSequence
 
 from fotolab import save_image
-from fotolab.info import extract_exif_tags
+from fotolab.subcommands.info import camera_metadata
 
 log = logging.getLogger(__name__)
 
@@ -139,7 +139,7 @@ def build_subparser(subparsers) -> None:
         "-l",
         "--lowercase",
         default=True,
-        action="store_true",
+        action=argparse.BooleanOptionalAction,
         dest="lowercase",
         help="lowercase the watermark text",
     )
@@ -157,13 +157,72 @@ def run(args: argparse.Namespace) -> None:
     log.debug(args)
 
     for image_filename in args.image_filenames:
-        watermarked_image = watermark_image(image_filename, args)
-        save_image(args, watermarked_image, image_filename, "watermark")
+        image = Image.open(image_filename)
+        if image.format == "GIF":
+            watermark_gif_image(image, args)
+        else:
+            watermarked_image = watermark_non_gif_image(image, args)
+            save_image(args, watermarked_image, image_filename, "watermark")
+
+
+def watermark_gif_image(original_image: Image.Image, args: argparse.Namespace):
+    """Watermark the image."""
+    watermarked_image = original_image.copy()
+
+    frames = []
+
+    for frame in ImageSequence.Iterator(original_image):
+        frame = frame.convert("RGBA")
+        draw = ImageDraw.Draw(frame)
+
+        font = ImageFont.load_default(calc_font_size(original_image, args))
+        log.debug("default font: %s", " ".join(font.getname()))
+
+        text = args.text
+        if args.camera and camera_metadata(original_image):
+            text = camera_metadata(original_image)
+
+        if args.lowercase:
+            text = text.lower()
 
+        (left, top, right, bottom) = draw.textbbox(
+            xy=(0, 0), text=text, font=font
+        )
+        text_width = right - left
+        text_height = bottom - top
+        (position_x, position_y) = calc_position(
+            watermarked_image,
+            text_width,
+            text_height,
+            args.position,
+            calc_padding(original_image, args),
+        )
+
+        draw.text(
+            (position_x, position_y),
+            text,
+            font=font,
+            fill=(*ImageColor.getrgb(args.font_color), 128),
+            stroke_width=calc_font_outline_width(original_image, args),
+            stroke_fill=(*ImageColor.getrgb(args.outline_color), 128),
+        )
+        frames.append(frame)
+
+    frames[0].save(
+        "foo.gif",
+        format="GIF",
+        append_images=frames[1:],
+        save_all=True,
+        duration=original_image.info.get("duration", 100),
+        loop=original_image.info.get("loop", 0),
+        disposal=original_image.info.get("disposal", 2),
+    )
 
-def watermark_image(image_filename, args):
+
+def watermark_non_gif_image(
+    original_image: Image.Image, args: argparse.Namespace
+):
     """Watermark the image."""
-    original_image = Image.open(image_filename)
     watermarked_image = original_image.copy()
 
     draw = ImageDraw.Draw(watermarked_image)
@@ -172,8 +231,8 @@ def watermark_image(image_filename, args):
     log.debug("default font: %s", " ".join(font.getname()))
 
     text = args.text
-    if args.camera and camera_metadata(image_filename):
-        text = camera_metadata(image_filename)
+    if args.camera and camera_metadata(original_image):
+        text = camera_metadata(original_image)
 
     if args.lowercase:
         text = text.lower()
@@ -200,13 +259,6 @@ def watermark_image(image_filename, args):
     return watermarked_image
 
 
-def camera_metadata(image_filename):
-    """Extract camera and model metadata."""
-    exif_tags = extract_exif_tags(image_filename)
-    metadata = f'{exif_tags["Make"]} {exif_tags["Model"]}'
-    return metadata.strip()
-
-
 def calc_font_size(image, args) -> int:
     """Calculate the font size based on the width of the image."""
     width, _height = image.size
@@ -244,19 +296,14 @@ def calc_padding(image, args) -> int:
 
 def calc_position(image, text_width, text_height, position, padding) -> tuple:
     """Calculate the boundary coordinates of the watermark text."""
-    (position_x, position_y) = (0, 0)
-
-    if position == "top-left":
-        position_x = 0 + padding
-        position_y = 0 + padding
-    elif position == "top-right":
-        position_x = image.width - text_width - padding
-        position_y = 0 + padding
-    elif position == "bottom-left":
-        position_x = 0 + padding
-        position_y = image.height - text_height - padding
-    elif position == "bottom-right":
-        position_x = image.width - text_width - padding
-        position_y = image.height - text_height - padding
-
-    return (position_x, position_y)
+    positions = {
+        "top-left": (padding, padding),
+        "top-right": (image.width - text_width - padding, padding),
+        "bottom-left": (padding, image.height - text_height - padding),
+        "bottom-right": (
+            image.width - text_width - padding,
+            image.height - text_height - padding,
+        ),
+    }
+
+    return positions.get(position, (0, 0))

{fotolab-0.21.1.dist-info → fotolab-0.24.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.21.1
+Version: 0.24.0
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -61,7 +61,7 @@ fotolab -h
 
 ```console
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
-               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env} ...
+               {animate,auto,border,contrast,env,info,montage,resize,rotate,sharpen,watermark} ...
 
 A console program to manipulate photos.
 
@@ -70,19 +70,19 @@ changelog: https://github.com/kianmeng/fotolab/blob/master/CHANGELOG.md
 issues: https://github.com/kianmeng/fotolab/issues
 
 positional arguments:
-  {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
+  {animate,auto,border,contrast,env,info,montage,resize,rotate,sharpen,watermark}
                     sub-command help
     animate         animate an image
     auto            auto adjust (resize, contrast, and watermark) a photo
     border          add border to image
     contrast        contrast an image
+    env             print environment information for bug reporting
     info            info an image
+    montage         montage a list of image
     resize          resize an image
     rotate          rotate an image
-    montage         montage a list of image
     sharpen         sharpen an image
     watermark       watermark an image
-    env             print environment information for bug reporting
 
 options:
   -h, --help        show this help message and exit
@@ -206,7 +206,7 @@ fotolab info -h
 <!--help-info !-->
 
 ```console
-usage: fotolab info [-h] [-s] IMAGE_FILENAME
+usage: fotolab info [-h] [-s] [--camera] [--datetime] IMAGE_FILENAME
 
 positional arguments:
   IMAGE_FILENAME  set the image filename
@@ -214,6 +214,8 @@ positional arguments:
 options:
   -h, --help      show this help message and exit
   -s, --sort      show image info by sorted field name
+  --camera        show the camera maker details
+  --datetime      show the datetime
 ```
 
 <!--help-info !-->
@@ -227,13 +229,17 @@ fotolab rotate -h
 <!--help-rotate !-->
 
 ```console
-usage: fotolab rotate [-h] IMAGE_FILENAMES [IMAGE_FILENAMES ...]
+usage: fotolab rotate [-h] [-r ROTATION] [-cw]
+                      IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
-  IMAGE_FILENAMES  set the image filenames
+  IMAGE_FILENAMES       set the image filenames
 
 options:
-  -h, --help       show this help message and exit
+  -h, --help            show this help message and exit
+  -r, --rotation ROTATION
+                        Rotation angle in degrees (default: '0')
+  -cw, --clockwise      Rotate clockwise (default: 'False)
 ```
 
 <!--help-rotate !-->
@@ -326,7 +332,7 @@ 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]
-                         [-l]
+                         [-l | --lowercase | --no-lowercase]
                          IMAGE_FILENAMES [IMAGE_FILENAMES ...]
 
 positional arguments:
@@ -354,7 +360,8 @@ options:
                         set the outline color of the watermark text (default:
                         'black')
   --camera              use camera metadata as watermark
-  -l, --lowercase       lowercase the watermark text
+  -l, --lowercase, --no-lowercase
+                        lowercase the watermark text
 ```
 
 <!--help-watermark !-->

fotolab-0.24.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+fotolab/__init__.py,sha256=xMgr0qY4XC9waGeCumA3xk1SjuwsIC0tuMY3k_u0suU,2061
+fotolab/__main__.py,sha256=aboOURPs_snOXTEWYR0q8oq1UTY9e-NxCd1j33V0wHI,833
+fotolab/cli.py,sha256=vUS7eVcwEy2CWn4g5wTujLXS_GAzug9Np7j8-sM6GHU,4321
+fotolab/subcommands/__init__.py,sha256=5ncuu_LxuWphjNohm32Z_lD0FmJPWrAynBzeza0lyCU,1124
+fotolab/subcommands/animate.py,sha256=ejimhTozo9DN7BbqqcV4x8zLnanZRKq1pxBBFeOdr6Q,2967
+fotolab/subcommands/auto.py,sha256=ljvC0Z88Dva18YHyn3auAjlvVHqGrxsky-HGXwaIMZo,2391
+fotolab/subcommands/border.py,sha256=5ch2d7LVPhB2OFuuXSW5ci6Cn967CPDQu0qSfaO7uMg,3591
+fotolab/subcommands/contrast.py,sha256=l7Bs5p8W8ypN9Cg3fFHnU-A20UwMKtjTiPk6D0PRwpM,2095
+fotolab/subcommands/env.py,sha256=6vQDQ1sunJl2XBaSAHpLZUOiKiHy4STO45CMjXJd_Ow,1466
+fotolab/subcommands/info.py,sha256=vDzomRfHOKCNk9TON5CX9UB_km6GYBJT_nkDcwtARVA,3330
+fotolab/subcommands/montage.py,sha256=lUVY-zDSH7mwH-s34_XefdNp7CoDJHkwpbTUGiyJGgs,2037
+fotolab/subcommands/resize.py,sha256=2bH1Kgoe_DqU8ozJ1E_oA6a9JPtuwIlo5a4sq_4Yles,5018
+fotolab/subcommands/rotate.py,sha256=27Xrc8iV9n8WI6tOE-vBBMUeSYu2CtZAh-PGcF7JL-k,2144
+fotolab/subcommands/sharpen.py,sha256=wUPtJdtB6mCRmcHrA0CoEVO0O0ROBJWhejTvUeL67QU,2655
+fotolab/subcommands/watermark.py,sha256=5vsMDeJZhLT5qmftJQXY4jK2gtPQsbTYKXA6Ye2MqmA,8900
+fotolab-0.24.0.dist-info/entry_points.txt,sha256=mvw7AY_yZkIyjAxPtHNed9X99NZeLnMxEeAfEJUbrCM,44
+fotolab-0.24.0.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
+fotolab-0.24.0.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
+fotolab-0.24.0.dist-info/METADATA,sha256=VH-jJMrow1yoLw1XXO4eVgl1putj9tJuLFd93Tg9MSE,10975
+fotolab-0.24.0.dist-info/RECORD,,

fotolab-0.21.1.dist-info/RECORD

@@ -1,19 +0,0 @@
-fotolab/__init__.py,sha256=fZZb0I229_RXcxunCTP3flULzE0p48prsOWsvTqLkyM,2061
-fotolab/__main__.py,sha256=aboOURPs_snOXTEWYR0q8oq1UTY9e-NxCd1j33V0wHI,833
-fotolab/animate.py,sha256=ejimhTozo9DN7BbqqcV4x8zLnanZRKq1pxBBFeOdr6Q,2967
-fotolab/auto.py,sha256=l_-Kf5V5Anvwz1QV1ET-42YsDWEeHf_okHkXWOycWAI,2295
-fotolab/border.py,sha256=5ch2d7LVPhB2OFuuXSW5ci6Cn967CPDQu0qSfaO7uMg,3591
-fotolab/cli.py,sha256=FBFSeMNqcOiJ6MuAcy0qUvc9cscdFUG946HlWZXBPtY,4984
-fotolab/contrast.py,sha256=l7Bs5p8W8ypN9Cg3fFHnU-A20UwMKtjTiPk6D0PRwpM,2095
-fotolab/env.py,sha256=fzUoRWgYEiYJIWYEiiSLEb7dH_xVUOnhMpQgc1yjrTY,1457
-fotolab/info.py,sha256=lY9n6HDnlDyRVDTRqYwzxm5xgPSyh0P8N3ybnnNtNtw,2892
-fotolab/montage.py,sha256=lUVY-zDSH7mwH-s34_XefdNp7CoDJHkwpbTUGiyJGgs,2037
-fotolab/resize.py,sha256=2bH1Kgoe_DqU8ozJ1E_oA6a9JPtuwIlo5a4sq_4Yles,5018
-fotolab/rotate.py,sha256=l_vQgf0IcI8AR1TSVsk4PrMZtJ3j_wpU77rKiGJ-KTA,1715
-fotolab/sharpen.py,sha256=wUPtJdtB6mCRmcHrA0CoEVO0O0ROBJWhejTvUeL67QU,2655
-fotolab/watermark.py,sha256=-YzxABVT5KJM1GgYLP3Z8X9YPfQzncOA9YnRJgNN6nA,7457
-fotolab-0.21.1.dist-info/entry_points.txt,sha256=mvw7AY_yZkIyjAxPtHNed9X99NZeLnMxEeAfEJUbrCM,44
-fotolab-0.21.1.dist-info/LICENSE.md,sha256=tGtFDwxWTjuR9syrJoSv1Hiffd2u8Tu8cYClfrXS_YU,31956
-fotolab-0.21.1.dist-info/WHEEL,sha256=EZbGkh7Ie4PoZfRQ8I0ZuP9VklN_TvcZ6DSE5Uar4z4,81
-fotolab-0.21.1.dist-info/METADATA,sha256=hH4mutSmdcXzZmt204mH0EdmgErcY18WK8KR9wtjw5o,10600
-fotolab-0.21.1.dist-info/RECORD,,