Added ExportOptions to photoexporter.py, #462

tests/test_export_catalina_10_15_7.py

@@ -8,7 +8,7 @@ import pytest
 import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
 from osxphotos.exiftool import get_exiftool_path
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 from osxphotos.utils import dd_to_dms_str
 
 # determine if exiftool installed so exiftool tests can be skipped
@@ -321,7 +321,9 @@ def test_export_12(photosdb):
 
     edited_name = pathlib.Path(photos[0].path_edited).name
     edited_suffix = pathlib.Path(edited_name).suffix
-    filename = pathlib.Path(photos[0].original_filename).stem + "_edited" + edited_suffix
+    filename = (
+        pathlib.Path(photos[0].original_filename).stem + "_edited" + edited_suffix
+    )
     expected_dest = os.path.join(dest, filename)
 
     got_dest = photos[0].export(dest, edited=True)[0]
@@ -418,7 +420,9 @@ def test_exiftool_json_sidecar_ignore_date_modified(photosdb):
     ) as fp:
         json_expected = json.load(fp)[0]
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(ignore_date_modified=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(ignore_date_modified=True)
+    )
     json_got = json.loads(json_got)[0]
 
     assert json_got == json_expected
@@ -449,7 +453,9 @@ def test_exiftool_json_sidecar_keyword_template_long(capsys, photosdb):
 
     long_str = "x" * (_MAX_IPTC_KEYWORD_LEN + 1)
     photos[0]._verbose = print
-    json_got = PhotoExporter(photos[0])._exiftool_json_sidecar(keyword_template=[long_str])
+    json_got = PhotoExporter(photos[0])._exiftool_json_sidecar(
+        ExportOptions(keyword_template=[long_str])
+    )
     json_got = json.loads(json_got)[0]
 
     captured = capsys.readouterr()
@@ -484,7 +490,9 @@ def test_exiftool_json_sidecar_keyword_template(photosdb):
         str(pathlib.Path(SIDECAR_DIR) / f"{uuid}_keyword_template.json"), "r"
     ) as fp:
         json_expected = json.load(fp)
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(keyword_template=["{folder_album}"])
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(keyword_template=["{folder_album}"])
+    )
     json_got = json.loads(json_got)
 
     assert json_got == json_expected
@@ -500,7 +508,9 @@ def test_exiftool_json_sidecar_use_persons_keyword(photosdb):
     ) as fp:
         json_expected = json.load(fp)[0]
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(use_persons_as_keywords=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(use_persons_as_keywords=True)
+    )
     json_got = json.loads(json_got)[0]
 
     assert json_got == json_expected
@@ -516,7 +526,9 @@ def test_exiftool_json_sidecar_use_albums_keywords(photosdb):
     ) as fp:
         json_expected = json.load(fp)
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(use_albums_as_keywords=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(use_albums_as_keywords=True)
+    )
     json_got = json.loads(json_got)
 
     assert json_got == json_expected
@@ -536,7 +548,7 @@ def test_exiftool_sidecar(photosdb):
 
 @pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
 def test_xmp_sidecar_is_valid(tmp_path, photosdb):
-    """ validate XMP sidecar file with exiftool """
+    """validate XMP sidecar file with exiftool"""
     from osxphotos.exiftool import ExifTool
 
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
@@ -560,7 +572,7 @@ def test_xmp_sidecar(photosdb):
 
 
 def test_xmp_sidecar_extension(photosdb):
-    """ test XMP sidecar when no extension is passed """
+    """test XMP sidecar when no extension is passed"""
 
     uuid = UUID_DICT["xmp"]
     photos = photosdb.photos(uuid=[uuid])
@@ -581,7 +593,9 @@ def test_xmp_sidecar_use_persons_keyword(photosdb):
     with open(pathlib.Path(SIDECAR_DIR) / f"{uuid}_persons_as_keywords.xmp") as fp:
         xmp_expected = fp.read()
 
-    xmp_got = PhotoExporter(photo)._xmp_sidecar(use_persons_as_keywords=True, extension="jpg")
+    xmp_got = PhotoExporter(photo)._xmp_sidecar(
+        ExportOptions(use_persons_as_keywords=True), extension="jpg"
+    )
     assert xmp_got == xmp_expected
 
 
@@ -593,12 +607,14 @@ def test_xmp_sidecar_use_albums_keyword(photosdb):
     with open(pathlib.Path(SIDECAR_DIR) / f"{uuid}_albums_as_keywords.xmp") as fp:
         xmp_expected = fp.read()
 
-    xmp_got = PhotoExporter(photo)._xmp_sidecar(use_albums_as_keywords=True, extension="jpg")
+    xmp_got = PhotoExporter(photo)._xmp_sidecar(
+        ExportOptions(use_albums_as_keywords=True), extension="jpg"
+    )
     assert xmp_got == xmp_expected
 
 
 def test_xmp_sidecar_gps(photosdb):
-    """ Test export XMP sidecar with GPS info """
+    """Test export XMP sidecar with GPS info"""
 
     uuid = UUID_DICT["location"]
     photo = photosdb.get_photo(uuid)
