AlbumInfo.photos now returns photos in album sort order

README.md

@@ -1354,7 +1354,7 @@ Returns the universally unique identifier (uuid) of the album.  This is how Phot
 Returns the title or name of the album.
 
 #### `photos`
-Returns a list of [PhotoInfo](#PhotoInfo) objects representing each photo contained in the album.
+Returns a list of [PhotoInfo](#PhotoInfo) objects representing each photo contained in the album sorted in the same order as in Photos. (e.g. if photos were manually sorted in the Photos albums, photos returned by `photos` will be in same order as they appear in the Photos album)
 
 #### `folder_list`
 Returns a hierarchical list of [FolderInfo](#FolderInfo) objects representing the folders the album is contained in.  For example, if album "AlbumInFolder" is in SubFolder2 of Folder1 as illustrated below, would return a list of `FolderInfo` objects representing ["Folder1", "SubFolder2"] 

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.30.8"
+__version__ = "0.30.9"

osxphotos/albuminfo.py

@@ -48,8 +48,13 @@ class AlbumInfo:
         try:
             return self._photos
         except AttributeError:
-            uuid = self._db._dbalbums_album[self._uuid]
+            uuid, sort_order = zip(*self._db._dbalbums_album[self.uuid])
             self._photos = self._db.photos(uuid=uuid)
+            # PhotosDB.photos does not preserve order when passing in list of uuids
+            # so need to build photo list one a time
+            # sort uuids by sort order
+            sorted_uuid = sorted(zip(sort_order, uuid))
+            self._photos = [self._db.photos(uuid=[uuid])[0] for _, uuid in sorted_uuid]
             return self._photos
 
     @property

osxphotos/photosdb/photosdb.py

@@ -167,8 +167,8 @@ class PhotosDB:
         self._dbalbums_pk = {}
 
         # Dict with information about all albums/photos by album
-        # key is album UUID, value is list of photo UUIDs contained in that album
-        # e.g. {'0C514A98-7B77-4E4F-801B-364B7B65EAFA': ['1EB2B765-0765-43BA-A90C-0D0580E6172C']}
+        # key is album UUID, value is list of tuples of (photo UUID, sort order) contained in that album
+        # e.g. {'0C514A98-7B77-4E4F-801B-364B7B65EAFA': [('1EB2B765-0765-43BA-A90C-0D0580E6172C', 1024)]}
         self._dbalbums_album = {}
 
         # Dict with information about album details
@@ -627,22 +627,34 @@ class PhotosDB:
 
         # Get info on albums
         c.execute(
-            """ select 
+            """ SELECT 
                 RKAlbum.uuid, 
-                RKVersion.uuid 
-                from RKAlbum, RKVersion, RKAlbumVersion 
-                where RKAlbum.modelID = RKAlbumVersion.albumId and 
-                RKAlbumVersion.versionID = RKVersion.modelId  
+                RKVersion.uuid,
+                RKCustomSortOrder.orderNumber
+                FROM RKVersion
+				JOIN RKCustomSortOrder on RKCustomSortOrder.objectUuid = RKVersion.uuid
+				JOIN RKAlbum on RKAlbum.uuid = RKCustomSortOrder.containerUuid
             """
         )
+
+        # 0     RKAlbum.uuid,
+        # 1     RKVersion.uuid,
+        # 2     RKCustomSortOrder.orderNumber
+
         for album in c:
             # store by uuid in _dbalbums_uuid and by album in _dbalbums_album
-            if not album[1] in self._dbalbums_uuid:
-                self._dbalbums_uuid[album[1]] = []
-            if not album[0] in self._dbalbums_album:
-                self._dbalbums_album[album[0]] = []
-            self._dbalbums_uuid[album[1]].append(album[0])
-            self._dbalbums_album[album[0]].append(album[1])
+            album_uuid = album[0]
+            photo_uuid = album[1]
+            sort_order = album[2]
+            try:
+                self._dbalbums_uuid[photo_uuid].append(album_uuid)
+            except KeyError:
+                self._dbalbums_uuid[photo_uuid] = [album_uuid]
+
+            try:
+                self._dbalbums_album[album_uuid].append((photo_uuid, sort_order))
+            except KeyError:
+                self._dbalbums_album[album_uuid] = [(photo_uuid, sort_order)]
 
         # now get additional details about albums
         c.execute(
@@ -1459,22 +1471,34 @@ class PhotosDB:
 
         # get details about albums
         c.execute(
-            "SELECT ZGENERICALBUM.ZUUID, ZGENERICASSET.ZUUID "
-            "FROM ZGENERICASSET "
-            "JOIN Z_26ASSETS ON Z_26ASSETS.Z_34ASSETS = ZGENERICASSET.Z_PK "
-            "JOIN ZGENERICALBUM ON ZGENERICALBUM.Z_PK = Z_26ASSETS.Z_26ALBUMS "
+            """ SELECT 
+                ZGENERICALBUM.ZUUID, 
+                ZGENERICASSET.ZUUID,
+				Z_26ASSETS.Z_FOK_34ASSETS
+                FROM ZGENERICASSET 
+                JOIN Z_26ASSETS ON Z_26ASSETS.Z_34ASSETS = ZGENERICASSET.Z_PK 
+                JOIN ZGENERICALBUM ON ZGENERICALBUM.Z_PK = Z_26ASSETS.Z_26ALBUMS
+            """
         )
+
+        # 0     ZGENERICALBUM.ZUUID,
+        # 1     ZGENERICASSET.ZUUID,
+        # 2	    Z_26ASSETS.Z_FOK_34ASSETS
+
         for album in c:
             # store by uuid in _dbalbums_uuid and by album in _dbalbums_album
+            album_uuid = album[0]
+            photo_uuid = album[1]
+            sort_order = album[2]
             try:
-                self._dbalbums_uuid[album[1]].append(album[0])
+                self._dbalbums_uuid[photo_uuid].append(album_uuid)
             except KeyError:
-                self._dbalbums_uuid[album[1]] = [album[0]]
+                self._dbalbums_uuid[photo_uuid] = [album_uuid]
 
             try:
-                self._dbalbums_album[album[0]].append(album[1])
+                self._dbalbums_album[album_uuid].append((photo_uuid, sort_order))
             except KeyError:
-                self._dbalbums_album[album[0]] = [album[1]]
+                self._dbalbums_album[album_uuid] = [(photo_uuid, sort_order)]
 
         # now get additional details about albums
         c.execute(
@@ -2379,7 +2403,9 @@ class PhotosDB:
                         title_set = set()
                         for album_id in self._dbalbum_titles[album]:
                             try:
-                                title_set.update(self._dbalbums_album[album_id])
+                                # _dbalbums_album value is list of tuples: [(uuid, sort order)]
+                                uuid_in_album, _ = zip(*self._dbalbums_album[album_id])
+                                title_set.update(uuid_in_album)
                             except KeyError:
                                 # an empty album will be in _dbalbum_titles but not _dbalbums_album
                                 pass

tests/Test-10.14.6.photoslibrary/private/com.apple.photoanalysisd/GraphService/PhotoAnalysisServicePreferences.plist

@@ -5,6 +5,6 @@
 	<key>PhotoAnalysisGraphLastBackgroundGraphRebuildJobDate</key>
 	<date>2020-04-25T23:54:43Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundMemoryGenerationJobDate</key>
-	<date>2020-06-27T16:03:48Z</date>
+	<date>2020-07-06T16:39:04Z</date>
 </dict>
 </plist>

tests/Test-10.14.6.photoslibrary/resources/moments/analysismetadata.plist

@@ -11,6 +11,6 @@
 	<key>PLLastRevGeoForcedProviderOutOfDateCheckVersionKey</key>
 	<integer>1</integer>
 	<key>PLLastRevGeoVerFileFetchDateKey</key>
-	<date>2020-06-27T16:03:43Z</date>
+	<date>2020-07-06T16:39:09Z</date>
 </dict>
 </plist>

tests/Test-10.14.6.photoslibrary/resources/moments/historicalmarker.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>LastHistoryRowId</key>
-	<integer>651</integer>
+	<integer>664</integer>
 	<key>LibraryBuildTag</key>
 	<string>D8C4AAA1-3AB6-4A65-BEBD-99CC3E5D433E</string>
 	<key>LibrarySchemaVersion</key>

tests/Test-10.14.6.photoslibrary/resources/recovery/Info.plist

@@ -9,7 +9,7 @@
 	<key>HistoricalMarker</key>
 	<dict>
 		<key>LastHistoryRowId</key>
-		<integer>606</integer>
+		<integer>664</integer>
 		<key>LibraryBuildTag</key>
 		<string>D8C4AAA1-3AB6-4A65-BEBD-99CC3E5D433E</string>
 		<key>LibrarySchemaVersion</key>
@@ -24,7 +24,7 @@
 	<key>SnapshotCompletedDate</key>
 	<date>2019-07-27T13:16:43Z</date>
 	<key>SnapshotLastValidated</key>
-	<date>2020-06-27T16:03:33Z</date>
+	<date>2020-07-06T16:39:02Z</date>
 	<key>SnapshotTables</key>
 	<dict/>
 </dict>

tests/Test-10.15.5.photoslibrary/database/Photos.sqlite.lock

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

tests/test_catalina_10_15_5.py

@@ -80,6 +80,12 @@ UUID_PUMPKIN_FARM = [
     "1EB2B765-0765-43BA-A90C-0D0580E6172C",
 ]
 
+ALBUM_SORT_ORDER = [
+"1EB2B765-0765-43BA-A90C-0D0580E6172C",
+"F12384F6-CD17-4151-ACBA-AE0E3688539E",
+"D79B8D77-BFFC-460B-9312-034F2877D35B",
+]
+ALBUM_KEY_PHOTO = "D79B8D77-BFFC-460B-9312-034F2877D35B"
 
 def test_init1():
     # test named argument
@@ -217,6 +223,15 @@ def test_albums_as_dict():
     assert albums["Pumpkin Farm"] == 3
     assert albums == ALBUM_DICT
 
+def test_album_sort_order():
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    album = [a for a in photosdb.album_info if a.title == "Pumpkin Farm"][0]
+    photos = album.photos
+
+    uuids = [p.uuid for p in photos]
+    assert uuids == ALBUM_SORT_ORDER
 
 def test_attributes():
     import datetime

tests/test_mojave_10_14_6.py

@@ -47,6 +47,13 @@ UUID_DICT = {
     "has_adjustments": "6bxcNnzRQKGnK4uPrCJ9UQ",
 }
 
+ALBUM_SORT_ORDER = [
+    "HrK3ZQdlQ7qpDA0FgOYXLA",
+    "8SOE9s0XQVGsuq4ONohTng",
+    "15uNd7%8RguTEgNPKHfTWw",
+]
+ALBUM_KEY_PHOTO = "15uNd7%8RguTEgNPKHfTWw"
+
 PHOTOS_DB_LEN = 8
 PHOTOS_NOT_IN_TRASH_LEN = 7
 PHOTOS_IN_TRASH_LEN = 1
@@ -136,6 +143,17 @@ def test_albums_as_dict():
     assert albums == ALBUM_DICT
 
 
+def test_album_sort_order():
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    album = [a for a in photosdb.album_info if a.title == "Pumpkin Farm"][0]
+    photos = album.photos
+
+    uuids = [p.uuid for p in photos]
+    assert uuids == ALBUM_SORT_ORDER
+
+
 def test_attributes():
     import datetime
     import osxphotos