Updated docs

README.md

@@ -347,18 +347,18 @@ Options:
                                   images will be skipped.
   --sidecar FORMAT                Create sidecar for each photo exported; valid
                                   FORMAT values: xmp, json, exiftool; --sidecar
-                                  xmp: create XMP sidecar used by Adobe
+                                  xmp: create XMP sidecar used by Digikam, Adobe
                                   Lightroom, etc. The sidecar file is named in
                                   format photoname.ext.xmp The XMP sidecar
                                   exports the following tags: Description,
                                   Title, Keywords/Tags, Subject (set to Keywords
                                   + PersonInImage), PersonInImage, CreateDate,
-                                  ModifyDate, GPSLongitude. 
-                                  --sidecar json:
-                                  create JSON sidecar useable by exiftool
-                                  (https://exiftool.org/) The sidecar file can
-                                  be used to apply metadata to the file with
-                                  exiftool, for example: "exiftool
+                                  ModifyDate, GPSLongitude, Face Regions
+                                  (Metadata Working Group and Microsoft Photo).
+                                  --sidecar json: create JSON sidecar useable by
+                                  exiftool (https://exiftool.org/) The sidecar
+                                  file can be used to apply metadata to the file
+                                  with exiftool, for example: "exiftool
                                   -j=photoname.jpg.json photoname.jpg" The
                                   sidecar file is named in format
                                   photoname.ext.json; format includes tag groups
@@ -373,10 +373,10 @@ Options:
   --sidecar-drop-ext              Drop the photo's extension when naming sidecar
                                   files. By default, sidecar files are named in
                                   format 'photo_filename.photo_ext.sidecar_ext',
-                                  e.g. 'IMG_1234.JPG.json'. Use '--sidecar-drop-
+                                  e.g. 'IMG_1234.JPG.xmp'. Use '--sidecar-drop-
                                   ext' to ignore the photo extension. Resulting
                                   sidecar files will have name in format
-                                  'IMG_1234.json'. Warning: this may result in
+                                  'IMG_1234.xmp'. Warning: this may result in
                                   sidecar filename collisions if there are files
                                   of different types but the same name in the
                                   output directory, e.g. 'IMG_1234.JPG' and
@@ -1445,7 +1445,7 @@ movies = photosdb.photos(images=False, movies=True)
 
 For example, in my library, Photos says I have 19,386 photos and 474 movies.  However, PhotosDB.photos() reports 25,002 photos.  The difference is due to 5,609 shared photos and 7 hidden photos.  (*Note* Shared photos only valid for Photos 5).  Similarly, filtering for just movies returns 625 results.  The difference between 625 and 474 reported by Photos is due to 151 shared movies.
 
-```python
+```pycon
 >>> import osxphotos
 >>> photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
 >>> photos = photosdb.photos()
@@ -1642,7 +1642,7 @@ If photo is a burst image (see [burst](#burst)), returns a list of PhotoInfo obj
 
 Example below gets list of all photos that are bursts, selects one of of them and prints out the names of the other images in the burst set.  PhotosDB.photos() will only return the photos in the burst set that the user [selected](https://support.apple.com/guide/photos/view-photo-bursts-phtde06a275d/mac) using "Make a Selection..." in Photos or the key image Photos selected if the user has not yet made a selection.  This is similar to how Photos displays and counts burst photos.  Using `burst_photos` you can access the other images in the burst set to export them, etc. 
 
-```python
+```pycon
 >>> import osxphotos
 >>> photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
 >>> bursts = [p for p in photosdb.photos() if p.burst]
@@ -1735,7 +1735,7 @@ If the file is missing from the library (e.g. not downloaded from iCloud), retur
 
 exiftool must be installed in the path for this to work.  If exiftool cannot be found in the path, calling `exiftool` will log a warning and return `None`.  You can check the exiftool path using `osxphotos.exiftool.get_exiftool_path` which will raise FileNotFoundError if exiftool cannot be found.
 
-```python
+```pycon
 >>> import osxphotos
 >>> osxphotos.exiftool.get_exiftool_path()
 '/usr/local/bin/exiftool'
@@ -2029,7 +2029,7 @@ Returns a [FolderInfo](#FolderInfo) object representing the folder's parent fold
 
 **Note**: FolderInfo and AlbumInfo objects effectively work as a linked list.  The children of a folder are contained in `subfolders` and `album_info` and the parent object of both `AlbumInfo` and `FolderInfo` is represented by `parent`.  For example:
 
-```python
+```pycon
 >>> import osxphotos
 >>> photosdb = osxphotos.PhotosDB()
 >>> photosdb.folder_info
@@ -2109,7 +2109,7 @@ Returns a `PostalAddress` namedtuple with details of the postal address containi
 - `iso_country_code`
 
 For example:
-```python
+```pycon
 >>> photo.place.address
 PostalAddress(street='3700 Wailea Alanui Dr', sub_locality=None, city='Kihei', sub_administrative_area='Maui', state='HI', postal_code='96753', country='United States', iso_country_code='US')
 >>> photo.place.address.postal_code
@@ -2388,7 +2388,7 @@ The latter are treated by Photos as a single image.  By default, Photos will tre
 #### Example
 To get the path of every raw photo, whether it's a single raw photo or a raw+JPEG pair, one could do something like this:
 
-```python
+```pycon
 >>> import osxphotos
 >>> photosdb = osxphotos.PhotosDB()
 >>> photos = photosdb.photos()

osxphotos/__main__.py

@@ -816,11 +816,11 @@ def cli(ctx, db, json_, debug):
     metavar="FORMAT",
     type=click.Choice(["xmp", "json", "exiftool"], case_sensitive=False),
     help="Create sidecar for each photo exported; valid FORMAT values: xmp, json, exiftool; "
-    "--sidecar xmp: create XMP sidecar used by Adobe Lightroom, etc. "
+    "--sidecar xmp: create XMP sidecar used by Digikam, Adobe Lightroom, etc. "
     "The sidecar file is named in format photoname.ext.xmp "
     "The XMP sidecar exports the following tags: Description, Title, Keywords/Tags, "
     "Subject (set to Keywords + PersonInImage), PersonInImage, CreateDate, ModifyDate, "
-    "GPSLongitude. "
+    "GPSLongitude, Face Regions (Metadata Working Group and Microsoft Photo)."
     f"\n--sidecar json: create JSON sidecar useable by exiftool ({_EXIF_TOOL_URL}) "
     "The sidecar file can be used to apply metadata to the file with exiftool, for example: "
     '"exiftool -j=photoname.jpg.json photoname.jpg" '
@@ -836,8 +836,8 @@ def cli(ctx, db, json_, debug):
     is_flag=True,
     help="Drop the photo's extension when naming sidecar files. "
     "By default, sidecar files are named in format 'photo_filename.photo_ext.sidecar_ext', "
-    "e.g. 'IMG_1234.JPG.json'. Use '--sidecar-drop-ext' to ignore the photo extension. "
-    "Resulting sidecar files will have name in format 'IMG_1234.json'. "
+    "e.g. 'IMG_1234.JPG.xmp'. Use '--sidecar-drop-ext' to ignore the photo extension. "
+    "Resulting sidecar files will have name in format 'IMG_1234.xmp'. "
     "Warning: this may result in sidecar filename collisions if there are files of different "
     "types but the same name in the output directory, e.g. 'IMG_1234.JPG' and 'IMG_1234.MOV'.",
 )

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.39.25"
+__version__ = "0.40.00"

osxphotos/templates/xmp_sidecar.mako

@@ -1,5 +1,3 @@
-<!-- Created with osxphotos https://github.com/RhetTbull/osxphotos -->
-
 <%def name="photoshop_sidecar_for_extension(extension)">
     % if extension is None:
         <photoshop:SidecarForExtension></photoshop:SidecarForExtension>
@@ -18,7 +16,7 @@
     % else:
         <dc:description>
         <rdf:Alt>
-            <rdf:li xml:lang='x-default'>${desc | x}</rdf:li>
+         <rdf:li xml:lang='x-default'>${desc | x}</rdf:li>
         </rdf:Alt>
         </dc:description>
     % endif
@@ -45,7 +43,7 @@
         <dc:subject>
          <rdf:Bag>
          % for subj in subject:
-            <rdf:li>${subj | x}</rdf:li>
+          <rdf:li>${subj | x}</rdf:li>
          % endfor
          </rdf:Bag>
         </dc:subject>
@@ -61,11 +59,11 @@
 <%def name="iptc_personinimage(persons)">
     % if persons:
         <Iptc4xmpExt:PersonInImage>
-            <rdf:Bag>
-                % for person in persons:
-                    <rdf:li>${person | x}</rdf:li>
-                % endfor
-            </rdf:Bag>
+        <rdf:Bag>
+         % for person in persons:
+         <rdf:li>${person | x}</rdf:li>
+         % endfor
+        </rdf:Bag>
         </Iptc4xmpExt:PersonInImage>
     % endif 
 </%def>
@@ -73,11 +71,11 @@
 <%def name="dk_tagslist(keywords)">
     % if keywords:
         <digiKam:TagsList>
-            <rdf:Seq>
-            % for keyword in keywords:
-                <rdf:li>${keyword | x}</rdf:li>
-            % endfor
-            </rdf:Seq>
+        <rdf:Seq>
+         % for keyword in keywords:
+          <rdf:li>${keyword | x}</rdf:li>
+         % endfor
+        </rdf:Seq>
         </digiKam:TagsList>
     % endif
 </%def>
@@ -101,33 +99,112 @@
     % endif
 </%def>
 
-<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="XMP Core 5.4.0">
-    <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
-        <rdf:Description rdf:about="" 
-            xmlns:dc="http://purl.org/dc/elements/1.1/" 
-            xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/">
-            ${photoshop_sidecar_for_extension(extension)}
-            ${dc_description(description)}
-            ${dc_title(photo.title)}
-            ${dc_subject(subjects)}
-            ${dc_datecreated(photo.date)}
-        </rdf:Description>
-        <rdf:Description rdf:about=""  
-            xmlns:Iptc4xmpExt='http://iptc.org/std/Iptc4xmpExt/2008-02-29/'>
-            ${iptc_personinimage(persons)}
-        </rdf:Description>
-        <rdf:Description rdf:about="" 
-            xmlns:digiKam='http://www.digikam.org/ns/1.0/'>
-            ${dk_tagslist(keywords)}
-        </rdf:Description>
-        <rdf:Description rdf:about="" 
-            xmlns:xmp='http://ns.adobe.com/xap/1.0/'>
-            ${adobe_createdate(photo.date)}
-            ${adobe_modifydate(photo.date)}
-        </rdf:Description>
-        <rdf:Description rdf:about=""
-            xmlns:exif='http://ns.adobe.com/exif/1.0/'>
-            ${gps_info(*photo.location)}
-        </rdf:Description>
-   </rdf:RDF>
-</x:xmpmeta>
+<%def name="orientation(orientation)">
+    % if orientation is not None:
+        <tiff:Orientation>${orientation}</tiff:Orientation>
+    % endif
+</%def>
+
+<%def name="mwg_face_regions(photo)">
+    % if photo.face_info:
+    <mwg-rs:Regions rdf:parseType="Resource">
+    <mwg-rs:AppliedToDimensions rdf:parseType="Resource">
+    <stDim:unit>pixel</stDim:unit>
+    </mwg-rs:AppliedToDimensions>
+    <mwg-rs:RegionList>
+    <rdf:Bag>
+    % for face in photo.face_info:
+     <rdf:li rdf:parseType="Resource">
+      <mwg-rs:Area rdf:parseType="Resource">
+      <stArea:h>${'{0:.6f}'.format(face.mwg_rs_area.h)}</stArea:h>
+      <stArea:w>${'{0:.6f}'.format(face.mwg_rs_area.w)}</stArea:w>
+      <stArea:x>${'{0:.6f}'.format(face.mwg_rs_area.x)}</stArea:x>
+      <stArea:y>${'{0:.6f}'.format(face.mwg_rs_area.y)}</stArea:y>
+      <stArea:unit>normalized</stArea:unit>
+      </mwg-rs:Area>
+      <mwg-rs:Name>${face.name}</mwg-rs:Name>
+      <mwg-rs:Rotation>${face.roll}</mwg-rs:Rotation>
+      <mwg-rs:Type>Face</mwg-rs:Type>
+     </rdf:li>
+    % endfor
+    </rdf:Bag>
+    </mwg-rs:RegionList>
+    </mwg-rs:Regions>
+    % endif
+</%def>
+
+<%def name="mpri_face_regions(photo)">
+    % if photo.face_info:
+    <MP:RegionInfo rdf:parseType="Resource">
+     <MPRI:Regions>
+      <rdf:Bag>
+      % for face in photo.face_info:
+       <rdf:li rdf:parseType="Resource">
+       <MPReg:PersonDisplayName>${face.name}</MPReg:PersonDisplayName>
+       <MPReg:Rectangle>${'{0:.6f}'.format(face.mpri_reg_rect.x)}, ${'{0:.6f}'.format(face.mpri_reg_rect.y)}, ${'{0:.6f}'.format(face.mpri_reg_rect.h)}, ${'{0:.6f}'.format(face.mpri_reg_rect.w)}</MPReg:Rectangle>
+       </rdf:li>
+      % endfor
+      </rdf:Bag>
+     </MPRI:Regions>
+    </MP:RegionInfo>
+    % endif
+</%def>
+
+
+<?xpacket begin="${"\uFEFF"}" id="W5M0MpCehiHzreSzNTczkc9d"?>
+<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="osxphotos ${version}">
+<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
+<rdf:Description rdf:about="" 
+ xmlns:dc="http://purl.org/dc/elements/1.1/" 
+ xmlns:photoshop="http://ns.adobe.com/photoshop/1.0/">
+ ${photoshop_sidecar_for_extension(extension)}
+ ${dc_description(description)}
+ ${dc_title(photo.title)}
+ ${dc_subject(subjects)}
+ ${dc_datecreated(photo.date)}
+</rdf:Description>
+
+<rdf:Description rdf:about=""  
+ xmlns:Iptc4xmpExt='http://iptc.org/std/Iptc4xmpExt/2008-02-29/'>
+ ${iptc_personinimage(persons)}
+</rdf:Description>
+
+<rdf:Description rdf:about="" 
+ xmlns:digiKam='http://www.digikam.org/ns/1.0/'>
+ ${dk_tagslist(keywords)}
+</rdf:Description>
+
+<rdf:Description rdf:about="" 
+ xmlns:xmp='http://ns.adobe.com/xap/1.0/'>
+ ${adobe_createdate(photo.date)}
+ ${adobe_modifydate(photo.date)}
+</rdf:Description>
+
+<rdf:Description rdf:about=""
+ xmlns:exif='http://ns.adobe.com/exif/1.0/'>
+ ${gps_info(*photo.location)}
+</rdf:Description>
+
+<rdf:Description rdf:about=''
+ xmlns:tiff='http://ns.adobe.com/tiff/1.0/'>
+ ${orientation(photo.orientation)}
+</rdf:Description>
+
+<rdf:Description rdf:about=""
+ xmlns:mwg-rs="http://www.metadataworkinggroup.com/schemas/regions/"
+ xmlns:stArea="http://ns.adobe.com/xmp/sType/Area#"
+ xmlns:stDim="http://ns.adobe.com/xap/1.0/sType/Dimensions#">
+ ${mwg_face_regions(photo)}
+</rdf:Description>
+
+
+<rdf:Description rdf:about=""
+ xmlns:MP="http://ns.microsoft.com/photo/1.2/"
+ xmlns:MPRI="http://ns.microsoft.com/photo/1.2/t/RegionInfo#"
+ xmlns:MPReg="http://ns.microsoft.com/photo/1.2/t/Region#">
+ ${mpri_face_regions(photo)}
+</rdf:Description>
+
+</rdf:RDF>
+</x:xmpmeta>
+<?xpacket end="w"?>

tests/Test-Faces-10.15.7.photoslibrary/database/Photos.sqlite.lock

@@ -7,7 +7,7 @@
 	<key>hostuuid</key>
 	<string>9575E48B-8D5F-5654-ABAC-4431B1167324</string>
 	<key>pid</key>
-	<integer>440</integer>
+	<integer>3447</integer>
 	<key>processname</key>
 	<string>photolibraryd</string>
 	<key>uid</key>

tests/Test-Faces-10.15.7.photoslibrary/database/search/searchMetadata.plist

@@ -4,6 +4,8 @@
 <dict>
 	<key>BlacklistedMeaningsByMeaning</key>
 	<dict/>
+	<key>MePersonUUID</key>
+	<string>39488755-78C0-40B2-B378-EDA280E1823C</string>
 	<key>SceneWhitelist</key>
 	<array>
 		<string>Graduation</string>

tests/Test-Faces-10.15.7.photoslibrary/private/com.apple.photoanalysisd/caches/graph/PhotoAnalysisServicePreferences.plist

@@ -3,24 +3,24 @@
 <plist version="1.0">
 <dict>
 	<key>BackgroundHighlightCollection</key>
-	<date>2020-07-27T00:34:02Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 	<key>BackgroundHighlightEnrichment</key>
-	<date>2020-07-27T00:34:02Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 	<key>BackgroundJobAssetRevGeocode</key>
-	<date>2020-07-27T01:57:21Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 	<key>BackgroundJobSearch</key>
-	<date>2020-07-27T00:34:02Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 	<key>BackgroundPeopleSuggestion</key>
-	<date>2020-07-27T00:34:02Z</date>
+	<date>2021-01-20T14:38:43Z</date>
 	<key>BackgroundUserBehaviorProcessor</key>
-	<date>2020-07-26T14:34:46Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphConsistencyUpdateJobDateKey</key>
 	<date>2020-07-27T00:01:51Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphRebuildJobDate</key>
 	<date>2020-07-26T14:34:45Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundMemoryGenerationJobDate</key>
-	<date>2020-07-27T01:57:22Z</date>
+	<date>2021-01-20T14:38:45Z</date>
 	<key>SiriPortraitDonation</key>
-	<date>2020-07-26T14:34:46Z</date>
+	<date>2021-01-20T14:38:44Z</date>
 </dict>
 </plist>