forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactored ExportResults

Browse Source
This commit is contained in:
Rhet Turnbull
2021-01-06 06:56:26 -08:00
parent d78097ccc0
commit 568d1b36a6
4 changed files with 115 additions and 174 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
osxphotos/__main__.py
View File

@@ -2321,6 +2321,8 @@ def export(
# but was missing on --update doesn't get deleted # but was missing on --update doesn't get deleted
# (better to have old version than none) # (better to have old version than none)
+ results.missing + results.missing
# include files that have error in case they exist from previous export
+ [r[0] for r in results.error]
+ [str(pathlib.Path(export_db_path).resolve())] + [str(pathlib.Path(export_db_path).resolve())]
) )
click.echo(f"Cleaning up {dest}") click.echo(f"Cleaning up {dest}")
@@ -3046,6 +3048,14 @@ def export_photo(
), ),
err=True, err=True,
) )
for error_ in export_results.error:
click.echo(
click.style(
f"Error exporting photo, file {error_[0]}: {error_[1]}",
fg=CLI_COLOR_ERROR,
),
err=True,
)
except Exception as e: except Exception as e:
click.echo( click.echo(
@@ -3056,7 +3066,7 @@ def export_photo(
err=True, err=True,
) )
results.error.append( results.error.append(
str(pathlib.Path(dest) / original_filename) (str(pathlib.Path(dest) / original_filename), e)
) )
else: else:
verbose_(f"Skipping original version of {photo.original_filename}") verbose_(f"Skipping original version of {photo.original_filename}")
@@ -3165,7 +3175,7 @@ def export_photo(
), ),
err=True, err=True,
) )
results.error.append(str(pathlib.Path(dest) / edited_filename)) results.error.append((str(pathlib.Path(dest) / edited_filename),e))
if verbose: if verbose:
if update: if update:
@@ -3369,7 +3379,7 @@ def write_export_report(report_file, results):
"sidecar_json": 0, "sidecar_json": 0,
"sidecar_exiftool": 0, "sidecar_exiftool": 0,
"missing": 0, "missing": 0,
"error": 0, "error": "",
"exiftool_warning": "", "exiftool_warning": "",
"exiftool_error": "", "exiftool_error": "",
"extended_attributes_written": 0, "extended_attributes_written": 0,
@@ -3427,7 +3437,7 @@ def write_export_report(report_file, results):
all_results[result]["missing"] = 1 all_results[result]["missing"] = 1
for result in results.error: for result in results.error:
all_results[result]["error"] = 1 all_results[result[0]]["error"] = result[1]
for result in results.exiftool_warning: for result in results.exiftool_warning:
all_results[result[0]]["exiftool_warning"] = result[1] all_results[result[0]]["exiftool_warning"] = result[1]

260
osxphotos/photoinfo/_photoinfo_export.py
View File