@@ -619,7 +635,7 @@ def test_xmp_sidecar_keyword_template(photosdb):
         xmp_expected = fp.read()
 
     xmp_got = PhotoExporter(photo)._xmp_sidecar(
-        keyword_template=["{created.year}", "{folder_album}"], extension="jpg"
+        ExportOptions(keyword_template=["{created.year}", "{folder_album}"]),
+        extension="jpg",
     )
     assert xmp_got == xmp_expected
-

tests/test_export_convert_to_jpeg.py

@@ -1,8 +1,9 @@
 import os
+
 import pytest
 
 from osxphotos._constants import _UNKNOWN_PERSON
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 skip_test = "OSXPHOTOS_TEST_CONVERT" not in os.environ
 pytestmark = pytest.mark.skipif(
@@ -16,16 +17,10 @@ UUID_DICT = {
     "heic": "7783E8E6-9CAC-40F3-BE22-81FB7051C266",
 }
 
-NAMES_DICT = {
-    "raw": "DSC03584.jpeg",
-    "heic": "IMG_3092.jpeg"
-}
+NAMES_DICT = {"raw": "DSC03584.jpeg", "heic": "IMG_3092.jpeg"}
 
 UUID_LIVE_HEIC = "8EC216A2-0032-4934-BD3F-04C6259B3304"
-NAMES_LIVE_HEIC = [
-    "IMG_3259.jpeg",
-    "IMG_3259.mov"
-]
+NAMES_LIVE_HEIC = ["IMG_3259.jpeg", "IMG_3259.mov"]
 
 
 @pytest.fixture(scope="module")
@@ -44,7 +39,8 @@ def test_export_convert_raw_to_jpeg(photosdb):
     dest = tempdir.name
     photos = photosdb.photos(uuid=[UUID_DICT["raw"]])
 
-    results = PhotoExporter(photos[0]).export2(dest, convert_to_jpeg=True)
+    export_options = ExportOptions(convert_to_jpeg=True)
+    results = PhotoExporter(photos[0]).export2(dest, options=export_options)
     got_dest = pathlib.Path(results.exported[0])
 
     assert got_dest.is_file()
@@ -61,7 +57,8 @@ def test_export_convert_heic_to_jpeg(photosdb):
     dest = tempdir.name
     photos = photosdb.photos(uuid=[UUID_DICT["heic"]])
 
-    results = PhotoExporter(photos[0]).export2(dest, convert_to_jpeg=True)
+    export_options = ExportOptions(convert_to_jpeg=True)
+    results = PhotoExporter(photos[0]).export2(dest, options=export_options)
     got_dest = pathlib.Path(results.exported[0])
 
     assert got_dest.is_file()
@@ -88,7 +85,8 @@ def test_export_convert_live_heic_to_jpeg():
     dest = tempdir.name
     photo = photosdb.get_photo(UUID_LIVE_HEIC)
 
-    results = PhotoExporter(photo).export2(dest, convert_to_jpeg=True, live_photo=True)
+    export_options = ExportOptions(convert_to_jpeg=True, live_photo=True)
+    results = PhotoExporter(photo).export2(dest, options=export_options)
 
     for name in NAMES_LIVE_HEIC:
         assert f"{tempdir.name}/{name}" in results.exported
@@ -96,4 +94,3 @@ def test_export_convert_live_heic_to_jpeg():
     for file_ in results.exported:
         dest = pathlib.Path(file_)
         assert dest.is_file()
-

tests/test_export_mojave_10_14_6.py

@@ -5,7 +5,7 @@ import pytest
 
 import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 PHOTOS_DB = "./tests/Test-10.14.6.photoslibrary/database/photos.db"
 PHOTOS_DB_PATH = "/Test-10.14.6.photoslibrary/database/photos.db"
@@ -365,7 +365,8 @@ def test_xmp_sidecar_keyword_template(photosdb):
         xmp_expected = fp.read()
 
     xmp_got = PhotoExporter(photo)._xmp_sidecar(
-        keyword_template=["{created.year}", "{folder_album}"], extension="jpg"
+        ExportOptions(keyword_template=["{created.year}", "{folder_album}"]),
+        extension="jpg",
     )
 
     assert xmp_got == xmp_expected

tests/test_sidecar_xmp.py

@@ -9,7 +9,7 @@ import osxphotos
 from osxphotos._constants import SIDECAR_XMP
 from osxphotos.exiftool import ExifTool, get_exiftool_path
 from osxphotos.fileutil import FileUtil
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 PHOTOS_DB_15_7 = "tests/Test-10.15.7.photoslibrary"
 
@@ -40,7 +40,10 @@ def test_sidecar_xmp(photosdb):
         tempdir = tempfile.TemporaryDirectory(prefix="osxphotos")
         dest = tempdir.name
         photo = photosdb.get_photo(uuid)
-        PhotoExporter(photo).export2(dest, photo.original_filename, sidecar=SIDECAR_XMP)
+        export_options = ExportOptions(sidecar=SIDECAR_XMP)
+        PhotoExporter(photo).export2(
+            dest, photo.original_filename, options=export_options
+        )
         filepath = str(pathlib.Path(dest) / photo.original_filename)
         xmppath = filepath + ".xmp"