"""PhotoExport class to export photos"""
from __future__ import annotations
import dataclasses
import datetime
import json
import logging
import os
import pathlib
import re
import subprocess
import typing as t
from enum import Enum
from ._version import __version__
from .dictdiff import dictdiff
from .exif_orientation import fix_exif_orientation
from .exiftool import ExifTool, exiftool_can_write
from .exifwriter import ExifWriter, exif_options_from_options
from .export_db import ExportDBTemp
from .exportoptions import ExportOptions, ExportResults
from .fileutil import FileUtil
from .photoinfo_common import photoinfo_minify_dict
from .phototemplate import RenderOptions
from .platform import is_macos
from .rich_utils import add_rich_markup_tag
from .sidecars import SidecarWriter, exiftool_json_sidecar
from .touch_files import touch_files
from .unicode import normalize_fs_path
from .uti import get_preferred_uti_extension
from .utils import (
increment_filename,
increment_filename_with_count,
isdir_cache,
lineno,
)
if is_macos:
import photoscript
from .photokit import (
PHOTOS_VERSION_CURRENT,
PHOTOS_VERSION_ORIGINAL,
PHOTOS_VERSION_UNADJUSTED,
PhotoKitFetchFailed,
PhotoLibrary,
)
__all__ = [
"ExportError",
"PhotoExporter",
"rename_jpeg_files",
]
if t.TYPE_CHECKING:
from .photoinfo import PhotoInfo
# retry if download_missing/use_photos_export fails the first time (which sometimes it does)
MAX_PHOTOSCRIPT_RETRIES = 3
# threshold for consecutive AppleScript export errors before restarting Photos
APPLESCRIPT_ERROR_THRESHOLD = 10
# counter for tracking consecutive AppleScript export errors
_consecutive_export_errors = 0
logger = logging.getLogger("osxphotos")
# return values for _should_update_photo
class ShouldUpdate(Enum):
NOT_IN_DATABASE = 1
HARDLINK_DIFFERENT_FILES = 2
NOT_HARDLINK_SAME_FILES = 3
DEST_SIG_DIFFERENT = 4
EXPORT_OPTIONS_DIFFERENT = 5
EXIFTOOL_DIFFERENT = 6
DATE_MODIFIED_DIFFERENT = 7
DIGEST_DIFFERENT = 8
UPDATE_ERRORS = 9
class ExportError(Exception):
"""error during export"""
pass
class StagedFiles:
"""Represents files staged for export"""
def __init__(
self,
original: t.Optional[str] = None,
original_live: t.Optional[str] = None,
edited: t.Optional[str] = None,
edited_live: t.Optional[str] = None,
preview: t.Optional[str] = None,
raw: t.Optional[str] = None,
aae: t.Optional[str] = None,
original_aae: t.Optional[str] = None,
error: t.Optional[t.List[str]] = None,
update_skipped: bool = False,
):
self.original = original
self.original_live = original_live
self.edited = edited
self.edited_live = edited_live
self.preview = preview
self.raw = raw
self.aae = aae
self.original_aae = original_aae
self.error = error or []
# True if download was skipped because no update needed (#1086)
self.update_skipped = update_skipped
# TODO: bursts?
def __ior__(self, other):
self.original = self.original or other.original
self.original_live = self.original_live or other.original_live
self.edited = self.edited or other.edited
self.edited_live = self.edited_live or other.edited_live
self.preview = self.preview or other.preview
self.raw = self.raw or other.raw
self.aae = self.aae or other.aae
self.original_aae = self.original_aae or other.original_aae
self.error += other.error
self.update_skipped = self.update_skipped or other.update_skipped
return self
def __str__(self):
return str(self.asdict())
def __repr__(self):
return f"StagedFiles({self.asdict()})"
def asdict(self):
return {
"original": self.original,
"original_live": self.original_live,
"edited": self.edited,
"edited_live": self.edited_live,
"preview": self.preview,
"raw": self.raw,
"aae": self.aae,
"original_aae": self.original_aae,
"error": self.error,
"update_skipped": self.update_skipped,
}
[docs]
class PhotoExporter:
"""Export a photo"""
@staticmethod
def _kill_photos_process():
"""Kill the Photos app process to restart it"""
try:
# Use pkill to kill the main Photos application process
# Use -f to match the full path containing Photos.app
result = subprocess.run(
["pkill", "-f", "Photos.app"], check=False, capture_output=True
)
if result.returncode == 0:
logger.debug(
"Photos process killed due to consecutive AppleScript failures"
)
else:
logger.debug("No Photos process found to kill")
except Exception as e:
logger.warning(f"Failed to kill Photos process: {e}")
def __init__(self, photo: "PhotoInfo", tmpdir: t.Optional[str] = None):
self.photo = photo
self._render_options = RenderOptions()
self._verbose = photo._verbose
# define functions for adding markup
self._filepath = add_rich_markup_tag("filepath", rich=False)
self._filename = add_rich_markup_tag("filename", rich=False)
self._uuid = add_rich_markup_tag("uuid", rich=False)
self._num = add_rich_markup_tag("num", rich=False)
# temp directory for staging downloaded missing files
self._temp_dir = None
self._temp_dir_path = None
self.fileutil = FileUtil
[docs]
def export(
self,
dest,
filename=None,
options: t.Optional[ExportOptions] = None,
) -> ExportResults:
"""Export photo
Args:
dest: must be valid destination path or exception raised
filename: (optional): name of exported picture; if not provided, will use current filename
**NOTE**: if provided, user must ensure file extension (suffix) is correct.
For example, if photo is .CR2 file, edited image may be .jpeg.
If you provide an extension different than what the actual file is,
will export the photo using the incorrect file extension (unless use_photos_export is true,
in which case export will use the extension provided by Photos upon export.
e.g. to get the extension of the edited photo,
reference PhotoInfo.path_edited
options ('ExportOptions'): t.Optional ExportOptions instance
Returns:
ExportResults instance
Note:
To use dry run mode, you must set options.dry_run=True and also pass in memory version of export_db,
and no-op fileutil (e.g. 'ExportDBInMemory' and 'FileUtilNoOp') in options.export_db and options.fileutil respectively
"""
options = options or ExportOptions()
# temp dir must be initialized before any of the methods called by export() are called
self._init_temp_dir(options)
verbose = options.verbose or self._verbose
if verbose and not callable(verbose):
raise TypeError("verbose must be callable")
# define functions for adding markup
self._filepath = add_rich_markup_tag("filepath", rich=options.rich)
self._filename = add_rich_markup_tag("filename", rich=options.rich)
self._uuid = add_rich_markup_tag("uuid", rich=options.rich)
self._num = add_rich_markup_tag("num", rich=options.rich)
# can't use export_as_hardlink with download_missing, use_photos_export as can't hardlink the temporary files downloaded
if options.export_as_hardlink and options.download_missing:
raise ValueError(
"Cannot use export_as_hardlink with download_missing or use_photos_export"
)
# when called from export(), won't get an export_db, so use temp version
options.export_db = options.export_db or ExportDBTemp()
# ensure there's a FileUtil class to use
options.fileutil = options.fileutil or FileUtil
self.fileutil = options.fileutil
self._render_options = options.render_options or RenderOptions()
# export_original, and export_edited are just used for clarity in the code
export_original = not options.edited
export_edited = options.edited
if export_edited and not self.photo.hasadjustments:
raise ValueError(
"Photo does not have adjustments, cannot export edited version"
)
# verify destination is a valid path
if dest is None:
raise ValueError("dest must not be None")
elif not options.dry_run and not isdir_cache(dest):
raise FileNotFoundError("Invalid path passed to export")
if export_edited:
filename = filename or self._get_edited_filename(
self.photo.original_filename
)
else:
filename = filename or self.photo.original_filename
dest = pathlib.Path(dest) / filename
# Is there something to convert with convert_to_jpeg?
dest, options = self._should_convert_to_jpeg(dest, options)
dest = self._get_dest_path(dest, options)
# In dry_run mode without update, register the claimed path in stat_cache
# so that subsequent photos with the same filename get correctly
# incremented. Skip this for update/force_update exports where real stat
# data is needed for change detection.
if (
options.dry_run
and not options.update
and not options.force_update
and options.stat_cache is not None
):
options.stat_cache.register_virtual_file(dest)
staged_files = self._stage_photos_for_export(options, dest=dest)
src = staged_files.edited if options.edited else staged_files.original
# skip the JPEG component of a RAW+JPEG pair if requested
if options.skip_raw_jpeg and self.photo.has_raw and not options.edited:
src = None
self._render_options.filepath = str(dest)
all_results = ExportResults()
# Helper to check exists using stat_cache when available
def _dest_exists(path: pathlib.Path) -> bool:
if options.stat_cache is not None:
return options.stat_cache.exists(path)
return path.exists()
if src:
# export the dest file
all_results += self._export_photo(
src,
dest,
options=options,
)
elif staged_files.update_skipped and _dest_exists(dest):
all_results.skipped.append(str(dest))
all_results.uuids[str(dest)] = self.photo.uuid
options.export_db.set_history(str(dest), self.photo.uuid, "skip", None)
else:
verbose(
f"Skipping missing {'edited' if options.edited else 'original'} photo {self._filename(self.photo.original_filename)} ({self._uuid(self.photo.uuid)})"
)
all_results.missing.append(dest)
all_results.uuids[str(dest)] = self.photo.uuid
# copy live photo associated .mov if requested
if export_original and options.live_photo and self.photo.live_photo:
live_name = dest.parent / f"{dest.stem}.mov"
if staged_files.original_live:
src_live = staged_files.original_live
all_results += self._export_photo(
src_live,
live_name,
# don't try to convert the live photo
options=dataclasses.replace(options, convert_to_jpeg=False),
)
elif staged_files.update_skipped and _dest_exists(live_name):
all_results.skipped.append(str(live_name))
options.export_db.set_history(
str(live_name), self.photo.uuid, "skip", None
)
else:
verbose(
f"Skipping missing live photo for {self._filename(self.photo.original_filename)} ({self._uuid(self.photo.uuid)})"
)
all_results.missing.append(live_name)
if export_edited and options.live_photo and self.photo.live_photo:
live_name = dest.parent / f"{dest.stem}.mov"
if staged_files.edited_live:
src_live = staged_files.edited_live
all_results += self._export_photo(
src_live,
live_name,
# don't try to convert the live photo
options=dataclasses.replace(options, convert_to_jpeg=False),
)
elif staged_files.update_skipped and _dest_exists(live_name):
all_results.skipped.append(str(live_name))
options.export_db.set_history(
str(live_name), self.photo.uuid, "skip", None
)
else:
verbose(
f"Skipping missing edited live photo for {self._filename(self.photo.original_filename)} ({self._uuid(self.photo.uuid)})"
)
all_results.missing.append(live_name)
# copy associated RAW image if requested
if options.raw_photo and self.photo.has_raw:
if staged_files.raw:
raw_path = pathlib.Path(staged_files.raw)
raw_ext = raw_path.suffix
raw_name = dest.parent / f"{dest.stem}{raw_ext}"
all_results += self._export_photo(
raw_path,
raw_name,
options=options,
)
else:
# guess at most likely raw name
raw_ext = (
get_preferred_uti_extension(self.photo.uti_raw)
if self.photo.uti_raw
else "raw"
)
raw_ext = raw_ext or "raw"
raw_name = dest.parent / f"{dest.stem}.{raw_ext}"
if staged_files.update_skipped and _dest_exists(raw_name):
all_results.skipped.append(str(raw_name))
options.export_db.set_history(
str(raw_name), self.photo.uuid, "skip", None
)
else:
all_results.missing.append(raw_name)
verbose(
f"Skipping missing raw photo for {self._filename(self.photo.original_filename)} ({self._uuid(self.photo.uuid)})"
)
all_results.uuids[str(raw_name)] = self.photo.uuid
# copy preview image if requested
if options.preview:
if staged_files.preview:
# Photos keeps multiple different derivatives and path_derivatives returns list of them
# first derivative is the largest so export that one
preview_path = pathlib.Path(staged_files.preview)
preview_ext = preview_path.suffix
preview_name = (
dest.parent / f"{dest.stem}{options.preview_suffix}{preview_ext}"
)
# if original is missing, the filename won't have been incremented so
# need to check here to make sure there aren't duplicate preview files in
# the export directory
preview_name = (
preview_name
if any([options.overwrite, options.update, options.force_update])
else pathlib.Path(increment_filename(preview_name))
)
all_results += self._export_photo(
preview_path,
preview_name,
options=options,
)
else:
# don't know what actual preview suffix would be but most likely jpeg
preview_name = dest.parent / f"{dest.stem}{options.preview_suffix}.jpeg"
all_results.missing.append(preview_name)
all_results.uuids[preview_name] = self.photo.uuid
verbose(
f"Skipping missing preview photo for {self._filename(self.photo.original_filename)} ({self._uuid(self.photo.uuid)})"
)
if export_original and self.photo.hasadjustments and options.export_aae:
# export associated AAE adjustments file if requested but only for original images
# AAE applies changes to the original so is not meaningful for the edited image
aae_name = normalize_fs_path(dest.with_suffix(".AAE"))
if staged_files.aae:
aae_path = pathlib.Path(staged_files.aae)
all_results += self._export_aae(
aae_path,
aae_name,
options=options,
)
else:
verbose(
f"Skipping adjustments for {self._filename(self.photo.original_filename)}: no AAE adjustments file"
)
all_results += ExportResults(missing=[aae_name])
if (
export_original
and options.export_aae
and self.photo.original_adjustments_path
):
# export associated AAE adjustments file if requested but only for original images
# AAE applies changes to the original so is not meaningful for the edited image
aae_name = original_aae_name(dest)
if staged_files.original_aae:
aae_path = pathlib.Path(staged_files.original_aae)
all_results += self._export_aae(
aae_path,
aae_name,
options=options,
)
else:
verbose(
f"Skipping original adjustments for {self._filename(self.photo.original_filename)}: no AAE adjustments file"
)
all_results += ExportResults(missing=[aae_name])
sidecar_writer = SidecarWriter(self.photo)
all_results += sidecar_writer.write_sidecar_files(
dest=dest, options=options, export_results=all_results
)
# write history record for any missing files
# for any exported, skipped, updated files,
# the history record is written in _export_photo
# but this isn't called for missing photos
for filename in all_results.missing:
action = "AAE: missing" if str(filename).endswith(".AAE") else "missing"
options.export_db.set_history(filename, self.photo.uuid, action, None)
return all_results
def _init_temp_dir(self, options: ExportOptions):
"""Initialize (if necessary) the object's temporary directory.
Args:
options: ExportOptions object
"""
if self._temp_dir is not None:
return
fileutil = options.fileutil or FileUtil
self._temp_dir = fileutil.tmpdir(
prefix="osxphotos_export_", dirpath=options.tmpdir
)
self._temp_dir_path = pathlib.Path(self._temp_dir.name)
return
def _get_edited_filename(self, original_filename):
"""Return the filename for the exported edited photo
(used when filename isn't provided in call to export)"""
# need to get the right extension for edited file
original_filename = pathlib.Path(original_filename)
if self.photo.path_edited:
ext = pathlib.Path(self.photo.path_edited).suffix
else:
uti = self.photo.uti_edited or self.photo.uti
ext = get_preferred_uti_extension(uti)
ext = f".{ext}"
return f"{original_filename.stem}_edited{ext}"
def _get_dest_path(
self, dest: pathlib.Path, options: ExportOptions
) -> pathlib.Path:
"""If destination exists find match in ExportDB, on disk, or add (1), (2), and so on to filename to get a valid destination
Args:
dest (str): destination path
options (ExportOptions): Export options
Returns:
new dest path (pathlib.Path)
"""
stat_cache = options.stat_cache
def _dest_exists(path: pathlib.Path) -> bool:
"""Check if destination exists, using stat cache if available."""
if stat_cache is not None:
return stat_cache.exists(path)
return path.exists()
# if overwrite==False and #increment==False, export should fail if file exists
if not any(
[
options.increment,
options.update,
options.force_update,
options.overwrite,
]
) and _dest_exists(dest):
raise FileExistsError(
f"destination exists ({dest}); overwrite={options.overwrite}, increment={options.increment}"
)
# if overwrite, we don't care if the file exists or not
if options.overwrite:
return dest
# if not update or overwrite, check to see if file exists and if so, add (1), (2), etc
# until we find one that works
# Photos checks the stem and adds (1), (2), etc which avoids collision with sidecars
# e.g. exporting sidecar for file1.png and file1.jpeg
# if file1.png exists and exporting file1.jpeg,
# dest will be file1 (1).jpeg even though file1.jpeg doesn't exist to prevent sidecar collision
if options.increment and not any(
[options.update, options.force_update, options.overwrite]
):
return pathlib.Path(increment_filename(dest, stat_cache=stat_cache))
# if update and file exists, need to check to see if it's the right file by checking export db
if options.update or options.force_update:
export_db = options.export_db
dest_uuid = export_db.get_uuid_for_file(dest)
if dest_uuid == self.photo.uuid:
# destination is the right file
return dest
# either dest_uuid is wrong or file exists and there's no associated UUID, so find a name that matches
# or create a new name if no match
# find files that match "dest_name (*.ext" (e.g. "dest_name (1).jpg", "dest_name (2).jpg)", ...)
# first, find all matching files in export db and see if there's a match
if dest_target := export_db.get_target_for_file(self.photo.uuid, dest):
# there's a match so use that
return pathlib.Path(dest_target)
# no match so need to create a new name
# increment the destination file until we find one that doesn't exist and doesn't match another uuid in the database
if options.dry_run:
# In dry_run mode (or pre-load), use db-only collision
# resolution so we can claim filenames that exist on disk
# but haven't been assigned to another photo yet.
count = 0
candidate = str(dest)
while export_db.get_uuid_for_file(candidate) is not None:
count += 1
candidate = normalize_fs_path(
str(dest.parent / f"{dest.stem} ({count}){dest.suffix}")
)
return pathlib.Path(candidate)
else:
count = 0
dest, count = increment_filename_with_count(
dest, count, stat_cache=stat_cache
)
count += 1
while export_db.get_uuid_for_file(dest) is not None:
dest, count = increment_filename_with_count(
dest, count, stat_cache=stat_cache
)
return pathlib.Path(dest)
# fail safe...I can't think of a case that gets here
return dest
def _should_update_photo(
self, src: pathlib.Path | None, dest: pathlib.Path, options: ExportOptions
) -> bool | ShouldUpdate:
"""Return True if photo should be updated, else False
Args:
src (pathlib.Path | None): source path; if None, photo is missing and
any checks that require src will return True
dest (pathlib.Path): destination path
Returns:
False if photo should not be updated otherwise a truthy ShouldUpdate value
"""
# NOTE: The order of checks is optimized for performance on network volumes.
# Database-only checks are done first to avoid filesystem operations when possible.
# If any database check indicates we need to update, we can skip expensive
# filesystem operations like stat() and samefile().
export_db = options.export_db
fileutil = options.fileutil
file_record = export_db.get_file_record(dest)
if not file_record:
# photo doesn't exist in database, should update
return ShouldUpdate.NOT_IN_DATABASE
# --- Database-only checks first (fast, no filesystem access) ---
if file_record.export_options != options.bit_flags:
# exporting with different set of options (e.g. exiftool), should update
# need to check this before exiftool in case exiftool options are different
# and export database is missing; this will always be True if database is missing
# as it'll be None and bit_flags will be an int
return ShouldUpdate.EXPORT_OPTIONS_DIFFERENT
if options.update_errors and file_record.error is not None:
# files that were exported but generated an error
# won't be updated unless --update-errors is specified
# for example, an exiftool error due to bad metadata
# that the user subsequently fixed should be updated; see #872
# this must be checked before exiftool which will return False if exif data matches
return ShouldUpdate.UPDATE_ERRORS
if options.edited and self.photo.date_modified != file_record.date_modified:
# edited file date modified in Photos doesn't match what was last exported
# this is a database-only check so it goes before filesystem checks
return ShouldUpdate.DATE_MODIFIED_DIFFERENT
# --- Filesystem checks (use stat_cache for efficiency) ---
# Hardlink checks: skip expensive samefile() calls when source and destination
# are on different filesystems (hardlinks can't span filesystems)
# same_filesystem is None if not yet determined, True if same, False if different
if not options.same_filesystem:
# Cross-volume export: hardlinks are impossible
if options.export_as_hardlink:
# Can't verify hardlink on different filesystem, need to update
return ShouldUpdate.HARDLINK_DIFFERENT_FILES
# If not exporting as hardlink, no need to check samefile - they can't be same
else:
# Same filesystem or unknown: do the full check
if options.export_as_hardlink and (not src or not dest.samefile(src)):
# different files, should update
return ShouldUpdate.HARDLINK_DIFFERENT_FILES
if not options.export_as_hardlink and (not src or dest.samefile(src)):
# same file but not exporting as hardlink, should update
return ShouldUpdate.NOT_HARDLINK_SAME_FILES
if not options.ignore_signature and not fileutil.cmp_file_sig(
dest, file_record.dest_sig, stat_cache=options.stat_cache
):
# destination file doesn't match what was last exported
return ShouldUpdate.DEST_SIG_DIFFERENT
# --- Additional checks that may involve computation ---
if options.exiftool:
current_exifdata = exiftool_json_sidecar(photo=self.photo, options=options)
if current_exifdata != file_record.exifdata:
return ShouldUpdate.EXIFTOOL_DIFFERENT
return False
if options.force_update:
if self.photo.hexdigest != file_record.digest:
# metadata in Photos changed, force update
return ShouldUpdate.DIGEST_DIFFERENT
# photo should not be updated
return False
def _should_update_photo_for_missing(
self, dest: pathlib.Path, options: ExportOptions
) -> bool | ShouldUpdate:
"""Check if a missing photo needs to be updated (before downloading).
This performs checks that don't require the source file, allowing us to
skip unnecessary iCloud downloads when in update mode. This is called
BEFORE downloading from iCloud.
Args:
dest: destination path to check
options: export options
Returns:
False if no update needed, otherwise a ShouldUpdate value indicating
why update is needed.
"""
export_db = options.export_db
fileutil = options.fileutil
file_record = export_db.get_file_record(dest)
if not file_record:
return ShouldUpdate.NOT_IN_DATABASE
# --- Database-only checks first (fast, no filesystem access) ---
if file_record.export_options != options.bit_flags:
return ShouldUpdate.EXPORT_OPTIONS_DIFFERENT
if options.update_errors and file_record.error is not None:
return ShouldUpdate.UPDATE_ERRORS
if options.edited and self.photo.date_modified != file_record.date_modified:
# edited file date modified in Photos doesn't match what was last exported
# this is a database-only check so it goes before filesystem checks
return ShouldUpdate.DATE_MODIFIED_DIFFERENT
# --- Filesystem check (uses stat_cache for efficiency) ---
if not options.ignore_signature and not fileutil.cmp_file_sig(
dest, file_record.dest_sig, stat_cache=options.stat_cache
):
return ShouldUpdate.DEST_SIG_DIFFERENT
# --- Additional checks that may involve computation ---
if options.exiftool:
current_exifdata = exiftool_json_sidecar(photo=self.photo, options=options)
if current_exifdata != file_record.exifdata:
return ShouldUpdate.EXIFTOOL_DIFFERENT
return False
if options.force_update:
if self.photo.hexdigest != file_record.digest:
return ShouldUpdate.DIGEST_DIFFERENT
return False
def _needs_download_for_update(
self, staged: "StagedFiles", dest: pathlib.Path, options: ExportOptions
) -> bool:
"""Check if any missing files need to be downloaded for update.
This checks the main photo, live photo, and raw photo to determine
if any of them need to be downloaded from iCloud for updating.
Args:
staged: currently staged files
dest: destination path for the main photo
options: export options
Returns:
True if at least one missing file needs updating, False if all can be skipped.
"""
live_photo = staged.edited_live if options.edited else staged.original_live
# Helper to check exists using stat_cache when available
def _dest_exists(path: pathlib.Path) -> bool:
if options.stat_cache is not None:
return options.stat_cache.exists(path)
return path.exists()
# Check main photo
main_missing = (
self.photo.hasadjustments and options.edited and not staged.edited
) or (not options.edited and not staged.original)
if main_missing:
if not _dest_exists(dest):
return True # New file, need to download
if self._should_update_photo_for_missing(dest, options):
return True # Needs updating
# Check live photo
live_missing = self.photo.live_photo and options.live_photo and not live_photo
if live_missing:
live_dest = dest.parent / f"{dest.stem}.mov"
if not _dest_exists(live_dest):
return True # New file, need to download
if self._should_update_photo_for_missing(live_dest, options):
return True # Needs updating
# Check raw photo
raw_missing = self.photo.has_raw and options.raw_photo and not staged.raw
if raw_missing:
raw_ext = (
get_preferred_uti_extension(self.photo.uti_raw)
if self.photo.uti_raw
else "raw"
)
raw_ext = raw_ext or "raw"
raw_dest = dest.parent / f"{dest.stem}.{raw_ext}"
if not _dest_exists(raw_dest):
return True # New file, need to download
if self._should_update_photo_for_missing(raw_dest, options):
return True # Needs updating
# Nothing needs updating
return False
def _stage_photos_for_export(
self, options: ExportOptions, dest: pathlib.Path | None = None
) -> StagedFiles:
"""Stages photos for export
If photo is present on disk in the library, uses path to the photo on disk.
If photo is missing and download_missing is true, downloads the photo from iCloud to temporary location.
Args:
options: ExportOptions instance
dest: destination path for the main photo (used to check if update is needed
before downloading from iCloud)
"""
staged = StagedFiles()
if options.use_photos_export:
return self._stage_missing_photos_for_export_helper(options=options)
if options.raw_photo and self.photo.has_raw:
staged.raw = self.photo.path_raw
if options.preview and self.photo.path_derivatives:
staged.preview = self.photo.path_derivatives[0]
if not options.edited:
# original file
if self.photo.path:
staged.original = self.photo.path
if options.live_photo and self.photo.live_photo:
staged.original_live = self.photo.path_live_photo
if options.export_aae:
staged.aae = self.photo.adjustments_path
staged.original_aae = self.photo.original_adjustments_path
if options.edited:
# edited file
staged.edited = self.photo.path_edited
if options.live_photo and self.photo.live_photo:
staged.edited_live = self.photo.path_edited_live_photo
# download any missing files
if options.download_missing:
staged |= self._stage_missing_photos_for_export(
staged=staged, options=options, dest=dest
)
return staged
def _stage_missing_photos_for_export(
self,
staged: StagedFiles,
options: ExportOptions,
dest: pathlib.Path | None = None,
) -> StagedFiles:
"""Download and stage any missing files for export
Args:
staged: currently staged files
options: export options
dest: destination path for the main photo (used to check if update is needed
before downloading from iCloud)
"""
# if live photo and requesting edited version need the edited live photo
live_photo = staged.edited_live if options.edited else staged.original_live
something_to_download = (
(self.photo.hasadjustments and options.edited and not staged.edited)
or (self.photo.live_photo and options.live_photo and not live_photo)
or (self.photo.has_raw and options.raw_photo and not staged.raw)
or (options.preview and not staged.preview)
or (not options.edited and not staged.original)
)
if not something_to_download:
return staged
# In update mode, check if any missing files actually need updating
# before downloading from iCloud (#1086)
# Skip this check in dry_run mode since we want to return predicted filenames
if not options.dry_run and dest and (options.update or options.force_update):
if not self._needs_download_for_update(staged, dest, options):
# No update needed, skip the download
staged.update_skipped = True
return staged
missing_options = ExportOptions(
edited=options.edited,
preview=options.preview and not staged.preview,
raw_photo=self.photo.has_raw and options.raw_photo and not staged.raw,
live_photo=self.photo.live_photo and options.live_photo and not live_photo,
use_photokit=options.use_photokit,
dry_run=options.dry_run,
)
missing_staged = self._stage_missing_photos_for_export_helper(
options=missing_options
)
staged |= missing_staged
return staged
def _stage_missing_photos_for_export_helper(
self, options: ExportOptions
) -> StagedFiles:
"""Stage a photo for export with AppleScript or PhotoKit"""
if options.use_photokit:
return self._stage_photo_for_export_with_photokit(options=options)
else:
return self._stage_photo_for_export_with_applescript(options=options)
def _predict_export_filenames(
self,
dest: pathlib.Path,
filestem: str | None,
edited: bool,
live_photo: bool,
) -> list[str]:
"""Predict the filenames that would be exported.
This helper is used for dry_run mode to return expected filenames without
actually calling AppleScript or PhotoKit.
Args:
dest: destination directory
filestem: stem to use for filename, or None to use photo's filename
edited: True if exporting edited version
live_photo: True if exporting live photo video
Returns:
List of predicted file paths
"""
# Determine the extension based on UTI
if edited and self.photo.uti_edited:
uti = self.photo.uti_edited
else:
uti = self.photo.uti
ext = get_preferred_uti_extension(uti) or "jpeg"
# Determine the base filename
if filestem:
stem = filestem
else:
stem = pathlib.Path(self.photo.original_filename).stem
predicted_files = []
# Main photo file
main_file = dest / f"{stem}.{ext}"
predicted_files.append(str(main_file))
# Live photo .mov file - only for original, not edited (AppleScript limitation)
if live_photo and self.photo.live_photo and not edited:
mov_file = dest / f"{stem}.mov"
predicted_files.append(str(mov_file))
# RAW+JPEG pair - AppleScript exports both when exporting original (not edited)
if not edited and self.photo.has_raw:
raw_uti = self.photo.uti_raw
raw_ext = get_preferred_uti_extension(raw_uti) if raw_uti else None
if raw_ext and raw_ext.lower() != ext.lower():
raw_file = dest / f"{stem}.{raw_ext}"
predicted_files.append(str(raw_file))
return predicted_files
def _stage_photo_for_export_with_photokit(
self,
options: ExportOptions,
) -> StagedFiles:
"""Stage a photo for export with photokit to a temporary directory"""
if options.edited and not self.photo.hasadjustments:
raise ValueError("Edited version requested but photo has no adjustments")
dest = self._temp_dir_path / self.photo.original_filename
# export live_photo .mov file?
live_photo = bool(options.live_photo and self.photo.live_photo)
overwrite = any([options.overwrite, options.update, options.force_update])
# figure out which photo version to request
if options.edited or self.photo.shared:
# shared photos (in shared albums) show up as not having adjustments (not edited)
# but Photos is unable to export the "original" as only a jpeg copy is shared in iCloud
# so tell Photos to export the current version in this case
photos_version = PHOTOS_VERSION_CURRENT
elif self.photo.has_raw:
# PhotoKit always returns the raw photo of raw+jpeg pair for PHOTOS_VERSION_ORIGINAL even if JPEG is the original
photos_version = PHOTOS_VERSION_UNADJUSTED
else:
photos_version = PHOTOS_VERSION_ORIGINAL
uti = (
self.photo.uti_edited
if options.edited and self.photo.uti_edited
else self.photo.uti
)
ext = get_preferred_uti_extension(uti)
dest = dest.parent / f"{dest.stem}.{ext}"
# In dry_run mode, return predicted filenames without calling PhotoKit
if options.dry_run:
predicted = self._predict_export_filenames(
dest=dest.parent,
filestem=dest.stem,
edited=options.edited,
live_photo=live_photo,
)
results = StagedFiles()
for filepath in predicted:
if filepath.lower().endswith(".mov"):
results_attr = "edited_live" if options.edited else "original_live"
elif self.photo.has_raw and pathlib.Path(
filepath
).suffix.lower() not in [".jpg", ".jpeg", ".heic"]:
results_attr = "raw" if options.raw_photo else None
else:
results_attr = "edited" if options.edited else "original"
if results_attr:
setattr(results, results_attr, filepath)
if options.preview and self.photo.path_derivatives:
results.preview = self.photo.path_derivatives[0]
return results
photolib = PhotoLibrary()
results = StagedFiles()
photo = None
try:
photo = photolib.fetch_uuid(self.photo.uuid)
except PhotoKitFetchFailed as e:
# if failed to find UUID, might be a burst photo
if self.photo.burst and self.photo._info["burstUUID"]:
bursts = photolib.fetch_burst_uuid(
self.photo._info["burstUUID"], all=True
)
# PhotoKit UUIDs may contain "/L0/001" so only look at beginning
photo = [p for p in bursts if p.uuid.startswith(self.photo.uuid)]
photo = photo[0] if photo else None
if not photo:
results.error.append(
(
str(dest),
f"PhotoKitFetchFailed exception exporting photo {self.photo.uuid}: {e} ({lineno(__file__)})",
)
)
return results
# now export the requested version of the photo
try:
exported = photo.export(
dest.parent,
dest.name,
version=photos_version,
overwrite=overwrite,
video=live_photo,
)
if len(exported) == 1:
results_attr = "edited" if options.edited else "original"
setattr(results, results_attr, exported[0])
elif len(exported) == 2:
for exported_file in exported:
if exported_file.lower().endswith(".mov"):
# live photo
results_attr = (
"edited_live" if options.edited else "original_live"
)
else:
results_attr = "edited" if options.edited else "original"
setattr(results, results_attr, exported_file)
except Exception as e:
results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
if options.raw_photo and self.photo.has_raw:
# also request the raw photo
try:
exported = photo.export(
dest.parent,
dest.name,
version=photos_version,
raw=True,
overwrite=overwrite,
video=live_photo,
)
if exported:
results.raw = exported[0]
results.uuids[exported[0]] = self.photo.uuid
except Exception as e:
results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
if options.preview and self.photo.path_derivatives:
results.preview = self.photo.path_derivatives[0]
return results
def _stage_photo_for_export_with_applescript(
self,
options: ExportOptions,
) -> StagedFiles:
"""Stage a photo for export with AppleScript to a temporary directory
Note: If exporting an edited live photo, the associated live video will not be exported.
This is a limitation of the Photos AppleScript interface and Photos behaves the same way.
"""
if options.edited and not self.photo.hasadjustments:
raise ValueError("Edited version requested but photo has no adjustments")
dest = self._temp_dir_path / self.photo.original_filename
dest = pathlib.Path(increment_filename(dest))
# export live_photo .mov file?
live_photo = bool(options.live_photo and self.photo.live_photo)
overwrite = any([options.overwrite, options.update, options.force_update])
edited_version = bool(options.edited or self.photo.shared)
# shared photos (in shared albums) show up as not having adjustments (not edited)
# but Photos is unable to export the "original" as only a jpeg copy is shared in iCloud
# so tell Photos to export the current version in this case
uti = (
self.photo.uti_edited
if options.edited and self.photo.uti_edited
else self.photo.uti
)
ext = get_preferred_uti_extension(uti)
dest = dest.parent / f"{dest.stem}.{ext}"
results = StagedFiles()
try:
exported = self._export_photo_uuid_applescript(
self.photo.uuid,
dest.parent,
filestem=dest.stem,
original=not edited_version,
edited=edited_version,
live_photo=live_photo,
timeout=options.timeout,
burst=self.photo.burst,
dry_run=options.dry_run,
overwrite=overwrite,
)
except ExportError as e:
results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
return results
if len(exported) == 1:
results_attr = "edited" if options.edited else "original"
setattr(results, results_attr, exported[0])
elif len(exported) == 2:
# could be live or raw+jpeg
for exported_file in exported:
if exported_file.lower().endswith(".mov"):
# live photo
results_attr = (
"edited_live"
if live_photo and options.edited
else "original_live" if live_photo else None
)
elif self.photo.has_raw and pathlib.Path(
exported_file.lower()
).suffix not in [
".jpg",
".jpeg",
".heic",
]:
# assume raw photo if not a common non-raw image format
results_attr = "raw" if options.raw_photo else None
else:
results_attr = "edited" if options.edited else "original"
if results_attr:
setattr(results, results_attr, exported_file)
if options.preview and self.photo.path_derivatives:
results.preview = self.photo.path_derivatives[0]
return results
def _should_convert_to_jpeg(
self, dest: pathlib.Path, options: ExportOptions
) -> t.Tuple[pathlib.Path, ExportOptions]:
"""Determine if a file really should be converted to jpeg or not
and return the new destination and ExportOptions instance with the convert_to_jpeg flag set appropriately
"""
if not (options.convert_to_jpeg and self.photo.isphoto):
# nothing to convert
return dest, dataclasses.replace(options, convert_to_jpeg=False)
convert_to_jpeg = False
ext = "." + options.jpeg_ext if options.jpeg_ext else ".jpeg"
if not options.edited and self.photo.uti_original != "public.jpeg":
# not a jpeg but will convert to jpeg upon export so fix file extension
convert_to_jpeg = True
dest = dest.parent / f"{dest.stem}{ext}"
elif options.edited and self.photo.uti != "public.jpeg":
# in Big Sur+, edited HEICs are HEIC
convert_to_jpeg = True
dest = dest.parent / f"{dest.stem}{ext}"
return dest, dataclasses.replace(options, convert_to_jpeg=convert_to_jpeg)
def _is_temp_file(self, filepath: str) -> bool:
"""Returns True if file is in the PhotosExporter temp directory otherwise False"""
filepath = pathlib.Path(filepath)
return filepath.parent == self._temp_dir_path
def _copy_to_temp_file(self, filepath: str) -> str:
"""Copies filepath to a temp file preserving access and modification times"""
filepath = pathlib.Path(filepath)
dest = self._temp_dir_path / filepath.name
dest = increment_filename(dest)
self.fileutil.copy(filepath, dest)
stat = os.stat(filepath)
self.fileutil.utime(dest, (stat.st_atime, stat.st_mtime))
return str(dest)
def _export_photo(
self,
src: str,
dest: pathlib.Path,
options: ExportOptions,
):
"""Helper function for export()
Does the actual copy or hardlink taking the appropriate
action depending on update, overwrite, export_as_hardlink
Assumes destination is the right destination (e.g. UUID matches)
Sets UUID and JSON info for exported file using set_uuid_for_file, set_info_for_uuid
Expects that src is a temporary file (as set by _stage_photos_for_export) and
may modify the src (e.g. for convert_to_jpeg or exiftool)
Args:
src (str): src path
dest (pathlib.Path): dest path
options (ExportOptions): options for export
Returns:
ExportResults
Raises:
ValueError if export_as_hardlink and convert_to_jpeg both True
"""
verbose = options.verbose or self._verbose
if options.export_as_hardlink and options.convert_to_jpeg:
raise ValueError(
"export_as_hardlink and convert_to_jpeg cannot both be True"
)
if options.export_as_hardlink and self._is_temp_file(src):
raise ValueError("export_as_hardlink cannot be used with temp files")
exported_files = []
update_updated_files = []
update_new_files = []
update_skipped_files = [] # skip files that are already up to date
converted_to_jpeg_files = []
exif_results = ExportResults()
dest_str = str(dest)
# Use stat cache for exists check if available
if options.stat_cache is not None:
dest_exists = options.stat_cache.exists(dest)
else:
dest_exists = dest.exists()
fileutil = options.fileutil
export_db = options.export_db
if options.update or options.force_update:
export_db.prefetch_directory_records(dest.parent)
action = None
if options.update or options.force_update: # updating
if dest_exists:
if update_reason := self._should_update_photo(src, dest, options):
update_updated_files.append(dest_str)
action = "update: " + update_reason.name
else:
update_skipped_files.append(dest_str)
action = "skip"
else:
# update, destination doesn't exist (new file)
update_new_files.append(dest_str)
action = "new"
else:
# not update, export the file
exported_files.append(dest_str)
action = "export"
export_files = update_new_files + update_updated_files + exported_files
# Compute src_sig before any modifications by convert_to_jpeg or exiftool
# but defer writing to database until the context manager block to batch commits
src_sig = fileutil.file_sig(src)
for export_dest in export_files:
if dest_exists and any(
[options.overwrite, options.update, options.force_update]
):
# need to remove the destination first
try:
fileutil.unlink(dest)
# Update stat cache to reflect deleted file
if options.stat_cache is not None:
options.stat_cache.remove_file(dest)
except Exception as e:
raise ExportError(
f"Error removing file {dest}: {e} (({lineno(__file__)})"
) from e
if options.export_as_hardlink:
try:
fileutil.hardlink(src, dest)
# Update stat cache to reflect new file
if options.stat_cache is not None:
options.stat_cache.update_file(dest)
except Exception as e:
raise ExportError(
f"Error hardlinking {src} to {dest}: {e} ({lineno(__file__)})"
) from e
else:
if options.convert_to_jpeg:
# use convert_to_jpeg to export the file
# convert to a temp file before copying
tmp_file = increment_filename(
self._temp_dir_path
/ f"{pathlib.Path(src).stem}_converted_to_jpeg.jpeg"
)
fileutil.convert_to_jpeg(
src, tmp_file, compression_quality=options.jpeg_quality
)
src = tmp_file
converted_to_jpeg_files.append(dest_str)
if options.exiftool or options.fix_orientation:
# if exiftool or fix_orientation, write the metadata
# need to copy the file to a temp file before writing metadata
src = pathlib.Path(src)
tmp_file = increment_filename(
self._temp_dir_path / f"{src.stem}_exiftool{src.suffix}"
)
fileutil.copy(src, tmp_file)
# point src to the tmp_file so that the original source is not modified
# and the export grabs the new file
src = tmp_file
if options.exiftool:
exif_results = self.write_exiftool_metadata_to_file(
src, dest, options=options
)
if options.fix_orientation:
fixed, msg = fix_exif_orientation(self.photo, src, options)
verbose(msg)
try:
fileutil.copy(src, dest_str)
# Update stat cache to reflect new file
if options.stat_cache is not None:
options.stat_cache.update_file(dest_str)
verbose(
f"Exported {self._filename(self.photo.original_filename)} to {self._filepath(normalize_fs_path(dest_str))}"
)
except Exception as e:
raise ExportError(
f"Error copying file {src} to {dest_str}: {e} ({lineno(__file__)})"
) from e
results = ExportResults(
converted_to_jpeg=converted_to_jpeg_files,
error=exif_results.error,
exif_updated=exif_results.exif_updated,
exiftool_error=exif_results.exiftool_error,
exiftool_warning=exif_results.exiftool_warning,
exported=exported_files + update_new_files + update_updated_files,
new=update_new_files,
skipped=update_skipped_files,
updated=update_updated_files,
)
for f in (
exported_files
+ update_new_files
+ update_updated_files
+ update_skipped_files
):
results.uuids[f] = self.photo.uuid
# touch files if needed
if options.touch_file:
results += touch_files(
self.photo,
exported_files
+ update_new_files
+ update_updated_files
+ update_skipped_files,
options,
)
# set data in the database
with export_db.create_or_get_file_record(dest_str, self.photo.uuid) as rec:
if rec.photoinfo:
last_data = photoinfo_minify_dict(json.loads(rec.photoinfo))
# to avoid issues with datetime comparisons, list order
# need to deserialize from photo.json() instead of using photo.asdict()
current_data = photoinfo_minify_dict(
json.loads(self.photo.json(shallow=False))
)
try:
diff = dictdiff(last_data, current_data)
except Exception as e:
# just in case there's an edge case not caught by dictdiff
logger.debug(
f"Error comparing last_data and current_data: {e} ({lineno(__file__)})"
)
diff = []
def _json_default(o):
if isinstance(o, (datetime.date, datetime.datetime)):
return o.isoformat()
if isinstance(o, pathlib.Path):
return str(o)
diff = json.dumps(diff, default=_json_default) if diff else None
else:
diff = None
rec.photoinfo = self.photo.json(shallow=False)
rec.export_options = options.bit_flags
rec.src_sig = src_sig
if not options.ignore_signature:
rec.dest_sig = fileutil.file_sig(dest)
if options.exiftool:
rec.exifdata = exiftool_json_sidecar(photo=self.photo, options=options)
if self.photo.hexdigest != rec.digest:
results.metadata_changed = [dest_str]
rec.digest = self.photo.hexdigest
rec.date_modified = self.photo.date_modified
# save errors to the export database (#872)
if (
results.error
or exif_results.exiftool_error
or exif_results.exiftool_warning
):
rec.error = {
"error": results.error,
"exiftool_error": exif_results.exiftool_error,
"exiftool_warning": exif_results.exiftool_warning,
}
export_db.set_history(
filename=dest_str, uuid=self.photo.uuid, action=action, diff=diff
)
return results
def _export_photo_uuid_applescript(
self,
uuid: str,
dest: str,
filestem=None,
original=True,
edited=False,
live_photo=False,
timeout=120,
burst=False,
dry_run=False,
overwrite=False,
):
"""Export photo to dest path using applescript to control Photos
If photo is a live photo, exports both the photo and associated .mov file
Args:
uuid: UUID of photo to export
dest: destination path to export to
filestem: (string) if provided, exported filename will be named stem.ext
where ext is extension of the file exported by photos (e.g. .jpeg, .mov, etc)
If not provided, file will be named with whatever name Photos uses
If filestem.ext exists, it wil be overwritten
original: (boolean) if True, export original image; default = True
edited: (boolean) if True, export edited photo; default = False
If photo not edited and edited=True, will still export the original image
caller must verify image has been edited
*Note*: must be called with either edited or original but not both,
will raise error if called with both edited and original = True
live_photo: (boolean) if True, export associated .mov live photo; default = False
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 returns predicted
filenames without calling AppleScript or downloading files
Returns: list of paths to exported file(s), or predicted paths if dry_run is True
Raises: ExportError if error during export
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.
"""
dest = pathlib.Path(dest)
if not original ^ edited:
raise ValueError("edited or original must be True but not both")
# In dry_run mode, return predicted filenames without calling AppleScript
if dry_run:
return self._predict_export_filenames(
dest=dest,
filestem=filestem,
edited=edited,
live_photo=live_photo,
)
global _consecutive_export_errors
# Check if we've hit the error threshold and need to restart Photos
if _consecutive_export_errors >= APPLESCRIPT_ERROR_THRESHOLD:
logger.warning(
f"AppleScript export has failed {_consecutive_export_errors} consecutive times, restarting Photos app"
)
self._kill_photos_process()
_consecutive_export_errors = 0
if not dest.is_dir():
raise ValueError(f"dest {dest} must be a directory")
# export to a subdirectory of tmpdir
tmpdir = self.fileutil.tmpdir(
"osxphotos_applescript_export_", dirpath=self._temp_dir_path
)
exported_files = []
filename = None
try:
# I've seen intermittent failures with the PhotoScript export so retry if
# export doesn't return anything
retries = 0
while not exported_files and retries < MAX_PHOTOSCRIPT_RETRIES:
photo = photoscript.Photo(uuid)
filename = photo.filename
exported_files = photo.export(
tmpdir.name, original=original, timeout=timeout
)
retries += 1
except Exception as e:
_consecutive_export_errors += 1
logger.debug(
f"AppleScript export error count: {_consecutive_export_errors}"
)
raise ExportError(e)
if not exported_files or not filename:
# nothing got exported
_consecutive_export_errors += 1
logger.debug(
f"AppleScript export error count: {_consecutive_export_errors}"
)
raise ExportError(f"Could not export photo {uuid} ({lineno(__file__)})")
# need to find actual filename as sometimes Photos renames JPG to jpeg on export
# may be more than one file exported (e.g. if Live Photo, Photos exports both .jpeg and .mov)
# TemporaryDirectory will cleanup on return
filename_stem = pathlib.Path(filename).stem
exported_paths = []
for fname in exported_files:
path = pathlib.Path(tmpdir.name) / fname
if (
len(exported_files) > 1
and not live_photo
and path.suffix.lower() == ".mov"
):
# it's the .mov part of live photo but not requested, so don't export
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
continue
if filestem:
# rename the file based on filestem, keeping original extension
dest_new = dest / f"{filestem}{path.suffix}"
else:
# use the name Photos provided
dest_new = dest / path.name
if not dry_run:
if overwrite and dest_new.exists():
FileUtil.unlink(dest_new)
FileUtil.copy(str(path), str(dest_new))
exported_paths.append(str(dest_new))
# Reset error counter on successful export
if exported_paths:
_consecutive_export_errors = 0
return exported_paths
def _export_aae(
self,
src: pathlib.Path,
dest: pathlib.Path,
options: ExportOptions,
) -> ExportResults:
"""Export AAE file for the photo."""
# AAE files describe adjustments to originals, so they don't make sense
# for edited files
if options.edited:
return ExportResults()
verbose = options.verbose or self._verbose
action = None
if options.update or options.force_update: # updating
if dest.exists():
if update_reason := self._should_update_photo(src, dest, options):
action = "update: " + update_reason.name
else:
# update_skipped_files.append(dest_str)
action = "skip"
else:
action = "new"
else:
action = "export"
if action == "skip":
if dest.exists():
options.export_db.set_history(
filename=str(dest),
uuid=self.photo.uuid,
action=f"AAE: {action}",
diff=None,
)
return ExportResults(aae_skipped=[str(dest)], skipped=[str(dest)])
else:
action = "export"
errors = []
if dest.exists() and any(
[options.overwrite, options.update, options.force_update]
):
try:
options.fileutil.unlink(dest)
except Exception as e:
errors.append(f"Error removing file {dest}: {e} (({lineno(__file__)})")
if options.export_as_hardlink:
try:
options.fileutil.hardlink(src, dest)
except Exception as e:
errors.append(
f"Error hardlinking {src} to {dest}: {e} ({lineno(__file__)})"
)
else:
try:
options.fileutil.copy(src, dest)
except Exception as e:
errors.append(
f"Error copying file {src} to {dest}: {e} ({lineno(__file__)})"
)
# set data in the database
fileutil = options.fileutil
with options.export_db.create_or_get_file_record(
str(dest), self.photo.uuid
) as rec:
# don't set src_sig as that is set above before any modifications by convert_to_jpeg or exiftool
rec.src_sig = fileutil.file_sig(src)
if not options.ignore_signature:
rec.dest_sig = fileutil.file_sig(dest)
rec.export_options = options.bit_flags
if errors:
rec.error = {
"error": errors,
"exiftool_error": None,
"exiftool_warning": None,
}
options.export_db.set_history(
filename=str(dest), uuid=self.photo.uuid, action=f"AAE: {action}", diff=None
)
verbose(
f"Exported adjustments for {self._filename(self.photo.original_filename)} to {self._filepath(dest)}"
)
written = [str(dest)]
exported = written if action in {"export", "new"} else []
new = written if action == "new" else []
updated = written if "update" in action else []
return ExportResults(
aae_written=written,
exported=exported,
new=new,
updated=updated,
error=errors,
uuids={str(dest): self.photo.uuid},
)
def _should_run_exiftool(self, dest, options: ExportOptions) -> bool:
"""Return True if exiftool should be run to update metadata"""
run_exiftool = not options.update and not options.force_update
if options.update or options.force_update:
files_are_different = False
exif_record = options.export_db.get_file_record(dest)
old_data = exif_record.exifdata if exif_record else None
if old_data is not None:
old_data = json.loads(old_data)[0]
current_data = json.loads(
exiftool_json_sidecar(photo=self.photo, options=options)
)
current_data = current_data[0]
if old_data != current_data:
files_are_different = True
if old_data is None or files_are_different:
# didn't have old data, assume we need to write it
# or files were different
run_exiftool = True
return run_exiftool
def _check_export_suffix(src, dest, edited):
"""Helper function for exporting photos to check file extensions of destination path.
Checks that dst file extension is appropriate for the src.
If edited=True, will use src file extension of ".jpeg" if None provided for src.
Args:
src: path to source file or None.
dest: path to destination file.
edited: set to True if exporting an edited photo.
Returns:
True if src and dest extensions are OK, else False.
Raises:
ValueError if edited is False and src is None
"""
# check extension of destination
if src is not None:
# use suffix from edited file
actual_suffix = pathlib.Path(src).suffix
elif edited:
# use .jpeg as that's probably correct
actual_suffix = ".jpeg"
else:
raise ValueError("src must not be None if edited=False")
# Photo's often converts .JPG to .jpeg or .tif to .tiff on import
dest_ext = dest.suffix.lower()
actual_ext = actual_suffix.lower()
suffixes = sorted([dest_ext, actual_ext])
return (
dest_ext == actual_ext
or suffixes == [".jpeg", ".jpg"]
or suffixes == [".tif", ".tiff"]
)
def rename_jpeg_files(files, jpeg_ext, fileutil):
"""rename any jpeg files in files so that extension matches jpeg_ext
Args:
files: list of file paths
jpeg_ext: extension to use for jpeg files found in files, e.g. "jpg"
fileutil: a FileUtil object
Returns:
list of files with updated names
Note: If non-jpeg files found, they will be ignore and returned in the return list
"""
jpeg_ext = "." + jpeg_ext
jpegs = [".jpeg", ".jpg"]
new_files = []
for file in files:
path = pathlib.Path(file)
if path.suffix.lower() in jpegs and path.suffix != jpeg_ext:
new_file = path.parent / (path.stem + jpeg_ext)
fileutil.rename(file, new_file)
new_files.append(new_file)
else:
new_files.append(file)
return new_files
def original_aae_name(dest: pathlib.Path):
"""Return name for original AAE file (e.g. for Portrait images)"""
# if name matches IMG_1234.ext, name the AAE file IMG_O1234.AAE, otherwise, use IMG_NAME_O.AAE (append _O and use aae extension)
if re.match(r"^IMG_\d{4}\.", dest.name, re.IGNORECASE):
return normalize_fs_path(dest.parent / f"{dest.stem}_O.AAE")
else:
return normalize_fs_path(dest.parent / f"{dest.stem}_O.AAE")