@@ -52,6 +52,12 @@ from ..photokit import (
from ..utils import dd_to_dms_str, findfiles, noop from ..utils import dd_to_dms_str, findfiles, noop
class ExportError(Exception):
""" error during export """
pass
class ExportResults: class ExportResults:
""" holds export results for export2 """ """ holds export results for export2 """
@@ -72,7 +78,6 @@ class ExportResults:
sidecar_xmp_skipped=None, sidecar_xmp_skipped=None,
missing=None, missing=None,
error=None, error=None,
error_str=None,
exiftool_warning=None, exiftool_warning=None,
exiftool_error=None, exiftool_error=None,
xattr_written=None, xattr_written=None,
@@ -93,7 +98,6 @@ class ExportResults:
self.sidecar_xmp_skipped = sidecar_xmp_skipped or [] self.sidecar_xmp_skipped = sidecar_xmp_skipped or []
self.missing = missing or [] self.missing = missing or []
self.error = error or [] self.error = error or []
self.error_str = error_str or []
self.exiftool_warning = exiftool_warning or [] self.exiftool_warning = exiftool_warning or []
self.exiftool_error = exiftool_error or [] self.exiftool_error = exiftool_error or []
self.xattr_written = xattr_written or [] self.xattr_written = xattr_written or []
@@ -116,10 +120,10 @@ class ExportResults:
+ self.sidecar_xmp_written + self.sidecar_xmp_written
+ self.sidecar_xmp_skipped + self.sidecar_xmp_skipped
+ self.missing + self.missing
+ self.error
) )
files += [x[0] for x in self.exiftool_warning] files += [x[0] for x in self.exiftool_warning]
files += [x[0] for x in self.exiftool_error] files += [x[0] for x in self.exiftool_error]
files += [x[0] for x in self.error]
files = list(set(files)) files = list(set(files))
return files return files
@@ -140,7 +144,6 @@ class ExportResults:
self.sidecar_xmp_skipped += other.sidecar_xmp_skipped self.sidecar_xmp_skipped += other.sidecar_xmp_skipped
self.missing += other.missing self.missing += other.missing
self.error += other.error self.error += other.error
self.error_str += other.error_str
self.exiftool_warning += other.exiftool_warning self.exiftool_warning += other.exiftool_warning
self.exiftool_error += other.exiftool_error self.exiftool_error += other.exiftool_error
return self return self
@@ -163,7 +166,6 @@ class ExportResults:
+ f",sidecar_xmp_skipped={self.sidecar_xmp_skipped}" + f",sidecar_xmp_skipped={self.sidecar_xmp_skipped}"
+ f",missing={self.missing}" + f",missing={self.missing}"
+ f",error={self.error}" + f",error={self.error}"
+ f",error_str={self.error_str}"
+ f",exiftool_warning={self.exiftool_warning}" + f",exiftool_warning={self.exiftool_warning}"
+ f",exiftool_error={self.exiftool_error}" + f",exiftool_error={self.exiftool_error}"
+ ")" + ")"
@@ -192,56 +194,33 @@ def _export_photo_uuid_applescript(
): ):
"""Export photo to dest path using applescript to control Photos """Export photo to dest path using applescript to control Photos
If photo is a live photo, exports both the photo and associated .mov file If photo is a live photo, exports both the photo and associated .mov file
uuid: UUID of photo to export
dest: destination path to export to Args:
filestem: (string) if provided, exported filename will be named stem.ext uuid: UUID of photo to export
where ext is extension of the file exported by photos (e.g. .jpeg, .mov, etc) dest: destination path to export to
If not provided, file will be named with whatever name Photos uses filestem: (string) if provided, exported filename will be named stem.ext
If filestem.ext exists, it wil be overwritten where ext is extension of the file exported by photos (e.g. .jpeg, .mov, etc)
original: (boolean) if True, export original image; default = True If not provided, file will be named with whatever name Photos uses
edited: (boolean) if True, export edited photo; default = False If filestem.ext exists, it wil be overwritten
If photo not edited and edited=True, will still export the original image original: (boolean) if True, export original image; default = True
caller must verify image has been edited edited: (boolean) if True, export edited photo; default = False
*Note*: must be called with either edited or original but not both, If photo not edited and edited=True, will still export the original image
will raise error if called with both edited and original = True caller must verify image has been edited
live_photo: (boolean) if True, export associated .mov live photo; default = False *Note*: must be called with either edited or original but not both,
timeout: timeout value in seconds; export will fail if applescript run time exceeds timeout will raise error if called with both edited and original = True
burst: (boolean) set to True if file is a burst image to avoid Photos export error live_photo: (boolean) if True, export associated .mov live photo; default = False
dry_run: (boolean) set to True to run in "dry run" mode which will download file but not actually copy to destination timeout: timeout value in seconds; export will fail if applescript run time exceeds timeout
burst: (boolean) set to True if file is a burst image to avoid Photos export error
dry_run: (boolean) set to True to run in "dry run" mode which will download file but not actually copy to destination
Returns: list of paths to exported file(s) or None if export failed Returns: list of paths to exported file(s) or None if export failed
Raises: ExportError if error during export
Note: For Live Photos, if edited=True, will export a jpeg but not the movie, even if photo Note: For Live Photos, if edited=True, will export a jpeg but not the movie, even if photo
has not been edited. This is due to how Photos Applescript interface works. has not been edited. This is due to how Photos Applescript interface works.
""" """
# setup the applescript to do the export
# export_scpt = AppleScript(
# """
# on export_by_uuid(theUUID, thePath, original, edited, theTimeOut)
# tell application "Photos"
# set thePath to thePath
# set theItem to media item id theUUID
# set theFilename to filename of theItem
# set itemList to {theItem}
# if original then
# with timeout of theTimeOut seconds
# export itemList to POSIX file thePath with using originals
# end timeout
# end if
# if edited then
# with timeout of theTimeOut seconds
# export itemList to POSIX file thePath
# end timeout
# end if
# return theFilename
# end tell
# end export_by_uuid
# """
# )
dest = pathlib.Path(dest) dest = pathlib.Path(dest)
if not dest.is_dir(): if not dest.is_dir():
raise ValueError(f"dest {dest} must be a directory") raise ValueError(f"dest {dest} must be a directory")
@@ -257,12 +236,8 @@ def _export_photo_uuid_applescript(
photo = photoscript.Photo(uuid) photo = photoscript.Photo(uuid)
filename = photo.filename filename = photo.filename
exported_files = photo.export(tmpdir.name, original=original, timeout=timeout) exported_files = photo.export(tmpdir.name, original=original, timeout=timeout)
# filename = export_scpt.call(
# "export_by_uuid", uuid, tmpdir.name, original, edited, timeout
# )
except Exception as e: except Exception as e:
logging.warning(f"Error exporting uuid {uuid}: {e}") raise ExportError(e)
return None
if exported_files and filename: if exported_files and filename:
# need to find actual filename as sometimes Photos renames JPG to jpeg on export # need to find actual filename as sometimes Photos renames JPG to jpeg on export
@@ -531,6 +506,7 @@ def export2(
"sidecar_xmp_skipped", "sidecar_xmp_skipped",
"missing", "missing",
"error", "error",
"error_str",
"exiftool_warning", "exiftool_warning",
"exiftool_error", "exiftool_error",
@@ -557,24 +533,6 @@ def export2(
# e.g. name will be filename_edited.jpg # e.g. name will be filename_edited.jpg
edited_identifier = "_edited" edited_identifier = "_edited"
# list of all files exported during this call to export
exported_files = []
# list of new files during update
update_new_files = []
# list of files that were updated
update_updated_files = []
# list of all files skipped because they do not need to be updated (for use with update=True)
update_skipped_files = []
# 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 # check edited and raise exception trying to export edited version of
# photo that hasn't been edited # photo that hasn't been edited
if edited and not self.hasadjustments: if edited and not self.hasadjustments:
@@ -649,6 +607,7 @@ def export2(
f"destination exists ({dest}); overwrite={overwrite}, increment={increment}" f"destination exists ({dest}); overwrite={overwrite}, increment={increment}"
) )
all_results = ExportResults()
if not use_photos_export: if not use_photos_export:
# find the source file on disk and export # find the source file on disk and export
# get path to source file and verify it's not None and is valid file # get path to source file and verify it's not None and is valid file
@@ -742,12 +701,7 @@ def export2(
jpeg_quality=jpeg_quality, jpeg_quality=jpeg_quality,
ignore_signature=ignore_signature, ignore_signature=ignore_signature,
) )
exported_files = results.exported all_results += results
update_new_files = results.new
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 # copy live photo associated .mov if requested
if live_photo and self.live_photo: if live_photo and self.live_photo:
@@ -768,12 +722,7 @@ def export2(
fileutil=fileutil, fileutil=fileutil,
ignore_signature=ignore_signature, ignore_signature=ignore_signature,
) )
exported_files.extend(results.exported) all_results += results
update_new_files.extend(results.new)
update_updated_files.extend(results.updated)
update_skipped_files.extend(results.skipped)
touched_files.extend(results.touched)
converted_to_jpeg_files.extend(results.converted_to_jpeg)
# copy associated RAW image if requested # copy associated RAW image if requested
if raw_photo and self.has_raw: if raw_photo and self.has_raw:
@@ -795,15 +744,9 @@ def export2(
jpeg_quality=jpeg_quality, jpeg_quality=jpeg_quality,
ignore_signature=ignore_signature, ignore_signature=ignore_signature,
) )
exported_files.extend(results.exported) all_results += results
update_new_files.extend(results.new)
update_updated_files.extend(results.updated)
update_skipped_files.extend(results.skipped)
touched_files.extend(results.touched)
converted_to_jpeg_files.extend(results.converted_to_jpeg)
else: else:
# use_photo_export # use_photo_export
exported = []
# export live_photo .mov file? # export live_photo .mov file?
live_photo = True if live_photo and self.live_photo else False live_photo = True if live_photo and self.live_photo else False
if edited or self.shared: if edited or self.shared:
@@ -833,26 +776,31 @@ def export2(
photo = [p for p in bursts if p.uuid.startswith(self.uuid)] photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
photo = photo[0] if photo else None photo = photo[0] if photo else None
if not photo: if not photo:
errors.append(dest) all_results.error.append((str(dest), f"PhotoKitFetchFailed exception exporting photo {self.uuid}: {e}"))
logging.warning(f"PhotoKitFetchFailed exception exporting photo {self.uuid}: {e}")
if photo: if photo:
exported = photo.export( try:
dest.parent, dest.name, version=PHOTOS_VERSION_CURRENT exported = photo.export(
) dest.parent, dest.name, version=PHOTOS_VERSION_CURRENT
else: )
exported = [] all_results.exported.extend(exported)
except Exception as e:
all_results.error.append((str(dest), e))
else: else:
exported = _export_photo_uuid_applescript( try:
self.uuid, exported = _export_photo_uuid_applescript(
dest.parent, self.uuid,
filestem=filestem, dest.parent,
original=False, filestem=filestem,
edited=True, original=False,
live_photo=live_photo, edited=True,
timeout=timeout, live_photo=live_photo,
burst=self.burst, timeout=timeout,
dry_run=dry_run, burst=self.burst,
) dry_run=dry_run,
)
all_results.exported.extend(exported)
except ExportError as e:
all_results.error.append((str(dest), e))
else: else:
# export original version and not edited # export original version and not edited
filestem = dest.stem filestem = dest.stem
@@ -871,13 +819,16 @@ def export2(
photo = [p for p in bursts if p.uuid.startswith(self.uuid)] photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
photo = photo[0] if photo else None photo = photo[0] if photo else None
if photo: if photo:
exported = photo.export( try:
exported = photo.export(
dest.parent, dest.name, version=PHOTOS_VERSION_ORIGINAL dest.parent, dest.name, version=PHOTOS_VERSION_ORIGINAL
) )
else: all_results.exported.extend(exported)
exported = [] except Exception as e:
all_results.error.append((str(dest), e))
else: else:
exported = _export_photo_uuid_applescript( try:
exported = _export_photo_uuid_applescript(
self.uuid, self.uuid,
dest.parent, dest.parent,
filestem=filestem, filestem=filestem,
@@ -887,21 +838,21 @@ def export2(
timeout=timeout, timeout=timeout,
burst=self.burst, burst=self.burst,
dry_run=dry_run, dry_run=dry_run,
) )
if exported: all_results.exported.extend(exported)
except ExportError as e:
all_results.error.append((str(dest), e))
if all_results.exported:
if touch_file: if touch_file:
for exported_file in exported: for exported_file in all_results.exported:
touched_files.append(exported_file) all_results.touched.append(exported_file)
ts = int(self.date.timestamp()) ts = int(self.date.timestamp())
fileutil.utime(exported_file, (ts, ts)) fileutil.utime(exported_file, (ts, ts))
exported_files.extend(exported)
if update: if update:
update_new_files.extend(exported) all_results.new.extend(all_results.exported)
else: # else:
logging.warning( # all_results.error.append((str(dest), f"Error exporting photo {self.uuid} to {dest} with use_photos_export"))
f"Error exporting photo {self.uuid} to {dest} with use_photos_export"
)
# export metadata # export metadata
sidecars = [] sidecars = []
@@ -1013,15 +964,10 @@ def export2(
# if exiftool, write the metadata # if exiftool, write the metadata
if update: if update:
exif_files = update_new_files + update_updated_files + update_skipped_files exif_files = all_results.new + all_results.updated + all_results.skipped
else: else:
exif_files = exported_files exif_files = all_results.exported
exif_files_updated = []
exiftool_warning = []
exiftool_error = []
errors = []
error_strs = []
# TODO: remove duplicative code from below # TODO: remove duplicative code from below
if exiftool and update and exif_files: if exiftool and update and exif_files:
for exported_file in exif_files: for exported_file in exif_files:
@@ -1060,10 +1006,10 @@ def export2(
merge_exif_persons=merge_exif_persons, merge_exif_persons=merge_exif_persons,
) )
if warning_: if warning_:
exiftool_warning.append((exported_file, warning_)) all_results.exiftool_warning.append((exported_file, warning_))
if error_: if error_:
exiftool_error.append((exported_file, error_)) all_results.exiftool_error.append((exported_file, error_))
errors.append(exported_file) all_results.error.append((exported_file, error_))
export_db.set_exifdata_for_file( export_db.set_exifdata_for_file(
exported_file, exported_file,
@@ -1080,7 +1026,7 @@ def export2(
export_db.set_stat_exif_for_file( export_db.set_stat_exif_for_file(
exported_file, fileutil.file_sig(exported_file) exported_file, fileutil.file_sig(exported_file)
) )
exif_files_updated.append(exported_file) all_results.exif_updated.append(exported_file)
else: else:
verbose(f"Skipped up to date exiftool metadata for {exported_file}") verbose(f"Skipped up to date exiftool metadata for {exported_file}")
elif exiftool and exif_files: elif exiftool and exif_files:
@@ -1099,10 +1045,10 @@ def export2(
merge_exif_persons=merge_exif_persons, merge_exif_persons=merge_exif_persons,
) )
if warning_: if warning_:
exiftool_warning.append((exported_file, warning_)) all_results.exiftool_warning.append((exported_file, warning_))
if error_: if error_:
exiftool_error.append((exported_file, error_)) all_results.exiftool_error.append((exported_file, error_))
errors.append(exported_file) all_results.error.append((exported_file, error_))
export_db.set_exifdata_for_file( export_db.set_exifdata_for_file(
exported_file, exported_file,
@@ -1119,37 +1065,25 @@ def export2(
export_db.set_stat_exif_for_file( export_db.set_stat_exif_for_file(
exported_file, fileutil.file_sig(exported_file) exported_file, fileutil.file_sig(exported_file)
) )
exif_files_updated.append(exported_file) all_results.exif_updated.append(exported_file)
if touch_file: if touch_file:
for exif_file in exif_files_updated: for exif_file in all_results.exif_updated:
verbose(f"Updating file modification time for {exif_file}") verbose(f"Updating file modification time for {exif_file}")
touched_files.append(exif_file) all_results.touched.append(exif_file)
ts = int(self.date.timestamp()) ts = int(self.date.timestamp())
fileutil.utime(exif_file, (ts, ts)) fileutil.utime(exif_file, (ts, ts))
touched_files = list(set(touched_files)) all_results.touched = list(set(all_results.touched))
results = ExportResults( all_results.sidecar_json_written = sidecar_json_files_written
exported=exported_files, all_results.sidecar_json_skipped = sidecar_json_files_skipped
new=update_new_files, all_results.sidecar_exiftool_written = sidecar_exiftool_files_written
updated=update_updated_files, all_results.sidecar_exiftool_skipped = sidecar_exiftool_files_skipped
skipped=update_skipped_files, all_results.sidecar_xmp_written = sidecar_xmp_files_written
exif_updated=exif_files_updated, all_results.sidecar_xmp_skipped = sidecar_xmp_files_skipped
touched=touched_files,
converted_to_jpeg=converted_to_jpeg_files, return all_results
sidecar_json_written=sidecar_json_files_written,
sidecar_json_skipped=sidecar_json_files_skipped,
sidecar_exiftool_written=sidecar_exiftool_files_written,
sidecar_exiftool_skipped=sidecar_exiftool_files_skipped,
sidecar_xmp_written=sidecar_xmp_files_written,
sidecar_xmp_skipped=sidecar_xmp_files_skipped,
error=errors,
error_str=error_strs,
exiftool_error=exiftool_error,
exiftool_warning=exiftool_warning,
)
return results
def _export_photo( def _export_photo(

2
tests/search_info_test_data_10_15_7.json
View File

File diff suppressed because one or more lines are too long

9
tests/test_exportresults.py
View File

@@ -19,7 +19,6 @@ EXPORT_RESULT_ATTRIBUTES = [
"sidecar_xmp_skipped", "sidecar_xmp_skipped",
"missing", "missing",
"error", "error",
"error_str",
"exiftool_warning", "exiftool_warning",
"exiftool_error", "exiftool_error",
] ]
@@ -42,7 +41,6 @@ def test_exportresults_init():
assert results.sidecar_xmp_skipped == [] assert results.sidecar_xmp_skipped == []
assert results.missing == [] assert results.missing == []
assert results.error == [] assert results.error == []
assert results.error_str == []
assert results.exiftool_warning == [] assert results.exiftool_warning == []
assert results.exiftool_error == [] assert results.exiftool_error == []
@@ -82,14 +80,13 @@ def test_all_files():
""" test ExportResults.all_files() """ """ test ExportResults.all_files() """
results = ExportResults() results = ExportResults()
for x in EXPORT_RESULT_ATTRIBUTES: for x in EXPORT_RESULT_ATTRIBUTES:
if x == "error_str":
continue
setattr(results, x, [f"{x}1"]) setattr(results, x, [f"{x}1"])
results.exiftool_warning = [("exiftool_warning1", "foo")] results.exiftool_warning = [("exiftool_warning1", "foo")]
results.exiftool_error = [("exiftool_error1", "foo")] results.exiftool_error = [("exiftool_error1", "foo")]
results.error = [("error1", "foo")]
assert sorted(results.all_files()) == sorted( assert sorted(results.all_files()) == sorted(
[f"{x}1" for x in EXPORT_RESULT_ATTRIBUTES if x != "error_str"] [f"{x}1" for x in EXPORT_RESULT_ATTRIBUTES]
) )
@@ -98,6 +95,6 @@ def test_str():
results = ExportResults() results = ExportResults()
assert ( assert (
str(results) str(results)
== "ExportResults(exported=[],new=[],updated=[],skipped=[],exif_updated=[],touched=[],converted_to_jpeg=[],sidecar_json_written=[],sidecar_json_skipped=[],sidecar_exiftool_written=[],sidecar_exiftool_skipped=[],sidecar_xmp_written=[],sidecar_xmp_skipped=[],missing=[],error=[],error_str=[],exiftool_warning=[],exiftool_error=[])" == "ExportResults(exported=[],new=[],updated=[],skipped=[],exif_updated=[],touched=[],converted_to_jpeg=[],sidecar_json_written=[],sidecar_json_skipped=[],sidecar_exiftool_written=[],sidecar_exiftool_skipped=[],sidecar_xmp_written=[],sidecar_xmp_skipped=[],missing=[],error=[],exiftool_warning=[],exiftool_error=[])"
) )