Added --report option to CLI, implements #253

CHANGELOG.md

@@ -4,6 +4,34 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.37.0](https://github.com/RhetTbull/osxphotos/compare/v0.36.25...v0.37.0)
+
+> 28 November 2020
+
+- Added {exiftool} template, implements issue #259 [`48acb42`](https://github.com/RhetTbull/osxphotos/commit/48acb42631226a71bfc636eea2d3151f1b7165f4)
+
+#### [v0.36.25](https://github.com/RhetTbull/osxphotos/compare/v0.36.24...v0.36.25)
+
+> 27 November 2020
+
+- Added --original-suffix for issue #263 [`399d432`](https://github.com/RhetTbull/osxphotos/commit/399d432a66354b9c235f30d10c6985fbde1b7e4f)
+
+#### [v0.36.24](https://github.com/RhetTbull/osxphotos/compare/v0.36.23...v0.36.24)
+
+> 26 November 2020
+
+- Initial implementation for issue #265 [`382fca3`](https://github.com/RhetTbull/osxphotos/commit/382fca3f92a3c251c12426dd0dc6d7dc21b691cf)
+- More work on issue #265 [`d5a9f76`](https://github.com/RhetTbull/osxphotos/commit/d5a9f767199d25ebd9d5925d05ee39ea7e51ac26)
+- Simplified sidecar table in export_db [`0632a97`](https://github.com/RhetTbull/osxphotos/commit/0632a97f55af67c7e5265b0d3283155c7c087e89)
+
+#### [v0.36.23](https://github.com/RhetTbull/osxphotos/compare/v0.36.22...v0.36.23)
+
+> 26 November 2020
+
+- Fix for missing original_filename, issue #267 [`fa33218`](https://github.com/RhetTbull/osxphotos/commit/fa332186ab3cdbe1bfd6496ff29b652ef984a5f8)
+- version bump [`b5195f9`](https://github.com/RhetTbull/osxphotos/commit/b5195f9d2b81cf6737b65e3cd3793ea9b0da13eb)
+- Updated test [`aa2ebf5`](https://github.com/RhetTbull/osxphotos/commit/aa2ebf55bb50eec14f86a532334b376e407f4bbc)
+
 #### [v0.36.22](https://github.com/RhetTbull/osxphotos/compare/v0.36.21...v0.36.22)
 
 > 26 November 2020

README.md

@@ -351,6 +351,13 @@ Options:
                                   photo would be named
                                   'photoname_bearbeiten.ext'.  The default
                                   suffix is '_edited'.
+  --original-suffix SUFFIX        Optional suffix for naming original photos.
+                                  Default name for original photos is in form
+                                  'filename.ext'. For example, with '--
+                                  original-suffix _original', the original
+                                  photo would be named
+                                  'filename_original.ext'.  The default suffix
+                                  is '' (no suffix).
   --no-extended-attributes        Don't copy extended attributes when
                                   exporting.  You only need this if exporting
                                   to a filesystem that doesn't support Mac OS
@@ -366,6 +373,8 @@ Options:
                                   work with iTerm2 (use with Terminal.app).
                                   This is faster and more reliable than the
                                   default AppleScript interface.
+  --report REPORTNAME.CSV         Write a CSV formatted report of all files
+                                  that were exported.
   -h, --help                      Show this message and exit.
 
 ** Export **
@@ -629,18 +638,26 @@ exported, one to each directory.  For example: --directory
 of the following directories if the photos were created in 2019 and were in
 albums 'Vacation' and 'Family': 2019/Vacation, 2019/Family
 
-Substitution        Description
+Substitution              Description
-{album}             Album(s) photo is contained in
+{album}                   Album(s) photo is contained in
-{folder_album}      Folder path + album photo is contained in. e.g.
+{folder_album}            Folder path + album photo is contained in. e.g.
-                    'Folder/Subfolder/Album' or just 'Album' if no enclosing
+                          'Folder/Subfolder/Album' or just 'Album' if no
-                    folder
+                          enclosing folder
-{keyword}           Keyword(s) assigned to photo
+{keyword}                 Keyword(s) assigned to photo
-{person}            Person(s) / face(s) in a photo
+{person}                  Person(s) / face(s) in a photo
-{label}             Image categorization label associated with a photo
+{label}                   Image categorization label associated with a photo
-                    (Photos 5 only)
+                          (Photos 5 only)
-{label_normalized}  All lower case version of 'label' (Photos 5 only)
+{label_normalized}        All lower case version of 'label' (Photos 5 only)
-{comment}           Comment(s) on shared Photos; format is 'Person name:
+{comment}                 Comment(s) on shared Photos; format is 'Person
-                    comment text' (Photos 5 only)
+                          name: comment text' (Photos 5 only)
+{exiftool:GROUP:TAGNAME}  Use exiftool (https://exiftool.org) to extract
+                          metadata, in form GROUP:TAGNAME, from image.  E.g.
+                          '{exiftool:EXIF:Make}' to get camera make, or
+                          {exiftool:IPTC:Keywords} to extract keywords. See
+                          https://exiftool.org/TagNames/ for list of valid
+                          tag names.  You must specify group (e.g. EXIF,
+                          IPTC, etc) as used in `exiftool -G`. exiftool must
+                          be installed in the path to use this template.
 ```
 
 Example: export all photos to ~/Desktop/export group in folders by date created
@@ -2038,6 +2055,7 @@ The following template field substitutions are availabe for use with `PhotoInfo.
 |{label}|Image categorization label associated with a photo (Photos 5 only)|
 |{label_normalized}|All lower case version of 'label' (Photos 5 only)|
 |{comment}|Comment(s) on shared Photos; format is 'Person name: comment text' (Photos 5 only)|
+|{exiftool:GROUP:TAGNAME}|Use exiftool (https://exiftool.org) to extract metadata, in form GROUP:TAGNAME, from image.  E.g. '{exiftool:EXIF:Make}' to get camera make, or {exiftool:IPTC:Keywords} to extract keywords. See https://exiftool.org/TagNames/ for list of valid tag names.  You must specify group (e.g. EXIF, IPTC, etc) as used in `exiftool -G`. exiftool must be installed in the path to use this template.|
 
 ### Utility Functions
 

osxphotos/__main__.py

@@ -1383,6 +1383,14 @@ def query(
     "'photoname_edited.ext'. For example, with '--edited-suffix _bearbeiten', the edited photo "
     "would be named 'photoname_bearbeiten.ext'.  The default suffix is '_edited'.",
 )
+@click.option(
+    "--original-suffix",
+    metavar="SUFFIX",
+    default="",
+    help="Optional suffix for naming original photos.  Default name for original photos is in form "
+    "'filename.ext'. For example, with '--original-suffix _original', the original photo "
+    "would be named 'filename_original.ext'.  The default suffix is '' (no suffix).",
+)
 @click.option(
     "--no-extended-attributes",
     is_flag=True,
@@ -1405,6 +1413,12 @@ def query(
     "Highly experimental alpha feature; does not work with iTerm2 (use with Terminal.app). "
     "This is faster and more reliable than the default AppleScript interface.",
 )
+@click.option(
+    "--report",
+    metavar="REPORTNAME.CSV",
+    help="Write a CSV formatted report of all files that were exported.",
+    type=click.Path(),
+)
 @DB_ARGUMENT
 @click.argument("dest", nargs=1, type=click.Path(exists=True))
 @click.pass_obj
@@ -1484,6 +1498,7 @@ def export(
     directory,
     filename_template,
     edited_suffix,
+    original_suffix,
     place,
     no_place,
     has_comment,
@@ -1496,6 +1511,7 @@ def export(
     deleted_only,
     use_photos_export,
     use_photokit,
+    report,
 ):
     """ Export photos from the Photos database.
         Export path DEST is required.
@@ -1513,7 +1529,12 @@ def export(
     VERBOSE = bool(verbose_)
 
     if not os.path.isdir(dest):
-        sys.exit(f"DEST {dest} must be valid path")
+        click.echo(f"DEST {dest} must be valid path", err=True)
+        raise click.Abort()
+
+    if report and os.path.isdir(report):
+        click.echo(f"report is a directory, must be file name", err=True)
+        raise click.Abort()
 
     # sanity check input args
     exclusive = [
@@ -1720,6 +1741,11 @@ def export(
         results_skipped = []
         results_exif_updated = []
         results_touched = []
+        results_converted = []
+        results_sidecar_json_written = []
+        results_sidecar_json_skipped = []
+        results_sidecar_xmp_written = []
+        results_sidecar_xmp_skipped = []
         if verbose_:
             for p in photos:
                 results = export_photo(
@@ -1750,6 +1776,7 @@ def export(
                     dry_run=dry_run,
                     touch_file=touch_file,
                     edited_suffix=edited_suffix,
+                    original_suffix=original_suffix,
                     use_photos_export=use_photos_export,
                     convert_to_jpeg=convert_to_jpeg,
                     jpeg_quality=jpeg_quality,
@@ -1762,6 +1789,11 @@ def export(
                 results_skipped.extend(results.skipped)
                 results_exif_updated.extend(results.exif_updated)
                 results_touched.extend(results.touched)
+                results_converted.extend(results.converted_to_jpeg)
+                results_sidecar_json_written.extend(results.sidecar_json_written)
+                results_sidecar_json_skipped.extend(results.sidecar_json_skipped)
+                results_sidecar_xmp_written.extend(results.sidecar_xmp_written)
+                results_sidecar_xmp_skipped.extend(results.sidecar_xmp_skipped)
 
                 # if convert_to_jpeg and p.isphoto and p.uti != "public.jpeg":
                 #     for photo_file in set(
@@ -1801,6 +1833,7 @@ def export(
                         dry_run=dry_run,
                         touch_file=touch_file,
                         edited_suffix=edited_suffix,
+                        original_suffix=original_suffix,
                         use_photos_export=use_photos_export,
                         convert_to_jpeg=convert_to_jpeg,
                         jpeg_quality=jpeg_quality,
@@ -1813,9 +1846,41 @@ def export(
                     results_skipped.extend(results.skipped)
                     results_exif_updated.extend(results.exif_updated)
                     results_touched.extend(results.touched)
+                    results_converted.extend(results.converted_to_jpeg)
+                    results_sidecar_json_written.extend(results.sidecar_json_written)
+                    results_sidecar_json_skipped.extend(results.sidecar_json_skipped)
+                    results_sidecar_xmp_written.extend(results.sidecar_xmp_written)
+                    results_sidecar_xmp_skipped.extend(results.sidecar_xmp_skipped)
 
         stop_time = time.perf_counter()
         # print summary results
+        # print(f"results_exported: {results_exported}")
+        # print(f"results_new: {results_new}")
+        # print(f"results_updated: {results_updated}")
+        # print(f"results_skipped: {results_skipped}")
+        # print(f"results_exif_updated: {results_exif_updated}")
+        # print(f"results_touched: {results_touched}")
+        # print(f"results_converted: {results_converted}")
+        # print(f"results_sidecar_json: {results_sidecar_json}")
+        # print(f"results_sidecar_xmp: {results_sidecar_xmp}")
+
+        if report:
+            verbose(f"Writing export report to {report}")
+            write_export_report(
+                report,
+                results_exported=results_exported,
+                results_new=results_new,
+                results_updated=results_updated,
+                results_skipped=results_skipped,
+                results_exif_updated=results_exif_updated,
+                results_touched=results_touched,
+                results_converted=results_converted,
+                results_sidecar_json_written=results_sidecar_json_written,
+                results_sidecar_json_skipped=results_sidecar_json_skipped,
+                results_sidecar_xmp_written=results_sidecar_xmp_written,
+                results_sidecar_xmp_skipped=results_sidecar_xmp_skipped,
+            )
+
         if update:
             photo_str_new = "photos" if len(results_new) != 1 else "photo"
             photo_str_updated = "photos" if len(results_updated) != 1 else "photo"
@@ -2309,6 +2374,7 @@ def export_photo(
     dry_run=None,
     touch_file=None,
     edited_suffix="_edited",
+    original_suffix="",
     use_photos_export=False,
     convert_to_jpeg=False,
     jpeg_quality=1.0,
@@ -2364,19 +2430,19 @@ def export_photo(
         if photo.ismissing:
             space = " " if not verbose_ else ""
             verbose(f"{space}Skipping missing photo {photo.original_filename}")
-            return ExportResults([], [], [], [], [], [])
+            return ExportResults([], [], [], [], [], [], [], [], [], [], [])
         elif photo.path is None:
             space = " " if not verbose_ else ""
             verbose(
                 f"{space}WARNING: photo {photo.original_filename} ({photo.uuid}) is missing but ismissing=False, "
                 f"skipping {photo.original_filename}"
             )
-            return ExportResults([], [], [], [], [], [])
+            return ExportResults([], [], [], [], [], [], [], [], [], [], [])
     elif photo.ismissing and not photo.iscloudasset and not photo.incloud:
         verbose(
             f"Skipping missing {photo.original_filename}: not iCloud asset or missing from cloud"
         )
-        return ExportResults([], [], [], [], [], [])
+        return ExportResults([], [], [], [], [], [], [], [], [], [], [])
 
     results_exported = []
     results_new = []
@@ -2384,6 +2450,11 @@ def export_photo(
     results_skipped = []
     results_exif_updated = []
     results_touched = []
+    results_converted = []
+    results_sidecar_json_written = []
+    results_sidecar_json_skipped = []
+    results_sidecar_xmp_written = []
+    results_sidecar_xmp_skipped = []
 
     export_original = not (skip_original_if_edited and photo.hasadjustments)
 
@@ -2405,7 +2476,19 @@ def export_photo(
 
     filenames = get_filenames_from_template(photo, filename_template, original_name)
     for filename in filenames:
-        verbose(f"Exporting {photo.original_filename} ({photo.filename}) as {filename}")
+        if original_suffix:
+            original_filename = pathlib.Path(filename)
+            original_filename = (
+                original_filename.parent
+                / f"{original_filename.stem}{original_suffix}{original_filename.suffix}"
+            )
+            original_filename = str(original_filename)
+        else:
+            original_filename = filename
+
+        verbose(
+            f"Exporting {photo.original_filename} ({photo.filename}) as {original_filename}"
+        )
 
         dest_paths = get_dirnames_from_template(
             photo, directory, export_by_date, dest, dry_run
@@ -2431,12 +2514,10 @@ def export_photo(
 
         # export the photo to each path in dest_paths
         for dest_path in dest_paths:
-            if not export_original:
+            if export_original:
-                verbose(f"Skipping original version of {photo.original_filename}")
-            else:
                 export_results = photo.export2(
                     dest_path,
-                    filename,
+                    original_filename,
                     sidecar_json=sidecar_json,
                     sidecar_xmp=sidecar_xmp,
                     live_photo=export_live,
@@ -2459,6 +2540,7 @@ def export_photo(
                     jpeg_quality=jpeg_quality,
                     ignore_date_modified=ignore_date_modified,
                     use_photokit=use_photokit,
+                    verbose=verbose,
                 )
 
                 results_exported.extend(export_results.exported)
@@ -2467,6 +2549,11 @@ def export_photo(
                 results_skipped.extend(export_results.skipped)
                 results_exif_updated.extend(export_results.exif_updated)
                 results_touched.extend(export_results.touched)
+                results_converted.extend(export_results.converted_to_jpeg)
+                results_sidecar_json_written.extend(export_results.sidecar_json_written)
+                results_sidecar_json_skipped.extend(export_results.sidecar_json_skipped)
+                results_sidecar_xmp_written.extend(export_results.sidecar_xmp_written)
+                results_sidecar_xmp_skipped.extend(export_results.sidecar_xmp_skipped)
 
                 if verbose_:
                     for exported in export_results.exported:
@@ -2480,6 +2567,9 @@ def export_photo(
                     for touched in export_results.touched:
                         verbose(f"Touched date on file {touched}")
 
+            else:
+                verbose(f"Skipping original version of {photo.original_filename}")
+
             # if export-edited, also export the edited version
             # verify the photo has adjustments and valid path to avoid raising an exception
             if export_edited and photo.hasadjustments:
@@ -2488,7 +2578,7 @@ def export_photo(
                 if not download_missing and photo.path_edited is None:
                     verbose(f"Skipping missing edited photo for {filename}")
                 else:
-                    edited_name = pathlib.Path(filename)
+                    edited_filename = pathlib.Path(filename)
                     # check for correct edited suffix
                     if photo.path_edited is not None:
                         edited_ext = pathlib.Path(photo.path_edited).suffix
@@ -2496,11 +2586,15 @@ def export_photo(
                         # use filename suffix which might be wrong,
                         # will be corrected by use_photos_export
                         edited_ext = pathlib.Path(photo.filename).suffix
-                    edited_name = f"{edited_name.stem}{edited_suffix}{edited_ext}"
+                    edited_filename = (
-                    verbose(f"Exporting edited version of {filename} as {edited_name}")
+                        f"{edited_filename.stem}{edited_suffix}{edited_ext}"
+                    )
+                    verbose(
+                        f"Exporting edited version of {filename} as {edited_filename}"
+                    )
                     export_results_edited = photo.export2(
                         dest_path,
-                        edited_name,
+                        edited_filename,
                         sidecar_json=sidecar_json,
                         sidecar_xmp=sidecar_xmp,
                         export_as_hardlink=export_as_hardlink,
@@ -2522,6 +2616,7 @@ def export_photo(
                         jpeg_quality=jpeg_quality,
                         ignore_date_modified=ignore_date_modified,
                         use_photokit=use_photokit,
+                        verbose=verbose,
                     )
 
                     results_exported.extend(export_results_edited.exported)
@@ -2530,6 +2625,19 @@ def export_photo(
                     results_skipped.extend(export_results_edited.skipped)
                     results_exif_updated.extend(export_results_edited.exif_updated)
                     results_touched.extend(export_results_edited.touched)
+                    results_converted.extend(export_results_edited.converted_to_jpeg)
+                    results_sidecar_json_written.extend(
+                        export_results_edited.sidecar_json_written
+                    )
+                    results_sidecar_json_skipped.extend(
+                        export_results_edited.sidecar_json_skipped
+                    )
+                    results_sidecar_xmp_written.extend(
+                        export_results_edited.sidecar_xmp_written
+                    )
+                    results_sidecar_xmp_skipped.extend(
+                        export_results_edited.sidecar_xmp_skipped
+                    )
 
                     if verbose_:
                         for exported in export_results_edited.exported:
@@ -2550,6 +2658,11 @@ def export_photo(
         results_skipped,
         results_exif_updated,
         results_touched,
+        results_converted,
+        results_sidecar_json_written,
+        results_sidecar_json_skipped,
+        results_sidecar_xmp_written,
+        results_sidecar_xmp_skipped,
     )
 
 
@@ -2579,7 +2692,11 @@ def get_filenames_from_template(photo, filename_template, original_name):
             )
         filenames = [f"{file_}{photo_ext}" for file_ in filenames]
     else:
-                filenames = [photo.original_filename] if (original_name and (photo.original_filename is not None)) else [photo.filename]
+        filenames = (
+            [photo.original_filename]
+            if (original_name and (photo.original_filename is not None))
+            else [photo.filename]
+        )
 
     filenames = [sanitize_filename(filename) for filename in filenames]
     return filenames
@@ -2697,5 +2814,111 @@ def load_uuid_from_file(filename):
     return uuid
 
 
+def write_export_report(
+    report_file,
+    results_exported,
+    results_new,
+    results_updated,
+    results_skipped,
+    results_exif_updated,
+    results_touched,
+    results_converted,
+    results_sidecar_json_written,
+    results_sidecar_json_skipped,
+    results_sidecar_xmp_written,
+    results_sidecar_xmp_skipped,
+):
+
+    """ write CSV report with results from export """
+
+    # Collect results for reporting
+    # TODO: pull this in a separate write_report function
+    all_results = {
+        result: {
+            "filename": result,
+            "exported": 0,
+            "new": 0,
+            "updated": 0,
+            "skipped": 0,
+            "exif_updated": 0,
+            "touched": 0,
+            "converted_to_jpeg": 0,
+            "sidecar_xmp": 0,
+            "sidecar_json": 0,
+        }
+        for result in results_exported
+        + results_new
+        + results_updated
+        + results_skipped
+        + results_exif_updated
+        + results_touched
+        + results_converted
+        + results_sidecar_json_written
+        + results_sidecar_json_skipped
+        + results_sidecar_xmp_written
+        + results_sidecar_xmp_skipped
+    }
+
+    for result in results_exported:
+        all_results[result]["exported"] = 1
+
+    for result in results_new:
+        all_results[result]["new"] = 1
+
+    for result in results_updated:
+        all_results[result]["updated"] = 1
+
+    for result in results_skipped:
+        all_results[result]["skipped"] = 1
+
+    for result in results_exif_updated:
+        all_results[result]["exif_updated"] = 1
+
+    for result in results_touched:
+        all_results[result]["touched"] = 1
+
+    for result in results_converted:
+        all_results[result]["converted_to_jpeg"] = 1
+
+    for result in results_sidecar_xmp_written:
+        all_results[result]["sidecar_xmp"] = 1
+        all_results[result]["exported"] = 1
+
+    for result in results_sidecar_xmp_skipped:
+        all_results[result]["sidecar_xmp"] = 1
+        all_results[result]["skipped"] = 1
+
+    for result in results_sidecar_json_written:
+        all_results[result]["sidecar_json"] = 1
+        all_results[result]["exported"] = 1
+
+    for result in results_sidecar_json_skipped:
+        all_results[result]["sidecar_json"] = 1
+        all_results[result]["skipped"] = 1
+
+    report_columns = [
+        "filename",
+        "exported",
+        "new",
+        "updated",
+        "skipped",
+        "exif_updated",
+        "touched",
+        "converted_to_jpeg",
+        "sidecar_xmp",
+        "sidecar_json",
+    ]
+
+    try:
+        with open(report_file, "w") as csvfile:
+            writer = csv.DictWriter(csvfile, fieldnames=report_columns)
+            writer.writeheader()
+            for data in [result for result in all_results.values()]:
+                writer.writerow(data)
+    except IOError:
+        click.echo("Could not open output file for writing", err=True)
+        raise click.Abort()
+
+
 if __name__ == "__main__":
     cli()  # pylint: disable=no-value-for-parameter

osxphotos/_version.py

@@ -1,4 +1,4 @@
 """ version info """
 
-__version__ = "0.36.23"
+__version__ = "0.37.1"
 

osxphotos/export_db.py

@@ -14,7 +14,7 @@ from sqlite3 import Error
 
 from ._version import __version__
 
-OSXPHOTOS_EXPORTDB_VERSION = "2.0"
+OSXPHOTOS_EXPORTDB_VERSION = "3.2"
 
 
 class ExportDB_ABC(ABC):
@@ -76,6 +76,14 @@ class ExportDB_ABC(ABC):
     def set_exifdata_for_file(self, uuid, exifdata):
         pass
 
+    @abstractmethod
+    def set_sidecar_for_file(self, filename, sidecar_data, sidecar_sig):
+        pass
+
+    @abstractmethod
+    def get_sidecar_for_file(self, filename):
+        pass
+
     @abstractmethod
     def set_data(
         self,
@@ -141,6 +149,12 @@ class ExportDBNoOp(ExportDB_ABC):
     def set_exifdata_for_file(self, uuid, exifdata):
         pass
 
+    def set_sidecar_for_file(self, filename, sidecar_data, sidecar_sig):
+        pass
+
+    def get_sidecar_for_file(self, filename):
+        return None, (None, None, None)
+
     def set_data(
         self,
         filename,
@@ -379,6 +393,48 @@ class ExportDB(ExportDB_ABC):
         except Error as e:
             logging.warning(e)
 
+    def get_sidecar_for_file(self, filename):
+        """ returns the sidecar data and signature for a file """
+        filename = str(pathlib.Path(filename).relative_to(self._path)).lower()
+        conn = self._conn
+        try:
+            c = conn.cursor()
+            c.execute(
+                "SELECT sidecar_data, mode, size, mtime FROM sidecar WHERE filepath_normalized = ?",
+                (filename,),
+            )
+            results = c.fetchone()
+            if results:
+                sidecar_data = results[0]
+                sidecar_sig = (
+                    results[1],
+                    results[2],
+                    int(results[3]) if results[3] is not None else None,
+                )
+            else:
+                sidecar_data = None
+                sidecar_sig = (None, None, None)
+        except Error as e:
+            logging.warning(e)
+            sidecar_data = None
+            sidecar_sig = (None, None, None)
+
+        return sidecar_data, sidecar_sig
+
+    def set_sidecar_for_file(self, filename, sidecar_data, sidecar_sig):
+        """ sets the sidecar data and signature for a file """
+        filename = str(pathlib.Path(filename).relative_to(self._path)).lower()
+        conn = self._conn
+        try:
+            c = conn.cursor()
+            c.execute(
+                "INSERT OR REPLACE INTO sidecar(filepath_normalized, sidecar_data, mode, size, mtime) VALUES (?, ?, ?, ?, ?);",
+                (filename, sidecar_data, *sidecar_sig),
+            )
+            conn.commit()
+        except Error as e:
+            logging.warning(e)
+
     def set_data(
         self,
         filename,
@@ -479,13 +535,11 @@ class ExportDB(ExportDB_ABC):
 
         if not os.path.isfile(dbfile):
             conn = self._get_db_connection(dbfile)
-            if conn:
+            if not conn:
-                self._create_db_tables(conn)
-                self.was_created = True
-                self.was_upgraded = ()
-                self.version = OSXPHOTOS_EXPORTDB_VERSION
-            else:
                 raise Exception("Error getting connection to database {dbfile}")
+            self._create_db_tables(conn)
+            self.was_created = True
+            self.was_upgraded = ()
         else:
             conn = self._get_db_connection(dbfile)
             self.was_created = False
@@ -495,8 +549,7 @@ class ExportDB(ExportDB_ABC):
                 self.was_upgraded = (version_info[1], OSXPHOTOS_EXPORTDB_VERSION)
             else:
                 self.was_upgraded = ()
-            self.version = OSXPHOTOS_EXPORTDB_VERSION
+        self.version = OSXPHOTOS_EXPORTDB_VERSION
-
         return conn
 
     def _get_db_connection(self, dbfile):
@@ -570,11 +623,20 @@ class ExportDB(ExportDB_ABC):
                               size INTEGER,
                               mtime REAL
                               ); """,
+            "sql_sidecar_table": """ CREATE TABLE IF NOT EXISTS sidecar (
+                              id INTEGER PRIMARY KEY,
+                              filepath_normalized TEXT NOT NULL,
+                              sidecar_data TEXT,
+                              mode INTEGER,
+                              size INTEGER,
+                              mtime REAL
+                              ); """,
             "sql_files_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_files_filepath_normalized on files (filepath_normalized); """,
             "sql_info_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_info_uuid on info (uuid); """,
             "sql_exifdata_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_exifdata_filename on exifdata (filepath_normalized); """,
             "sql_edited_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_edited_filename on edited (filepath_normalized);""",
             "sql_converted_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_converted_filename on converted (filepath_normalized);""",
+            "sql_sidecar_idx": """ CREATE UNIQUE INDEX IF NOT EXISTS idx_sidecar_filename on sidecar (filepath_normalized);""",
         }
         try:
             c = conn.cursor()

osxphotos/photoinfo/_photoinfo_export.py

@@ -13,6 +13,7 @@
 # TODO: should this be its own PhotoExporter class?
 
 import glob
+import hashlib
 import json
 import logging
 import os
@@ -41,14 +42,34 @@ from ..photokit import (
     PhotoLibrary,
     PhotoKitFetchFailed,
 )
-from ..utils import dd_to_dms_str, findfiles
+from ..utils import dd_to_dms_str, findfiles, noop
 
 ExportResults = namedtuple(
     "ExportResults",
-    ["exported", "new", "updated", "skipped", "exif_updated", "touched"],
+    [
+        "exported",
+        "new",
+        "updated",
+        "skipped",
+        "exif_updated",
+        "touched",
+        "converted_to_jpeg",
+        "sidecar_json_written",
+        "sidecar_json_skipped",
+        "sidecar_xmp_written",
+        "sidecar_xmp_skipped",
+    ],
 )
 
 
+# hexdigest is not a class method, don't import this into PhotoInfo
+def hexdigest(strval):
+    """ hexdigest of a string, using blake2b """
+    h = hashlib.blake2b(digest_size=20)
+    h.update(bytes(strval, "utf-8"))
+    return h.hexdigest()
+
+
 # _export_photo_uuid_applescript is not a class method, don't import this into PhotoInfo
 def _export_photo_uuid_applescript(
     uuid,
@@ -149,11 +170,9 @@ def _export_photo_uuid_applescript(
                 and path.suffix.lower() == ".mov"
             ):
                 # it's the .mov part of live photo but not requested, so don't export
-                logging.debug(f"Skipping live photo file {path}")
                 continue
             if len(exported_files) > 1 and burst and path.stem != filename_stem:
                 # skip any burst photo that's not the one we asked for
-                logging.debug(f"Skipping burst photo file {path}")
                 continue
             if filestem:
                 # rename the file based on filestem, keeping original extension
@@ -161,7 +180,6 @@ def _export_photo_uuid_applescript(
             else:
                 # use the name Photos provided
                 dest_new = dest / path.name
-            logging.debug(f"exporting {path} to dest_new: {dest_new}")
             if not dry_run:
                 FileUtil.copy(str(path), str(dest_new))
             exported_paths.append(str(dest_new))
@@ -324,6 +342,7 @@ def export2(
     jpeg_quality=1.0,
     ignore_date_modified=False,
     use_photokit=False,
+    verbose=None,
 ):
     """ export photo, like export but with update and dry_run options
         dest: must be valid destination path or exception raised 
@@ -367,6 +386,7 @@ def export2(
         convert_to_jpeg: boolean; if True, converts non-jpeg images to jpeg
         jpeg_quality: float in range 0.0 <= jpeg_quality <= 1.0.  A value of 1.0 specifies use best quality, a value of 0.0 specifies use maximum compression.
         ignore_date_modified: for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set
+        verbose: optional callable function to use for printing verbose text during processing; if None (default), does not print output.
 
         Returns: ExportResults namedtuple with fields: exported, new, updated, skipped 
                     where each field is a list of file paths
@@ -383,6 +403,12 @@ def export2(
     if export_db is None:
         export_db = ExportDBNoOp()
 
+    if verbose is None:
+        verbose = noop
+    elif not callable(verbose):
+        raise TypeError("verbose must be callable")
+    self._verbose = verbose
+
     # suffix to add to edited files
     # e.g. name will be filename_edited.jpg
     edited_identifier = "_edited"
@@ -402,6 +428,9 @@ def export2(
     # list of all files with utime touched (touch_file = True)
     touched_files = []
 
+    # list of all files convereted to jpeg
+    converted_to_jpeg_files = []
+
     # check edited and raise exception trying to export edited version of
     # photo that hasn't been edited
     if edited and not self.hasadjustments:
@@ -488,11 +517,6 @@ def export2(
                     f"Cannot export edited photo if path_edited is None"
                 )
         else:
-            if self.ismissing:
-                logging.debug(
-                    f"Attempting to export photo with ismissing=True: path = {self.path}"
-                )
-
             if self.path is not None:
                 src = self.path
             else:
@@ -501,32 +525,22 @@ def export2(
         if not os.path.isfile(src):
             raise FileNotFoundError(f"{src} does not appear to exist")
 
-        if not _check_export_suffix(src, dest, edited):
-            logging.debug(
-                f"Invalid destination suffix: {dest.suffix} for {self.path}, "
-                + f"edited={edited}, path_edited={self.path_edited}, "
-                + f"original_filename={self.original_filename}, filename={self.filename}"
-            )
-
         # found source now try to find right destination
         if update and dest.exists():
             # destination exists, check to see if destination is the right UUID
             dest_uuid = export_db.get_uuid_for_file(dest)
             if dest_uuid is None and fileutil.cmp(src, dest):
                 # might be exporting into a pre-ExportDB folder or the DB got deleted
-                logging.debug(
-                    f"Found matching file with blank uuid: {self.uuid}, {dest}"
-                )
                 dest_uuid = self.uuid
                 export_db.set_data(
-                    dest,
+                    filename=dest,
-                    self.uuid,
+                    uuid=self.uuid,
-                    fileutil.file_sig(dest),
+                    orig_stat=fileutil.file_sig(dest),
-                    (None, None, None),
+                    exif_stat=(None, None, None),
-                    (None, None, None),
+                    converted_stat=(None, None, None),
-                    (None, None, None),
+                    edited_stat=(None, None, None),
-                    self.json(),
+                    info_json=self.json(),
-                    None,
+                    exif_json=None,
                 )
             if dest_uuid != self.uuid:
                 # not the right file, find the right one
@@ -545,14 +559,14 @@ def export2(
                         dest = pathlib.Path(file_)
                         found_match = True
                         export_db.set_data(
-                            dest,
+                            filename=dest,
-                            self.uuid,
+                            uuid=self.uuid,
-                            fileutil.file_sig(dest),
+                            orig_stat=fileutil.file_sig(dest),
-                            (None, None, None),
+                            exif_stat=(None, None, None),
-                            (None, None, None),
+                            converted_stat=(None, None, None),
-                            (None, None, None),
+                            edited_stat=(None, None, None),
-                            self.json(),
+                            info_json=self.json(),
-                            None,
+                            exif_json=None,
                         )
                         break
 
@@ -589,6 +603,7 @@ def export2(
         update_updated_files = results.updated
         update_skipped_files = results.skipped
         touched_files = results.touched
+        converted_to_jpeg_files = results.converted_to_jpeg
 
         # copy live photo associated .mov if requested
         if live_photo and self.live_photo:
@@ -596,9 +611,6 @@ def export2(
             src_live = self.path_live_photo
 
             if src_live is not None:
-                logging.debug(
-                    f"Exporting live photo video of {filename} as {live_name.name}"
-                )
                 results = self._export_photo(
                     src_live,
                     live_name,
@@ -617,8 +629,7 @@ def export2(
                 update_updated_files.extend(results.updated)
                 update_skipped_files.extend(results.skipped)
                 touched_files.extend(results.touched)
-            else:
+                converted_to_jpeg_files.extend(results.converted_to_jpeg)
-                logging.debug(f"Skipping missing live movie for {filename}")
 
         # copy associated RAW image if requested
         if raw_photo and self.has_raw:
@@ -626,7 +637,6 @@ def export2(
             raw_ext = raw_path.suffix
             raw_name = dest.parent / f"{dest.stem}{raw_ext}"
             if raw_path is not None:
-                logging.debug(f"Exporting RAW photo of {filename} as {raw_name.name}")
                 results = self._export_photo(
                     raw_path,
                     raw_name,
@@ -646,8 +656,7 @@ def export2(
                 update_updated_files.extend(results.updated)
                 update_skipped_files.extend(results.skipped)
                 touched_files.extend(results.touched)
-            else:
+                converted_to_jpeg_files.extend(results.converted_to_jpeg)
-                logging.debug(f"Skipping missing RAW photo for {filename}")
     else:
         # use_photo_export
         exported = []
@@ -748,8 +757,9 @@ def export2(
             )
 
     # export metadata
+    sidecar_json_files_skipped = []
+    sidecar_json_files_written = []
     if sidecar_json:
-        logging.debug("writing exiftool_json_sidecar")
         sidecar_filename = dest.parent / pathlib.Path(f"{dest.stem}{dest.suffix}.json")
         sidecar_str = self._exiftool_json_sidecar(
             use_albums_as_keywords=use_albums_as_keywords,
@@ -758,15 +768,36 @@ def export2(
             description_template=description_template,
             ignore_date_modified=ignore_date_modified,
         )
-        if not dry_run:
+        sidecar_digest = hexdigest(sidecar_str)
-            try:
+        old_sidecar_digest, sidecar_sig = export_db.get_sidecar_for_file(
+            sidecar_filename
+        )
+        write_sidecar = (
+            not update
+            or (update and not sidecar_filename.exists())
+            or (
+                update
+                and (sidecar_digest != old_sidecar_digest)
+                or not fileutil.cmp_file_sig(sidecar_filename, sidecar_sig)
+            )
+        )
+        if write_sidecar:
+            verbose(f"Writing exiftool JSON sidecar {sidecar_filename}")
+            sidecar_json_files_written.append(str(sidecar_filename))
+            if not dry_run:
                 self._write_sidecar(sidecar_filename, sidecar_str)
-            except Exception as e:
+                export_db.set_sidecar_for_file(
-                logging.warning(f"Error writing json sidecar to {sidecar_filename}")
+                    sidecar_filename,
-                raise e
+                    sidecar_digest,
+                    fileutil.file_sig(sidecar_filename),
+                )
+        else:
+            verbose(f"Skipped up to date exiftool JSON sidecar {sidecar_filename}")
+            sidecar_json_files_skipped.append(str(sidecar_filename))
 
+    sidecar_xmp_files_skipped = []
+    sidecar_xmp_files_written = []
     if sidecar_xmp:
-        logging.debug("writing xmp_sidecar")
         sidecar_filename = dest.parent / pathlib.Path(f"{dest.stem}{dest.suffix}.xmp")
         sidecar_str = self._xmp_sidecar(
             use_albums_as_keywords=use_albums_as_keywords,
@@ -775,12 +806,32 @@ def export2(
             description_template=description_template,
             extension=dest.suffix[1:] if dest.suffix else None,
         )
-        if not dry_run:
+        sidecar_digest = hexdigest(sidecar_str)
-            try:
+        old_sidecar_digest, sidecar_sig = export_db.get_sidecar_for_file(
+            sidecar_filename
+        )
+        write_sidecar = (
+            not update
+            or (update and not sidecar_filename.exists())
+            or (
+                update
+                and (sidecar_digest != old_sidecar_digest)
+                or not fileutil.cmp_file_sig(sidecar_filename, sidecar_sig)
+            )
+        )
+        if write_sidecar:
+            verbose(f"Writing XMP sidecar {sidecar_filename}")
+            sidecar_xmp_files_written.append(str(sidecar_filename))
+            if not dry_run:
                 self._write_sidecar(sidecar_filename, sidecar_str)
-            except Exception as e:
+                export_db.set_sidecar_for_file(
-                logging.warning(f"Error writing xmp sidecar to {sidecar_filename}")
+                    sidecar_filename,
-                raise e
+                    sidecar_digest,
+                    fileutil.file_sig(sidecar_filename),
+                )
+        else:
+            verbose(f"Skipped up to date XMP sidecar {sidecar_filename}")
+            sidecar_xmp_files_skipped.append(str(sidecar_filename))
 
     # if exiftool, write the metadata
     if update:
@@ -791,7 +842,6 @@ def export2(
     exif_files_updated = []
     if exiftool and update and exif_files:
         for exported_file in exif_files:
-            logging.debug(f"checking exif for {exported_file}")
             files_are_different = False
             old_data = export_db.get_exifdata_for_file(exported_file)
             if old_data is not None:
@@ -811,6 +861,7 @@ def export2(
             if old_data is None or files_are_different:
                 # didn't have old data, assume we need to write it
                 # or files were different
+                verbose(f"Writing metadata with exiftool for {exported_file}")
                 if not dry_run:
                     self._write_exif_data(
                         exported_file,
@@ -834,8 +885,11 @@ def export2(
                     exported_file, fileutil.file_sig(exported_file)
                 )
                 exif_files_updated.append(exported_file)
+            else:
+                verbose(f"Skipped up to date exiftool metadata for {exported_file}")
     elif exiftool and exif_files:
         for exported_file in exif_files:
+            verbose(f"Writing metadata with exiftool for {exported_file}")
             if not dry_run:
                 self._write_exif_data(
                     exported_file,
@@ -863,6 +917,7 @@ def export2(
 
     if touch_file:
         for exif_file in exif_files_updated:
+            verbose(f"Updating file modification time for {exif_file}")
             touched_files.append(exif_file)
             ts = int(self.date.timestamp())
             fileutil.utime(exif_file, (ts, ts))
@@ -876,6 +931,11 @@ def export2(
         update_skipped_files,
         exif_files_updated,
         touched_files,
+        converted_to_jpeg_files,
+        sidecar_json_files_written,
+        sidecar_json_files_skipped,
+        sidecar_xmp_files_written,
+        sidecar_xmp_files_skipped,
     )
     return results
 
@@ -932,6 +992,7 @@ def _export_photo(
     update_new_files = []
     update_skipped_files = []
     touched_files = []
+    converted_to_jpeg_files = []
 
     dest_str = str(dest)
     dest_exists = dest.exists()
@@ -998,13 +1059,11 @@ def _export_photo(
 
         else:
             # update, destination doesn't exist (new file)
-            logging.debug(f"Update: exporting new file with {op_desc} {src} {dest}")
             update_new_files.append(dest_str)
             if touch_file:
                 touched_files.append(dest_str)
     else:
         # not update, export the file
-        logging.debug(f"Exporting file with {op_desc} {src} {dest}")
         exported_files.append(dest_str)
         if touch_file:
             sig = fileutil.file_sig(src)
@@ -1016,9 +1075,6 @@ def _export_photo(
         edited_stat = fileutil.file_sig(src) if edited else (None, None, None)
         if dest_exists and (update or overwrite):
             # need to remove the destination first
-            logging.debug(
-                f"Update: removing existing file prior to {op_desc} {src} {dest}"
-            )
             fileutil.unlink(dest)
         if export_as_hardlink:
             fileutil.hardlink(src, dest)
@@ -1026,18 +1082,19 @@ def _export_photo(
             # use convert_to_jpeg to export the file
             fileutil.convert_to_jpeg(src, dest_str, compression_quality=jpeg_quality)
             converted_stat = fileutil.file_sig(dest_str)
+            converted_to_jpeg_files.append(dest_str)
         else:
             fileutil.copy(src, dest_str, norsrc=no_xattr)
 
         export_db.set_data(
-            dest_str,
+            filename=dest_str,
-            self.uuid,
+            uuid=self.uuid,
-            fileutil.file_sig(dest_str),
+            orig_stat=fileutil.file_sig(dest_str),
-            (None, None, None),
+            exif_stat=(None, None, None),
-            converted_stat,
+            converted_stat=converted_stat,
-            edited_stat,
+            edited_stat=edited_stat,
-            self.json(),
+            info_json=self.json(),
-            None,
+            exif_json=None,
         )
 
     if touched_files:
@@ -1051,6 +1108,11 @@ def _export_photo(
         update_skipped_files,
         [],
         touched_files,
+        converted_to_jpeg_files,
+        [],
+        [],
+        [],
+        [],
     )
 
 
@@ -1121,9 +1183,9 @@ def _exiftool_dict(
         IPTC:Keywords (may include album name, person name, or template)
         XMP:Subject
         XMP:PersonInImage
+        EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
         EXIF:GPSLatitude, EXIF:GPSLongitude
         EXIF:GPSPosition
-        EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
         EXIF:DateTimeOriginal
         EXIF:OffsetTimeOriginal
         EXIF:ModifyDate
@@ -1283,9 +1345,9 @@ def _exiftool_json_sidecar(
         IPTC:Keywords (may include album name, person name, or template)
         XMP:Subject
         XMP:PersonInImage
+        EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
         EXIF:GPSLatitude, EXIF:GPSLongitude
         EXIF:GPSPosition
-        EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
         EXIF:DateTimeOriginal
         EXIF:OffsetTimeOriginal
         EXIF:ModifyDate

osxphotos/phototemplate.py

@@ -18,6 +18,7 @@ from functools import partial
 
 from ._constants import _UNKNOWN_PERSON
 from .datetime_formatter import DateTimeFormatter
+from .exiftool import ExifTool
 from .path_utils import sanitize_dirname, sanitize_filename, sanitize_pathpart
 
 # ensure locale set to user's locale
@@ -126,6 +127,10 @@ TEMPLATE_SUBSTITUTIONS_MULTI_VALUED = {
     "{label}": "Image categorization label associated with a photo (Photos 5 only)",
     "{label_normalized}": "All lower case version of 'label' (Photos 5 only)",
     "{comment}": "Comment(s) on shared Photos; format is 'Person name: comment text' (Photos 5 only)",
+    "{exiftool:GROUP:TAGNAME}": "Use exiftool (https://exiftool.org) to extract metadata, in form GROUP:TAGNAME, from image.  "
+    "E.g. '{exiftool:EXIF:Make}' to get camera make, or {exiftool:IPTC:Keywords} to extract keywords. "
+    "See https://exiftool.org/TagNames/ for list of valid tag names.  You must specify group (e.g. EXIF, IPTC, etc) "
+    "as used in `exiftool -G`. exiftool must be installed in the path to use this template.",
 }
 
 # Just the multi-valued substitution names without the braces
@@ -150,6 +155,62 @@ class PhotoTemplate:
         # gets initialized in get_template_value
         self.today = None
 
+    def make_subst_function(
+        self, none_str, filename, dirname, replacement, get_func=None
+    ):
+        """ returns: substitution function for use in re.sub 
+            none_str: value to use if substitution lookup is None and no default provided
+            get_func: function that gets the substitution value for a given template field
+                    default is get_template_value which handles the single-value fields """
+
+        if get_func is None:
+            # used by make_subst_function to get the value for a template substitution
+            get_func = partial(
+                self.get_template_value,
+                filename=filename,
+                dirname=dirname,
+                replacement=replacement,
+            )
+
+        # closure to capture photo, none_str, filename, dirname in subst
+        def subst(matchobj):
+            groups = len(matchobj.groups())
+            if groups != 5:
+                raise ValueError(
+                    f"Unexpected number of groups: expected 4, got {groups}"
+                )
+
+            delim = matchobj.group(1)
+            field = matchobj.group(2)
+            path_sep = matchobj.group(3)
+            bool_val = matchobj.group(4)
+            default = matchobj.group(5)
+
+            # drop the '+' on delim
+            delim = delim[:-1] if delim is not None else None
+            # drop () from path_sep
+            path_sep = path_sep.strip("()") if path_sep is not None else None
+            # drop the ? on bool_val
+            bool_val = bool_val[1:] if bool_val is not None else None
+            # drop the comma on default
+            default_val = default[1:] if default is not None else None
+
+            try:
+                val = get_func(field, default_val, bool_val, delim, path_sep)
+            except ValueError:
+                return matchobj.group(0)
+
+            if val is None:
+                # field valid but didn't match a value
+                if default == ",":
+                    val = ""
+                else:
+                    val = default_val if default_val is not None else none_str
+
+            return val
+
+        return subst
+
     def render(
         self,
         template,
@@ -208,60 +269,7 @@ class PhotoTemplate:
         if type(template) is not str:
             raise TypeError(f"template must be type str, not {type(template)}")
 
-        # used by make_subst_function to get the value for a template substitution
+        subst_func = self.make_subst_function(none_str, filename, dirname, replacement)
-        get_func = partial(
-            self.get_template_value,
-            filename=filename,
-            dirname=dirname,
-            replacement=replacement,
-        )
-
-        def make_subst_function(self, none_str, get_func=get_func):
-            """ returns: substitution function for use in re.sub 
-                none_str: value to use if substitution lookup is None and no default provided
-                get_func: function that gets the substitution value for a given template field
-                        default is get_template_value which handles the single-value fields """
-
-            # closure to capture photo, none_str, filename, dirname in subst
-            def subst(matchobj):
-                groups = len(matchobj.groups())
-                if groups == 5:
-                    delim = matchobj.group(1)
-                    field = matchobj.group(2)
-                    path_sep = matchobj.group(3)
-                    bool_val = matchobj.group(4)
-                    default = matchobj.group(5)
-
-                    # drop the '+' on delim
-                    delim = delim[:-1] if delim is not None else None
-                    # drop () from path_sep
-                    path_sep = path_sep.strip("()") if path_sep is not None else None
-                    # drop the ? on bool_val
-                    bool_val = bool_val[1:] if bool_val is not None else None
-                    # drop the comma on default
-                    default_val = default[1:] if default is not None else None
-
-                    try:
-                        val = get_func(field, default_val, bool_val, delim, path_sep)
-                    except ValueError:
-                        return matchobj.group(0)
-
-                    if val is None:
-                        # field valid but didn't match a value
-                        if default == ",":
-                            val = ""
-                        else:
-                            val = default_val if default_val is not None else none_str
-
-                    return val
-                else:
-                    raise ValueError(
-                        f"Unexpected number of groups: expected 4, got {groups}"
-                    )
-
-            return subst
-
-        subst_func = make_subst_function(self, none_str)
 
         # do the replacements
         rendered = re.sub(regex, subst_func, template)
@@ -289,88 +297,28 @@ class PhotoTemplate:
         #    '2011/Album2/keyword1/person1',
         #    '2011/Album2/keyword2/person1',]
 
-        rendered_strings = [rendered]
+        rendered_strings = self._render_multi_valued_templates(
-        for field in MULTI_VALUE_SUBSTITUTIONS:
+            rendered,
-            # Build a regex that matches only the field being processed
+            none_str,
-            re_str = (
+            path_sep,
-                r"(?<!\{)\{"  # match { but not {{
+            expand_inplace,
-                + r"([^}]*\+)?"  # group 1: optional DELIM+
+            inplace_sep,
-                + r"("
+            filename,
-                + field  # group 2: field name
+            dirname,
-                + r")"
+            replacement,
-                + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
+        )
-                + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
-                + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
-                + r"(?=\}(?!\}))\}"  # match } but not }}
-            )
-            regex_multi = re.compile(re_str)
 
-            # holds each of the new rendered_strings, dict to avoid repeats (dict.keys())
+        # process exiftool: templates
-            new_strings = {}
+        rendered_strings = self._render_exiftool_template(
-
+            rendered_strings,
-            for str_template in rendered_strings:
+            none_str,
-                matches = regex_multi.search(str_template)
+            path_sep,
-                if matches:
+            expand_inplace,
-                    path_sep = (
+            inplace_sep,
-                        matches.group(3).strip("()")
+            filename,
-                        if matches.group(3) is not None
+            dirname,
-                        else path_sep
+            replacement,
-                    )
+        )
-                    values = self.get_template_value_multi(
-                        field,
-                        path_sep,
-                        filename=filename,
-                        dirname=dirname,
-                        replacement=replacement,
-                    )
-                    if expand_inplace or matches.group(1) is not None:
-                        delim = (
-                            matches.group(1)[:-1] if matches.group(1) is not None else inplace_sep 
-                        )
-                        # instead of returning multiple strings, join values into a single string
-                        val = delim.join(sorted(values)) if values and values[0] else None
-
-                        def lookup_template_value_multi(lookup_value, *_):
-                            """ Closure passed to make_subst_function get_func 
-                                    Capture val and field in the closure 
-                                    Allows make_subst_function to be re-used w/o modification
-                                    _ is not used but required so signature matches get_template_value """
-                            if lookup_value == field:
-                                return val
-                            else:
-                                raise ValueError(f"Unexpected value: {lookup_value}")
-
-                        subst = make_subst_function(
-                            self, none_str, get_func=lookup_template_value_multi
-                        )
-                        new_string = regex_multi.sub(subst, str_template)
-
-                        # update rendered_strings for the next field to process
-                        rendered_strings = {new_string}
-                    else:
-                        # create a new template string for each value
-                        for val in values:
-
-                            def lookup_template_value_multi(lookup_value, *_):
-                                """ Closure passed to make_subst_function get_func 
-                                    Capture val and field in the closure 
-                                    Allows make_subst_function to be re-used w/o modification
-                                    _ is not used but required so signature matches get_template_value """
-                                if lookup_value == field:
-                                    return val
-                                else:
-                                    raise ValueError(
-                                        f"Unexpected value: {lookup_value}"
-                                    )
-
-                            subst = make_subst_function(
-                                self, none_str, get_func=lookup_template_value_multi
-                            )
-                            new_string = regex_multi.sub(subst, str_template)
-                            new_strings[new_string] = 1
-
-                        # update rendered_strings for the next field to process
-                        rendered_strings = list(new_strings.keys())
 
         # find any {fields} that weren't replaced
         unmatched = []
@@ -396,6 +344,244 @@ class PhotoTemplate:
 
         return rendered_strings, unmatched
 
+    def _render_multi_valued_templates(
+        self,
+        rendered,
+        none_str,
+        path_sep,
+        expand_inplace,
+        inplace_sep,
+        filename,
+        dirname,
+        replacement,
+    ):
+        rendered_strings = [rendered]
+        new_rendered_strings = []
+        while new_rendered_strings != rendered_strings:
+            new_rendered_strings = rendered_strings
+            for field in MULTI_VALUE_SUBSTITUTIONS:
+                # Build a regex that matches only the field being processed
+                re_str = (
+                    r"(?<!\{)\{"  # match { but not {{
+                    + r"([^}]*\+)?"  # group 1: optional DELIM+
+                    + r"("
+                    + field  # group 2: field name
+                    + r")"
+                    + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
+                    + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
+                    + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
+                    + r"(?=\}(?!\}))\}"  # match } but not }}
+                )
+                regex_multi = re.compile(re_str)
+
+                # holds each of the new rendered_strings, dict to avoid repeats (dict.keys())
+                new_strings = {}
+
+                for str_template in rendered_strings:
+                    matches = regex_multi.search(str_template)
+                    if matches:
+                        path_sep = (
+                            matches.group(3).strip("()")
+                            if matches.group(3) is not None
+                            else path_sep
+                        )
+                        values = self.get_template_value_multi(
+                            field,
+                            path_sep,
+                            filename=filename,
+                            dirname=dirname,
+                            replacement=replacement,
+                        )
+                        if expand_inplace or matches.group(1) is not None:
+                            delim = (
+                                matches.group(1)[:-1]
+                                if matches.group(1) is not None
+                                else inplace_sep
+                            )
+                            # instead of returning multiple strings, join values into a single string
+                            val = (
+                                delim.join(sorted(values))
+                                if values and values[0]
+                                else None
+                            )
+
+                            def lookup_template_value_multi(lookup_value, *_):
+                                """ Closure passed to make_subst_function get_func 
+                                        Capture val and field in the closure 
+                                        Allows make_subst_function to be re-used w/o modification
+                                        _ is not used but required so signature matches get_template_value """
+                                if lookup_value == field:
+                                    return val
+                                else:
+                                    raise ValueError(
+                                        f"Unexpected value: {lookup_value}"
+                                    )
+
+                            subst = self.make_subst_function(
+                                none_str,
+                                filename,
+                                dirname,
+                                replacement,
+                                get_func=lookup_template_value_multi,
+                            )
+                            new_string = regex_multi.sub(subst, str_template)
+
+                            # update rendered_strings for the next field to process
+                            rendered_strings = list({new_string})
+                        else:
+                            # create a new template string for each value
+                            for val in values:
+
+                                def lookup_template_value_multi(lookup_value, *_):
+                                    """ Closure passed to make_subst_function get_func 
+                                        Capture val and field in the closure 
+                                        Allows make_subst_function to be re-used w/o modification
+                                        _ is not used but required so signature matches get_template_value """
+                                    if lookup_value == field:
+                                        return val
+                                    else:
+                                        raise ValueError(
+                                            f"Unexpected value: {lookup_value}"
+                                        )
+
+                                subst = self.make_subst_function(
+                                    none_str,
+                                    filename,
+                                    dirname,
+                                    replacement,
+                                    get_func=lookup_template_value_multi,
+                                )
+                                new_string = regex_multi.sub(subst, str_template)
+                                new_strings[new_string] = 1
+
+                            # update rendered_strings for the next field to process
+                            rendered_strings = sorted(list(new_strings.keys()))
+        return rendered_strings
+
+    def _render_exiftool_template(
+        self,
+        rendered_strings,
+        none_str,
+        path_sep,
+        expand_inplace,
+        inplace_sep,
+        filename,
+        dirname,
+        replacement,
+    ):
+        # TODO: lots of code commonality with render_multi_valued_templates -- combine or pull out
+        # TODO: put these in globals
+        if path_sep is None:
+            path_sep = os.path.sep
+
+        if inplace_sep is None:
+            inplace_sep = ","
+
+        # Build a regex that matches only the field being processed
+        # todo: pull out regexes into globals?
+        re_str = (
+            r"(?<!\{)\{"  # match { but not {{
+            + r"([^}]*\+)?"  # group 1: optional DELIM+
+            + r"(exiftool:[^\\,}+\?]+)"  # group 3 field name
+            + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
+            + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
+            + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
+            + r"(?=\}(?!\}))\}"  # match } but not }}
+        )
+        regex_multi = re.compile(re_str)
+
+        # holds each of the new rendered_strings, dict to avoid repeats (dict.keys())
+        new_rendered_strings = []
+        while new_rendered_strings != rendered_strings:
+            new_rendered_strings = rendered_strings
+            new_strings = {}
+            for str_template in rendered_strings:
+                matches = regex_multi.search(str_template)
+                if matches:
+                    # allmatches = regex_multi.finditer(str_template)
+                    # for matches in allmatches:
+                    path_sep = (
+                        matches.group(3).strip("()")
+                        if matches.group(3) is not None
+                        else path_sep
+                    )
+                    field = matches.group(2)
+                    subfield = field[9:]
+
+                    if not self.photo.path:
+                        values = []
+                    else:
+                        exif = ExifTool(self.photo.path)
+                        exifdict = exif.asdict()
+                        exifdict = {k.lower(): v for (k, v) in exifdict.items()}
+                        subfield = subfield.lower()
+                        if subfield in exifdict:
+                            values = exifdict[subfield]
+                            values = (
+                                [values] if not isinstance(values, list) else values
+                            )
+                        else:
+                            values = [None]
+                    if expand_inplace or matches.group(1) is not None:
+                        delim = (
+                            matches.group(1)[:-1]
+                            if matches.group(1) is not None
+                            else inplace_sep
+                        )
+                        # instead of returning multiple strings, join values into a single string
+                        val = (
+                            delim.join(sorted(values)) if values and values[0] else None
+                        )
+
+                        def lookup_template_value_exif(lookup_value, *_):
+                            """ Closure passed to make_subst_function get_func 
+                                    Capture val and field in the closure 
+                                    Allows make_subst_function to be re-used w/o modification
+                                    _ is not used but required so signature matches get_template_value """
+                            if lookup_value == field:
+                                return val
+                            else:
+                                raise ValueError(f"Unexpected value: {lookup_value}")
+
+                        subst = self.make_subst_function(
+                            none_str,
+                            filename,
+                            dirname,
+                            replacement,
+                            get_func=lookup_template_value_exif,
+                        )
+                        new_string = regex_multi.sub(subst, str_template)
+                        # update rendered_strings for the next field to process
+                        rendered_strings = list({new_string})
+                    else:
+                        # create a new template string for each value
+                        for val in values:
+
+                            def lookup_template_value_exif(lookup_value, *_):
+                                """ Closure passed to make_subst_function get_func 
+                                    Capture val and field in the closure 
+                                    Allows make_subst_function to be re-used w/o modification
+                                    _ is not used but required so signature matches get_template_value """
+                                if lookup_value == field:
+                                    return val
+                                else:
+                                    raise ValueError(
+                                        f"Unexpected value: {lookup_value}"
+                                    )
+
+                            subst = self.make_subst_function(
+                                none_str,
+                                filename,
+                                dirname,
+                                replacement,
+                                get_func=lookup_template_value_exif,
+                            )
+                            new_string = regex_multi.sub(subst, str_template)
+                            new_strings[new_string] = 1
+                        # update rendered_strings for the next field to process
+                        rendered_strings = sorted(list(new_strings.keys()))
+        return rendered_strings
+
     def get_template_value(
         self,
         field,
@@ -681,6 +867,7 @@ class PhotoTemplate:
         """
 
         """ return list of values for a multi-valued template field """
+        values = [] 
         if field == "album":
             values = self.photo.albums
         elif field == "keyword":
@@ -724,7 +911,7 @@ class PhotoTemplate:
             values = [
                 f"{comment.user}: {comment.text}" for comment in self.photo.comments
             ]
-        else:
+        elif not field.startswith("exiftool:"):
             raise ValueError(f"Unhandled template value: {field}")
 
         # sanitize directory names if needed, folder_album handled differently above

tests/test_cli.py

@@ -65,6 +65,7 @@ CLI_EXPORT_FILENAMES_ALBUM_UNICODE = ["IMG_4547.jpg"]
 CLI_EXPORT_FILENAMES_DELETED_TWIN = ["wedding.jpg", "wedding_edited.jpeg"]
 
 CLI_EXPORT_EDITED_SUFFIX = "_bearbeiten"
+CLI_EXPORT_ORIGINAL_SUFFIX = "_original"
 
 CLI_EXPORT_FILENAMES_EDITED_SUFFIX = [
     "Pumkins1.jpg",
@@ -77,6 +78,16 @@ CLI_EXPORT_FILENAMES_EDITED_SUFFIX = [
     "wedding_bearbeiten.jpeg",
 ]
 
+CLI_EXPORT_FILENAMES_ORIGINAL_SUFFIX = [
+    "Pumkins1_original.jpg",
+    "Pumkins2_original.jpg",
+    "Pumpkins3_original.jpg",
+    "St James Park_original.jpg",
+    "St James Park_edited.jpeg",
+    "Tulips_original.jpg",
+    "wedding_original.jpg",
+    "wedding_edited.jpeg",
+]
 
 CLI_EXPORT_FILENAMES_CURRENT = [
     "1EB2B765-0765-43BA-A90C-0D0580E6172C.jpeg",
@@ -976,7 +987,9 @@ def test_export_exiftool_ignore_date_modified():
             )
             assert result.exit_code == 0
 
-            exif = ExifTool(CLI_EXIFTOOL_IGNORE_DATE_MODIFIED[uuid]["File:FileName"]).asdict()
+            exif = ExifTool(
+                CLI_EXIFTOOL_IGNORE_DATE_MODIFIED[uuid]["File:FileName"]
+            ).asdict()
             for key in CLI_EXIFTOOL_IGNORE_DATE_MODIFIED[uuid]:
                 assert exif[key] == CLI_EXIFTOOL_IGNORE_DATE_MODIFIED[uuid][key]
 
@@ -1008,6 +1021,33 @@ def test_export_edited_suffix():
         assert sorted(files) == sorted(CLI_EXPORT_FILENAMES_EDITED_SUFFIX)
 
 
+def test_export_original_suffix():
+    """ test export with --original-suffix """
+    import glob
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            export,
+            [
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--original-suffix",
+                CLI_EXPORT_ORIGINAL_SUFFIX,
+                "-V",
+            ],
+        )
+        assert result.exit_code == 0
+        files = glob.glob("*")
+        assert sorted(files) == sorted(CLI_EXPORT_FILENAMES_ORIGINAL_SUFFIX)
+
+
 @pytest.mark.skipif(
     "OSXPHOTOS_TEST_CONVERT" not in os.environ,
     reason="Skip if running in Github actions, no GPU.",
@@ -1734,6 +1774,142 @@ def test_export_sidecar_templates():
         )
 
 
+def test_export_sidecar_update():
+    """ test sidecar don't update if not changed and do update if changed """
+    import datetime
+    import glob
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.fileutil import FileUtil
+
+    from osxphotos.__main__ import cli
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Writing XMP sidecar" in result.output
+        assert "Writing exiftool JSON sidecar" in result.output
+
+        # delete a sidecar file and run update
+        fileutil = FileUtil()
+        fileutil.unlink(CLI_EXPORT_SIDECAR_FILENAMES[1])
+
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+                "--update",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Skipped up to date XMP sidecar" in result.output
+        assert "Writing exiftool JSON sidecar" in result.output
+
+        # run update again, no sidecar files should update
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+                "--update",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Skipped up to date XMP sidecar" in result.output
+        assert "Skipped up to date exiftool JSON sidecar" in result.output
+
+        # touch a file and export again
+        ts = datetime.datetime.now().timestamp() + 1000
+        fileutil.utime(CLI_EXPORT_SIDECAR_FILENAMES[2], (ts, ts))
+
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+                "--update",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Writing XMP sidecar" in result.output
+        assert "Skipped up to date exiftool JSON sidecar" in result.output
+
+        # run update again, no sidecar files should update
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+                "--update",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Skipped up to date XMP sidecar" in result.output
+        assert "Skipped up to date exiftool JSON sidecar" in result.output
+
+        # run update again with updated metadata, forcing update
+        result = runner.invoke(
+            cli,
+            [
+                "export",
+                "--db",
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "--sidecar=json",
+                "--sidecar=xmp",
+                f"--uuid={CLI_EXPORT_UUID}",
+                "-V",
+                "--update",
+                "--keyword-template",
+                "foo",
+            ],
+        )
+        assert result.exit_code == 0
+        assert "Writing XMP sidecar" in result.output
+        assert "Writing exiftool JSON sidecar" in result.output
+
+
 def test_export_live():
     import glob
     import os
@@ -3587,3 +3763,44 @@ def test_persons():
 
     json_got = json.loads(result.output)
     assert json_got == PERSONS_JSON
+
+
+def test_export_report():
+    """ test export with --report option """
+    import glob
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            export,
+            [os.path.join(cwd, CLI_PHOTOS_DB), ".", "-V", "--report", "report.csv"],
+        )
+        assert result.exit_code == 0
+        assert "Writing export report" in result.output
+        assert os.path.exists("report.csv")
+
+
+def test_export_report_not_a_file():
+    """ test export with --report option and bad report value """
+    import glob
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            export, [os.path.join(cwd, CLI_PHOTOS_DB), ".", "-V", "--report", "."]
+        )
+        assert result.exit_code != 0
+        assert "Aborted!" in result.output
+

tests/test_export_db.py

@@ -4,6 +4,8 @@ import pytest
 
 EXIF_DATA = """[{"_CreatedBy": "osxphotos, https://github.com/RhetTbull/osxphotos", "EXIF:ImageDescription": "\u2068Elder Park\u2069, \u2068Adelaide\u2069, \u2068Australia\u2069", "XMP:Description": "\u2068Elder Park\u2069, \u2068Adelaide\u2069, \u2068Australia\u2069", "XMP:Title": "Elder Park", "EXIF:GPSLatitude": "34 deg 55' 8.01\" S", "EXIF:GPSLongitude": "138 deg 35' 48.70\" E", "Composite:GPSPosition": "34 deg 55' 8.01\" S, 138 deg 35' 48.70\" E", "EXIF:GPSLatitudeRef": "South", "EXIF:GPSLongitudeRef": "East", "EXIF:DateTimeOriginal": "2017:06:20 17:18:56", "EXIF:OffsetTimeOriginal": "+09:30", "EXIF:ModifyDate": "2020:05:18 14:42:04"}]"""
 INFO_DATA = """{"uuid": "3DD2C897-F19E-4CA6-8C22-B027D5A71907", "filename": "3DD2C897-F19E-4CA6-8C22-B027D5A71907.jpeg", "original_filename": "IMG_4547.jpg", "date": "2017-06-20T17:18:56.518000+09:30", "description": "\u2068Elder Park\u2069, \u2068Adelaide\u2069, \u2068Australia\u2069", "title": "Elder Park", "keywords": [], "labels": ["Statue", "Art"], "albums": ["AlbumInFolder"], "folders": {"AlbumInFolder": ["Folder1", "SubFolder2"]}, "persons": [], "path": "/Users/rhet/Pictures/Test-10.15.4.photoslibrary/originals/3/3DD2C897-F19E-4CA6-8C22-B027D5A71907.jpeg", "ismissing": false, "hasadjustments": true, "external_edit": false, "favorite": false, "hidden": false, "latitude": -34.91889167000001, "longitude": 138.59686167, "path_edited": "/Users/rhet/Pictures/Test-10.15.4.photoslibrary/resources/renders/3/3DD2C897-F19E-4CA6-8C22-B027D5A71907_1_201_a.jpeg", "shared": false, "isphoto": true, "ismovie": false, "uti": "public.jpeg", "burst": false, "live_photo": false, "path_live_photo": null, "iscloudasset": false, "incloud": null, "date_modified": "2020-05-18T14:42:04.608664+09:30", "portrait": false, "screenshot": false, "slow_mo": false, "time_lapse": false, "hdr": false, "selfie": false, "panorama": false, "has_raw": false, "uti_raw": null, "path_raw": null, "place": {"name": "Elder Park, Adelaide, South Australia, Australia, River Torrens", "names": {"field0": [], "country": ["Australia"], "state_province": ["South Australia"], "sub_administrative_area": ["Adelaide"], "city": ["Adelaide", "Adelaide"], "field5": [], "additional_city_info": ["Adelaide CBD", "Tarndanya"], "ocean": [], "area_of_interest": ["Elder Park", ""], "inland_water": ["River Torrens", "River Torrens"], "field10": [], "region": [], "sub_throughfare": [], "field13": [], "postal_code": [], "field15": [], "field16": [], "street_address": [], "body_of_water": ["River Torrens", "River Torrens"]}, "country_code": "AU", "ishome": false, "address_str": "River Torrens, Adelaide SA, Australia", "address": {"street": null, "sub_locality": "Tarndanya", "city": "Adelaide", "sub_administrative_area": "Adelaide", "state_province": "SA", "postal_code": null, "country": "Australia", "iso_country_code": "AU"}}, "exif": {"flash_fired": false, "iso": 320, "metering_mode": 3, "sample_rate": null, "track_format": null, "white_balance": 0, "aperture": 2.2, "bit_rate": null, "duration": null, "exposure_bias": 0.0, "focal_length": 4.15, "fps": null, "latitude": null, "longitude": null, "shutter_speed": 0.058823529411764705, "camera_make": "Apple", "camera_model": "iPhone 6s", "codec": null, "lens_model": "iPhone 6s back camera 4.15mm f/2.2"}}"""
+SIDECAR_DATA = """FOO_BAR"""
+
 EXIF_DATA2 = """[{"_CreatedBy": "osxphotos, https://github.com/RhetTbull/osxphotos", "XMP:Title": "St. James's Park", "XMP:TagsList": ["London 2018", "St. James's Park", "England", "United Kingdom", "UK", "London"], "IPTC:Keywords": ["London 2018", "St. James's Park", "England", "United Kingdom", "UK", "London"], "XMP:Subject": ["London 2018", "St. James's Park", "England", "United Kingdom", "UK", "London"], "EXIF:GPSLatitude": "51 deg 30' 12.86\" N", "EXIF:GPSLongitude": "0 deg 7' 54.50\" W", "Composite:GPSPosition": "51 deg 30' 12.86\" N, 0 deg 7' 54.50\" W", "EXIF:GPSLatitudeRef": "North", "EXIF:GPSLongitudeRef": "West", "EXIF:DateTimeOriginal": "2018:10:13 09:18:12", "EXIF:OffsetTimeOriginal": "-04:00", "EXIF:ModifyDate": "2019:12:08 14:06:44"}]"""
 INFO_DATA2 = """{"uuid": "F2BB3F98-90F0-4E4C-A09B-25C6822A4529", "filename": "F2BB3F98-90F0-4E4C-A09B-25C6822A4529.jpeg", "original_filename": "IMG_8440.JPG", "date": "2019-06-11T11:42:06.711805-07:00", "description": null, "title": null, "keywords": [], "labels": ["Sky", "Cloudy", "Fence", "Land", "Outdoor", "Park", "Amusement Park", "Roller Coaster"], "albums": [], "folders": {}, "persons": [], "path": "/Volumes/MacBook Catalina - Data/Users/rhet/Pictures/Photos Library.photoslibrary/originals/F/F2BB3F98-90F0-4E4C-A09B-25C6822A4529.jpeg", "ismissing": false, "hasadjustments": false, "external_edit": false, "favorite": false, "hidden": false, "latitude": 33.81558666666667, "longitude": -117.99298, "path_edited": null, "shared": false, "isphoto": true, "ismovie": false, "uti": "public.jpeg", "burst": false, "live_photo": false, "path_live_photo": null, "iscloudasset": true, "incloud": true, "date_modified": "2019-10-14T00:51:47.141950-07:00", "portrait": false, "screenshot": false, "slow_mo": false, "time_lapse": false, "hdr": false, "selfie": false, "panorama": false, "has_raw": false, "uti_raw": null, "path_raw": null, "place": {"name": "Adventure City, Stanton, California, United States", "names": {"field0": [], "country": ["United States"], "state_province": ["California"], "sub_administrative_area": ["Orange"], "city": ["Stanton", "Anaheim", "Anaheim"], "field5": [], "additional_city_info": ["West Anaheim"], "ocean": [], "area_of_interest": ["Adventure City", "Adventure City"], "inland_water": [], "field10": [], "region": [], "sub_throughfare": [], "field13": [], "postal_code": [], "field15": [], "field16": [], "street_address": [], "body_of_water": []}, "country_code": "US", "ishome": false, "address_str": "Adventure City, 1240 S Beach Blvd, Anaheim, CA  92804, United States", "address": {"street": "1240 S Beach Blvd", "sub_locality": "West Anaheim", "city": "Stanton", "sub_administrative_area": "Orange", "state_province": "CA", "postal_code": "92804", "country": "United States", "iso_country_code": "US"}}, "exif": {"flash_fired": false, "iso": 25, "metering_mode": 5, "sample_rate": null, "track_format": null, "white_balance": 0, "aperture": 2.2, "bit_rate": null, "duration": null, "exposure_bias": 0.0, "focal_length": 4.15, "fps": null, "latitude": null, "longitude": null, "shutter_speed": 0.0004940711462450593, "camera_make": "Apple", "camera_model": "iPhone 6s", "codec": null, "lens_model": "iPhone 6s back camera 4.15mm f/2.2"}}"""
 DATABASE_VERSION1 = "tests/export_db_version1.db"
@@ -41,6 +43,8 @@ def test_export_db():
     assert db.get_stat_edited_for_file(filepath) == (10, 11, 12)
     db.set_stat_converted_for_file(filepath, (7, 8, 9))
     assert db.get_stat_converted_for_file(filepath) == (7, 8, 9)
+    db.set_sidecar_for_file(filepath, SIDECAR_DATA, (13, 14, 15))
+    assert db.get_sidecar_for_file(filepath) == (SIDECAR_DATA, (13, 14, 15))
 
     # test set_data which sets all at the same time
     filepath2 = os.path.join(tempdir.name, "test2.jpg")
@@ -109,6 +113,8 @@ def test_export_db_no_op():
     assert db.get_stat_converted_for_file(filepath) is None
     db.set_stat_edited_for_file(filepath, (10, 11, 12))
     assert db.get_stat_edited_for_file(filepath) is None
+    db.set_sidecar_for_file(filepath, SIDECAR_DATA, (13, 14, 15))
+    assert db.get_sidecar_for_file(filepath) == (None, (None, None, None))
 
     # test set_data which sets all at the same time
     filepath2 = os.path.join(tempdir.name, "test2.jpg")
@@ -160,6 +166,7 @@ def test_export_db_in_memory():
     db.set_stat_exif_for_file(filepath, (4, 5, 6))
     db.set_stat_converted_for_file(filepath, (7, 8, 9))
     db.set_stat_edited_for_file(filepath, (10, 11, 12))
+    db.set_sidecar_for_file(filepath, SIDECAR_DATA, (13, 14, 15))
 
     db.close()
 
@@ -176,6 +183,7 @@ def test_export_db_in_memory():
     assert dbram.get_stat_exif_for_file(filepath) == (4, 5, 6)
     assert dbram.get_stat_converted_for_file(filepath) == (7, 8, 9)
     assert dbram.get_stat_edited_for_file(filepath) == (10, 11, 12)
+    assert dbram.get_sidecar_for_file(filepath) == (SIDECAR_DATA, (13, 14, 15))
 
     # change a value
     dbram.set_uuid_for_file(filepath, "FUBAR")
@@ -185,6 +193,7 @@ def test_export_db_in_memory():
     dbram.set_stat_exif_for_file(filepath, (10, 11, 12))
     dbram.set_stat_converted_for_file(filepath, (1, 2, 3))
     dbram.set_stat_edited_for_file(filepath, (4, 5, 6))
+    dbram.set_sidecar_for_file(filepath, "FUBAR", (20, 21, 22))
 
     assert dbram.get_uuid_for_file(filepath_lower) == "FUBAR"
     assert dbram.get_info_for_uuid("FUBAR") == INFO_DATA2
@@ -193,6 +202,7 @@ def test_export_db_in_memory():
     assert dbram.get_stat_exif_for_file(filepath) == (10, 11, 12)
     assert dbram.get_stat_converted_for_file(filepath) == (1, 2, 3)
     assert dbram.get_stat_edited_for_file(filepath) == (4, 5, 6)
+    assert dbram.get_sidecar_for_file(filepath) == ("FUBAR", (20, 21, 22))
 
     dbram.close()
 
@@ -205,6 +215,7 @@ def test_export_db_in_memory():
     assert db.get_stat_exif_for_file(filepath) == (4, 5, 6)
     assert db.get_stat_converted_for_file(filepath) == (7, 8, 9)
     assert db.get_stat_edited_for_file(filepath) == (10, 11, 12)
+    assert db.get_sidecar_for_file(filepath) == (SIDECAR_DATA, (13, 14, 15))
 
     assert db.get_info_for_uuid("FUBAR") is None
 
@@ -232,6 +243,7 @@ def test_export_db_in_memory_nofile():
     dbram.set_stat_exif_for_file(filepath, (10, 11, 12))
     dbram.set_stat_converted_for_file(filepath, (1, 2, 3))
     dbram.set_stat_edited_for_file(filepath, (4, 5, 6))
+    dbram.set_sidecar_for_file(filepath, "FUBAR", (20, 21, 22))
 
     assert dbram.get_uuid_for_file(filepath_lower) == "FUBAR"
     assert dbram.get_info_for_uuid("FUBAR") == INFO_DATA2
@@ -240,5 +252,6 @@ def test_export_db_in_memory_nofile():
     assert dbram.get_stat_exif_for_file(filepath) == (10, 11, 12)
     assert dbram.get_stat_converted_for_file(filepath) == (1, 2, 3)
     assert dbram.get_stat_edited_for_file(filepath) == (4, 5, 6)
+    assert dbram.get_sidecar_for_file(filepath) == ("FUBAR", (20, 21, 22))
 
     dbram.close()

tests/test_template.py

@@ -1,6 +1,13 @@
 """ Test template.py """
 import pytest
 
+from osxphotos.exiftool import get_exiftool_path
+
+try:
+    exiftool = get_exiftool_path()
+except:
+    exiftool = None
+
 PHOTOS_DB_PLACES = (
     "./tests/Test-Places-Catalina-10_15_7.photoslibrary/database/photos.db"
 )
@@ -57,6 +64,29 @@ UUID_BOOL_VALUES = {"hdr": "D11D25FF-5F31-47D2-ABA9-58418878DC15"}
 # Boolean type values that render to False
 UUID_BOOL_VALUES_NOT = {"hdr": "51F2BEF7-431A-4D31-8AC1-3284A57826AE"}
 
+# for exiftool template
+UUID_EXIFTOOL = {
+    "A92D9C26-3A50-4197-9388-CB5F7DB9FA91": {
+        "{exiftool:EXIF:Make}": ["Canon"],
+        "{exiftool:EXIF:Model}": ["Canon PowerShot G10"],
+        "{exiftool:EXIF:Make}/{exiftool:EXIF:Model}": ["Canon/Canon PowerShot G10"],
+        "{exiftool:IPTC:Keywords,foo}": ["foo"],
+    },
+    "DC99FBDD-7A52-4100-A5BB-344131646C30": {
+        "{exiftool:IPTC:Keywords}": [
+            "England",
+            "London",
+            "London 2018",
+            "St. James's Park",
+            "UK",
+            "United Kingdom",
+        ],
+        "{,+exiftool:IPTC:Keywords}": [
+            "England,London,London 2018,St. James's Park,UK,United Kingdom"
+        ],
+    },
+}
+
 TEMPLATE_VALUES = {
     "{name}": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
     "{original_name}": "IMG_1064",
@@ -737,3 +767,15 @@ def test_expand_in_place_with_delim_single_value():
     for template in TEMPLATE_VALUES_TITLE:
         rendered, _ = photo.render_template(template)
         assert sorted(rendered) == sorted(TEMPLATE_VALUES_TITLE[template])
+
+
+@pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
+def test_exiftool_template():
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB_15_7)
+    for uuid in UUID_EXIFTOOL:
+        photo = photosdb.get_photo(uuid)
+        for template in UUID_EXIFTOOL[uuid]:
+            rendered, _ = photo.render_template(template)
+            assert sorted(rendered) == sorted(UUID_EXIFTOOL[uuid][template])