Set XMP:Subject to match Keywords, issue #302

CHANGELOG.md

@@ -4,6 +4,28 @@ 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.38.12](https://github.com/RhetTbull/osxphotos/compare/v0.38.11...v0.38.12)
+
+> 26 December 2020
+
+- Fixed city/sub-locality for SearchInfo [`f9f699b`](https://github.com/RhetTbull/osxphotos/commit/f9f699ba3500d58494f955d4e5d8118e336e6a2c)
+
+#### [v0.38.11](https://github.com/RhetTbull/osxphotos/compare/v0.38.9...v0.38.11)
+
+> 26 December 2020
+
+- Exposed SearchInfo, closes #121 [`#121`](https://github.com/RhetTbull/osxphotos/issues/121)
+- Added version to --verbose, closes #297 [`#297`](https://github.com/RhetTbull/osxphotos/issues/297)
+- Added --exportdb [`2a49255`](https://github.com/RhetTbull/osxphotos/commit/2a49255277d3c6bd3b0d5f8288afd7de7dab0320)
+- Updated README.md [`f469ccc`](https://github.com/RhetTbull/osxphotos/commit/f469cccc4b4561db7611c3e9abf5aefc3ab0f648)
+- Fixed help text [`f3b7134`](https://github.com/RhetTbull/osxphotos/commit/f3b7134af1e3d07fb956eaccccd9d60bd075d3bf)
+
+#### [v0.38.9](https://github.com/RhetTbull/osxphotos/compare/v0.38.8...v0.38.9)
+
+> 21 December 2020
+
+- Added --exiftool-option to CLI, closes #298 [`#298`](https://github.com/RhetTbull/osxphotos/issues/298)
+
 #### [v0.38.8](https://github.com/RhetTbull/osxphotos/compare/v0.38.7...v0.38.8)
 
 > 21 December 2020

README.md

@@ -21,6 +21,7 @@
     + [FolderInfo](#folderinfo)
     + [PlaceInfo](#placeinfo)
     + [ScoreInfo](#scoreinfo)
+    + [SearchInfo](#searchinfo)
     + [PersonInfo](#personinfo)
     + [FaceInfo](#faceinfo)
     + [CommentInfo](#commentinfo)
@@ -349,9 +350,9 @@ Options:
                                   exiftool command line. See exiftool docs at
                                   https://exiftool.org/exiftool_pod.html for
                                   full list of options. More than one option
-                                  may be specified with by repeating the
-                                  option, e.g. --exiftool-option '-m'
-                                  --exiftool-option '-F'.
+                                  may be specified by repeating the option,
+                                  e.g. --exiftool-option '-m' --exiftool-
+                                  option '-F'.
   --ignore-date-modified          If used with --exiftool or --sidecar, will
                                   ignore the photo modification date and set
                                   EXIF:ModifyDate to EXIF:DateTimeOriginal;
@@ -429,6 +430,14 @@ Options:
                                   set. For example, photos which had
                                   previously been exported and were
                                   subsequently deleted in Photos.
+  --exportdb EXPORTDB_FILE        Specify alternate name for database file
+                                  which stores state information for export
+                                  and --update. If --exportdb is not
+                                  specified, export database will be saved to
+                                  '.osxphotos_export.db' in the export
+                                  directory.  Must be specified as filename
+                                  only, not a path, as export database will be
+                                  saved in export directory.
   --load-config <config file path>
                                   Load options from file as written with
                                   --save-config. This allows you to save a
@@ -1462,6 +1471,7 @@ Returns image categorization labels associated with the photo as list of str.
 #### `labels_normalized`
 Returns image categorization labels associated with the photo as list of str. Labels are normalized (e.g. converted to lower case).  Use of normalized strings makes it easier to search if you don't how Apple capitalizes a label. For example:
 
+
 ```python
 import osxphotos
 
@@ -1471,12 +1481,23 @@ for photo in photosdb.photos():
         print(f"I found a statue! {photo.original_filename}")
 ```
 
-**Note**: Only valid on Photos 5; on earlier versions, returns empty list. In Photos 5, Photos runs machine learning image categorization against photos in the library and automatically assigns labels to photos such as "People", "Dog", "Water", etc.  A photo may have zero or more labels associated with it.  See also [labels](#labels).  
+**Note**: Only valid on Photos 5+; on earlier versions, returns empty list. In Photos 5+, Photos runs machine learning image categorization against photos in the library and automatically assigns labels to photos such as "People", "Dog", "Water", etc.  A photo may have zero or more labels associated with it.  See also [labels](#labels).  
+
+
+#### <a name="photosearchinfo">`search_info`</a>
+Returns [SearchInfo](#searchinfo) object that represents search metadata for the photo.  
+
+**Note**: Only valid on Photos 5+; on ealier versions, returns None.
+
+#### <a name="photosearchinfo-normalized">`search_info_normalized`</a>
+Returns [SearchInfo](#searchinfo) object that represents normalized search metadata for the photo.  This returns a SearchInfo object just as `search_info` but all the properties of the object return normalized text (converted to lowercase).
+
+**Note**: Only valid on Photos 5+; on ealier versions, returns None.
 
 #### `exif_info`
 Returns an [ExifInfo](#exifinfo) object with EXIF details from the Photos database.  See [ExifInfo](#exifinfo) for additional details.
 
-**Note**: Only valid on Photos 5; on earlier versions, returns `None`.  The EXIF details returned are a subset of the actual EXIF data in a typical image.  At import Photos stores this subset in the database and it's this stored data that `exif_info` returns.
+**Note**: Only valid on Photos 5+; on earlier versions, returns `None`.  The EXIF details returned are a subset of the actual EXIF data in a typical image.  At import Photos stores this subset in the database and it's this stored data that `exif_info` returns.
 
 See also `exiftool`.
 
@@ -1864,7 +1885,7 @@ PostalAddress(street='3700 Wailea Alanui Dr', sub_locality=None, city='Kihei', s
 '96753'
 ```
 ### ScoreInfo
-[PhotoInfo.score](#score) returns a ScoreInfo object that exposes the computed aesthetic scores for each photo (**Photos 5 only**).  I have not yet reverse engineered the meaning of each score.  The `overall` score seems to the most useful and appears to be a composite of the other scores.  The following score properties are currently available:
+[PhotoInfo.score](#score) returns a ScoreInfo object that exposes the computed aesthetic scores for each photo (**Photos 5+ only**).  I have not yet reverse engineered the meaning of each score.  The `overall` score seems to the most useful and appears to be a composite of the other scores.  The following score properties are currently available:
 
 ```python
 overall: float
@@ -1903,6 +1924,71 @@ Example: find your "best" photo of food
 >>> best_food_photo = sorted([p for p in photos if "food" in p.labels_normalized], key=lambda p: p.score.overall, reverse=True)[0]
 ```
 
+### SearchInfo
+[PhotoInfo.search_info](#photosearchinfo) and [PhotoInfo.search_info_normalized](#photosearchinfo-normalized) return a SearchInfo object that exposes various metadata that Photos uses when searching for photos such as labels, associated holiday, etc. (**Photos 5+ only**).
+
+The following properties are available:
+
+#### `labels`
+Returns list of labels applied to photo by Photos image categorization algorithms.
+
+#### `place_names`
+Returns list of place names associated with the photo.
+
+#### `streets`
+Returns list of street names associated with the photo. (e.g. reverse geolocation of where the photo was taken)
+
+#### `neighborhoods`
+Returns list of neighborhood names associated with the photo.
+
+#### `locality_names`
+Returns list of locality names associated with the photo.
+
+#### `city`
+Returns str of city/town/municipality associated with the photo.
+
+#### `state`
+Returns str of state name associated with the photo.
+
+#### `state_abbreviation`
+Returns str of state abbreviation associated with the photo.
+
+#### `country`
+Returns str of country name associated with the photo.
+
+#### `month`
+Returns str of month name associated witht the photo (e.g. month in which the photo was taken)
+
+#### `year`
+Returns year associated with the photo.
+
+#### `bodies_of_water`
+Returns list of bodies of water associated with the photo.
+
+#### `holidays`
+Returns list of holiday names associated with the photo.
+
+#### `activities`
+Returns list of activities associated with the photo.
+
+#### `season`
+Returns str of season name associated with the photo.
+
+#### `venues`
+Returns list of venue names associated with the photo.
+
+#### `venue_types`
+Returns list of venue types associated with the photoo.
+
+#### `media_types`
+Returns list of media types associated with the photo.
+
+#### `all`
+Returns all search_info properties as a single list of strings.
+
+#### `asdict()`
+Returns all associated search_info metadata as a dict.
+
 ### PersonInfo
 [PhotosDB.person_info](#dbpersoninfo) and [PhotoInfo.person_info](#photopersoninfo) return a list of PersonInfo objects represents persons in the database and in a photo, respectively.  The PersonInfo class has the following properties and methods.
 

osxphotos/__main__.py

@@ -1374,7 +1374,7 @@ def query(
     "For example, --exiftool-option '-m' to ignore minor warnings. "
     "Specify these as you would on the exiftool command line. "
     "See exiftool docs at https://exiftool.org/exiftool_pod.html for full list of options. "
-    "More than one option may be specified with by repeating the option, e.g. "
+    "More than one option may be specified by repeating the option, e.g. "
     "--exiftool-option '-m' --exiftool-option '-F'. ",
 )
 @click.option(
@@ -1476,6 +1476,18 @@ def query(
     help="Cleanup export directory by deleting any files which were not included in this export set. "
     "For example, photos which had previously been exported and were subsequently deleted in Photos.",
 )
+@click.option(
+    "--exportdb",
+    metavar="EXPORTDB_FILE",
+    default=None,
+    help=(
+        "Specify alternate name for database file which stores state information for export and --update. "
+        f"If --exportdb is not specified, export database will be saved to '{OSXPHOTOS_EXPORT_DB}' "
+        "in the export directory.  Must be specified as filename only, not a path, as export database "
+        "will be saved in export directory."
+    ),
+    type=click.Path(),
+)
 @click.option(
     "--load-config",
     required=False,
@@ -1595,6 +1607,7 @@ def export(
     use_photokit,
     report,
     cleanup,
+    exportdb,
     load_config,
     save_config,
 ):
@@ -1724,11 +1737,14 @@ def export(
         use_photokit = cfg.use_photokit
         report = cfg.report
         cleanup = cfg.cleanup
+        exportdb = cfg.exportdb
 
         # config file might have changed verbose
         VERBOSE = bool(verbose)
         verbose_(f"Loaded options from file {load_config}")
 
+    verbose_(f"osxphotos version {__version__}")
+
     exclusive_options = [
         ("favorite", "not_favorite"),
         ("hidden", "not_hidden"),
@@ -1854,8 +1870,27 @@ def export(
         _list_libraries()
         return
 
+    # sanity check exportdb
+    if exportdb and exportdb != OSXPHOTOS_EXPORT_DB:
+        if "/" in exportdb:
+            click.echo(
+                click.style(
+                    f"Error: --exportdb must be specified as filename not path; "
+                    + f"export database will saved in export directory '{dest}'.",
+                    fg=CLI_COLOR_ERROR,
+                )
+            )
+            raise click.Abort()
+        elif pathlib.Path(pathlib.Path(dest) / OSXPHOTOS_EXPORT_DB).exists():
+            click.echo(
+                click.style(
+                    f"Warning: export database is '{exportdb}' but found '{OSXPHOTOS_EXPORT_DB}' in {dest}; using '{exportdb}'",
+                    fg=CLI_COLOR_WARNING,
+                )
+            )
+
     # open export database and assign copy/link/unlink functions
-    export_db_path = os.path.join(dest, OSXPHOTOS_EXPORT_DB)
+    export_db_path = os.path.join(dest, exportdb or OSXPHOTOS_EXPORT_DB)
 
     # check that export isn't in the parent or child of a previously exported library
     other_db_files = find_files_in_branch(dest, OSXPHOTOS_EXPORT_DB)

osxphotos/_constants.py

@@ -102,6 +102,63 @@ _OSXPHOTOS_NONE_SENTINEL = "OSXPhotosXYZZY42_Sentinel$"
 
 # SearchInfo categories for Photos 5, corresponds to categories in database/search/psi.sqlite
 SEARCH_CATEGORY_LABEL = 2024
+SEARCH_CATEGORY_PLACE_NAME = 1
+SEARCH_CATEGORY_STREET = 2
+SEARCH_CATEGORY_NEIGHBORHOOD = 3
+SEARCH_CATEGORY_LOCALITY_4 = 4
+SEARCH_CATEGORY_SUB_LOCALITY_5 = 5
+SEARCH_CATEGORY_SUB_LOCALITY_6 = 6
+SEARCH_CATEGORY_CITY = 7 
+SEARCH_CATEGORY_LOCALITY_8 = 8
+SEARCH_CATEGORY_NAMED_AREA = 9
+SEARCH_CATEGORY_ALL_LOCALITY = [
+    SEARCH_CATEGORY_LOCALITY_4,
+    SEARCH_CATEGORY_SUB_LOCALITY_5,
+    SEARCH_CATEGORY_SUB_LOCALITY_6,
+    SEARCH_CATEGORY_LOCALITY_8,
+    SEARCH_CATEGORY_NAMED_AREA,
+]
+SEARCH_CATEGORY_STATE = 10
+SEARCH_CATEGORY_STATE_ABBREVIATION = 11
+SEARCH_CATEGORY_COUNTRY = 12
+SEARCH_CATEGORY_BODY_OF_WATER = 14
+SEARCH_CATEGORY_MONTH = 1014
+SEARCH_CATEGORY_YEAR = 1015
+SEARCH_CATEGORY_KEYWORDS = 2016
+SEARCH_CATEGORY_TITLE = 2017
+SEARCH_CATEGORY_DESCRIPTION = 2018
+SEARCH_CATEGORY_HOME = 2020
+SEARCH_CATEGORY_PERSON = 2021
+SEARCH_CATEGORY_ACTIVITY = 2027
+SEARCH_CATEGORY_HOLIDAY = 2029
+SEARCH_CATEGORY_SEASON = 2030
+SEARCH_CATEGORY_WORK = 2036
+SEARCH_CATEGORY_VENUE = 2038
+SEARCH_CATEGORY_VENUE_TYPE = 2039
+SEARCH_CATEGORY_PHOTO_TYPE_VIDEO = 2044
+SEARCH_CATEGORY_PHOTO_TYPE_SLOMO = 2045
+SEARCH_CATEGORY_PHOTO_TYPE_LIVE = 2046
+SEARCH_CATEGORY_PHOTO_TYPE_SCREENSHOT = 2047
+SEARCH_CATEGORY_PHOTO_TYPE_PANORAMA = 2048
+SEARCH_CATEGORY_PHOTO_TYPE_TIMELAPSE = 2049
+SEARCH_CATEGORY_PHOTO_TYPE_BURSTS = 2052
+SEARCH_CATEGORY_PHOTO_TYPE_PORTRAIT = 2053
+SEARCH_CATEGORY_PHOTO_TYPE_SELFIES = 2054
+SEARCH_CATEGORY_PHOTO_TYPE_FAVORITES = 2055
+SEARCH_CATEGORY_MEDIA_TYPES = [
+    SEARCH_CATEGORY_PHOTO_TYPE_VIDEO,
+    SEARCH_CATEGORY_PHOTO_TYPE_SLOMO,
+    SEARCH_CATEGORY_PHOTO_TYPE_LIVE,
+    SEARCH_CATEGORY_PHOTO_TYPE_SCREENSHOT,
+    SEARCH_CATEGORY_PHOTO_TYPE_PANORAMA,
+    SEARCH_CATEGORY_PHOTO_TYPE_TIMELAPSE,
+    SEARCH_CATEGORY_PHOTO_TYPE_BURSTS,
+    SEARCH_CATEGORY_PHOTO_TYPE_PORTRAIT,
+    SEARCH_CATEGORY_PHOTO_TYPE_SELFIES,
+    SEARCH_CATEGORY_PHOTO_TYPE_FAVORITES,
+]
+SEARCH_CATEGORY_PHOTO_NAME = 2056
+
 
 # Max filename length on MacOS
 MAX_FILENAME_LEN = 255
@@ -119,5 +176,5 @@ DEFAULT_EDITED_SUFFIX = "_edited"
 DEFAULT_ORIGINAL_SUFFIX = ""
 
 # Colors for print CLI messages
-CLI_COLOR_ERROR = 'red'
-CLI_COLOR_WARNING = 'yellow'
+CLI_COLOR_ERROR = "red"
+CLI_COLOR_WARNING = "yellow"

osxphotos/_version.py

@@ -1,5 +1,5 @@
 """ version info """
 
-__version__ = "0.38.9"
+__version__ = "0.38.13"
 
 

osxphotos/photoinfo/_photoinfo_export.py

@@ -1390,18 +1390,14 @@ def _exiftool_dict(
     if keyword_list:
         # remove duplicates
         keyword_list = sorted(list(set(keyword_list)))
-        exif["XMP:TagsList"] = keyword_list.copy()
         exif["IPTC:Keywords"] = keyword_list.copy()
+        exif["XMP:Subject"] = keyword_list.copy()
+        exif["XMP:TagsList"] = keyword_list.copy()
 
     if person_list:
         person_list = sorted(list(set(person_list)))
         exif["XMP:PersonInImage"] = person_list.copy()
 
-    if self.keywords or person_list:
-        # Photos puts both keywords and persons in Subject when using "Export IPTC as XMP"
-        # only use Photos' keywords for subject (e.g. don't include template values)
-        exif["XMP:Subject"] = sorted(list(set(self.keywords + person_list)))
-
     # if self.favorite():
     #     exif["Rating"] = 5
 
@@ -1607,20 +1603,15 @@ def _xmp_sidecar(
 
         keyword_list.extend(rendered_keywords)
 
-    subject_list = []
-    if self.keywords or person_list:
-        # Photos puts both keywords and persons in Subject when using "Export IPTC as XMP"
-        subject_list = list(self.keywords) + person_list
-
     # remove duplicates
     # sorted mainly to make testing the XMP file easier
     if keyword_list:
         keyword_list = sorted(list(set(keyword_list)))
-    if subject_list:
-        subject_list = sorted(list(set(subject_list)))
     if person_list:
         person_list = sorted(list(set(person_list)))
 
+    subject_list = keyword_list
+
     xmp_str = xmp_template.render(
         photo=self,
         description=description,

osxphotos/photoinfo/_photoinfo_searchinfo.py

@@ -1,11 +1,32 @@
 """ Methods and class for PhotoInfo exposing SearchInfo data such as labels 
     Adds the following properties to PhotoInfo (valid only for Photos 5):
         search_info: returns a SearchInfo object
+        search_info_normalized: returns a SearchInfo object with properties that produce normalized results
         labels: returns list of labels
         labels_normalized: returns list of normalized labels
 """
 
-from .._constants import _PHOTOS_4_VERSION, SEARCH_CATEGORY_LABEL
+from .._constants import (
+    _PHOTOS_4_VERSION,
+    SEARCH_CATEGORY_CITY,
+    SEARCH_CATEGORY_LABEL,
+    SEARCH_CATEGORY_NEIGHBORHOOD,
+    SEARCH_CATEGORY_PLACE_NAME,
+    SEARCH_CATEGORY_STREET,
+    SEARCH_CATEGORY_ALL_LOCALITY,
+    SEARCH_CATEGORY_COUNTRY,
+    SEARCH_CATEGORY_STATE,
+    SEARCH_CATEGORY_STATE_ABBREVIATION,
+    SEARCH_CATEGORY_BODY_OF_WATER,
+    SEARCH_CATEGORY_MONTH,
+    SEARCH_CATEGORY_YEAR,
+    SEARCH_CATEGORY_HOLIDAY,
+    SEARCH_CATEGORY_ACTIVITY,
+    SEARCH_CATEGORY_SEASON,
+    SEARCH_CATEGORY_VENUE,
+    SEARCH_CATEGORY_VENUE_TYPE,
+    SEARCH_CATEGORY_MEDIA_TYPES,
+)
 
 
 @property
@@ -24,6 +45,22 @@ def search_info(self):
         return self._search_info
 
 
+@property
+def search_info_normalized(self):
+    """ returns SearchInfo object for photo that produces normalized results
+        only valid on Photos 5, on older libraries, returns None
+    """
+    if self._db._db_version <= _PHOTOS_4_VERSION:
+        return None
+
+    # memoize SearchInfo object
+    try:
+        return self._search_info_normalized
+    except AttributeError:
+        self._search_info_normalized = SearchInfo(self, normalized=True)
+        return self._search_info_normalized
+
+
 @property
 def labels(self):
     """ returns list of labels applied to photo by Photos image categorization
@@ -43,14 +80,15 @@ def labels_normalized(self):
     if self._db._db_version <= _PHOTOS_4_VERSION:
         return []
 
-    return self.search_info.labels_normalized
+    return self.search_info_normalized.labels
 
 
 class SearchInfo:
     """ Info about search terms such as machine learning labels that Photos knows about a photo """
 
-    def __init__(self, photo):
-        """ photo: PhotoInfo object """
+    def __init__(self, photo, normalized=False):
+        """ photo: PhotoInfo object
+            normalized: if True, all properties return normalized (lower case) results """
 
         if photo._db._db_version <= _PHOTOS_4_VERSION:
             raise NotImplementedError(
@@ -58,6 +96,7 @@ class SearchInfo:
             )
 
         self._photo = photo
+        self._normalized = normalized
         self.uuid = photo.uuid
         try:
             # get search info for this UUID
@@ -69,25 +108,170 @@ class SearchInfo:
     @property
     def labels(self):
         """ return list of labels associated with Photo """
-        if self._db_searchinfo:
-            labels = [
-                rec["content_string"]
-                for rec in self._db_searchinfo
-                if rec["category"] == SEARCH_CATEGORY_LABEL
-            ]
-        else:
-            labels = []
-        return labels
+        return self._get_text_for_category(SEARCH_CATEGORY_LABEL)
 
     @property
-    def labels_normalized(self):
-        """ return list of normalized labels associated with Photo """
+    def place_names(self):
+        """ returns list of place names """
+        return self._get_text_for_category(SEARCH_CATEGORY_PLACE_NAME)
+
+    @property
+    def streets(self):
+        """ returns list of street names """
+        return self._get_text_for_category(SEARCH_CATEGORY_STREET)
+
+    @property
+    def neighborhoods(self):
+        """ returns list of neighborhoods """
+        return self._get_text_for_category(SEARCH_CATEGORY_NEIGHBORHOOD)
+
+    @property
+    def locality_names(self):
+        """ returns list of other locality names """
+        locality = []
+        for category in SEARCH_CATEGORY_ALL_LOCALITY:
+            locality += self._get_text_for_category(category)
+        return locality
+
+    @property
+    def city(self):
+        """ returns city/town """
+        city = self._get_text_for_category(SEARCH_CATEGORY_CITY)
+        return city[0] if city else ""
+
+    @property
+    def state(self):
+        """ returns state name """
+        state = self._get_text_for_category(SEARCH_CATEGORY_STATE)
+        return state[0] if state else ""
+
+    @property
+    def state_abbreviation(self):
+        """ returns state abbreviation """
+        abbrev = self._get_text_for_category(SEARCH_CATEGORY_STATE_ABBREVIATION)
+        return abbrev[0] if abbrev else ""
+
+    @property
+    def country(self):
+        """ returns country name """
+        country = self._get_text_for_category(SEARCH_CATEGORY_COUNTRY)
+        return country[0] if country else ""
+
+    @property
+    def month(self):
+        """ returns month name """
+        month = self._get_text_for_category(SEARCH_CATEGORY_MONTH)
+        return month[0] if month else ""
+
+    @property
+    def year(self):
+        """ returns year """
+        year = self._get_text_for_category(SEARCH_CATEGORY_YEAR)
+        return year[0] if year else ""
+
+    @property
+    def bodies_of_water(self):
+        """ returns list of body of water names """
+        return self._get_text_for_category(SEARCH_CATEGORY_BODY_OF_WATER)
+
+    @property
+    def holidays(self):
+        """ returns list of holiday names """
+        return self._get_text_for_category(SEARCH_CATEGORY_HOLIDAY)
+
+    @property
+    def activities(self):
+        """ returns list of activity names """
+        return self._get_text_for_category(SEARCH_CATEGORY_ACTIVITY)
+
+    @property
+    def season(self):
+        """ returns season name """
+        season = self._get_text_for_category(SEARCH_CATEGORY_SEASON)
+        return season[0] if season else ""
+
+    @property
+    def venues(self):
+        """ returns list of venue names """
+        return self._get_text_for_category(SEARCH_CATEGORY_VENUE)
+
+    @property
+    def venue_types(self):
+        """ returns list of venue types """
+        return self._get_text_for_category(SEARCH_CATEGORY_VENUE_TYPE)
+
+    @property
+    def media_types(self):
+        """ returns list of media types (photo, video, panorama, etc) """
+        types = []
+        for category in SEARCH_CATEGORY_MEDIA_TYPES:
+            types += self._get_text_for_category(category)
+        return types
+
+    @property
+    def all(self):
+        """ return all search info properties in a single list """
+        all = (
+            self.labels
+            + self.place_names
+            + self.streets
+            + self.neighborhoods
+            + self.locality_names
+            + self.bodies_of_water
+            + self.holidays
+            + self.activities
+            + self.venues
+            + self.venue_types
+            + self.media_types
+        )
+        if self.city:
+            all += [self.city]
+        if self.state:
+            all += [self.state]
+        if self.state_abbreviation:
+            all += [self.state_abbreviation]
+        if self.country:
+            all += [self.country]
+        if self.month:
+            all += [self.month]
+        if self.year:
+            all += [self.year]
+        if self.season:
+            all += [self.season]
+
+        return all
+
+    def asdict(self):
+        """ return dict of search info """
+        return {
+            "labels": self.labels,
+            "place_names": self.place_names,
+            "streets": self.streets,
+            "neighborhoods": self.neighborhoods,
+            "city": self.city,
+            "locality_names": self.locality_names,
+            "state": self.state,
+            "state_abbreviation": self.state_abbreviation,
+            "country": self.country,
+            "bodies_of_water": self.bodies_of_water,
+            "month": self.month,
+            "year": self.year,
+            "holidays": self.holidays,
+            "activities": self.activities,
+            "season": self.season,
+            "venues": self.venues,
+            "venue_types": self.venue_types,
+            "media_types": self.media_types,
+        }
+
+    def _get_text_for_category(self, category):
+        """ return list of text for a specified category ID """
         if self._db_searchinfo:
-            labels = [
-                rec["normalized_string"]
+            content = "normalized_string" if self._normalized else "content_string"
+            return [
+                rec[content]
                 for rec in self._db_searchinfo
-                if rec["category"] == SEARCH_CATEGORY_LABEL
+                if rec["category"] == category
             ]
         else:
-            labels = []
-        return labels
+            return []

osxphotos/photoinfo/photoinfo.py

@@ -43,6 +43,7 @@ class PhotoInfo:
     # import additional methods
     from ._photoinfo_searchinfo import (
         search_info,
+        search_info_normalized,
         labels,
         labels_normalized,
         SearchInfo,
@@ -980,6 +981,7 @@ class PhotoInfo:
         comments = [comment.asdict() for comment in self.comments]
         likes = [like.asdict() for like in self.likes]
         faces = [face.asdict() for face in self.face_info]
+        search_info = self.search_info.asdict() if self.search_info else {}
 
         return {
             "library": self._db._library_path,
@@ -1041,6 +1043,7 @@ class PhotoInfo:
             "original_filesize": self.original_filesize,
             "comments": comments,
             "likes": likes,
+            "search_info": search_info,
         }
 
     def json(self):

osxphotos/photosdb/_photosdb_process_searchinfo.py

@@ -104,17 +104,19 @@ def _process_searchinfo(self):
     for row in c:
         uuid = ints_to_uuid(row[1], row[2])
         # strings have null character appended, so strip it
-        record = {}
-        record["uuid"] = uuid
-        record["rowid"] = row[0]
-        record["uuid_0"] = row[1]
-        record["uuid_1"] = row[2]
-        record["groupid"] = row[3]
-        record["category"] = row[4]
-        record["owning_groupid"] = row[5]
-        record["content_string"] = normalize_unicode(row[6].replace("\x00", ""))
+        record = {
+            "uuid": uuid,
+            "rowid": row[0],
+            "uuid_0": row[1],
+            "uuid_1": row[2],
+            "groupid": row[3],
+            "category": row[4],
+            "owning_groupid": row[5],
+            "content_string": normalize_unicode(row[6].replace("\x00", "")),
+        }
+
         record["normalized_string"] = normalize_unicode(row[7].replace("\x00", ""))
-        record["lookup_identifier"] = row[8]
+        record["lookup_identifier"] = normalize_unicode(row[8].replace("\x00", ""))
 
         try:
             _db_searchinfo_uuid[uuid].append(record)

osxphotos/templates/xmp_sidecar.mako

@@ -26,7 +26,6 @@
 
 <%def name="dc_subject(subject)">
     % if subject:
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
             % for subj in subject:

tests/test_cli.py

@@ -1,4 +1,4 @@
-""" Test the command line interface (CLI) """
+r""" Test the command line interface (CLI) """
 
 import os
 
@@ -354,7 +354,7 @@ CLI_EXIFTOOL = {
         "EXIF:ImageDescription": "Girl holding pumpkin",
         "XMP:Description": "Girl holding pumpkin",
         "XMP:PersonInImage": "Katie",
-        "XMP:Subject": ["Kids", "Katie"],
+        "XMP:Subject": "Kids",
         "EXIF:GPSLatitudeRef": "N",
         "EXIF:GPSLongitudeRef": "W",
         "EXIF:GPSLatitude": 41.256566,
@@ -395,7 +395,7 @@ CLI_EXIFTOOL_IGNORE_DATE_MODIFIED = {
         "XMP:TagsList": "wedding",
         "IPTC:Keywords": "wedding",
         "XMP:PersonInImage": "Maria",
-        "XMP:Subject": ["wedding", "Maria"],
+        "XMP:Subject": "wedding",
         "EXIF:DateTimeOriginal": "2019:04:15 14:40:24",
         "EXIF:CreateDate": "2019:04:15 14:40:24",
         "EXIF:OffsetTimeOriginal": "-04:00",
@@ -3135,7 +3135,7 @@ def test_export_sidecar_keyword_template():
             "XMP:TagsList": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], 
             "IPTC:Keywords": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], 
             "XMP:PersonInImage": ["Katie"], 
-            "XMP:Subject": ["Kids", "Katie"], 
+            "XMP:Subject": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], 
             "EXIF:DateTimeOriginal": "2018:09:28 16:07:07", 
             "EXIF:CreateDate": "2018:09:28 16:07:07", 
             "EXIF:OffsetTimeOriginal": "-04:00", 
@@ -4444,3 +4444,71 @@ def test_save_load_config():
         assert result.exit_code == 0
         assert "Writing exiftool JSON sidecar" in result.output
         assert "Writing XMP sidecar" not in result.output
+
+
+def test_export_exportdb():
+    """ test --exportdb """
+    import glob
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.__main__ import export
+    import re
+
+    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", "--exportdb", "export.db"],
+        )
+        assert result.exit_code == 0
+        assert re.search(r"Created export database.*export\.db", result.output)
+        files = glob.glob("*")
+        assert "export.db" in files
+
+        result = runner.invoke(
+            export,
+            [
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "-V",
+                "--exportdb",
+                "export.db",
+                "--update",
+            ],
+        )
+        assert result.exit_code == 0
+        assert re.search(r"Using export database.*export\.db", result.output)
+
+        # export again w/o --exportdb
+        result = runner.invoke(export, [os.path.join(cwd, CLI_PHOTOS_DB), ".", "-V"])
+        assert result.exit_code == 0
+        assert re.search(
+            r"Created export database.*\.osxphotos_export\.db", result.output
+        )
+        files = glob.glob(".*")
+        assert ".osxphotos_export.db" in files
+
+        # now try again with --exportdb, should generate warning
+        result = runner.invoke(
+            export,
+            [os.path.join(cwd, CLI_PHOTOS_DB), ".", "-V", "--exportdb", "export.db"],
+        )
+        assert result.exit_code == 0
+        assert (
+            "Warning: export database is 'export.db' but found '.osxphotos_export.db'"
+            in result.output
+        )
+
+        # specify a path for exportdb, should generate error
+        result = runner.invoke(
+            export,
+            [os.path.join(cwd, CLI_PHOTOS_DB), ".", "-V", "--exportdb", "./export.db"],
+        )
+        assert result.exit_code != 0
+        assert (
+            "Error: --exportdb must be specified as filename not path" in result.output
+        )
+

tests/test_export_catalina_10_15_7.py

@@ -1,5 +1,6 @@
 import pytest
 
+import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
 from osxphotos.exiftool import get_exiftool_path
 from osxphotos.utils import dd_to_dms_str
@@ -12,6 +13,12 @@ except:
 
 PHOTOS_DB = "./tests/Test-10.15.7.photoslibrary/database/photos.db"
 
+
+@pytest.fixture(scope="module")
+def photosdb():
+    return osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+
+
 KEYWORDS = [
     "Kids",
     "wedding",
@@ -22,7 +29,7 @@ KEYWORDS = [
     "St. James's Park",
     "UK",
     "United Kingdom",
-    "Maria"
+    "Maria",
 ]
 # Photos 5 includes blank person for detected face
 PERSONS = ["Katie", "Suzy", "Maria", _UNKNOWN_PERSON]
@@ -100,18 +107,15 @@ EXIF_JSON_EXPECTED_IGNORE_DATE_MODIFIED = """
     """
 
 
-def test_export_1():
+def test_export_1(photosdb):
     # test basic export
     # get an unedited image and export it using default filename
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -122,18 +126,15 @@ def test_export_1():
     assert os.path.isfile(got_dest)
 
 
-def test_export_2():
+def test_export_2(photosdb):
     # test export with user provided filename
     import os
     import os.path
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -145,18 +146,15 @@ def test_export_2():
     assert os.path.isfile(got_dest)
 
 
-def test_export_3():
+def test_export_3(photosdb):
     # test file already exists and test increment=True (default)
     import os
     import os.path
     import pathlib
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -172,7 +170,7 @@ def test_export_3():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_4():
+def test_export_4(photosdb):
     # test user supplied file already exists and test increment=True (default)
     import os
     import os.path
@@ -180,11 +178,8 @@ def test_export_4():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -200,18 +195,15 @@ def test_export_4():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_5():
+def test_export_5(photosdb):
     # test file already exists and test increment=True (default)
     # and overwrite = True
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -225,7 +217,7 @@ def test_export_5():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_6():
+def test_export_6(photosdb):
     # test user supplied file already exists and test increment=True (default)
     # and overwrite = True
     import os
@@ -234,11 +226,8 @@ def test_export_6():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -253,18 +242,15 @@ def test_export_6():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_7():
+def test_export_7(photosdb):
     # test file already exists and test increment=False (not default), overwrite=False (default)
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -277,18 +263,15 @@ def test_export_7():
     assert e.type == type(FileExistsError())
 
 
-def test_export_8():
+def test_export_8(photosdb):
     # try to export missing file
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["missing"]])
 
     filename = photos[0].filename
@@ -299,18 +282,15 @@ def test_export_8():
     assert e.type == type(FileNotFoundError())
 
 
-def test_export_9():
+def test_export_9(photosdb):
     # try to export edited file that's not edited
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["no_adjustments"]])
 
     with pytest.raises(Exception) as e:
@@ -318,7 +298,7 @@ def test_export_9():
     assert e.type == ValueError
 
 
-def test_export_10():
+def test_export_10(photosdb):
     # try to export edited file that's not edited and name provided
     # should raise exception
     import os
@@ -326,11 +306,8 @@ def test_export_10():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["no_adjustments"]])
 
     timestamp = time.time()
@@ -342,18 +319,15 @@ def test_export_10():
     assert e.type == ValueError
 
 
-def test_export_11():
+def test_export_11(photosdb):
     # export edited file with name provided
     import os
     import os.path
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["has_adjustments"]])
 
     timestamp = time.time()
@@ -364,18 +338,15 @@ def test_export_11():
     assert got_dest == expected_dest
 
 
-def test_export_12():
+def test_export_12(photosdb):
     # export edited file with default name
     import os
     import os.path
     import pathlib
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["has_adjustments"]])
 
     edited_name = pathlib.Path(photos[0].path_edited).name
@@ -387,15 +358,13 @@ def test_export_12():
     assert got_dest == expected_dest
 
 
-def test_export_13():
+def test_export_13(photosdb):
     # export to invalid destination
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
 
@@ -405,7 +374,6 @@ def test_export_13():
         dest = os.path.join(dest, str(i))
         i += 1
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -417,7 +385,6 @@ def test_export_13():
 
 
 def test_dd_to_dms_str_1():
-    import osxphotos
 
     lat_str, lon_str = dd_to_dms_str(
         34.559331096, 69.206499174
@@ -428,7 +395,6 @@ def test_dd_to_dms_str_1():
 
 
 def test_dd_to_dms_str_2():
-    import osxphotos
 
     lat_str, lon_str = dd_to_dms_str(
         -34.601997592, -58.375665164
@@ -439,7 +405,6 @@ def test_dd_to_dms_str_2():
 
 
 def test_dd_to_dms_str_3():
-    import osxphotos
 
     lat_str, lon_str = dd_to_dms_str(
         -1.2666656, 36.7999968
@@ -450,7 +415,6 @@ def test_dd_to_dms_str_3():
 
 
 def test_dd_to_dms_str_4():
-    import osxphotos
 
     lat_str, lon_str = dd_to_dms_str(
         38.889248, -77.050636
@@ -460,11 +424,9 @@ def test_dd_to_dms_str_4():
     assert lon_str == "77 deg 3' 2.29\" W"
 
 
-def test_exiftool_json_sidecar():
-    import osxphotos
+def test_exiftool_json_sidecar(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[EXIF_JSON_UUID])
 
     json_expected = json.loads(EXIF_JSON_EXPECTED)[0]
@@ -486,11 +448,9 @@ def test_exiftool_json_sidecar():
             assert json_got[k] == v
 
 
-def test_exiftool_json_sidecar_ignore_date_modified():
-    import osxphotos
+def test_exiftool_json_sidecar_ignore_date_modified(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[EXIF_JSON_UUID])
 
     json_expected = json.loads(EXIF_JSON_EXPECTED_IGNORE_DATE_MODIFIED)[0]
@@ -512,12 +472,10 @@ def test_exiftool_json_sidecar_ignore_date_modified():
             assert json_got[k] == v
 
 
-def test_exiftool_json_sidecar_keyword_template_long(caplog):
-    import osxphotos
+def test_exiftool_json_sidecar_keyword_template_long(caplog, photosdb):
     from osxphotos._constants import _MAX_IPTC_KEYWORD_LEN
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[EXIF_JSON_UUID])
 
     json_expected = json.loads(
@@ -526,8 +484,8 @@ def test_exiftool_json_sidecar_keyword_template_long(caplog):
         "XMP:Description": "Bride Wedding day", 
         "XMP:TagsList": ["Maria", "wedding", "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], 
         "IPTC:Keywords": ["Maria", "wedding", "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], 
+        "XMP:Subject": ["Maria", "wedding", "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"], 
         "XMP:PersonInImage": ["Maria"], 
-        "XMP:Subject": ["wedding", "Maria"], 
         "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", 
         "EXIF:CreateDate": "2019:04:15 14:40:24", 
         "EXIF:OffsetTimeOriginal": "-04:00", 
@@ -562,11 +520,9 @@ def test_exiftool_json_sidecar_keyword_template_long(caplog):
             assert json_got[k] == v
 
 
-def test_exiftool_json_sidecar_keyword_template():
-    import osxphotos
+def test_exiftool_json_sidecar_keyword_template(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[EXIF_JSON_UUID])
 
     json_expected = json.loads(
@@ -575,8 +531,8 @@ def test_exiftool_json_sidecar_keyword_template():
         "XMP:Description": "Bride Wedding day", 
         "XMP:TagsList": ["Maria", "wedding", "Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin"], 
         "IPTC:Keywords": ["Maria", "wedding", "Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin"], 
+        "XMP:Subject": ["Maria", "wedding", "Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin"], 
         "XMP:PersonInImage": ["Maria"], 
-        "XMP:Subject": ["wedding", "Maria"],
         "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", 
         "EXIF:CreateDate": "2019:04:15 14:40:24", 
         "EXIF:OffsetTimeOriginal": "-04:00", 
@@ -622,11 +578,9 @@ def test_exiftool_json_sidecar_keyword_template():
             assert json_got[k] == v
 
 
-def test_exiftool_json_sidecar_use_persons_keyword():
-    import osxphotos
+def test_exiftool_json_sidecar_use_persons_keyword(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     json_expected = json.loads(
@@ -664,11 +618,9 @@ def test_exiftool_json_sidecar_use_persons_keyword():
             assert json_got[k] == v
 
 
-def test_exiftool_json_sidecar_use_albums_keyword():
-    import osxphotos
+def test_exiftool_json_sidecar_use_albums_keyword(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     json_expected = json.loads(
@@ -679,7 +631,7 @@ def test_exiftool_json_sidecar_use_albums_keyword():
         "XMP:TagsList": ["Kids", "Pumpkin Farm", "Test Album"], 
         "IPTC:Keywords": ["Kids", "Pumpkin Farm", "Test Album"], 
         "XMP:PersonInImage": ["Suzy", "Katie"], 
-        "XMP:Subject": ["Kids", "Suzy", "Katie"], 
+        "XMP:Subject": ["Kids", "Pumpkin Farm", "Test Album"], 
         "EXIF:DateTimeOriginal": "2018:09:28 15:35:49", 
         "EXIF:CreateDate": "2018:09:28 15:35:49", 
         "EXIF:OffsetTimeOriginal": "-04:00", 
@@ -707,12 +659,10 @@ def test_exiftool_json_sidecar_use_albums_keyword():
 
 
 @pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
-def test_xmp_sidecar_is_valid(tmp_path):
+def test_xmp_sidecar_is_valid(tmp_path, photosdb):
     """ validate XMP sidecar file with exiftool """
-    import osxphotos
     from osxphotos.exiftool import ExifTool
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
     photos[0].export(str(tmp_path), XMP_JPG_FILENAME, sidecar_xmp=True)
     xmp_file = tmp_path / XMP_FILENAME
@@ -722,10 +672,8 @@ def test_xmp_sidecar_is_valid(tmp_path):
     assert output == b"[ExifTool]      Validate                        : 0 0 0"
 
 
-def test_xmp_sidecar():
-    import osxphotos
+def test_xmp_sidecar(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -738,12 +686,9 @@ def test_xmp_sidecar():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
-                <rdf:li>Katie</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>
@@ -787,11 +732,9 @@ def test_xmp_sidecar():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_extension():
+def test_xmp_sidecar_extension(photosdb):
     """ test XMP sidecar when no extension is passed """
-    import osxphotos
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -804,12 +747,9 @@ def test_xmp_sidecar_extension():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
-                <rdf:li>Katie</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>
@@ -853,10 +793,8 @@ def test_xmp_sidecar_extension():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_use_persons_keyword():
-    import osxphotos
+def test_xmp_sidecar_use_persons_keyword(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -869,7 +807,6 @@ def test_xmp_sidecar_use_persons_keyword():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
@@ -920,10 +857,8 @@ def test_xmp_sidecar_use_persons_keyword():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_use_albums_keyword():
-    import osxphotos
+def test_xmp_sidecar_use_albums_keyword(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -936,12 +871,11 @@ def test_xmp_sidecar_use_albums_keyword():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
-                <rdf:li>Katie</rdf:li>
+                <rdf:li>Pumpkin Farm</rdf:li>
+                <rdf:li>Test Album</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>
@@ -987,11 +921,9 @@ def test_xmp_sidecar_use_albums_keyword():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_gps():
+def test_xmp_sidecar_gps(photosdb):
     """ Test export XMP sidecar with GPS info """
-    import osxphotos
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["location"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -1004,7 +936,6 @@ def test_xmp_sidecar_gps():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description></dc:description>
         <dc:title>St. James&#39;s Park</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>UK</rdf:li>
@@ -1057,10 +988,8 @@ def test_xmp_sidecar_gps():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_keyword_template():
-    import osxphotos
+def test_xmp_sidecar_keyword_template(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -1073,12 +1002,12 @@ def test_xmp_sidecar_keyword_template():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
-                <rdf:li>Katie</rdf:li>
+                <rdf:li>Pumpkin Farm</rdf:li>
+                <rdf:li>Test Album</rdf:li>
+                <rdf:li>2018</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>

tests/test_export_mojave_10_14_6.py

@@ -1,9 +1,8 @@
 import pytest
 
+import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
 
-# TODO: put some of this code into a pre-function
-
 
 PHOTOS_DB = "./tests/Test-10.14.6.photoslibrary/database/photos.db"
 PHOTOS_DB_PATH = "/Test-10.14.6.photoslibrary/database/photos.db"
@@ -63,18 +62,20 @@ EXIF_JSON_EXPECTED = """
     """
 
 
-def test_export_1():
+@pytest.fixture(scope="module")
+def photosdb():
+    return osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+
+
+def test_export_1(photosdb):
     # test basic export
     # get an unedited image and export it using default filename
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -85,18 +86,15 @@ def test_export_1():
     assert os.path.isfile(got_dest)
 
 
-def test_export_2():
+def test_export_2(photosdb):
     # test export with user provided filename
     import os
     import os.path
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -108,18 +106,15 @@ def test_export_2():
     assert os.path.isfile(got_dest)
 
 
-def test_export_3():
+def test_export_3(photosdb):
     # test file already exists and test increment=True (default)
     import os
     import os.path
     import pathlib
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -135,7 +130,7 @@ def test_export_3():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_4():
+def test_export_4(photosdb):
     # test user supplied file already exists and test increment=True (default)
     import os
     import os.path
@@ -143,11 +138,8 @@ def test_export_4():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -163,18 +155,15 @@ def test_export_4():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_5():
+def test_export_5(photosdb):
     # test file already exists and test increment=True (default)
     # and overwrite = True
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -188,7 +177,7 @@ def test_export_5():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_6():
+def test_export_6(photosdb):
     # test user supplied file already exists and test increment=True (default)
     # and overwrite = True
     import os
@@ -197,11 +186,8 @@ def test_export_6():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     timestamp = time.time()
@@ -216,18 +202,15 @@ def test_export_6():
     assert os.path.isfile(got_dest_2)
 
 
-def test_export_7():
+def test_export_7(photosdb):
     # test file already exists and test increment=False (not default), overwrite=False (default)
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -240,18 +223,15 @@ def test_export_7():
     assert e.type == type(FileExistsError())
 
 
-def test_export_8():
+def test_export_8(photosdb):
     # try to export missing file
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["missing"]])
 
     filename = photos[0].filename
@@ -262,18 +242,15 @@ def test_export_8():
     assert e.type == type(FileNotFoundError())
 
 
-def test_export_9():
+def test_export_9(photosdb):
     # try to export edited file that's not edited
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["no_adjustments"]])
 
     filename = photos[0].filename
@@ -284,7 +261,7 @@ def test_export_9():
     assert e.type == ValueError
 
 
-def test_export_10():
+def test_export_10(photosdb):
     # try to export edited file that's not edited and name provided
     # should raise exception
     import os
@@ -292,11 +269,8 @@ def test_export_10():
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["no_adjustments"]])
 
     timestamp = time.time()
@@ -308,18 +282,15 @@ def test_export_10():
     assert e.type == ValueError
 
 
-def test_export_11():
+def test_export_11(photosdb):
     # export edited file with name provided
     import os
     import os.path
     import tempfile
     import time
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["has_adjustments"]])
 
     timestamp = time.time()
@@ -330,18 +301,15 @@ def test_export_11():
     assert got_dest == expected_dest
 
 
-def test_export_12():
+def test_export_12(photosdb):
     # export edited file with default name
     import os
     import os.path
     import pathlib
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["has_adjustments"]])
 
     edited_name = pathlib.Path(photos[0].path_edited).name
@@ -353,15 +321,13 @@ def test_export_12():
     assert got_dest == expected_dest
 
 
-def test_export_13():
+def test_export_13(photosdb):
     # export to invalid destination
     # should raise exception
     import os
     import os.path
     import tempfile
 
-    import osxphotos
-
     tempdir = tempfile.TemporaryDirectory(prefix="osxphotos_")
     dest = tempdir.name
 
@@ -371,7 +337,6 @@ def test_export_13():
         dest = os.path.join(dest, str(i))
         i += 1
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["export"]])
 
     filename = photos[0].filename
@@ -382,11 +347,9 @@ def test_export_13():
     assert e.type == type(FileNotFoundError())
 
 
-def test_exiftool_json_sidecar():
-    import osxphotos
+def test_exiftool_json_sidecar(photosdb):
     import json
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["location"]])
 
     json_expected = json.loads(EXIF_JSON_EXPECTED)[0]
@@ -408,10 +371,8 @@ def test_exiftool_json_sidecar():
             assert json_got[k] == v
 
 
-def test_xmp_sidecar():
-    import osxphotos
+def test_xmp_sidecar(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -424,12 +385,9 @@ def test_xmp_sidecar():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
-                <rdf:li>Katie</rdf:li>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>
@@ -471,10 +429,8 @@ def test_xmp_sidecar():
         assert line_expected == line_got
 
 
-def test_xmp_sidecar_keyword_template():
-    import osxphotos
+def test_xmp_sidecar_keyword_template(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
 
     xmp_expected = """<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
@@ -487,12 +443,12 @@ def test_xmp_sidecar_keyword_template():
         <photoshop:SidecarForExtension>jpg</photoshop:SidecarForExtension>
         <dc:description>Girls with pumpkins</dc:description>
         <dc:title>Can we carry this?</dc:title>
-        <!-- keywords and persons listed in <dc:subject> as Photos does -->
         <dc:subject>
             <rdf:Seq>
                 <rdf:li>Kids</rdf:li>
-                <rdf:li>Suzy</rdf:li>
-                <rdf:li>Katie</rdf:li>
+                <rdf:li>Test Album</rdf:li>
+                <rdf:li>Pumpkin Farm</rdf:li>
+                <rdf:li>2018</rdf:li>
             </rdf:Seq>
         </dc:subject>
         <photoshop:DateCreated>2018-09-28T15:35:49.063000-04:00</photoshop:DateCreated>

tests/test_search_info_10_15_4.py

@@ -210,7 +210,7 @@ def test_search_info(photosdb):
 def test_labels_normalized(photosdb):
     for uuid in LABELS_NORMALIZED_DICT:
         photo = photosdb.photos(uuid=[uuid])[0]
-        assert sorted(photo.search_info.labels_normalized) == sorted(
+        assert sorted(photo.search_info_normalized.labels) == sorted(
             LABELS_NORMALIZED_DICT[uuid]
         )
         assert sorted(photo.labels_normalized) == sorted(LABELS_NORMALIZED_DICT[uuid])

tests/test_search_info_10_15_5.py

@@ -349,7 +349,7 @@ def test_labels_normalized(photosdb):
     for uuid in LABELS_NORMALIZED_DICT:
         photo = photosdb.photos(uuid=[uuid])[0]
         logging.warning(f"uuid = {uuid}")
-        assert sorted(photo.search_info.labels_normalized) == sorted(
+        assert sorted(photo.search_info_normalized.labels) == sorted(
             LABELS_NORMALIZED_DICT[uuid]
         )
         assert sorted(photo.labels_normalized) == sorted(LABELS_NORMALIZED_DICT[uuid])

tests/test_search_info_10_15_7.py

@@ -0,0 +1,65 @@
+""" test SearchInfo class """
+
+import json
+import os
+
+import pytest
+
+import osxphotos
+
+# These tests must be run against the author's personal photo library
+skip_test = "OSXPHOTOS_TEST_EXPORT" not in os.environ
+pytestmark = pytest.mark.skipif(
+    skip_test, reason="These tests only run against system Photos library"
+)
+
+PHOTOS_DB = "/Users/rhet/Pictures/Photos Library.photoslibrary"
+
+with open("tests/search_info_test_data_10_15_7.json") as fp:
+    test_data = json.load(fp)
+
+UUID_SEARCH_INFO = test_data["UUID_SEARCH_INFO"]
+UUID_SEARCH_INFO_NORMALIZED = test_data["UUID_SEARCH_INFO_NORMALIZED"]
+UUID_SEARCH_INFO_ALL = test_data["UUID_SEARCH_INFO_ALL"]
+UUID_SEARCH_INFO_ALL_NORMALIZED = test_data["UUID_SEARCH_INFO_ALL_NORMALIZED"]
+
+
+@pytest.fixture(scope="module")
+def photosdb():
+    return osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+
+
+def test_search_info(photosdb):
+    for uuid in UUID_SEARCH_INFO:
+        photo = photosdb.get_photo(uuid)
+        search_dict = photo.search_info.asdict()
+        for k, v in search_dict.items():
+            if type(v) == list:
+                assert sorted(v) == sorted(UUID_SEARCH_INFO[uuid][k])
+            else:
+                assert v == UUID_SEARCH_INFO[uuid][k]
+
+
+def test_search_info_normalized(photosdb):
+    for uuid in UUID_SEARCH_INFO_NORMALIZED:
+        photo = photosdb.get_photo(uuid)
+        search_dict = photo.search_info_normalized.asdict()
+        for k, v in search_dict.items():
+            if type(v) == list:
+                assert sorted(v) == sorted(UUID_SEARCH_INFO_NORMALIZED[uuid][k])
+            else:
+                assert v == UUID_SEARCH_INFO_NORMALIZED[uuid][k]
+
+
+def test_search_info_all(photosdb):
+    for uuid in UUID_SEARCH_INFO_ALL:
+        photo = photosdb.get_photo(uuid)
+        assert sorted(photo.search_info.all) == sorted(UUID_SEARCH_INFO_ALL[uuid])
+
+
+def test_search_info_all_normalized(photosdb):
+    for uuid in UUID_SEARCH_INFO_ALL_NORMALIZED:
+        photo = photosdb.get_photo(uuid)
+        assert sorted(photo.search_info_normalized.all) == sorted(
+            UUID_SEARCH_INFO_ALL_NORMALIZED[uuid]
+        )

utils/generate_search_info_test_data.py

@@ -0,0 +1,34 @@
+""" Create the test data needed for test_search_info_10_15_7.py """
+
+# reads data from the author's system photo library to build the test data
+# used to test SearchInfo
+
+import json
+
+import osxphotos
+
+UUID = [
+    "C8EAF50A-D891-4E0C-8086-C417E1284153",
+    "71DFB4C3-E868-4BE4-906E-D96BD8692D7E",
+    "2C151013-5BBA-4D00-B70F-1C9420418B86",
+]
+
+data = {
+    "UUID_SEARCH_INFO": {},
+    "UUID_SEARCH_INFO_NORMALIZED": {},
+    "UUID_SEARCH_INFO_ALL": {},
+    "UUID_SEARCH_INFO_ALL_NORMALIZED": {},
+}
+
+photosdb = osxphotos.PhotosDB()
+
+for uuid in UUID:
+    photo = photosdb.get_photo(uuid)
+    search = photo.search_info
+    search_norm = photo.search_info_normalized
+    data["UUID_SEARCH_INFO"][uuid] = search.asdict()
+    data["UUID_SEARCH_INFO_NORMALIZED"][uuid] = search_norm.asdict()
+    data["UUID_SEARCH_INFO_ALL"][uuid] = search.all
+    data["UUID_SEARCH_INFO_ALL_NORMALIZED"][uuid] = search_norm.all
+
+print(json.dumps(data))