Added batch_edit.py example, [skip ci]

examples/batch_edit.py

@@ -0,0 +1,100 @@
+"""
+Batch edit photo metadata using osxphotos.
+
+Run this with `osxphotos run batch_edit.py` or `osxphotos run batch_edit.py --help` for more information.
+"""
+
+from __future__ import annotations
+
+import sys
+
+import click
+import photoscript
+
+import osxphotos
+from osxphotos.cli import echo, echo_error, selection_command, verbose
+from osxphotos.cli.param_types import TemplateString
+
+
+@selection_command
+@click.option(
+    "--title",
+    metavar="TITLE_TEMPLATE",
+    type=TemplateString(),
+    help="Set title of photo.",
+)
+@click.option(
+    "--description",
+    metavar="DESCRIPTION_TEMPLATE",
+    type=TemplateString(),
+    help="Set description of photo.",
+)
+@click.option(
+    "--keyword",
+    metavar="KEYWORD_TEMPLATE",
+    type=TemplateString(),
+    multiple=True,
+    help="Set keywords of photo. May be specified multiple times.",
+)
+@click.option("--dry-run", is_flag=True, help="Don't actually change anything.")
+def batch_edit(
+    photos: list[osxphotos.PhotoInfo], title, description, keyword, dry_run, **kwargs
+):
+    """
+    Batch edit photo metadata such as title, description, keywords, etc.
+    """
+
+    if not title and not description and not keyword:
+        echo_error(
+            "[error] Must specify at least one of --title, --description, or --keyword"
+        )
+        sys.exit(1)
+
+    if not photos:
+        echo_error("[error] No photos selected")
+        sys.exit(1)
+
+    echo(f"Processing [num]{len(photos)}[/] photos...")
+    for photo in photos:
+        ps_photo = photoscript.Photo(photo.uuid)
+        verbose(
+            f"Processing [filename]{photo.original_filename}[/] ([uuid]{photo.uuid}[/])"
+        )
+        if title:
+            title_string, _ = photo.render_template(title)
+            if len(title_string) > 1:
+                echo_error(
+                    f"[error] Title template must return a single string: {title_string}"
+                )
+                sys.exit(1)
+            if title_string:
+                verbose(f"Setting title to [bold]{title_string[0]}")
+                if not dry_run:
+                    ps_photo.title = title_string[0]
+        if description:
+            description_string, _ = photo.render_template(description)
+            if len(description_string) > 1:
+                echo_error(
+                    f"[error] Description template must return a single string: {description_string}"
+                )
+                sys.exit(1)
+            if description_string:
+                verbose(f"Setting description to [bold]{description_string[0]}")
+                if not dry_run:
+                    ps_photo.description = description_string[0]
+        if keyword:
+            keywords = []
+            for kw in keyword:
+                kw_string, _ = photo.render_template(kw)
+                if kw_string:
+                    keywords.extend(kw_string)
+            keywords = list(set(keywords))
+            verbose(
+                f"Setting keywords to {', '.join(f'[bold]{kw}[/]' for kw in keywords)}"
+            )
+            if not dry_run:
+                ps_photo.keywords = keywords
+
+
+if __name__ == "__main__":
+    batch_edit()