Added test for issue #178

CHANGELOG.md

@@ -4,6 +4,49 @@ 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.29.28](https://github.com/RhetTbull/osxphotos/compare/v0.29.26...v0.29.28)
+
+> 22 June 2020
+
+- Closes #174 [`#174`](https://github.com/RhetTbull/osxphotos/issues/174)
+- Added today to template system, closes #167 [`#167`](https://github.com/RhetTbull/osxphotos/issues/167)
+- Minor refactoring in photoinfo.py [`a8e996e`](https://github.com/RhetTbull/osxphotos/commit/a8e996e66072e94de93fd4ea78a456bc61831f52)
+
+#### [v0.29.26](https://github.com/RhetTbull/osxphotos/compare/v0.29.25...v0.29.26)
+
+> 21 June 2020
+
+- Bug fix for issue #172 [`1ebf995`](https://github.com/RhetTbull/osxphotos/commit/1ebf99583397617f0d3a234c898beae1c14f5a63)
+
+#### [v0.29.25](https://github.com/RhetTbull/osxphotos/compare/v0.29.24...v0.29.25)
+
+> 21 June 2020
+
+- More PhotoInfo.albums refactoring, closes #169 [`#169`](https://github.com/RhetTbull/osxphotos/issues/169)
+
+#### [v0.29.24](https://github.com/RhetTbull/osxphotos/compare/v0.29.23...v0.29.24)
+
+> 21 June 2020
+
+- Refactored album code in photosdb to fix issue #169 [`cfabd0d`](https://github.com/RhetTbull/osxphotos/commit/cfabd0dbead62c8ab6a774899239e5da5bfe1203)
+
+#### [v0.29.23](https://github.com/RhetTbull/osxphotos/compare/v0.29.22...v0.29.23)
+
+> 20 June 2020
+
+- Fixed PhotoInfo.albums, album_info for issue #169 [`1212fad`](https://github.com/RhetTbull/osxphotos/commit/1212fad4adde0b4c6b2887392eed829d8d96d61d)
+
+#### [v0.29.22](https://github.com/RhetTbull/osxphotos/compare/v0.29.19...v0.29.22)
+
+> 19 June 2020
+
+- Don't raise KeyError when SystemLibraryPath is absent [`#168`](https://github.com/RhetTbull/osxphotos/pull/168)
+- Added check for export db in directory branch, closes #164 [`#164`](https://github.com/RhetTbull/osxphotos/issues/164)
+- Added OSXPhotosDB.get_db_connection() [`43d28e7`](https://github.com/RhetTbull/osxphotos/commit/43d28e78f394fa33f8d88f64b56b7dc7258cd454)
+- Added show() to photos_repl.py [`e98c3fe`](https://github.com/RhetTbull/osxphotos/commit/e98c3fe42912ac16d13675bf14154981089d41ea)
+- Fixed get_last_library_path and get_system_library_path to not raise KeyError [`5a83218`](https://github.com/RhetTbull/osxphotos/commit/5a832181f73e082927c80864f2063e554906b06b)
+- Don't raise KeyError when SystemLibraryPath is absent [`1fd0f96`](https://github.com/RhetTbull/osxphotos/commit/1fd0f96b14f0bc38e47bddb4cae12e19406324fb)
+
 #### [v0.29.19](https://github.com/RhetTbull/osxphotos/compare/v0.29.18...v0.29.19)
 
 > 14 June 2020

README.md

@@ -428,6 +428,34 @@ Substitution                    Description
 {modified.hour}                 2-digit hour of the file modification time
 {modified.min}                  2-digit minute of the file modification time
 {modified.sec}                  2-digit second of the file modification time
+{today.date}                    Current date in iso format, e.g.
+                                '2020-03-22'
+{today.year}                    4-digit year of current date
+{today.yy}                      2-digit year of current date
+{today.mm}                      2-digit month of the current date (zero
+                                padded)
+{today.month}                   Month name in user's locale of the current
+                                date
+{today.mon}                     Month abbreviation in the user's locale of
+                                the current date
+{today.dd}                      2-digit day of the month (zero padded) of
+                                current date
+{today.dow}                     Day of week in user's locale of the current
+                                date
+{today.doy}                     3-digit day of year (e.g Julian day) of
+                                current date, starting from 1 (zero padded)
+{today.hour}                    2-digit hour of the current date
+{today.min}                     2-digit minute of the current date
+{today.sec}                     2-digit second of the current date
+{today.strftime}                Apply strftime template to current
+                                date/time. Should be used in form
+                                {today.strftime,TEMPLATE} where TEMPLATE is
+                                a valid strftime template, e.g.
+                                {today.strftime,%Y-%U} would result in year-
+                                week number of year: '2020-23'. If used with
+                                no template will return null value. See
+                                https://strftime.org/ for help on strftime
+                                templates.
 {place.name}                    Place name from the photo's reverse
                                 geolocation data, as displayed in Photos
 {place.country_code}            The ISO country code from the photo's
@@ -1461,7 +1489,6 @@ Example: find your "best" photo of food
 ### Template Substitutions
 
 The following substitutions are availabe for use with `PhotoInfo.render_template()` 
-
 | Substitution | Description |
 |--------------|-------------|
 |{name}|Current filename of the photo|
@@ -1492,6 +1519,19 @@ The following substitutions are availabe for use with `PhotoInfo.render_template
 |{modified.hour}|2-digit hour of the file modification time|
 |{modified.min}|2-digit minute of the file modification time|
 |{modified.sec}|2-digit second of the file modification time|
+|{today.date}|Current date in iso format, e.g. '2020-03-22'|
+|{today.year}|4-digit year of current date|
+|{today.yy}|2-digit year of current date|
+|{today.mm}|2-digit month of the current date (zero padded)|
+|{today.month}|Month name in user's locale of the current date|
+|{today.mon}|Month abbreviation in the user's locale of the current date|
+|{today.dd}|2-digit day of the month (zero padded) of current date|
+|{today.dow}|Day of week in user's locale of the current date|
+|{today.doy}|3-digit day of year (e.g Julian day) of current date, starting from 1 (zero padded)|
+|{today.hour}|2-digit hour of the current date|
+|{today.min}|2-digit minute of the current date|
+|{today.sec}|2-digit second of the current date|
+|{today.strftime}|Apply strftime template to current date/time. Should be used in form {today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {today.strftime,%Y-%U} would result in year-week number of year: '2020-23'. If used with no template will return null value. See https://strftime.org/ for help on strftime templates.|
 |{place.name}|Place name from the photo's reverse geolocation data, as displayed in Photos|
 |{place.country_code}|The ISO country code from the photo's reverse geolocation data|
 |{place.name.country}|Country name from the photo's reverse geolocation data|

osxphotos/__init__.py

@@ -3,14 +3,9 @@ import logging
 from ._version import __version__
 from .photoinfo import PhotoInfo
 from .photosdb import PhotosDB
-from .utils import _set_debug, _debug, _get_logger
+from .phototemplate import PhotoTemplate
+from .utils import _debug, _get_logger, _set_debug
 
-# TODO: find edited photos: see https://github.com/orangeturtle739/photos-export/blob/master/extract_photos.py
 # TODO: Add test for imageTimeZoneOffsetSeconds = None
-# TODO: Fix command line so multiple --keyword, etc. are AND (instead of OR as they are in .photos())
-#       Or fix the help text to match behavior
 # TODO: Add test for __str__ and to_json
-# TODO: fix docstrings
 # TODO: Add special albums and magic albums
-# TODO: cleanup os.path and pathlib code (import pathlib and also from pathlib import Path)
-

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.29.22"
+__version__ = "0.29.30"

osxphotos/photoinfo/photoinfo.py

@@ -21,12 +21,16 @@ import yaml
 from .._constants import (
     _MOVIE_TYPE,
     _PHOTO_TYPE,
+    _PHOTOS_4_ALBUM_KIND,
+    _PHOTOS_4_ROOT_FOLDER,
     _PHOTOS_4_VERSION,
+    _PHOTOS_5_ALBUM_KIND,
+    _PHOTOS_5_SHARED_ALBUM_KIND,
     _PHOTOS_5_SHARED_PHOTO_PATH,
 )
 from ..albuminfo import AlbumInfo
-from ..placeinfo import PlaceInfo4, PlaceInfo5
 from ..phototemplate import PhotoTemplate
+from ..placeinfo import PlaceInfo4, PlaceInfo5
 from ..utils import _debug, _get_resource_loc, findfiles, get_preferred_uti_extension
 
 
@@ -65,6 +69,7 @@ class PhotoInfo:
     @property
     def filename(self):
         """ filename of the picture """
+        # sourcery off
         if self.has_raw and self.raw_original:
             # return name of the RAW file
             # TODO: not yet implemented
@@ -85,8 +90,7 @@ class PhotoInfo:
         seconds = self._info["imageTimeZoneOffsetSeconds"] or 0
         delta = timedelta(seconds=seconds)
         tz = timezone(delta)
-        imagedate_utc = imagedate.astimezone(tz=tz)
-        return imagedate_utc
+        return imagedate.astimezone(tz=tz)
 
     @property
     def date_modified(self):
@@ -97,8 +101,7 @@ class PhotoInfo:
             seconds = self._info["imageTimeZoneOffsetSeconds"] or 0
             delta = timedelta(seconds=seconds)
             tz = timezone(delta)
-            imagedate_utc = imagedate.astimezone(tz=tz)
-            return imagedate_utc
+            return imagedate.astimezone(tz=tz)
         else:
             return None
 
@@ -341,21 +344,26 @@ class PhotoInfo:
     @property
     def albums(self):
         """ list of albums picture is contained in """
-        albums = []
-        for album in self._info["albums"]:
-            if not self._db._dbalbum_details[album]["intrash"]:
-                albums.append(self._db._dbalbum_details[album]["title"])
-        return albums
+        try:
+            return self._albums
+        except AttributeError:
+            album_uuids = self._get_album_uuids()
+            self._albums = list(
+                {self._db._dbalbum_details[album]["title"] for album in album_uuids}
+            )
+            return self._albums
 
     @property
     def album_info(self):
         """ list of AlbumInfo objects representing albums the photos is contained in """
-        albums = []
-        for album in self._info["albums"]:
-            if not self._db._dbalbum_details[album]["intrash"]:
-                albums.append(AlbumInfo(db=self._db, uuid=album))
-
-        return albums
+        try:
+            return self._album_info
+        except AttributeError:
+            album_uuids = self._get_album_uuids()
+            self._album_info = [
+                AlbumInfo(db=self._db, uuid=album) for album in album_uuids
+            ]
+            return self._album_info
 
     @property
     def keywords(self):
@@ -485,12 +493,11 @@ class PhotoInfo:
             self is not included in the returned list """
         if self._info["burst"]:
             burst_uuid = self._info["burstUUID"]
-            burst_photos = [
+            return [
                 PhotoInfo(db=self._db, uuid=u, info=self._db._dbphotos[u])
                 for u in self._db._dbphotos_burst[burst_uuid]
                 if u != self._uuid
             ]
-            return burst_photos
         else:
             return []
 
@@ -655,6 +662,37 @@ class PhotoInfo:
         """ Returns latitude, in degrees """
         return self._info["latitude"]
 
+    def _get_album_uuids(self):
+        """ Return list of album UUIDs this photo is found in
+        
+            Filters out albums in the trash and any special album types
+        
+        Returns: list of album UUIDs 
+        """
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            version4 = True
+            album_kind = [_PHOTOS_4_ALBUM_KIND]
+        else:
+            version4 = False
+            album_kind = [_PHOTOS_5_SHARED_ALBUM_KIND, _PHOTOS_5_ALBUM_KIND]
+
+        album_list = []
+        for album in self._info["albums"]:
+            detail = self._db._dbalbum_details[album]
+            if (
+                detail["kind"] in album_kind
+                and not detail["intrash"]
+                and (
+                    not version4
+                    # in Photos <= 4, special albums like "printAlbum" have kind _PHOTOS_4_ALBUM_KIND
+                    # but should not be listed here; they can be distinguished by looking
+                    # for folderUuid of _PHOTOS_4_ROOT_FOLDER as opposed to _PHOTOS_4_TOP_LEVEL_ALBUM
+                    or (version4 and detail["folderUuid"] != _PHOTOS_4_ROOT_FOLDER)
+                )
+            ):
+                album_list.append(album)
+        return album_list
+
     def __repr__(self):
         return f"osxphotos.{self.__class__.__name__}(db={self._db}, uuid='{self._uuid}', info={self._info})"
 
@@ -772,12 +810,18 @@ class PhotoInfo:
         }
         return json.dumps(pic)
 
-    # compare two PhotoInfo objects for equality
     def __eq__(self, other):
+        """ Compare two PhotoInfo objects for equality """
+        # Can't just compare the two __dicts__ because some methods (like albums)
+        # memoize their value once called in an instance variable (e.g. self._albums)
         if isinstance(other, self.__class__):
-            return self.__dict__ == other.__dict__
-
+            return (
+                self._db.db_path == other._db.db_path
+                and self.uuid == other.uuid
+                and self._info == other._info
+            )
         return False
 
     def __ne__(self, other):
+        """ Compare two PhotoInfo objects for inequality """
         return not self.__eq__(other)

osxphotos/photosdb/photosdb.py

@@ -311,18 +311,16 @@ class PhotosDB:
     def albums_as_dict(self):
         """ return albums as dict of albums, count in reverse sorted order (descending) """
         albums = {}
-        album_keys = [
-            k
-            for k in self._dbalbums_album.keys()
-            if self._dbalbum_details[k]["cloudownerhashedpersonid"] is None
-            and not self._dbalbum_details[k]["intrash"]
-        ]
-        for k in album_keys:
-            title = self._dbalbum_details[k]["title"]
-            if title in albums:
-                albums[title] += len(self._dbalbums_album[k])
+        album_keys = self._get_album_uuids(shared=False)
+        for album in album_keys:
+            title = self._dbalbum_details[album]["title"]
+            if album in self._dbalbums_album:
+                try:
+                    albums[title] += len(self._dbalbums_album[album])
+                except KeyError:
+                    albums[title] = len(self._dbalbums_album[album])
             else:
-                albums[title] = len(self._dbalbums_album[k])
+                albums[title] = 0  # empty album
         albums = dict(sorted(albums.items(), key=lambda kv: kv[1], reverse=True))
         return albums
 
@@ -331,25 +329,17 @@ class PhotosDB:
         """ returns shared albums as dict of albums, count in reverse sorted order (descending)
             valid only on Photos 5; on Photos <= 4, prints warning and returns empty dict """
 
-        # if _dbalbum_details[key]["cloudownerhashedpersonid"] is not None, then it's a shared album
-        if self._db_version <= _PHOTOS_4_VERSION:
-            logging.warning(
-                f"albums_shared not implemented for Photos versions < {_PHOTOS_5_VERSION}"
-            )
-            return {}
-
         albums = {}
-        album_keys = [
-            k
-            for k in self._dbalbums_album.keys()
-            if self._dbalbum_details[k]["cloudownerhashedpersonid"] is not None
-        ]
-        for k in album_keys:
-            title = self._dbalbum_details[k]["title"]
-            if title in albums:
-                albums[title] += len(self._dbalbums_album[k])
+        album_keys = self._get_album_uuids(shared=True)
+        for album in album_keys:
+            title = self._dbalbum_details[album]["title"]
+            if album in self._dbalbums_album:
+                try:
+                    albums[title] += len(self._dbalbums_album[album])
+                except KeyError:
+                    albums[title] = len(self._dbalbums_album[album])
             else:
-                albums[title] = len(self._dbalbums_album[k])
+                albums[title] = 0  # empty album
         albums = dict(sorted(albums.items(), key=lambda kv: kv[1], reverse=True))
         return albums
 
@@ -410,32 +400,28 @@ class PhotosDB:
     @property
     def album_info(self):
         """ return list of AlbumInfo objects for each album in the photos database """
-
-        return [
-            AlbumInfo(db=self, uuid=album)
-            for album in self._dbalbums_album.keys()
-            if self._dbalbum_details[album]["cloudownerhashedpersonid"] is None
-            and not self._dbalbum_details[album]["intrash"]
-        ]
+        try:
+            return self._album_info
+        except AttributeError:
+            self._album_info = [
+                AlbumInfo(db=self, uuid=album)
+                for album in self._get_album_uuids(shared=False)
+            ]
+            return self._album_info
 
     @property
     def album_info_shared(self):
         """ return list of AlbumInfo objects for each shared album in the photos database
             only valid for Photos 5; on Photos <= 4, prints warning and returns empty list """
         # if _dbalbum_details[key]["cloudownerhashedpersonid"] is not None, then it's a shared album
-
-        if self._db_version <= _PHOTOS_4_VERSION:
-            logging.warning(
-                f"albums_shared not implemented for Photos versions < {_PHOTOS_5_VERSION}"
-            )
-            return []
-
-        return [
-            AlbumInfo(db=self, uuid=album)
-            for album in self._dbalbums_album.keys()
-            if self._dbalbum_details[album]["cloudownerhashedpersonid"] is not None
-            and not self._dbalbum_details[album]["intrash"]
-        ]
+        try:
+            return self._album_info_shared
+        except AttributeError:
+            self._album_info_shared = [
+                AlbumInfo(db=self, uuid=album)
+                for album in self._get_album_uuids(shared=True)
+            ]
+            return self._album_info_shared
 
     @property
     def albums(self):
@@ -444,13 +430,11 @@ class PhotosDB:
         # Could be more than one album with same name
         # Right now, they are treated as same album and photos are combined from albums with same name
 
-        albums = {
-            self._dbalbum_details[album]["title"]
-            for album in self._dbalbums_album.keys()
-            if self._dbalbum_details[album]["cloudownerhashedpersonid"] is None
-            and not self._dbalbum_details[album]["intrash"]
-        }
-        return list(albums)
+        try:
+            return self._albums
+        except AttributeError:
+            self._albums = self._get_albums(shared=False)
+            return self._albums
 
     @property
     def albums_shared(self):
@@ -462,19 +446,11 @@ class PhotosDB:
 
         # if _dbalbum_details[key]["cloudownerhashedpersonid"] is not None, then it's a shared album
 
-        if self._db_version <= _PHOTOS_4_VERSION:
-            logging.warning(
-                f"album_names_shared not implemented for Photos versions < {_PHOTOS_5_VERSION}"
-            )
-            return []
-
-        albums = {
-            self._dbalbum_details[album]["title"]
-            for album in self._dbalbums_album.keys()
-            if self._dbalbum_details[album]["cloudownerhashedpersonid"] is not None
-            and not self._dbalbum_details[album]["intrash"]
-        }
-        return list(albums)
+        try:
+            return self._albums_shared
+        except AttributeError:
+            self._albums_shared = self._get_albums(shared=True)
+            return self._albums_shared
 
     @property
     def db_version(self):
@@ -634,6 +610,8 @@ class PhotosDB:
                 "folderUuid": album[5],
                 "albumType": album[6],
                 "albumSubclass": album[7],
+                # for compatability with Photos 5 where album kind is ZKIND
+                "kind": album[7],
             }
 
         # get details about folders
@@ -820,7 +798,7 @@ class PhotosDB:
             try:
                 self._dbphotos[uuid]["imageDate"] = datetime.fromtimestamp(row[5] + td)
             except ValueError:
-                self._dbphotos[uuid]["imageDate"] = datetime.date(1970, 1, 1)
+                self._dbphotos[uuid]["imageDate"] = datetime(1970, 1, 1)
 
             self._dbphotos[uuid]["mainRating"] = row[6]
             self._dbphotos[uuid]["hasAdjustments"] = row[7]
@@ -1538,7 +1516,7 @@ class PhotosDB:
             try:
                 info["imageDate"] = datetime.fromtimestamp(row[5] + td)
             except ValueError:
-                info["imageDate"] = datetime.date(1970, 1, 1)
+                info["imageDate"] = datetime(1970, 1, 1)
 
             info["imageTimeZoneOffsetSeconds"] = row[6]
             info["hidden"] = row[9]
@@ -2098,6 +2076,65 @@ class PhotosDB:
         hierarchy = _recurse_folder_hierarchy(folders)
         return hierarchy
 
+    def _get_album_uuids(self, shared=False):
+        """ Return list of album UUIDs found in photos database
+        
+            Filters out albums in the trash and any special album types
+        
+        Args:
+            shared: boolean; if True, returns shared albums, else normal albums
+        
+        Returns: list of album UUIDs 
+        """
+        if self._db_version <= _PHOTOS_4_VERSION:
+            version4 = True
+            if shared:
+                logging.warning(
+                    f"Shared albums not implemented for Photos library version {self._db_version}"
+                )
+                return []  # not implemented for _PHOTOS_4_VERSION
+            else:
+                album_kind = _PHOTOS_4_ALBUM_KIND
+        else:
+            version4 = False
+            album_kind = _PHOTOS_5_SHARED_ALBUM_KIND if shared else _PHOTOS_5_ALBUM_KIND
+
+        album_list = []
+        # look through _dbalbum_details because _dbalbums_album won't have empty albums it
+        for album, detail in self._dbalbum_details.items():
+            if (
+                detail["kind"] == album_kind
+                and not detail["intrash"]
+                and (
+                    (shared and detail["cloudownerhashedpersonid"] is not None)
+                    or (not shared and detail["cloudownerhashedpersonid"] is None)
+                )
+                and (
+                    not version4
+                    # in Photos 4, special albums like "printAlbum" have kind _PHOTOS_4_ALBUM_KIND
+                    # but should not be listed here; they can be distinguished by looking
+                    # for folderUuid of _PHOTOS_4_ROOT_FOLDER as opposed to _PHOTOS_4_TOP_LEVEL_ALBUM
+                    or (version4 and detail["folderUuid"] != _PHOTOS_4_ROOT_FOLDER)
+                )
+            ):
+                album_list.append(album)
+        return album_list
+
+    def _get_albums(self, shared=False):
+        """ Return list of album titles found in photos database
+            Albums may have duplicate titles -- these will be treated as a single album.
+        
+            Filters out albums in the trash and any special album types
+
+        Args:
+            shared: boolean; if True, returns shared albums, else normal albums
+        
+        Returns: list of album names
+        """
+
+        album_uuids = self._get_album_uuids(shared=shared)
+        return list({self._dbalbum_details[album]["title"] for album in album_uuids})
+
     def photos(
         self,
         keywords=None,

osxphotos/phototemplate.py

@@ -9,6 +9,7 @@
 # 4. Couldn't figure out how to do #1 and #2 with str.format()
 #
 # This code isn't elegant but it seems to work well.  PRs gladly accepted.
+import datetime
 import locale
 import os
 import re
@@ -59,6 +60,23 @@ TEMPLATE_SUBSTITUTIONS = {
     # + "{modified.strftime,%Y-%U} would result in year-week number of year: '2020-23'. "
     # + "If used with no template will return null value. "
     # + "See https://strftime.org/ for help on strftime templates.",
+    "{today.date}": "Current date in iso format, e.g. '2020-03-22'",
+    "{today.year}": "4-digit year of current date",
+    "{today.yy}": "2-digit year of current date",
+    "{today.mm}": "2-digit month of the current date (zero padded)",
+    "{today.month}": "Month name in user's locale of the current date",
+    "{today.mon}": "Month abbreviation in the user's locale of the current date",
+    "{today.dd}": "2-digit day of the month (zero padded) of current date",
+    "{today.dow}": "Day of week in user's locale of the current date",
+    "{today.doy}": "3-digit day of year (e.g Julian day) of current date, starting from 1 (zero padded)",
+    "{today.hour}": "2-digit hour of the current date",
+    "{today.min}": "2-digit minute of the current date",
+    "{today.sec}": "2-digit second of the current date",
+    "{today.strftime}": "Apply strftime template to current date/time. Should be used in form "
+    + "{today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. "
+    + "{today.strftime,%Y-%U} would result in year-week number of year: '2020-23'. "
+    + "If used with no template will return null value. "
+    + "See https://strftime.org/ for help on strftime templates.",
     "{place.name}": "Place name from the photo's reverse geolocation data, as displayed in Photos",
     "{place.country_code}": "The ISO country code from the photo's reverse geolocation data",
     "{place.name.country}": "Country name from the photo's reverse geolocation data",
@@ -102,6 +120,10 @@ class PhotoTemplate:
         """
         self.photo = photo
 
+        # holds value of current date/time for {today.x} fields
+        # gets initialized in get_template_value
+        self.today = None
+
     def render(self, template, none_str="_", path_sep=None):
         """ Render a filename or directory template 
 
@@ -258,6 +280,10 @@ class PhotoTemplate:
             ValueError if no rule exists for field.
         """
 
+        # initialize today with current date/time if needed
+        if self.today is None:
+            self.today = datetime.datetime.now()
+
         # must be a valid keyword
         if field == "name":
             return pathlib.Path(self.photo.filename).stem
@@ -404,6 +430,51 @@ class PhotoTemplate:
         #     else:
         #         return None
 
+        if field == "today.date":
+            return DateTimeFormatter(self.today).date
+
+        if field == "today.year":
+            return DateTimeFormatter(self.today).year
+
+        if field == "today.yy":
+            return DateTimeFormatter(self.today).yy
+
+        if field == "today.mm":
+            return DateTimeFormatter(self.today).mm
+
+        if field == "today.month":
+            return DateTimeFormatter(self.today).month
+
+        if field == "today.mon":
+            return DateTimeFormatter(self.today).mon
+
+        if field == "today.dd":
+            return DateTimeFormatter(self.today).dd
+
+        if field == "today.dow":
+            return DateTimeFormatter(self.today).dow
+
+        if field == "today.doy":
+            return DateTimeFormatter(self.today).doy
+
+        if field == "today.hour":
+            return DateTimeFormatter(self.today).hour
+
+        if field == "today.min":
+            return DateTimeFormatter(self.today).min
+
+        if field == "today.sec":
+            return DateTimeFormatter(self.today).sec
+
+        if field == "today.strftime":
+            if default:
+                try:
+                    return self.today.strftime(default)
+                except:
+                    raise ValueError(f"Invalid strftime template: '{default}'")
+            else:
+                return None
+
         if field == "place.name":
             return self.photo.place.name if self.photo.place else None
 

osxphotos/placeinfo.py

@@ -503,7 +503,6 @@ class PlaceInfo5(PlaceInfo):
         """ revgeoloc_bplist: a binary plist blob containing 
                 a serialized PLRevGeoLocationInfo object """
         self._bplist = revgeoloc_bplist
-        # todo: check for None?
         self._plrevgeoloc = archiver.unarchive(revgeoloc_bplist)
         self._process_place_info()
 
@@ -535,16 +534,23 @@ class PlaceInfo5(PlaceInfo):
     @property
     def address(self):
         addr = self._plrevgeoloc.postalAddress
-        return PostalAddress(
-            street=addr._street,
-            sub_locality=addr._subLocality,
-            city=addr._city,
-            sub_administrative_area=addr._subAdministrativeArea,
-            state_province=addr._state,
-            postal_code=addr._postalCode,
-            country=addr._country,
-            iso_country_code=addr._ISOCountryCode,
-        )
+        if addr is not None:
+            postal_address = PostalAddress(
+                street=addr._street,
+                sub_locality=addr._subLocality,
+                city=addr._city,
+                sub_administrative_area=addr._subAdministrativeArea,
+                state_province=addr._state,
+                postal_code=addr._postalCode,
+                country=addr._country,
+                iso_country_code=addr._ISOCountryCode,
+            )
+        else:
+            postal_address = PostalAddress(
+                None, None, None, None, None, None, None, None
+            )
+
+        return postal_address
 
     def _process_place_info(self):
         """ Process sortedPlaceInfos to set self._name and self._names """
@@ -632,5 +638,5 @@ class PlaceInfo5(PlaceInfo):
             "country_code": self.country_code,
             "ishome": self.ishome,
             "address_str": self.address_str,
-            "address": self.address._asdict(),
+            "address": self.address._asdict() if self.address is not None else None,
         }

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>703</integer>
+	<integer>763</integer>
 	<key>processname</key>
 	<string>photolibraryd</string>
 	<key>uid</key>

tests/Test-10.15.5.photoslibrary/private/com.apple.Photos/appPrivateData.plist

@@ -10,6 +10,7 @@
 		<string>88A5F8B8-5B9A-43C7-BB85-3952B81580EB/L0/020</string>
 		<string>29EF7A97-7E76-4D5F-A5E0-CC0A93E8524C/L0/020</string>
 		<string>2C2AF115-BD1D-4434-A747-D1C8BD8E2045/L0/020</string>
+		<string>CB051A4C-2CB7-4B90-B59B-08CC4D0C2823/L0/020</string>
 	</array>
 	<key>Photos</key>
 	<dict>

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

@@ -3,24 +3,24 @@
 <plist version="1.0">
 <dict>
 	<key>BackgroundHighlightCollection</key>
-	<date>2020-06-06T14:26:31Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 	<key>BackgroundHighlightEnrichment</key>
-	<date>2020-06-06T14:26:29Z</date>
+	<date>2020-06-24T04:02:12Z</date>
 	<key>BackgroundJobAssetRevGeocode</key>
-	<date>2020-06-06T14:26:31Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 	<key>BackgroundJobSearch</key>
-	<date>2020-06-06T14:26:31Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 	<key>BackgroundPeopleSuggestion</key>
-	<date>2020-06-06T14:26:29Z</date>
+	<date>2020-06-24T04:02:12Z</date>
 	<key>BackgroundUserBehaviorProcessor</key>
-	<date>2020-06-06T14:26:31Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphConsistencyUpdateJobDateKey</key>
 	<date>2020-05-30T02:16:06Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphRebuildJobDate</key>
 	<date>2020-05-29T04:31:37Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundMemoryGenerationJobDate</key>
-	<date>2020-06-06T14:26:33Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 	<key>SiriPortraitDonation</key>
-	<date>2020-06-06T14:26:31Z</date>
+	<date>2020-06-24T04:02:13Z</date>
 </dict>
 </plist>

tests/test_10_12_6.py

@@ -16,7 +16,7 @@ KEYWORDS = [
     "United Kingdom",
 ]
 PERSONS = ["Katie", "Suzy", "Maria"]
-ALBUMS = ["Pumpkin Farm", "Last Import", "AlbumInFolder"]
+ALBUMS = ["Pumpkin Farm", "AlbumInFolder"]
 KEYWORDS_DICT = {
     "Kids": 4,
     "wedding": 2,
@@ -29,7 +29,7 @@ KEYWORDS_DICT = {
     "United Kingdom": 1,
 }
 PERSONS_DICT = {"Katie": 3, "Suzy": 2, "Maria": 1}
-ALBUM_DICT = {"Pumpkin Farm": 3, "Last Import": 1, "AlbumInFolder": 1}
+ALBUM_DICT = {"Pumpkin Farm": 3, "AlbumInFolder": 1}
 
 
 def test_init():
@@ -124,7 +124,7 @@ def test_attributes():
     )
     assert p.description == "Girl holding pumpkin"
     assert p.title == "I found one!"
-    assert p.albums == ["Pumpkin Farm", "AlbumInFolder"]
+    assert sorted(p.albums) == ["AlbumInFolder", "Pumpkin Farm"]
     assert p.persons == ["Katie"]
     assert p.path.endswith(
         "/tests/Test-10.12.6.photoslibrary/Masters/2019/08/24/20190824-030824/Pumkins2.jpg"

tests/test_albums_folders_catalina_10_15_4.py

@@ -229,6 +229,7 @@ def test_albums_photos():
 
 
 def test_photoinfo_albums():
+    """ Test PhotoInfo.albums """
     import osxphotos
 
     photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
@@ -238,7 +239,20 @@ def test_photoinfo_albums():
     assert "Pumpkin Farm" in albums
 
 
+def test_photoinfo_albums_2():
+    """ Test that PhotoInfo.albums returns only number albums expected """
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos = photosdb.photos(uuid=[UUID_DICT["two_albums"]])
+
+    albums = photos[0].albums
+    assert len(albums) == 2
+
+
 def test_photoinfo_album_info():
+    """ test PhotoInfo.album_info """
+
     import osxphotos
 
     photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
@@ -249,4 +263,4 @@ def test_photoinfo_album_info():
     assert album_info[0].title in ["Pumpkin Farm", "Test Album"]
     assert album_info[1].title in ["Pumpkin Farm", "Test Album"]
 
-    assert photos[0] in album_info[0].photos
+    assert photos[0].uuid in [photo.uuid for photo in album_info[0].photos]

tests/test_albums_folders_mojave_10_14_6.py

@@ -244,4 +244,4 @@ def test_photoinfo_album_info():
     assert album_info[0].title in ["Pumpkin Farm", "Test Album"]
     assert album_info[1].title in ["Pumpkin Farm", "Test Album"]
 
-    assert photos[0] in album_info[0].photos
+    assert photos[0].uuid in [photo.uuid for photo in album_info[0].photos]

tests/test_catalina_10_15_1.py

@@ -106,6 +106,7 @@ def test_init4():
     except:
         pass
 
+
 def test_init5(mocker):
     # test failed get_last_library_path
     import osxphotos
@@ -116,7 +117,6 @@ def test_init5(mocker):
     # get_last_library actually in utils but need to patch it in photosdb because it's imported into photosdb
     # because of the layout of photosdb/ need to patch it this way...don't really understand why, but it works
     mocker.patch("osxphotos.photosdb.photosdb.get_last_library_path", new=bad_library)
-    
 
     with pytest.raises(Exception):
         assert osxphotos.PhotosDB()
@@ -207,7 +207,7 @@ def test_attributes():
     )
     assert p.description == "Girl holding pumpkin"
     assert p.title == "I found one!"
-    assert p.albums == ["Pumpkin Farm", "Test Album", "Multi Keyword"]
+    assert sorted(p.albums) == ["Multi Keyword", "Pumpkin Farm", "Test Album"]
     assert p.persons == ["Katie"]
     assert p.path.endswith(
         "tests/Test-10.15.1.photoslibrary/originals/D/D79B8D77-BFFC-460B-9312-034F2877D35B.jpeg"

tests/test_catalina_10_15_4.py

@@ -215,7 +215,7 @@ def test_attributes():
     )
     assert p.description == "Girl holding pumpkin"
     assert p.title == "I found one!"
-    assert p.albums == ["Pumpkin Farm", "Test Album"]
+    assert sorted(p.albums) == ["Pumpkin Farm", "Test Album"]
     assert p.persons == ["Katie"]
     assert p.path.endswith(
         "tests/Test-10.15.4.photoslibrary/originals/D/D79B8D77-BFFC-460B-9312-034F2877D35B.jpeg"

tests/test_catalina_10_15_5.py

@@ -28,6 +28,7 @@ ALBUMS = [
     "AlbumInFolder",
     "Raw",
     "I have a deleted twin",  # there's an empty album with same name that has been deleted
+    "EmptyAlbum",
 ]
 KEYWORDS_DICT = {
     "Kids": 4,
@@ -47,6 +48,7 @@ ALBUM_DICT = {
     "AlbumInFolder": 2,
     "Raw": 4,
     "I have a deleted twin": 1,
+    "EmptyAlbum": 0,
 }  # Note: there are 2 albums named "Test Album" for testing duplicate album names
 
 UUID_DICT = {
@@ -63,6 +65,8 @@ UUID_DICT = {
     "no_external_edit": "E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51",
     "export": "D79B8D77-BFFC-460B-9312-034F2877D35B",  # "Pumkins2.jpg"
     "export_tif": "8846E3E6-8AC8-4857-8448-E3D025784410",
+    "in_album": "D79B8D77-BFFC-460B-9312-034F2877D35B",  # "Pumkins2.jpg"
+    "date_invalid": "8846E3E6-8AC8-4857-8448-E3D025784410",
 }
 
 UUID_PUMPKIN_FARM = [
@@ -225,7 +229,7 @@ def test_attributes():
     )
     assert p.description == "Girl holding pumpkin"
     assert p.title == "I found one!"
-    assert p.albums == ["Pumpkin Farm", "Test Album"]
+    assert sorted(p.albums) == ["Pumpkin Farm", "Test Album"]
     assert p.persons == ["Katie"]
     assert p.path.endswith(
         "tests/Test-10.15.5.photoslibrary/originals/D/D79B8D77-BFFC-460B-9312-034F2877D35B.jpeg"
@@ -797,11 +801,29 @@ def test_export_14(caplog):
 
 
 def test_eq():
+    """ Test equality of two PhotoInfo objects """
     import osxphotos
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-    photos1 = photosdb.photos(uuid=[UUID_DICT["export"]])
-    photos2 = photosdb.photos(uuid=[UUID_DICT["export"]])
+    photosdb1 = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photosdb2 = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos1 = photosdb1.photos(uuid=[UUID_DICT["export"]])
+    photos2 = photosdb2.photos(uuid=[UUID_DICT["export"]])
+    assert photos1[0] == photos2[0]
+
+
+def test_eq_2():
+    """ Test equality of two PhotoInfo objects when one has memoized property """
+    import osxphotos
+
+    photosdb1 = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photosdb2 = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos1 = photosdb1.photos(uuid=[UUID_DICT["in_album"]])
+    photos2 = photosdb2.photos(uuid=[UUID_DICT["in_album"]])
+
+    # memoize a value
+    albums = photos1[0].albums
+    assert albums
+
     assert photos1[0] == photos2[0]
 
 
@@ -847,12 +869,39 @@ def test_from_to_date():
     photosdb = osxphotos.PhotosDB(PHOTOS_DB)
 
     photos = photosdb.photos(from_date=dt.datetime(2018, 10, 28))
-    assert len(photos) == 7
+    assert len(photos) == 6
 
     photos = photosdb.photos(to_date=dt.datetime(2018, 10, 28))
-    assert len(photos) == 6
+    assert len(photos) == 7
 
     photos = photosdb.photos(
         from_date=dt.datetime(2018, 9, 28), to_date=dt.datetime(2018, 9, 29)
     )
     assert len(photos) == 4
+
+
+def test_date_invalid():
+    """ Test date is invalid """
+    from datetime import datetime, timedelta, timezone
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos = photosdb.photos(uuid=[UUID_DICT["date_invalid"]])
+    assert len(photos) == 1
+    p = photos[0]
+    delta = timedelta(seconds=p.tzoffset)
+    tz = timezone(delta)
+    assert p.date == datetime(1970, 1, 1).astimezone(tz=tz)
+
+
+def test_date_modified_invalid():
+    """ Test date modified is invalid """
+    from datetime import datetime, timedelta, timezone
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos = photosdb.photos(uuid=[UUID_DICT["date_invalid"]])
+    assert len(photos) == 1
+    p = photos[0]
+    assert p.date_modified is None
+

tests/test_cli.py

@@ -261,6 +261,7 @@ ALBUMS_JSON = {
         "AlbumInFolder": 2,
         "Test Album": 2,
         "I have a deleted twin": 1,
+        "EmptyAlbum": 0,
     },
     "shared albums": {},
 }
@@ -354,7 +355,10 @@ def test_query_uuid():
     for key_ in json_expected:
         assert key_ in json_got
         if key_ != "path":
-            assert json_expected[key_] == json_got[key_]
+            if isinstance(json_expected[key_], list):
+                assert sorted(json_expected[key_]) == sorted(json_got[key_])
+            else:
+                assert json_expected[key_] == json_got[key_]
         else:
             assert json_expected[key_] in json_got[key_]
 

tests/test_mojave_10_14_6.py

@@ -41,6 +41,7 @@ ALBUM_DICT = {
 UUID_DICT = {
     "favorite": "6bxcNnzRQKGnK4uPrCJ9UQ",
     "not_favorite": "8SOE9s0XQVGsuq4ONohTng",
+    "date_invalid": "YZFCPY24TUySvpu7owiqxA",
 }
 
 
@@ -58,6 +59,7 @@ def test_db_version():
     assert photosdb.db_version in osxphotos._constants._TESTED_DB_VERSIONS
     assert photosdb.db_version == "4025"
 
+
 def test_db_len():
     import osxphotos
 
@@ -407,3 +409,30 @@ def test_multi_person():
     photos = photosdb.photos(persons=["Katie", "Suzy"])
 
     assert len(photos) == 3
+
+
+def test_date_invalid():
+    """ Test date is invalid """
+    from datetime import datetime, timedelta, timezone
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos = photosdb.photos(uuid=[UUID_DICT["date_invalid"]])
+    assert len(photos) == 1
+    p = photos[0]
+    delta = timedelta(seconds=p.tzoffset)
+    tz = timezone(delta)
+    assert p.date == datetime(1970, 1, 1).astimezone(tz=tz)
+
+
+def test_date_modified_invalid():
+    """ Test date modified is invalid """
+    from datetime import datetime, timedelta, timezone
+    import osxphotos
+
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+    photos = photosdb.photos(uuid=[UUID_DICT["date_invalid"]])
+    assert len(photos) == 1
+    p = photos[0]
+    assert p.date_modified is None
+

tests/test_template_today.py

@@ -0,0 +1,70 @@
+import datetime
+
+import pytest
+
+PHOTOS_DB_PLACES = (
+    "./tests/Test-Places-Catalina-10_15_1.photoslibrary/database/photos.db"
+)
+
+DATETIME_TODAY = datetime.datetime(2020, 6, 21, 13, 0, 0)
+""" Used to patch osxphotos.phototemplate.TODAY for testing """
+
+UUID_DICT = {
+    "place_dc": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
+    "1_1_2": "1EB2B765-0765-43BA-A90C-0D0580E6172C",
+    "2_1_1": "D79B8D77-BFFC-460B-9312-034F2877D35B",
+    "0_2_0": "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4",
+    "folder_album_1": "3DD2C897-F19E-4CA6-8C22-B027D5A71907",
+    "folder_album_no_folder": "D79B8D77-BFFC-460B-9312-034F2877D35B",
+    "mojave_album_1": "15uNd7%8RguTEgNPKHfTWw",
+}
+
+TODAY_VALUES = {
+    "{today.date}": "2020-06-21",
+    "{today.year}": "2020",
+    "{today.yy}": "20",
+    "{today.mm}": "06",
+    "{today.month}": "June",
+    "{today.mon}": "Jun",
+    "{today.dd}": "21",
+    "{today.dow}": "Sunday",
+    "{today.doy}": "173",
+    "{today.hour}": "13",
+    "{today.min}": "00",
+    "{today.sec}": "00",
+}
+
+
+def test_subst_today():
+    """ Test that substitutions are correct for {today.x}"""
+    import locale
+    import osxphotos
+
+    locale.setlocale(locale.LC_ALL, "en_US")
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB_PLACES)
+    photo = photosdb.photos(uuid=[UUID_DICT["place_dc"]])[0]
+
+    photo_template = osxphotos.PhotoTemplate(photo)
+    photo_template.today = DATETIME_TODAY
+
+    for template in TODAY_VALUES:
+        rendered, _ = photo_template.render(template)
+        assert rendered[0] == TODAY_VALUES[template]
+
+
+def test_subst_strftime_today():
+    """ Test that strftime substitutions are correct for {today.strftime}"""
+    import locale
+    import osxphotos
+
+    locale.setlocale(locale.LC_ALL, "en_US")
+    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB_PLACES)
+    photo = photosdb.photos(uuid=[UUID_DICT["place_dc"]])[0]
+
+    photo_template = osxphotos.PhotoTemplate(photo)
+    photo_template.today = DATETIME_TODAY
+    rendered, unmatched = photo_template.render("{today.strftime,%Y-%m-%d-%H%M%S}")
+    assert rendered[0] == "2020-06-21-130000"
+
+    rendered, unmatched = photo.render_template("{today.strftime}")
+    assert rendered[0] == "_"