Bug fix for PhotosDB.photos() query

.github/workflows/pythonpackage.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7]
+        python-version: [3.6, 3.7, 3.8]
 
     steps:
     - uses: actions/checkout@v1

CHANGELOG.md

@@ -4,6 +4,113 @@ 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.26.0](https://github.com/RhetTbull/osxphotos/compare/v0.25.1...v0.26.0)
+
+> 11 April 2020
+
+- Added test for 10.15.4 [`1820715`](https://github.com/RhetTbull/osxphotos/commit/182071584904d001a9b199eef5febfb79e00696e)
+- Changed PhotosDB albums interface as prep for adding folders [`3e50626`](https://github.com/RhetTbull/osxphotos/commit/3e5062684ab6d706d91d4abeb4e3b0ca47867b70)
+- Updated CHANGELOG.md [`a6ca3f4`](https://github.com/RhetTbull/osxphotos/commit/a6ca3f453ce0fae4e8d13c7c256ed69a16d2e3f2)
+
+#### [v0.25.1](https://github.com/RhetTbull/osxphotos/compare/v0.25.0...v0.25.1)
+
+> 5 April 2020
+
+- Added --no-extended-attributes option to CLI, closes #85 [`#85`](https://github.com/RhetTbull/osxphotos/issues/85)
+- Fixed CLI help for invalid topic, closes #76 [`#76`](https://github.com/RhetTbull/osxphotos/issues/76)
+- Updated test library [`bae0283`](https://github.com/RhetTbull/osxphotos/commit/bae0283441f04d71aa78dbd1cf014f376ef1f91a)
+
+#### [v0.25.0](https://github.com/RhetTbull/osxphotos/compare/v0.24.2...v0.25.0)
+
+> 4 April 2020
+
+- Added places, --place, --no-place to CLI, closes #87, #88 [`#87`](https://github.com/RhetTbull/osxphotos/issues/87)
+- Updated render_filepath_template to support multiple values [`6a89888`](https://github.com/RhetTbull/osxphotos/commit/6a898886ddadc9d5bc9dbad6ee7365270dd0a26d)
+- Added {album}, {keyword}, and {person} to template system [`507c4a3`](https://github.com/RhetTbull/osxphotos/commit/507c4a374014f999ca19789bce0df0c14332e021)
+- Added places command to CLI [`fd5e748`](https://github.com/RhetTbull/osxphotos/commit/fd5e748dca759ea1c3a7329d447f363afe8418b7)
+- Updated export example [`01cd7fe`](https://github.com/RhetTbull/osxphotos/commit/01cd7fed6d7fc0c61c171a05319c211eb0a9f7c1)
+- Updated CHANGELOG.md [`daea30f`](https://github.com/RhetTbull/osxphotos/commit/daea30f1626a208209ab6854cbd3b12f4b0a3405)
+
+#### [v0.24.2](https://github.com/RhetTbull/osxphotos/compare/v0.24.1...v0.24.2)
+
+> 28 March 2020
+
+- added {place.country_code} to template system [`be2e167`](https://github.com/RhetTbull/osxphotos/commit/be2e16769d5d2c75af6d7792f1311f5a65c3bc67)
+
+#### [v0.24.1](https://github.com/RhetTbull/osxphotos/compare/v0.23.4...v0.24.1)
+
+> 28 March 2020
+
+- Added detailed place data in PlaceInfo.names [`c06dd42`](https://github.com/RhetTbull/osxphotos/commit/c06dd4233f917f068c087f5604013d371b0a826a)
+- Template system now supports default values [`67a9a9e`](https://github.com/RhetTbull/osxphotos/commit/67a9a9e21bd05d01a3202b0a1279487f5d04c9d9)
+- Replaced template renderer with regex-based renderer [`427c4c0`](https://github.com/RhetTbull/osxphotos/commit/427c4c0bc49f671477866d30eee74834c67d7bc5)
+
+#### [v0.23.4](https://github.com/RhetTbull/osxphotos/compare/v0.23.3...v0.23.4)
+
+> 22 March 2020
+
+- Added export_by_album.py to examples [`908fead`](https://github.com/RhetTbull/osxphotos/commit/908fead8a2fbcef3b4a387f34d83d88c507c5939)
+- Updated CHANGELOG.md [`072e894`](https://github.com/RhetTbull/osxphotos/commit/072e894e56c4dfe5522d073b202933fed0204ef5)
+- Updated pathvalidate calls [`d066435`](https://github.com/RhetTbull/osxphotos/commit/d066435e3df4062be6a0a3d5fa7308f293e764d5)
+
+#### [v0.23.3](https://github.com/RhetTbull/osxphotos/compare/v0.23.1...v0.23.3)
+
+> 22 March 2020
+
+- Initial version of templating system for CLI [`2feb099`](https://github.com/RhetTbull/osxphotos/commit/2feb0999b3f9ffd9a24e37238f780239a027aa49)
+- Added __str__ to place [`ad58b03`](https://github.com/RhetTbull/osxphotos/commit/ad58b03f2d31daf33849b141570dd0fb5e0a262e)
+- Test library updates [`e90d9c6`](https://github.com/RhetTbull/osxphotos/commit/e90d9c6e11fce7a4e4aa348dcc5f57420c0b6c44)
+
+#### [v0.23.1](https://github.com/RhetTbull/osxphotos/compare/v0.23.0...v0.23.1)
+
+> 21 March 2020
+
+- Fixed requirements.txt for bplist2 [`cda5f44`](https://github.com/RhetTbull/osxphotos/commit/cda5f446933ea2272409d1f153e2a7811626ada6)
+- Updated CHANGELOG.md [`b8da976`](https://github.com/RhetTbull/osxphotos/commit/b8da9765b8949eb90852d249c2877eeb1806d987)
+- Updated requirements.txt [`9da7ad6`](https://github.com/RhetTbull/osxphotos/commit/9da7ad6dcc021fdafe358d74e1c52f69dc49ade8)
+
+#### [v0.23.0](https://github.com/RhetTbull/osxphotos/compare/v0.22.23...v0.23.0)
+
+> 21 March 2020
+
+- Added PhotoInfo.place for reverse geolocation data [`b338b34`](https://github.com/RhetTbull/osxphotos/commit/b338b34d5055a7621e4ebe4fbbae12227d77af6d)
+- Updated CHANGELOG.md [`816b98e`](https://github.com/RhetTbull/osxphotos/commit/816b98e617c30d0bdb51bc2413f9915742c8592e)
+- Update pythonpackage.yml [`92e5bdd`](https://github.com/RhetTbull/osxphotos/commit/92e5bdd2e986e5de2a710abf60ba0dc99c6a6730)
+
+#### [v0.22.23](https://github.com/RhetTbull/osxphotos/compare/v0.22.21...v0.22.23)
+
+> 15 March 2020
+
+- Lots of work on export code [`0940f03`](https://github.com/RhetTbull/osxphotos/commit/0940f039d3e628dc4f25c69bf27ce413807d3f71)
+- test library update [`1e08a74`](https://github.com/RhetTbull/osxphotos/commit/1e08a7449e69965a37373dadabb37c993d93fc69)
+
+#### [v0.22.21](https://github.com/RhetTbull/osxphotos/compare/v0.22.17...v0.22.21)
+
+> 15 March 2020
+
+- Working on export edited bug for issue #78 [`8542e1a`](https://github.com/RhetTbull/osxphotos/commit/8542e1a97f6b640f287b37af9e50fd05f964ec4d)
+- Fixed download-missing to only download when actually missing [`dd20b8d`](https://github.com/RhetTbull/osxphotos/commit/dd20b8d8ac3b16d3b72a26b97dcc620b11e3a7c0)
+- Updated CHANGELOG.md [`cc9220e`](https://github.com/RhetTbull/osxphotos/commit/cc9220e0763816d784f2fd8377dfe14a99981622)
+
+#### [v0.22.17](https://github.com/RhetTbull/osxphotos/compare/v0.22.16...v0.22.17)
+
+> 14 March 2020
+
+- Added MANIFEST.in [`279ab36`](https://github.com/RhetTbull/osxphotos/commit/279ab369295cfe1c778b38e212248271e4fc659e)
+- version bump [`783e097`](https://github.com/RhetTbull/osxphotos/commit/783e097da35a210a2aa5c75865a8599541b9da0b)
+
+#### [v0.22.16](https://github.com/RhetTbull/osxphotos/compare/v0.22.13...v0.22.16)
+
+> 14 March 2020
+
+- removed activate from --download-missing-photos Applescript, closes #69 [`#69`](https://github.com/RhetTbull/osxphotos/issues/69)
+- Added media type specials to json and string output, closes #68 [`#68`](https://github.com/RhetTbull/osxphotos/issues/68)
+- Added query/export options for special media types [`2b7d84a`](https://github.com/RhetTbull/osxphotos/commit/2b7d84a4d103982ad874d875bafbc34d654d539a)
+- README.md update [`a27ce33`](https://github.com/RhetTbull/osxphotos/commit/a27ce33473df3260dfb7ed26e28295cbf87d1e78)
+- Test library updates [`2d7d0b8`](https://github.com/RhetTbull/osxphotos/commit/2d7d0b86e0008cae043e314937504f36ad882990)
+- Fixed bug in --download-missing related to burst images [`1f13ba8`](https://github.com/RhetTbull/osxphotos/commit/1f13ba837fe36ff4eeb48cca02f5312a88a0a765)
+- test library update [`acb6b9e`](https://github.com/RhetTbull/osxphotos/commit/acb6b9e72f7f6b8f4f1d64b46f270a4d3e984fef)
+
 #### [v0.22.13](https://github.com/RhetTbull/osxphotos/compare/v0.22.12...v0.22.13)
 
 > 8 March 2020

README.md

@@ -13,8 +13,10 @@
   * [Package Interface](#package-interface)
     + [PhotosDB](#photosdb)
     + [PhotoInfo](#photoinfo)
+    + [PlaceInfo](#placeinfo)
+    + [Template Functions](#template-functions)
     + [Utility Functions](#utility-functions)
-    + [Examples](#examples)
+  * [Examples](#examples)
   * [Related Projects](#related-projects)
   * [Contributing](#contributing)
   * [Implementation Notes](#implementation-notes)
@@ -55,7 +57,14 @@ Then you should be able to run `osxphotos` on the command line:
 Usage: osxphotos [OPTIONS] COMMAND [ARGS]...
 
 Options:
-  --db <Photos database path>  Specify database file.
+  --db <Photos database path>  Specify Photos database path. Path to Photos
+                               library/database can be specified using either
+                               --db or directly as PHOTOS_LIBRARY positional
+                               argument. If neither --db or PHOTOS_LIBRARY
+                               provided, will attempt to find the library to
+                               use in the following order: 1. last opened
+                               library, 2. system library, 3.
+                               ~/Pictures/Photos Library.photoslibrary
   --json                       Print output in JSON format.
   -v, --version                Show the version and exit.
   -h, --help                   Show this message and exit.
@@ -69,6 +78,7 @@ Commands:
   keywords  Print out keywords found in the Photos library.
   list      Print list of Photos libraries found on the system.
   persons   Print out persons (faces) found in the Photos library.
+  places    Print out places found in the Photos library.
   query     Query the Photos database using 1 or more search options; if...
 ```
 
@@ -109,11 +119,15 @@ Options:
   --no-title                      Search for photos with no title.
   --description DESC              Search for DESC in description of photo.
   --no-description                Search for photos with no description.
+  --place PLACE                   Search for PLACE in photo's reverse
+                                  geolocation info
+  --no-place                      Search for photos with no associated place
+                                  name info (no reverse geolocation info)
   --uti UTI                       Search for photos whose uniform type
                                   identifier (UTI) matches UTI
-  -i, --ignore-case               Case insensitive search for title or
-                                  description. Does not apply to keyword,
-                                  person, or album.
+  -i, --ignore-case               Case insensitive search for title,
+                                  description, or place. Does not apply to
+                                  keyword, person, or album.
   --edited                        Search for photos that have been edited.
   --external-edit                 Search for photos edited in external editor.
   --favorite                      Search for photos marked favorite.
@@ -212,22 +226,139 @@ Options:
                                   exiftool must be installed and in the path.
                                   exiftool may be installed from
                                   https://exiftool.org/
+  --directory DIRECTORY           Optional template for specifying name of
+                                  output directory in the form
+                                  '{name,DEFAULT}'. See below for additional
+                                  details on templating system.
   -h, --help                      Show this message and exit.
+
+**Templating System**
+
+With the --directory option, you may specify a template for the export
+directory.  This directory will be appended to the export path specified in
+the export DEST argument to export.  For example, if template is
+'{created.year}/{created.month}', and export desitnation DEST is
+'/Users/maria/Pictures/export', the actual export directory for a photo would
+be '/Users/maria/Pictures/export/2020/March' if the photo was created in March
+2020.
+
+In the template, valid template substitutions will be replaced by the
+corresponding value from the table below.  Invalid substitutions will result
+in a an error and the script will abort.
+
+If you want the actual text of the template substition to appear in the
+rendered name, use double braces, e.g. '{{' or '}}', thus using
+'{created.year}/{{name}}' for --directory would result in output of
+2020/{name}/photoname.jpg
+
+You may specify an optional default value to use if the substitution does not
+contain a value (e.g. the value is null) by specifying the default value after
+a ',' in the template string: for example, if template is
+'{created.year}/{place.address,'NO_ADDRESS'}' but there was no address
+associated with the photo, the resulting output would be:
+'2020/NO_ADDRESS/photoname.jpg'. If specified, the default value may not
+contain a brace symbol ('{' or '}').
+
+If you do not specify a default value and the template substitution has no
+value, '_' (underscore) will be used as the default value. For example, in the
+above example, this would result in '2020/_/photoname.jpg' if address was null
+I plan to eventually extend the templating system to the exported filename so
+you can specify the filename using a template.
+
+Substitution                    Description
+{name}                          Filename of the photo
+{original_name}                 Photo's original filename when imported to
+                                Photos
+{title}                         Title of the photo
+{descr}                         Description of the photo
+{created.date}                  Photo's creation date in ISO format, e.g.
+                                '2020-03-22'
+{created.year}                  4-digit year of file creation time
+{created.yy}                    2-digit year of file creation time
+{created.mm}                    2-digit month of the file creation time
+                                (zero padded)
+{created.month}                 Month name in user's locale of the file
+                                creation time
+{created.mon}                   Month abbreviation in the user's locale of
+                                the file creation time
+{created.doy}                   3-digit day of year (e.g Julian day) of file
+                                creation time, starting from 1 (zero padded)
+{modified.date}                 Photo's modification date in ISO format,
+                                e.g. '2020-03-22'
+{modified.year}                 4-digit year of file modification time
+{modified.yy}                   2-digit year of file modification time
+{modified.mm}                   2-digit month of the file modification time
+                                (zero padded)
+{modified.month}                Month name in user's locale of the file
+                                modification time
+{modified.mon}                  Month abbreviation in the user's locale of
+                                the file modification time
+{modified.doy}                  3-digit day of year (e.g Julian day) of file
+                                modification time, starting from 1 (zero
+                                padded)
+{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
+{place.name.state_province}     State or province name from the photo's
+                                reverse geolocation data
+{place.name.city}               City or locality name from the photo's
+                                reverse geolocation data
+{place.name.area_of_interest}   Area of interest name (e.g. landmark or
+                                public place) from the photo's reverse
+                                geolocation data
+{place.address}                 Postal address from the photo's reverse
+                                geolocation data, e.g. '2007 18th St NW,
+                                Washington, DC 20009, United States'
+{place.address.street}          Street part of the postal address, e.g.
+                                '2007 18th St NW'
+{place.address.city}            City part of the postal address, e.g.
+                                'Washington'
+{place.address.state_province}  State/province part of the postal address,
+                                e.g. 'DC'
+{place.address.postal_code}     Postal code part of the postal address, e.g.
+                                '20009'
+{place.address.country}         Country name of the postal address, e.g.
+                                'United States'
+{place.address.country_code}    ISO country code of the postal address, e.g.
+                                'US'
+
+The following substitutions may result in multiple values. Thus if specified
+for --directory these could result in multiple copies of a photo being being
+exported, one to each directory.  For example: --directory
+'{created.year}/{album}' could result in the same photo being exported to each
+of the following directories if the photos were created in 2019 and were in
+albums 'Vacation' and 'Family': 2019/Vacation, 2019/Family
+
+Substitution  Description
+{album}       Album(s) photo is contained in
+{keyword}     Keyword(s) assigned to photo
+{person}      Person(s) / face(s) in a photo
 ```
 
 Example: export all photos to ~/Desktop/export, including edited versions and live photo movies, group in folders by date created
+
 `osxphotos export --export-edited --export-live --export-by-date ~/Pictures/Photos\ Library.photoslibrary ~/Desktop/export`
 
 **Note**: Photos library/database path can also be specified using --db option:
+
 `osxphotos export --export-edited --export-live --export-by-date --db ~/Pictures/Photos\ Library.photoslibrary ~/Desktop/export`
 
 Example: find all photos with keyword "Kids" and output results to json file named results.json:
 
 `osxphotos query --keyword Kids --json ~/Pictures/Photos\ Library.photoslibrary >results.json`
 
+Example: export photos to file structure based on 4-digit year and full name of month of photo's creation date:
+
+`osxphotos export ~/Desktop/export --directory "{created.year}/{created.month}"`
+
+
 ## Example uses of the package 
 
 ```python
+""" Simple usage of the package """
 import os.path
 
 import osxphotos
@@ -237,7 +368,7 @@ def main():
     photosdb = osxphotos.PhotosDB(db)
     print(photosdb.keywords)
     print(photosdb.persons)
-    print(photosdb.albums)
+    print(photosdb.album_names)
 
     print(photosdb.keywords_as_dict)
     print(photosdb.persons_as_dict)
@@ -268,34 +399,81 @@ if __name__ == "__main__":
 ```
 
 ```python
-""" Export all photos to ~/Desktop/export
-    If file has been edited, export the edited version, 
-    otherwise, export the original version """
+""" Export all photos to specified directory using album names as folders
+    If file has been edited, also export the edited version, 
+    otherwise, export the original version 
+    This will result in duplicate photos if photo is in more than album """
 
 import os.path
+import pathlib
+import sys
+
+import click
+from pathvalidate import is_valid_filepath, sanitize_filepath
+
 import osxphotos
 
 
-def main():
-    db = os.path.expanduser("~/Pictures/Photos Library.photoslibrary")
-    photosdb = osxphotos.PhotosDB(db)
-    photos = photosdb.photos()
+@click.command()
+@click.argument("export_path", type=click.Path(exists=True))
+@click.option(
+    "--default-album",
+    help="Default folder for photos with no album. Defaults to 'unfiled'",
+    default="unfiled",
+)
+@click.option(
+    "--library-path",
+    help="Path to Photos library, default to last used library",
+    default=None,
+)
+def export(export_path, default_album, library_path):
+    export_path = os.path.expanduser(export_path)
+    library_path = os.path.expanduser(library_path) if library_path else None
 
-    export_path = os.path.expanduser("~/Desktop/export")
+    if library_path is not None:
+        photosdb = osxphotos.PhotosDB(library_path)
+    else:
+        photosdb = osxphotos.PhotosDB()
+
+    photos = photosdb.photos()
 
     for p in photos:
         if not p.ismissing:
-            if p.hasadjustments:
-                exported = p.export(export_path, edited=True)
-            else:
-                exported = p.export(export_path)
-            print(f"Exported {p.filename} to {exported}")
+            albums = p.albums
+            if not albums:
+                albums = [default_album]
+            for album in albums:
+                click.echo(f"exporting {p.filename} in album {album}")
+
+                # make sure no invalid characters in destination path (could be in album name)
+                album_name = sanitize_filepath(album, platform="auto")
+
+                # create destination folder, if necessary, based on album name
+                dest_dir = os.path.join(export_path, album_name)
+
+                # verify path is a valid path
+                if not is_valid_filepath(dest_dir, platform="auto"):
+                    sys.exit(f"Invalid filepath {dest_dir}")
+
+                # create destination dir if needed
+                if not os.path.isdir(dest_dir):
+                    os.makedirs(dest_dir)
+
+                # export the photo
+                if p.hasadjustments:
+                    # export edited version
+                    exported = p.export(dest_dir, edited=True)
+                    edited_name = pathlib.Path(p.path_edited).name
+                    click.echo(f"Exported {edited_name} to {exported}")
+                # export unedited version
+                exported = p.export(dest_dir)
+                click.echo(f"Exported {p.filename} to {exported}")
         else:
-            print(f"Skipping missing photo: {p.filename}")
+            click.echo(f"Skipping missing photo: {p.filename}")
 
 
 if __name__ == "__main__":
-    main()
+    export()  # pylint: disable=no-value-for-parameter
 ```
 
 ## Package Interface
@@ -376,17 +554,17 @@ keywords = photosdb.keywords
 
 Returns a list of the keywords found in the Photos library
 
-#### `albums`
+#### `album_names`
 ```python
 # assumes photosdb is a PhotosDB object (see above)
-albums = photosdb.albums
+albums = photosdb.album_names
 ```
 
 Returns a list of the albums found in the Photos library.  
 
 **Note**: In Photos 5.0 (MacOS 10.15/Catalina), It is possible to have more than one album with the same name in Photos.  Albums with duplicate names are treated as a single album and the photos in each are combined.  For example, if you have two albums named "Wedding" and each has 2 photos, osxphotos will treat this as a single album named "Wedding" with 4 photos in it.
 
-#### `albums_shared`
+#### `album_names_shared`
 
 Returns list of shared albums found in photos database (e.g. albums shared via iCloud photo sharing)
 
@@ -632,6 +810,9 @@ Returns `True` if the picture has been marked as hidden, otherwise `False`
 #### `location`
 Returns latitude and longitude as a tuple of floats (latitude, longitude).  If location is not set, latitude and longitude are returned as `None`
 
+#### `place`
+Returns a [PlaceInfo](#PlaceInfo) object with reverse geolocation data or None if there is the photo has no reverse geolocation information.
+
 #### `shared`
 Returns True if photo is in a shared album, otherwise False.
 
@@ -711,11 +892,11 @@ Returns True if photo is a panorama, otherwise False.
 #### `json()`
 Returns a JSON representation of all photo info 
 
-#### `export(dest, *filename, edited=False, live_photo=False, overwrite=False, increment=True, sidecar_json=False, sidecar_xmp=False, use_photos_export=False, timeout=120, exiftool=False)`
+#### `export(dest, *filename, edited=False, live_photo=False, overwrite=False, increment=True, sidecar_json=False, sidecar_xmp=False, use_photos_export=False, timeout=120, exiftool=False, no_xattr=False)`
 
 Export photo from the Photos library to another destination on disk.  
 - dest: must be valid destination path as str (or exception raised).
-- *filename (optional): name of picture as str; if not provided, will use current filename
+- *filename (optional): name of picture as str; if not provided, will use current filename.  **NOTE**: if provided, user must ensure file extension (suffix) is correct. For example, if photo is .CR2 file, edited image may be .jpeg.  If you provide an extension different than what the actual file is, export will print a warning but will happily export the photo using the incorrect file extension.  e.g. to get the extension of the edited photo, look at [PhotoInfo.path_edited](#path_edited).
 - edited: boolean; if True (default=False), will export the edited version of the photo (or raise exception if no edited version)
 - overwrite: boolean; if True (default=False), will overwrite files if they alreay exist
 - live_photo: boolean; if True (default=False), will also export the associted .mov for live photos; exported live photo will be named filename.mov
@@ -725,6 +906,9 @@ Export photo from the Photos library to another destination on disk.
 - use_photos_export: boolean; (default=False), if True will attempt to export photo via applescript interaction with Photos; useful for forcing download of missing photos.  This only works if the Photos library being used is the default library (last opened by Photos) as applescript will directly interact with whichever library Photos is currently using.
 - timeout: (int, default=120) timeout in seconds used with use_photos_export
 - exiftool: (boolean, default = False) if True, will use [exiftool](https://exiftool.org/) to write metadata directly to the exported photo; exiftool must be installed and in the system path
+- no_xattr: (boolean, default = False); if True, exports file without preserving extended attributes
+
+Returns: list of paths to exported files. More than one file could be exported, for example if live_photo=True, both the original imaage and the associated .mov file will be exported
 
 The json sidecar file can be used by exiftool to apply the metadata from the json file to the image.  For example: 
 
@@ -742,40 +926,181 @@ Then
 
 If overwrite=False and increment=False, export will fail if destination file already exists
 
-Returns the full path to the exported file
-
 **Implementation Note**: Because the usual python file copy methods don't preserve all the metadata available on MacOS, export uses /usr/bin/ditto to do the copy for export. ditto preserves most metadata such as extended attributes, permissions, ACLs, etc.
 
+### PlaceInfo
+[PhotoInfo.place](#place) returns a PlaceInfo object if the photo contains valid reverse geolocation information.  PlaceInfo has the following properties.  
+
+**Note** For Photos versions <= 4, only `name`, `names`, and `country_code` properties are defined.  All others return `None`.  This is because older versions of Photos do not store the more detailed reverse geolocation information.
+
+#### `ishome`
+Returns `True` if photo place is user's home address, otherwise `False`.
+
+#### `name`
+Returns the name of the local place as str.  This is what Photos displays in the Info window.  **Note** Photos 5 uses a different algorithm to determine the name than earlier versions which means the same Photo may have a different place name in Photos 4 and Photos 5. `PhotoInfo.name` will return the name Photos would have shown depending on the version of the library being processed.  In Photos 5, the place name is generally more detailed than in earlier versions of Photos.
+
+For example, I have photo in my library that under Photos 4, has place name of "‎⁨Mayfair Shopping Centre⁩, ⁨Victoria⁩, ⁨Canada⁩" and under Photos 5 the same photo has place name of "Mayfair⁩, ⁨Vancouver Island⁩, ⁨Victoria⁩, ⁨British Columbia⁩, ⁨Canada⁩".
+
+Returns `None` if photo does not contain a name.
+
+#### `names`
+Returns a `PlaceNames` namedtuple with the following fields.  Each field is a list with zero or more values, sorted by area in ascending order.  E.g. `names.area_of_interest` could be ['Gulf Islands National Seashore', 'Santa Rosa Island'], ["Knott's Berry Farm"], or [] if `area_of_interest` not defined.  The value shown in Photos is the first value in the list. With the exception of `body_of_water` each of these field corresponds to an attribute of a [CLPlacemark](https://developer.apple.com/documentation/corelocation/clplacemark) object.  **Note** The `PlaceNames` namedtuple contains reserved fields not listed below (see implementation for details), thus it should be referenced only by name (e.g. `names.city`) and not by index.
+
+- `country`; the name of the country associated with the placemark.
+- `state_province`; administrativeArea, The state or province associated with the placemark.
+- `sub_administrative_area`; additional administrative area information for the placemark.
+- `city`; locality; the city associated with the placemark.
+- `additional_city_info`; subLocality, Additional city-level information for the placemark.
+- `ocean`; the name of the ocean associated with the placemark.
+- `area_of_interest`; areasOfInterest, The relevant areas of interest associated with the placemark.
+- `inland_water`; the name of the inland water body associated with the placemark.
+- `region`; the geographic region associated with the placemark.
+- `sub_throughfare`; additional street-level information for the placemark.
+- `postal_code`; the postal code associated with the placemark.
+- `street_address`; throughfare, The street address associated with the placemark.
+- `body_of_water`; in Photos 4, any body of water; in Photos 5 contains the union of ocean and inland_water
+
+**Note**: In Photos <= 4.0, only the following fields are defined; all others are set to empty list:
+
+- `country`
+- `state_province`
+- `sub_administrative_area`
+- `city` 
+- `additional_city_info`
+- `area_of_interest`
+- `body_of_water`
+
+#### `country_code`
+Returns the country_code of place, for example "GB".  Returns `None` if PhotoInfo contains no country code.
+
+#### `address_str`
+Returns the full postal address as a string if defined, otherwise `None`.
+
+For example: "2038 18th St NW, Washington, DC  20009, United States"
+
+#### `address`:
+Returns a `PostalAddress` namedtuple with details of the postal address containing the following fields:
+- `city`
+- `country`
+- `postal_code`
+- `state`
+- `street`
+- `sub_administrative_area`
+- `sub_locality`
+- `iso_country_code`
+
+For example:
+```python
+>>> 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
+'96753'
+```
+
+### Template Functions
+
+There is a simple template system used by the command line client to specify the output directory using a template.  The following are available in `osxphotos.template`.
+
+#### `render_filepath_template(template, photo, none_str="_")`
+Render template string for photo.  none_str is used if template substitution results in None value and no default specified. 
+- `template`: str in form "{name,DEFAULT}" where name is one of the values in table below. The "," and default value that follows are optional. If specified, "DEFAULT" will be used if "name" is None.  This is useful for values which are not always present, for example reverse geolocation data.
+- `photo`: a [PhotoInfo](#photoinfo) object
+- `none_str`: optional str to use as substitution when template value is None and no default specified in the template string.  default is "_".
+
+Returns a tuple of (rendered, unmatched) where rendered is a list of rendered strings with all substitutions made and unmatched is a list of any strings that resembled a template substitution but did not match a known substitution. E.g. if template contained "{foo}", unmatched would be ["foo"].
+
+e.g. `render_filepath_template("{created.year}/{foo}", photo)` would return `(["2020/{foo}"],["foo"])`
+
+If you want to include "{" or "}" in the output, use "{{" or "}}"
+
+e.g. `render_filepath_template("{created.year}/{{foo}}", photo)` would return `(["2020/{foo}"],[])`
+
+Some substitutions, notably `album`, `keyword`, and `person` could return multiple values, hence a new string will be return for each possible substitution (hence why a list of rendered strings is returned).  For example, a photo in 2 albums: 'Vacation' and 'Family' would result in the following rendered values if template was "{created.year}/{album}" and created.year == 2020: `["2020/Vacation","2020/Family"]` 
+
+
+| Substitution | Description |
+|--------------|-------------|
+|{name}|Filename of the photo|
+|{original_name}|Photo's original filename when imported to Photos|
+|{title}|Title of the photo|
+|{descr}|Description of the photo|
+|{created.date}|Photo's creation date in ISO format, e.g. '2020-03-22'|
+|{created.year}|4-digit year of file creation time|
+|{created.yy}|2-digit year of file creation time|
+|{created.mm}|2-digit month of the file creation time (zero padded)|
+|{created.month}|Month name in user's locale of the file creation time|
+|{created.mon}|Month abbreviation in the user's locale of the file creation time|
+|{created.doy}|3-digit day of year (e.g Julian day) of file creation time, starting from 1 (zero padded)|
+|{modified.date}|Photo's modification date in ISO format, e.g. '2020-03-22'|
+|{modified.year}|4-digit year of file modification time|
+|{modified.yy}|2-digit year of file modification time|
+|{modified.mm}|2-digit month of the file modification time (zero padded)|
+|{modified.month}|Month name in user's locale of the file modification time|
+|{modified.mon}|Month abbreviation in the user's locale of the file modification time|
+|{modified.doy}|3-digit day of year (e.g Julian day) of file modification time, starting from 1 (zero padded)|
+|{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|
+|{place.name.state_province}|State or province name from the photo's reverse geolocation data|
+|{place.name.city}|City or locality name from the photo's reverse geolocation data|
+|{place.name.area_of_interest}|Area of interest name (e.g. landmark or public place) from the photo's reverse geolocation data|
+|{place.address}|Postal address from the photo's reverse geolocation data, e.g. '2007 18th St NW, Washington, DC 20009, United States'|
+|{place.address.street}|Street part of the postal address, e.g. '2007 18th St NW'|
+|{place.address.city}|City part of the postal address, e.g. 'Washington'|
+|{place.address.state_province}|State/province part of the postal address, e.g. 'DC'|
+|{place.address.postal_code}|Postal code part of the postal address, e.g. '20009'|
+|{place.address.country}|Country name of the postal address, e.g. 'United States'|
+|{place.address.country_code}|ISO country code of the postal address, e.g. 'US'|
+|{album}|Album(s) photo is contained in|
+|{keyword}|Keyword(s) assigned to photo|
+|{person}|Person(s) / face(s) in a photo|
+
+
+#### `DateTimeFormatter(dt)`
+Class that provides easy access to formatted datetime values.
+- `dt`: a datetime.datetime object
+
+Returnes `DateTimeFormater` class.
+
+Has the following properties:
+- `date`: Date in ISO format without timezone, e.g. "2020-03-04"
+- `year`: 4-digit year
+- `yy`: 2-digit year
+- `month`: month name in user's locale
+- `mon`: month abbreviation in user's locale
+- `mm`: 2-digit month
+- `doy`: 3-digit day of year (e.g. Julian day)
+
 ### Utility Functions
 
 The following functions are located in osxphotos.utils
 
-#### ```get_system_library_path()```
+#### `get_system_library_path()`
 
 **MacOS 10.15 Only** Returns path to System Photo Library as string.  On MacOS version < 10.15, returns None.
 
-#### ```get_last_library_path()```
+#### `get_last_library_path()`
 
 Returns path to last opened Photo Library as string.  
 
-#### ```list_photo_libraries()```
+#### `list_photo_libraries()`
 
 Returns list of Photos libraries found on the system.  **Note**: On MacOS 10.15, this appears to list all libraries. On older systems, it may not find some libraries if they are not located in ~/Pictures.  Provided for convenience but do not rely on this to find all libraries on the system.
 
-#### ```dd_to_dms_str(lat, lon)```
+#### `dd_to_dms_str(lat, lon)`
 Convert latitude, longitude in degrees to degrees, minutes, seconds as string.
-lat: latitude in degrees
-lon: longitude in degrees
+- `lat`: latitude in degrees
+- `lon`: longitude in degrees
 returns: string tuple in format ("51 deg 30' 12.86\\" N", "0 deg 7' 54.50\\" W")
 This is the same format used by exiftool's json format.
 
-#### ```create_path_by_date(dest, dt)```
+#### `create_path_by_date(dest, dt)`
 Creates a path in dest folder in form dest/YYYY/MM/DD/
-dest: valid path as str
-dt: datetime.timetuple() object
+- `dest`: valid path as str
+- `dt`: datetime.timetuple() object
 Checks to see if path exists, if it does, do nothing and return path. If path does not exist, creates it and returns path.  Useful for exporting photos to a date-based folder structure.
 
-### Examples
+## Examples
 
 ```python
 import osxphotos
@@ -788,7 +1113,7 @@ def main():
 
     print(photosdb.keywords)
     print(photosdb.persons)
-    print(photosdb.albums)
+    print(photosdb.album_names)
 
     print(photosdb.keywords_as_dict)
     print(photosdb.persons_as_dict)
@@ -829,7 +1154,13 @@ if __name__ == "__main__":
 
 ## Related Projects
 
-[photosmeta](https://github.com/rhettbull/photosmeta): uses osxphotos and [exiftool](https://exiftool.org/) to apply metadata from Photos as exif data in the photo files.  Can also export photos while preserving metadata and also apply Photos keywords as spotlight tags to make it easier to search for photos using spotlight.
+- [rhettbull/photosmeta](https://github.com/rhettbull/photosmeta): uses osxphotos and [exiftool](https://exiftool.org/) to apply metadata from Photos as exif data in the photo files.  Can also export photos while preserving metadata and also apply Photos keywords as spotlight tags to make it easier to search for photos using spotlight.  This is mostly made obsolete by osxphotos.  The one feature that photosmeta has that osxphotos does not is ability to update the metadata of the actual photo files in the Photos library without exporting them. (Use with caution!)
+- [patrikhson/photo-export](https://github.com/patrikhson/photo-export): Exports older versions of Photos databases.  Provided the inspiration for osxphotos.
+- [orangeturtle739/photos-export](https://github.com/orangeturtle739/photos-export): Set of scripts to export Photos libraries.
+- [ndbroadbent/icloud_photos_downloader](https://github.com/ndbroadbent/icloud_photos_downloader): Download photos from iCloud.  Currently unmaintained.
+- [AaronVanGeffen/ExportPhotosLibrary](https://github.com/AaronVanGeffen/ExportPhotosLibrary): Another python script for exporting older versions of Photos libraries.
+- [MossieurPropre/PhotosAlbumExporter](https://github.com/MossieurPropre/PhotosAlbumExporter): Javascript script to export photos while maintaining album structure.
+- [ajslater/magritte](https://github.com/ajslater/magritte): Another python command line script for exporting photos from older versions of Photos libraries.
 
 ## Contributing
 
@@ -854,6 +1185,8 @@ Apple does provide a framework ([PhotoKit](https://developer.apple.com/documenta
 - [PyYAML](https://pypi.org/project/PyYAML/)
 - [Click](https://pypi.org/project/click/)
 - [Mako](https://www.makotemplates.org/)
+- [bpylist2](https://pypi.org/project/bpylist2/)
+- [pathvalidate](https://pypi.org/project/pathvalidate/)
 
 ## Acknowledgements
 This project was originally inspired by [photo-export](https://github.com/patrikhson/photo-export) by Patrick Fältström,  Copyright (c) 2015 Patrik Fältström paf@frobbit.se

examples/examples.py

@@ -14,7 +14,7 @@ def main():
 
     print(photosdb.keywords)
     print(photosdb.persons)
-    print(photosdb.albums)
+    print(photosdb.album_names)
 
     print(photosdb.keywords_as_dict)
     print(photosdb.persons_as_dict)

examples/export_by_album.py

@@ -0,0 +1,86 @@
+""" Export all photos to specified directory using album names as folders
+    If file has been edited, also export the edited version, 
+    otherwise, export the original version 
+    This will result in duplicate photos if photo is in more than album """
+
+import os.path
+import pathlib
+import sys
+
+import click
+from pathvalidate import is_valid_filepath, sanitize_filepath
+
+import osxphotos
+
+
+@click.command()
+@click.argument("export_path", type=click.Path(exists=True))
+@click.option(
+    "--default-album",
+    help="Default folder for photos with no album. Defaults to 'unfiled'",
+    default="unfiled",
+)
+@click.option(
+    "--library-path",
+    help="Path to Photos library, default to last used library",
+    default=None,
+)
+@click.option(
+    "--edited",
+    help="Also export edited versions of photos (default is originals only)",
+    is_flag=True,
+    default=False,
+)
+def export(export_path, default_album, library_path, edited):
+    """ Export all photos, organized by album """
+    export_path = os.path.expanduser(export_path)
+    library_path = os.path.expanduser(library_path) if library_path else None
+
+    if library_path is not None:
+        photosdb = osxphotos.PhotosDB(library_path)
+    else:
+        photosdb = osxphotos.PhotosDB()
+
+    photos = photosdb.photos()
+
+    for p in photos:
+        if not p.ismissing:
+            albums = p.albums
+            if not albums:
+                albums = [default_album]
+            for album in albums:
+                click.echo(f"exporting {p.original_filename} in album {album}")
+
+                # make sure no invalid characters in destination path (could be in album name)
+                album_name = sanitize_filepath(album, platform="auto")
+
+                # create destination folder, if necessary, based on album name
+                dest_dir = os.path.join(export_path, album_name)
+
+                # verify path is a valid path
+                if not is_valid_filepath(dest_dir, platform="auto"):
+                    sys.exit(f"Invalid filepath {dest_dir}")
+
+                # create destination dir if needed
+                if not os.path.isdir(dest_dir):
+                    os.makedirs(dest_dir)
+
+                filename = p.original_filename
+                # export the photo but only if --edited, photo has adjustments, and 
+                # path_edited is not None (can be None if edited photo is missing)
+                if edited and p.hasadjustments and p.path_edited:
+                    # export edited version
+                    # use original filename with _edited appended but make sure suffix is 
+                    # same as edited file
+                    edited_filename = f"{pathlib.Path(filename).stem}_edited{pathlib.Path(p.path_edited).suffix}"
+                    exported = p.export(dest_dir, edited_filename, edited=True)
+                    click.echo(f"Exported {edited_filename} to {exported}")
+                # export unedited version
+                exported = p.export(dest_dir, filename)
+                click.echo(f"Exported {filename} to {exported}")
+        else:
+            click.echo(f"Skipping missing photo: {p.original_filename} in album {album}")
+
+
+if __name__ == "__main__":
+    export()  # pylint: disable=no-value-for-parameter

osxphotos/__main__.py

@@ -1,6 +1,7 @@
 import csv
 import datetime
 import json
+import logging
 import os
 import os.path
 import pathlib
@@ -8,13 +9,24 @@ import sys
 
 import click
 import yaml
+from pathvalidate import (
+    is_valid_filename,
+    is_valid_filepath,
+    sanitize_filepath,
+    sanitize_filename,
+)
 
 import osxphotos
 
-from ._constants import _EXIF_TOOL_URL, _PHOTOS_5_VERSION
+from ._constants import _EXIF_TOOL_URL, _PHOTOS_5_VERSION, _UNKNOWN_PLACE
 from ._version import __version__
-from .utils import create_path_by_date, _copy_file
 from .exiftool import get_exiftool_path
+from .template import (
+    render_filepath_template,
+    TEMPLATE_SUBSTITUTIONS,
+    TEMPLATE_SUBSTITUTIONS_MULTI_VALUED,
+)
+from .utils import _copy_file, create_path_by_date
 
 
 def get_photos_db(*db_options):
@@ -59,6 +71,86 @@ class CLI_Obj:
         self.json = json
 
 
+class ExportCommand(click.Command):
+    """ Custom click.Command that overrides get_help() to show additional help info for export """
+
+    def get_help(self, ctx):
+        help_text = super().get_help(ctx)
+        formatter = click.HelpFormatter()
+
+        formatter.write("\n\n")
+        # passed to click.HelpFormatter.write_dl for formatting
+        formatter.write_text("**Templating System**")
+        formatter.write("\n")
+        formatter.write_text(
+            "With the --directory option, you may specify a template for the "
+            + "export directory.  This directory will be appended to the export path specified "
+            + "in the export DEST argument to export.  For example, if template is "
+            + "'{created.year}/{created.month}', and export desitnation DEST is "
+            + "'/Users/maria/Pictures/export', "
+            + "the actual export directory for a photo would be '/Users/maria/Pictures/export/2020/March' "
+            + "if the photo was created in March 2020. "
+        )
+        formatter.write("\n")
+        formatter.write_text(
+            "In the template, valid template substitutions will be replaced by "
+            + "the corresponding value from the table below.  Invalid substitutions will result in a "
+            + "an error and the script will abort."
+        )
+        formatter.write("\n")
+        formatter.write_text(
+            "If you want the actual text of the template substition to appear "
+            + "in the rendered name, use double braces, e.g. '{{' or '}}', thus "
+            + "using '{created.year}/{{name}}' for --directory "
+            + "would result in output of 2020/{name}/photoname.jpg"
+        )
+        formatter.write("\n")
+        formatter.write_text(
+            "You may specify an optional default value to use if the substitution does not contain a value "
+            + "(e.g. the value is null) "
+            + "by specifying the default value after a ',' in the template string: "
+            + "for example, if template is '{created.year}/{place.address,'NO_ADDRESS'}' "
+            + "but there was no address associated with the photo, the resulting output would be: "
+            + "'2020/NO_ADDRESS/photoname.jpg'. "
+            + "If specified, the default value may not contain a brace symbol ('{' or '}')."
+        )
+        formatter.write("\n")
+        formatter.write_text(
+            "If you do not specify a default value and the template substitution "
+            + "has no value, '_' (underscore) will be used as the default value. For example, in the "
+            + "above example, this would result in '2020/_/photoname.jpg' if address was null"
+        )
+        formatter.write_text(
+            "I plan to eventually extend the templating system "
+            + "to the exported filename so you can specify the filename using a template."
+        )
+
+        formatter.write("\n")
+        templ_tuples = [("Substitution", "Description")]
+        templ_tuples.extend((k, v) for k, v in TEMPLATE_SUBSTITUTIONS.items())
+        formatter.write_dl(templ_tuples)
+
+        formatter.write("\n")
+        formatter.write_text(
+            "The following substitutions may result in multiple values. Thus "
+            + "if specified for --directory these could result in multiple copies of a photo being "
+            + "being exported, one to each directory.  For example: "
+            + "--directory '{created.year}/{album}' could result in the same photo being exported "
+            + "to each of the following directories if the photos were created in 2019 "
+            + "and were in albums 'Vacation' and 'Family': "
+            + "2019/Vacation, 2019/Family"
+        )
+        formatter.write("\n")
+        templ_tuples = [("Substitution", "Description")]
+        templ_tuples.extend(
+            (k, v) for k, v in TEMPLATE_SUBSTITUTIONS_MULTI_VALUED.items()
+        )
+
+        formatter.write_dl(templ_tuples)
+        help_text += formatter.getvalue()
+        return help_text
+
+
 CTX_SETTINGS = dict(help_option_names=["-h", "--help"])
 DB_OPTION = click.option(
     "--db",
@@ -141,6 +233,18 @@ def query_options(f):
             is_flag=True,
             help="Search for photos with no description.",
         ),
+        o(
+            "--place",
+            metavar="PLACE",
+            default=None,
+            multiple=True,
+            help="Search for PLACE in photo's reverse geolocation info",
+        ),
+        o(
+            "--no-place",
+            is_flag=True,
+            help="Search for photos with no associated place name info (no reverse geolocation info)",
+        ),
         o(
             "--uti",
             metavar="UTI",
@@ -152,7 +256,7 @@ def query_options(f):
             "-i",
             "--ignore-case",
             is_flag=True,
-            help="Case insensitive search for title or description. Does not apply to keyword, person, or album.",
+            help="Case insensitive search for title, description, or place. Does not apply to keyword, person, or album.",
         ),
         o("--edited", is_flag=True, help="Search for photos that have been edited."),
         o(
@@ -406,6 +510,56 @@ def info(ctx, cli_obj, db, json_, photos_library):
         click.echo(yaml.dump(info, sort_keys=False))
 
 
+@cli.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def places(ctx, cli_obj, db, json_, photos_library):
+    """ Print out places found in the Photos library. """
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(cli.commands["places"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    place_names = {}
+    for photo in photosdb.photos(movies=True):
+        if photo.place:
+            try:
+                place_names[photo.place.name] += 1
+            except:
+                place_names[photo.place.name] = 1
+        else:
+            try:
+                place_names[_UNKNOWN_PLACE] += 1
+            except:
+                place_names[_UNKNOWN_PLACE] = 1
+
+    # sort by place count
+    places = {
+        "places": {
+            name: place_names[name]
+            for name in sorted(
+                place_names.keys(), key=lambda key: place_names[key], reverse=True
+            )
+        }
+    }
+
+    # below needed for to make CliRunner work for testing
+    cli_json = cli_obj.json if cli_obj is not None else None
+    if json_ or cli_json:
+        click.echo(json.dumps(places))
+    else:
+        click.echo(yaml.dump(places, sort_keys=False))
+
+
 @cli.command()
 @DB_OPTION
 @JSON_OPTION
@@ -560,6 +714,8 @@ def query(
     not_selfie,
     panorama,
     not_panorama,
+    place,
+    no_place,
 ):
     """ Query the Photos database using 1 or more search options; 
         if more than one option is provided, they are treated as "AND" 
@@ -597,6 +753,7 @@ def query(
         (hdr, not_hdr),
         (selfie, not_selfie),
         (panorama, not_panorama),
+        (any(place), no_place),
     ]
     # print help if no non-exclusive term or a double exclusive term is given
     if not any(nonexclusive + [b ^ n for b, n in exclusive]):
@@ -667,6 +824,8 @@ def query(
         not_selfie=not_selfie,
         panorama=panorama,
         not_panorama=not_panorama,
+        place=place,
+        no_place=no_place,
     )
 
     # below needed for to make CliRunner work for testing
@@ -674,7 +833,7 @@ def query(
     print_photo_info(photos, cli_json or json_)
 
 
-@cli.command()
+@cli.command(cls=ExportCommand)
 @DB_OPTION
 @query_options
 @click.option("--verbose", "-V", is_flag=True, help="Print verbose output.")
@@ -746,6 +905,21 @@ def query(
     "To use this option, exiftool must be installed and in the path.  "
     "exiftool may be installed from https://exiftool.org/",
 )
+@click.option(
+    "--directory",
+    metavar="DIRECTORY",
+    default=None,
+    help="Optional template for specifying name of output directory in the form '{name,DEFAULT}'. "
+    "See below for additional details on templating system.",
+)
+@click.option(
+    "--no-extended-attributes",
+    is_flag=True,
+    default=False,
+    help="Don't copy extended attributes when exporting.  You only need this if exporting "
+    "to a filesystem that doesn't support Mac OS extended attributes.  Only use this if you get "
+    "an error while exporting.",
+)
 @DB_ARGUMENT
 @click.argument("dest", nargs=1, type=click.Path(exists=True))
 @click.pass_obj
@@ -806,6 +980,10 @@ def export(
     not_selfie,
     panorama,
     not_panorama,
+    directory,
+    place,
+    no_place,
+    no_extended_attributes,
 ):
     """ Export photos from the Photos database.
         Export path DEST is required.
@@ -834,6 +1012,8 @@ def export(
         (hdr, not_hdr),
         (selfie, not_selfie),
         (panorama, not_panorama),
+        (export_by_date, directory),
+        (any(place), no_place),
     ]
     if any([all(bb) for bb in exclusive]):
         click.echo(cli.commands["export"].get_help(ctx), err=True)
@@ -914,6 +1094,8 @@ def export(
         not_selfie=not_selfie,
         panorama=panorama,
         not_panorama=not_panorama,
+        place=place,
+        no_place=no_place,
     )
 
     if photos:
@@ -943,10 +1125,12 @@ def export(
                         export_live,
                         download_missing,
                         exiftool,
+                        directory,
+                        no_extended_attributes,
                     )
         else:
             for p in photos:
-                export_path = export_photo(
+                export_paths = export_photo(
                     p,
                     dest,
                     verbose,
@@ -958,9 +1142,11 @@ def export(
                     export_live,
                     download_missing,
                     exiftool,
+                    directory,
+                    no_extended_attributes,
                 )
-                if export_path:
-                    click.echo(f"Exported {p.filename} to {export_path}")
+                if export_paths:
+                    click.echo(f"Exported {p.filename} to {export_paths}")
                 else:
                     click.echo(f"Did not export missing file {p.filename}")
     else:
@@ -974,9 +1160,12 @@ def help(ctx, topic, **kw):
     """ Print help; for help on commands: help <command>. """
     if topic is None:
         click.echo(ctx.parent.get_help())
-    else:
+    elif topic in cli.commands:
         ctx.info_name = topic
-        click.echo(cli.commands[topic].get_help(ctx))
+        click.echo_via_pager(cli.commands[topic].get_help(ctx))
+    else:
+        click.echo(f"Invalid command: {topic}", err=True)
+        click.echo(ctx.parent.get_help())
 
 
 def print_photo_info(photos, json=False):
@@ -1124,6 +1313,8 @@ def _query(
     not_selfie=None,
     panorama=None,
     not_panorama=None,
+    place=None,
+    no_place=None,
 ):
     """ run a query against PhotosDB to extract the photos based on user supply criteria """
     """ used by query and export commands """
@@ -1158,7 +1349,7 @@ def _query(
 
     if description:
         # search description field for text
-        # if more than one, find photos with all name values in description
+        # if more than one, find photos with all description values in description
         if ignore_case:
             # case-insensitive
             for d in description:
@@ -1172,6 +1363,40 @@ def _query(
     elif no_description:
         photos = [p for p in photos if not p.description]
 
+    if place:
+        # search place.names for text matching place
+        # if more than one place, find photos with all place values in description
+        if ignore_case:
+            # case-insensitive
+            for place_name in place:
+                place_name = place_name.lower()
+                photos = [
+                    p
+                    for p in photos
+                    if p.place
+                    and any(
+                        pname
+                        for pname in p.place.names
+                        if any(
+                            pvalue for pvalue in pname if place_name in pvalue.lower()
+                        )
+                    )
+                ]
+        else:
+            for place_name in place:
+                photos = [
+                    p
+                    for p in photos
+                    if p.place
+                    and any(
+                        pname
+                        for pname in p.place.names
+                        if any(pvalue for pvalue in pname if place_name in pvalue)
+                    )
+                ]
+    elif no_place:
+        photos = [p for p in photos if not p.place]
+
     if edited:
         photos = [p for p in photos if p.hasadjustments]
 
@@ -1276,6 +1501,8 @@ def export_photo(
     export_live,
     download_missing,
     exiftool,
+    directory,
+    no_extended_attributes,
 ):
     """ Helper function for export that does the actual export
         photo: PhotoInfo object
@@ -1289,9 +1516,15 @@ def export_photo(
                      live video will have same name as photo but with .mov extension
         download_missing: attempt download of missing iCloud photos
         exiftool: use exiftool to write EXIF metadata directly to exported photo
-        returns destination path of exported photo or None if photo was missing 
+        directory: template used to determine output directory
+        no_extended_attributes: boolean; if True, exports photo without preserving extended attributes
+        returns list of path(s) of exported photo or None if photo was missing 
     """
 
+    # Can export to multiple paths
+    # Start with single path [dest] but direcotry and export_by_date will modify dest_paths
+    dest_paths = [dest]
+
     if not download_missing:
         if photo.ismissing:
             space = " " if not verbose else ""
@@ -1321,7 +1554,25 @@ def export_photo(
 
     if export_by_date:
         date_created = photo.date.timetuple()
-        dest = create_path_by_date(dest, date_created)
+        dest_path = create_path_by_date(dest, date_created)
+        dest_paths = [dest_path]
+    elif directory:
+        # got a directory template, render it and check results are valid
+        dirnames, unmatched = render_filepath_template(directory, photo)
+        if unmatched:
+            raise click.BadOptionUsage(
+                "directory",
+                f"Invalid substitution in template '{directory}': {unmatched}",
+            )
+        dest_paths = []
+        for dirname in dirnames:
+            dirname = sanitize_filepath(dirname, platform="auto")
+            if not is_valid_filepath(dirname, platform="auto"):
+                raise ValueError(f"Invalid file path: {dirname}")
+            dest_path = os.path.join(dest, dirname)
+            if not os.path.isdir(dest_path):
+                os.makedirs(dest_path)
+            dest_paths.append(dest_path)
 
     sidecar = [s.lower() for s in sidecar]
     sidecar_json = sidecar_xmp = False
@@ -1330,40 +1581,64 @@ def export_photo(
     if "xmp" in sidecar:
         sidecar_xmp = True
 
-    photo_path = photo.export(
-        dest,
-        filename,
-        sidecar_json=sidecar_json,
-        sidecar_xmp=sidecar_xmp,
-        live_photo=export_live,
-        overwrite=overwrite,
-        use_photos_export=download_missing,
-        exiftool=exiftool,
+    # if download_missing and the photo is missing or path doesn't exist,
+    # try to download with Photos
+    use_photos_export = download_missing and (
+        photo.ismissing or not os.path.exists(photo.path)
     )
 
-    # if export-edited, also export the edited version
-    # verify the photo has adjustments and valid path to avoid raising an exception
-    if export_edited and photo.hasadjustments:
-        if download_missing or photo.path_edited is not None:
-            edited_name = pathlib.Path(filename)
-            edited_name = f"{edited_name.stem}_edited{edited_name.suffix}"
-            if verbose:
-                click.echo(f"Exporting edited version of {filename} as {edited_name}")
-            photo.export(
-                dest,
-                edited_name,
-                sidecar_json=sidecar_json,
-                sidecar_xmp=sidecar_xmp,
-                overwrite=overwrite,
-                edited=True,
-                use_photos_export=download_missing,
-                exiftool=exiftool,
-            )
-        else:
-            click.echo(f"Skipping missing edited photo for {filename}")
+    # export the photo to each path in dest_paths
+    photo_paths = []
+    for dest_path in dest_paths:
+        photo_path = photo.export(
+            dest_path,
+            filename,
+            sidecar_json=sidecar_json,
+            sidecar_xmp=sidecar_xmp,
+            live_photo=export_live,
+            overwrite=overwrite,
+            use_photos_export=use_photos_export,
+            exiftool=exiftool,
+            no_xattr=no_extended_attributes,
+        )[0]
+        photo_paths.append(photo_path)
 
-    return photo_path
+        # if export-edited, also export the edited version
+        # verify the photo has adjustments and valid path to avoid raising an exception
+        if export_edited and photo.hasadjustments:
+            # if download_missing and the photo is missing or path doesn't exist,
+            # try to download with Photos
+            use_photos_export = download_missing and photo.path_edited is None
+            if not download_missing and photo.path_edited is None:
+                click.echo(f"Skipping missing edited photo for {filename}")
+            else:
+                edited_name = pathlib.Path(filename)
+                # check for correct edited suffix
+                if photo.path_edited is not None:
+                    edited_suffix = pathlib.Path(photo.path_edited).suffix
+                else:
+                    # use filename suffix which might be wrong,
+                    # will be corrected by use_photos_export
+                    edited_suffix = pathlib.Path(photo.filename).suffix
+                edited_name = f"{edited_name.stem}_edited{edited_suffix}"
+                if verbose:
+                    click.echo(
+                        f"Exporting edited version of {filename} as {edited_name}"
+                    )
+                photo.export(
+                    dest_path,
+                    edited_name,
+                    sidecar_json=sidecar_json,
+                    sidecar_xmp=sidecar_xmp,
+                    overwrite=overwrite,
+                    edited=True,
+                    use_photos_export=use_photos_export,
+                    exiftool=exiftool,
+                    no_xattr=no_extended_attributes,
+                )
+
+    return photo_paths
 
 
 if __name__ == "__main__":
-    cli()
+    cli()  # pylint: disable=no-value-for-parameter

osxphotos/_constants.py

@@ -25,6 +25,9 @@ _TESTED_OS_VERSIONS = ["12", "13", "14", "15"]
 # Photos 5 has persons who are empty string if unidentified face
 _UNKNOWN_PERSON = "_UNKNOWN_"
 
+# photos with no reverse geolocation info (place)
+_UNKNOWN_PLACE = "_UNKNOWN_"
+
 _EXIF_TOOL_URL = "https://exiftool.org/"
 
 # Where are shared iCloud photos located?

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.22.17"
+__version__ = "0.26.1"

osxphotos/exiftool.py

@@ -10,7 +10,7 @@ import logging
 import os
 import subprocess
 import sys
-from functools import lru_cache
+from functools import lru_cache # pylint: disable=syntax-error
 
 from .utils import _debug
 

osxphotos/photoinfo.py

@@ -26,13 +26,14 @@ from ._constants import (
     _TEMPLATE_DIR,
     _XMP_TEMPLATE_NAME,
 )
+from .exiftool import ExifTool
+from .placeinfo import PlaceInfo4, PlaceInfo5
 from .utils import (
     _copy_file,
     _export_photo_uuid_applescript,
     _get_resource_loc,
     dd_to_dms_str,
 )
-from .exiftool import ExifTool
 
 
 class PhotoInfo:
@@ -115,8 +116,6 @@ class PhotoInfo:
             )
             return photopath
 
-        # if self._info["masterFingerprint"]:
-        # if masterFingerprint is not null, path appears to be valid
         if self._info["directory"].startswith("/"):
             photopath = os.path.join(self._info["directory"], self._info["filename"])
         else:
@@ -125,13 +124,6 @@ class PhotoInfo:
             )
         return photopath
 
-        # if all else fails, photopath = None
-        # photopath = None
-        # logging.debug(
-        #     f"WARNING: photopath None, masterFingerprint null, not shared {pformat(self._info)}"
-        # )
-        # return photopath
-
     @property
     def path_edited(self):
         """ absolute path on disk of the edited picture """
@@ -489,6 +481,34 @@ class PhotoInfo:
         """ Returns True if photo is a selfie (front facing camera), otherwise False """
         return self._info["selfie"]
 
+    @property
+    def place(self):
+        """ Returns PlaceInfo object containing reverse geolocation info """
+
+        # implementation note: doesn't create the PlaceInfo object until requested
+        # then memoizes the object in self._place to avoid recreating the object
+
+        if self._db._db_version < _PHOTOS_5_VERSION:
+            try:
+                return self._place  # pylint: disable=access-member-before-definition
+            except AttributeError:
+                if self._info["placeNames"]:
+                    self._place = PlaceInfo4(
+                        self._info["placeNames"], self._info["countryCode"]
+                    )
+                else:
+                    self._place = None
+                return self._place
+        else:
+            try:
+                return self._place  # pylint: disable=access-member-before-definition
+            except AttributeError:
+                if self._info["reverse_geolocation"]:
+                    self._place = PlaceInfo5(self._info["reverse_geolocation"])
+                else:
+                    self._place = None
+                return self._place
+
     def export(
         self,
         dest,
@@ -502,10 +522,17 @@ class PhotoInfo:
         use_photos_export=False,
         timeout=120,
         exiftool=False,
+        no_xattr=False,
     ):
         """ export photo 
             dest: must be valid destination path (or exception raised) 
-            filename: (optional): name of picture; if not provided, will use current filename 
+            filename: (optional): name of exported picture; if not provided, will use current filename 
+                      **NOTE**: if provided, user must ensure file extension (suffix) is correct. 
+                      For example, if photo is .CR2 file, edited image may be .jpeg.  
+                      If you provide an extension different than what the actual file is, 
+                      export will print a warning but will happily export the photo using the 
+                      incorrect file extension.  e.g. to get the extension of the edited photo, 
+                      reference PhotoInfo.path_edited
             edited: (boolean, default=False); if True will export the edited version of the photo 
                     (or raise exception if no edited version) 
             live_photo: (boolean, default=False); if True, will also export the associted .mov for live photos
@@ -519,14 +546,19 @@ class PhotoInfo:
             use_photos_export: (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos
             timeout: (int, default=120) timeout in seconds used with use_photos_export
             exiftool: (boolean, default = False); if True, will use exiftool to write metadata to export file
-            returns the full path to the exported file """
-
-        # TODO: add this docs:
-        #  ( for jpeg in *.jpeg; do exiftool -v -json=$jpeg.json $jpeg; done )
+            no_xattr: (boolean, default = False); if True, exports file without preserving extended attributes
+            returns list of full paths to the exported files """
 
         # list of all files exported during this call to export
         exported_files = []
 
+        # check edited and raise exception trying to export edited version of
+        # photo that hasn't been edited
+        if edited and not self.hasadjustments:
+            raise ValueError(
+                "Photo does not have adjustments, cannot export edited version"
+            )
+
         # check arguments and get destination path and filename (if provided)
         if filename and len(filename) > 2:
             raise TypeError(
@@ -540,8 +572,8 @@ class PhotoInfo:
                 raise FileNotFoundError("Invalid path passed to export")
 
             if filename and len(filename) == 1:
-                # second arg is filename of picture
-                filename = filename[0]
+                # if filename passed, use it
+                fname = filename[0]
             else:
                 # no filename provided so use the default
                 # if edited file requested, use filename but add _edited
@@ -555,16 +587,35 @@ class PhotoInfo:
                         )
                     edited_name = pathlib.Path(self.path_edited).name
                     edited_suffix = pathlib.Path(edited_name).suffix
-                    filename = (
-                        pathlib.Path(self.filename).stem + "_edited" + edited_suffix
-                    )
+                    fname = pathlib.Path(self.filename).stem + "_edited" + edited_suffix
                 else:
-                    filename = self.filename
+                    fname = self.filename
 
         # check destination path
         dest = pathlib.Path(dest)
-        filename = pathlib.Path(filename)
-        dest = dest / filename
+        fname = pathlib.Path(fname)
+        dest = dest / fname
+
+        # check extension of destination
+        if edited and self.path_edited is not None:
+            # use suffix from edited file
+            actual_suffix = pathlib.Path(self.path_edited).suffix
+        elif edited:
+            # use .jpeg as that's probably correct
+            # if edited and path_edited is None, will raise FileNotFoundError below
+            # unless use_photos_export is True
+            actual_suffix = ".jpeg"
+        else:
+            # use suffix from the non-edited file
+            actual_suffix = pathlib.Path(self.filename).suffix
+
+        # warn if suffixes don't match but ignore .JPG / .jpeg as
+        # Photo's often converts .JPG to .jpeg
+        suffixes = sorted([x.lower() for x in [dest.suffix, actual_suffix]])
+        if dest.suffix != actual_suffix and suffixes != [".jpeg", ".jpg"]:
+            logging.warning(
+                f"Invalid destination suffix: {dest.suffix}, should be {actual_suffix}"
+            )
 
         # check to see if file exists and if so, add (1), (2), etc until we find one that works
         # Photos checks the stem and adds (1), (2), etc which avoids collision with sidecars
@@ -593,16 +644,11 @@ class PhotoInfo:
             # get path to source file and verify it's not None and is valid file
             # TODO: how to handle ismissing or not hasadjustments and edited=True cases?
             if edited:
-                if not self.hasadjustments:
-                    logging.warning(
-                        "Attempting to export edited photo but hasadjustments=False"
-                    )
-
                 if self.path_edited is not None:
                     src = self.path_edited
                 else:
                     raise FileNotFoundError(
-                        f"edited=True but path_edited is none; hasadjustments: {self.hasadjustments}"
+                        f"Cannot export edited photo if path_edited is None"
                     )
             else:
                 if self.ismissing:
@@ -610,13 +656,10 @@ class PhotoInfo:
                         f"Attempting to export photo with ismissing=True: path = {self.path}"
                     )
 
-                if self.path is None:
-                    logging.warning(
-                        f"Attempting to export photo but path is None: ismissing = {self.ismissing}"
-                    )
-                    raise FileNotFoundError("Cannot export photo if path is None")
-                else:
+                if self.path is not None:
                     src = self.path
+                else:
+                    raise FileNotFoundError("Cannot export photo if path is None")
 
             if not os.path.isfile(src):
                 raise FileNotFoundError(f"{src} does not appear to exist")
@@ -626,7 +669,7 @@ class PhotoInfo:
             )
 
             # copy the file, _copy_file uses ditto to preserve Mac extended attributes
-            _copy_file(src, dest)
+            _copy_file(src, dest, norsrc=no_xattr)
             exported_files.append(str(dest))
 
             # copy live photo associated .mov if requested
@@ -638,7 +681,7 @@ class PhotoInfo:
                     logging.debug(
                         f"Exporting live photo video of {filename} as {live_name.name}"
                     )
-                    _copy_file(src_live, str(live_name))
+                    _copy_file(src_live, str(live_name), norsrc=no_xattr)
                     exported_files.append(str(live_name))
                 else:
                     logging.warning(f"Skipping missing live movie for {filename}")
@@ -655,16 +698,18 @@ class PhotoInfo:
                 else:
                     # didn't get passed a filename, add _edited
                     filestem = f"{dest.stem}_edited"
-                    exported = _export_photo_uuid_applescript(
-                        self.uuid,
-                        dest.parent,
-                        filestem=filestem,
-                        original=False,
-                        edited=True,
-                        live_photo=live_photo,
-                        timeout=timeout,
-                        burst=self.burst,
-                    )
+                    dest = dest.parent / f"{filestem}.jpeg"
+
+                exported = _export_photo_uuid_applescript(
+                    self.uuid,
+                    dest.parent,
+                    filestem=filestem,
+                    original=False,
+                    edited=True,
+                    live_photo=live_photo,
+                    timeout=timeout,
+                    burst=self.burst,
+                )
             else:
                 # export original version and not edited
                 filestem = dest.stem
@@ -682,7 +727,9 @@ class PhotoInfo:
             if exported is not None:
                 exported_files.extend(exported)
             else:
-                logging.warning(f"Error exporting photo {self.uuid} to {dest}")
+                logging.warning(
+                    f"Error exporting photo {self.uuid} to {dest} with use_photos_export"
+                )
 
         if sidecar_json:
             logging.debug("writing exiftool_json_sidecar")
@@ -704,14 +751,12 @@ class PhotoInfo:
                 logging.warning(f"Error writing xmp sidecar to {sidecar_filename}")
                 raise e
 
-        logging.debug(f"export exported_files: {exported_files}")
-
         # if exiftool, write the metadata
         if exiftool and exported_files:
             for exported_file in exported_files:
                 self._write_exif_data(exported_file)
 
-        return str(dest)
+        return exported_files
 
     def _write_exif_data(self, filepath):
         """ write exif data to image file at filepath
@@ -751,7 +796,6 @@ class PhotoInfo:
 
         exif = {}
         exif["_CreatedBy"] = "osxphotos, https://github.com/RhetTbull/osxphotos"
-        exif["File:FileName"] = self.filename
 
         if self.description:
             exif["EXIF:ImageDescription"] = self.description

osxphotos/photosdb.py

@@ -28,11 +28,11 @@ from ._version import __version__
 from .photoinfo import PhotoInfo
 from .utils import (
     _check_file_exists,
-    _get_os_version,
-    get_last_library_path,
-    _debug,
-    _open_sql_file,
     _db_is_locked,
+    _debug,
+    _get_os_version,
+    _open_sql_file,
+    get_last_library_path,
 )
 
 # TODO: Add test for imageTimeZoneOffsetSeconds = None
@@ -120,6 +120,12 @@ class PhotosDB:
         # e.g.  {'1EB2B765-0765-43BA-A90C-0D0580E6172C': ['0C514A98-7B77-4E4F-801B-364B7B65EAFA']}
         self._dbalbums_uuid = {}
 
+        # Dict with information about all albums/photos by primary key in the album database
+        # key is album pk, value is album uuid
+        # e.g.  {'43': '0C514A98-7B77-4E4F-801B-364B7B65EAFA'}
+        # specific to Photos versions >= 5
+        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']}
@@ -264,6 +270,7 @@ class PhotosDB:
             k
             for k in self._dbalbums_album.keys()
             if self._dbalbum_details[k]["cloudownerhashedpersonid"] is None
+            and self._dbalbum_details[k]["intrash"] == 0
         ]
         for k in album_keys:
             title = self._dbalbum_details[k]["title"]
@@ -314,7 +321,7 @@ class PhotosDB:
         return list(persons)
 
     @property
-    def albums(self):
+    def album_names(self):
         """ return list of albums found in photos database """
 
         # Could be more than one album with same name
@@ -331,7 +338,7 @@ class PhotosDB:
         return list(albums)
 
     @property
-    def albums_shared(self):
+    def album_names_shared(self):
         """ return list of shared albums found in photos database
             only valid for Photos 5; on Photos <= 4, prints warning and returns empty list """
 
@@ -395,18 +402,6 @@ class PhotosDB:
 
         return dest_path
 
-    # def _open_sql_file(self, fname):
-    #     """ opens sqlite file fname in read-only mode
-    #         returns tuple of (connection, cursor) """
-    #     try:
-    #         conn = sqlite3.connect(
-    #             f"{pathlib.Path(fname).as_uri()}?mode=ro", timeout=1, uri=True
-    #         )
-    #         c = conn.cursor()
-    #     except sqlite3.Error as e:
-    #         sys.exit(f"An error occurred opening sqlite file: {e.args[0]} {fname}")
-    #     return (conn, c)
-
     def _get_db_version(self):
         """ gets the Photos DB version from LiGlobals table """
         """ returns the version as str"""
@@ -478,9 +473,9 @@ class PhotosDB:
             "uuid, "  # 0
             "name, "  # 1
             "cloudLibraryState, "  # 2
-            "cloudIdentifier "  # 3
+            "cloudIdentifier, "  # 3
+            "isInTrash "  # 4
             "FROM RKAlbum "
-            "WHERE isInTrash = 0"
         )
 
         for album in c:
@@ -488,6 +483,7 @@ class PhotosDB:
                 "title": album[1],
                 "cloudlibrarystate": album[2],
                 "cloudidentifier": album[3],
+                "intrash": album[4],
                 "cloudlocalstate": None,  # Photos 5
                 "cloudownerfirstname": None,  # Photos 5
                 "cloudownderlastname": None,  # Photos 5
@@ -534,7 +530,7 @@ class PhotosDB:
                     RKVersion.latitude, RKVersion.longitude, 
                     RKVersion.adjustmentUuid, RKVersion.type, RKMaster.UTI,
                     RKVersion.burstUuid, RKVersion.burstPickType,
-                    RKVersion.specialType, RKMaster.modelID
+                    RKVersion.specialType, RKMaster.modelID, RKVersion.momentUuid
                     FROM RKVersion, RKMaster WHERE RKVersion.isInTrash = 0 AND 
                     RKVersion.masterUuid = RKMaster.uuid AND RKVersion.filename NOT LIKE '%.pdf' """
             )
@@ -549,7 +545,8 @@ class PhotosDB:
                     RKVersion.adjustmentUuid, RKVersion.type, RKMaster.UTI,
                     RKVersion.burstUuid, RKVersion.burstPickType,
                     RKVersion.specialType, RKMaster.modelID,
-                    RKVersion.selfPortrait 
+                    RKVersion.selfPortrait, 
+                    RKVersion.momentUuid
                     FROM RKVersion, RKMaster WHERE RKVersion.isInTrash = 0 AND 
                     RKVersion.masterUuid = RKMaster.uuid AND RKVersion.filename NOT LIKE '%.pdf' """
             )
@@ -583,6 +580,7 @@ class PhotosDB:
         # 25    RKVersion.specialType
         # 26    RKMaster.modelID
         # 27    RKVersion.selfPortrait -- 1 if selfie, Photos >= 3, not present for Photos < 3
+        # 28    RKVersion.momentID (# 27 for Photos < 3)
 
         for row in c:
             uuid = row[0]
@@ -689,8 +687,10 @@ class PhotosDB:
             # selfies (front facing camera, RKVersion.selfPortrait == 1)
             if self._db_version >= _PHOTOS_3_VERSION:
                 self._dbphotos[uuid]["selfie"] = True if row[27] == 1 else False
+                self._dbphotos[uuid]["momentID"] = row[28]
             else:
                 self._dbphotos[uuid]["selfie"] = None
+                self._dbphotos[uuid]["momentID"] = row[27]
 
             # Init cloud details that will be filled in later if cloud asset
             self._dbphotos[uuid]["cloudAssetGUID"] = None  # Photos 5
@@ -830,6 +830,55 @@ class PhotosDB:
                 self._dbphotos[uuid]["cloudStatus"] = row[3]
                 self._dbphotos[uuid]["incloud"] = True if row[2] == 1 else False
 
+        # get location data
+        # get the country codes
+        country_codes = c.execute(
+            "SELECT modelID, countryCode "
+            "FROM RKPlace "
+            "WHERE countryCode IS NOT NULL "
+        ).fetchall()
+        countries = {code[0]: code[1] for code in country_codes}
+        self._db_countries = countries
+
+        # get the place data
+        place_data = c.execute(
+            "SELECT modelID, defaultName, type, area " "FROM RKPlace "
+        ).fetchall()
+        places = {p[0]: p for p in place_data}
+        self._db_places = places
+
+        for uuid in self._dbphotos:
+            # get placeId which is then used to lookup defaultName
+            place_ids_query = c.execute(
+                "SELECT placeId "
+                "FROM RKPlaceForVersion "
+                f"WHERE versionId = '{self._dbphotos[uuid]['modelID']}'"
+            )
+
+            place_ids = [id[0] for id in place_ids_query.fetchall()]
+            self._dbphotos[uuid]["placeIDs"] = place_ids
+            country_code = [countries[x] for x in place_ids if x in countries]
+            if len(country_code) > 1:
+                logging.warning(f"Found more than one country code for uuid: {uuid}")
+
+            if country_code:
+                self._dbphotos[uuid]["countryCode"] = country_code[0]
+            else:
+                self._dbphotos[uuid]["countryCode"] = None
+
+            # get the place info that matches the RKPlace modelIDs for this photo
+            # (place_ids), sort by area (element 3 of the place_data tuple in places)
+            place_names = [
+                pname
+                for pname in sorted(
+                    [places[p] for p in places if p in place_ids],
+                    key=lambda place: place[3],
+                )
+            ]
+
+            self._dbphotos[uuid]["placeNames"] = place_names
+            self._dbphotos[uuid]["reverse_geolocation"] = None  # Photos 5
+
         # build album_titles dictionary
         for album_id in self._dbalbum_details:
             title = self._dbalbum_details[album_id]["title"]
@@ -943,6 +992,7 @@ class PhotosDB:
             logging.debug(pformat(self._dbfaces_person))
             logging.debug(self._dbfaces_uuid)
 
+        # get details about albums
         c.execute(
             "SELECT ZGENERICALBUM.ZUUID, ZGENERICASSET.ZUUID "
             "FROM ZGENERICASSET "
@@ -952,12 +1002,15 @@ class PhotosDB:
         )
         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])
+            try:
+                self._dbalbums_uuid[album[1]].append(album[0])
+            except KeyError:
+                self._dbalbums_uuid[album[1]] = [album[0]]
+
+            try:
+                self._dbalbums_album[album[0]].append(album[1])
+            except KeyError:
+                self._dbalbums_album[album[0]] = [album[1]]
 
         # now get additional details about albums
         c.execute(
@@ -967,8 +1020,12 @@ class PhotosDB:
             "ZCLOUDLOCALSTATE, "  # 2
             "ZCLOUDOWNERFIRSTNAME, "  # 3
             "ZCLOUDOWNERLASTNAME, "  # 4
-            "ZCLOUDOWNERHASHEDPERSONID "  # 5
-            "FROM ZGENERICALBUM"
+            "ZCLOUDOWNERHASHEDPERSONID, "  # 5
+            "ZKIND, "  # 6
+            "ZPARENTFOLDER, "  # 7
+            "Z_PK, "  # 8
+            "ZTRASHEDSTATE "  # 9
+            "FROM ZGENERICALBUM "
         )
         for album in c:
             self._dbalbum_details[album[0]] = {
@@ -978,9 +1035,18 @@ class PhotosDB:
                 "cloudownderlastname": album[4],
                 "cloudownerhashedpersonid": album[5],
                 "cloudlibrarystate": None,  # Photos 4
-                "cloudidentifier": None,  # Photos4
+                "cloudidentifier": None,  # Photos 4
+                "kind": album[6],
+                "parentfolder": album[7],
+                "pk": album[8],
+                "intrash": album[9],
             }
 
+            # add cross-reference by pk to uuid
+            # needed to extract folder hierarchy
+            # in Photos >= 5, folders are special albums
+            self._dbalbums_pk[album[8]] = album[0]
+
         if _debug():
             logging.debug(f"Finished walking through albums")
             logging.debug(pformat(self._dbalbums_album))
@@ -1045,7 +1111,9 @@ class PhotosDB:
                 ZGENERICASSET.ZKINDSUBTYPE,
                 ZGENERICASSET.ZCUSTOMRENDEREDVALUE,
                 ZADDITIONALASSETATTRIBUTES.ZCAMERACAPTUREDEVICE,
-                ZGENERICASSET.ZCLOUDASSETGUID 
+                ZGENERICASSET.ZCLOUDASSETGUID,
+                ZADDITIONALASSETATTRIBUTES.ZREVERSELOCATIONDATA,
+                ZGENERICASSET.ZMOMENT
                 FROM ZGENERICASSET 
                 JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = ZGENERICASSET.Z_PK 
                 WHERE ZGENERICASSET.ZTRASHEDSTATE = 0  
@@ -1076,8 +1144,10 @@ class PhotosDB:
         # 21   ZGENERICASSET.ZKINDSUBTYPE -- determine if live photos, etc
         # 22   ZGENERICASSET.ZCUSTOMRENDEREDVALUE -- determine if HDR photo
         # 23   ZADDITIONALASSETATTRIBUTES.ZCAMERACAPTUREDEVICE -- 1 if selfie (front facing camera)
-        # 25   ZGENERICASSET.ZCLOUDASSETGUID  -- not null if asset is cloud asset
+        # 24   ZGENERICASSET.ZCLOUDASSETGUID  -- not null if asset is cloud asset
         #       (e.g. user has "iCloud Photos" checked in Photos preferences)
+        # 25   ZADDITIONALASSETATTRIBUTES.ZREVERSELOCATIONDATA -- reverse geolocation data
+        # 26   ZGENERICASSET.ZMOMENT -- FK for ZMOMENT.Z_PK
 
         for row in c:
             uuid = row[0]
@@ -1203,6 +1273,15 @@ class PhotosDB:
             info["cloudStatus"] = None  # Photos 4
             info["cloudAvailable"] = None  # Photos 4
 
+            # reverse geolocation info
+            info["reverse_geolocation"] = row[25]
+            info["placeIDs"] = None  # Photos 4
+            info["placeNames"] = None  # Photos 4
+            info["countryCode"] = None  # Photos 4
+
+            # moment info
+            info["momentID"] = row[26]
+
             self._dbphotos[uuid] = info
 
             # # if row[19] is not None and ((row[20] == 2) or (row[20] == 4)):
@@ -1371,6 +1450,9 @@ class PhotosDB:
             else:
                 self._dbalbum_titles[title] = [album_id]
 
+        # country codes (only used in Photos <=4)
+        self._db_countries = None
+
         # close connection and remove temporary files
         conn.close()
 
@@ -1411,6 +1493,7 @@ class PhotosDB:
 
     def _process_database5X(self):
         """ ALPHA: TESTING using SimpleNamespace to clean up code for info, DO NOT CALL THIS METHOD """
+        """ Needs to be updated for changes in process_database5 due to adding PlaceInfo """
         """ process the Photos database to extract info """
         """ works on Photos version >= 5.0 """
 
@@ -1608,7 +1691,7 @@ class PhotosDB:
                 ZGENERICASSET.ZKINDSUBTYPE,
                 ZGENERICASSET.ZCUSTOMRENDEREDVALUE,
                 ZADDITIONALASSETATTRIBUTES.ZCAMERACAPTUREDEVICE,
-                ZGENERICASSET.ZCLOUDASSETGUID 
+                ZGENERICASSET.ZCLOUDASSETGUID
                 FROM ZGENERICASSET 
                 JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = ZGENERICASSET.Z_PK 
                 WHERE ZGENERICASSET.ZTRASHEDSTATE = 0  
@@ -1715,8 +1798,8 @@ class PhotosDB:
                     info.burst_key = True  # it's a key photo (selected from the burst)
                 else:
                     info.burst_key = (
-                        False
-                    )  # it's a burst photo but not one that's selected
+                        False  # it's a burst photo but not one that's selected
+                    )
             else:
                 # not a burst photo
                 info.burst = False
@@ -2006,37 +2089,45 @@ class PhotosDB:
             photos_sets.append(set(self._dbphotos.keys()))
         else:
             if albums:
+                album_set = set()
                 for album in albums:
                     # TODO: can have >1 album with same name. This globs them together.
                     # Need a way to select which album?
                     if album in self._dbalbum_titles:
-                        album_set = set()
+                        title_set = set()
                         for album_id in self._dbalbum_titles[album]:
-                            album_set.update(self._dbalbums_album[album_id])
-                        photos_sets.append(album_set)
+                            title_set.update(self._dbalbums_album[album_id])
+                        album_set.update(title_set)
                     else:
                         logging.debug(f"Could not find album '{album}' in database")
+                photos_sets.append(album_set)
 
             if uuid:
+                uuid_set = set()
                 for u in uuid:
                     if u in self._dbphotos:
-                        photos_sets.append(set([u]))
+                        uuid_set.update([u])
                     else:
                         logging.debug(f"Could not find uuid '{u}' in database")
+                photos_sets.append(uuid_set)
 
             if keywords:
+                keyword_set = set()
                 for keyword in keywords:
                     if keyword in self._dbkeywords_keyword:
-                        photos_sets.append(set(self._dbkeywords_keyword[keyword]))
+                        keyword_set.update(self._dbkeywords_keyword[keyword])
                     else:
                         logging.debug(f"Could not find keyword '{keyword}' in database")
+                photos_sets.append(keyword_set)
 
             if persons:
+                person_set = set()
                 for person in persons:
                     if person in self._dbfaces_person:
-                        photos_sets.append(set(self._dbfaces_person[person]))
+                        person_set.update(self._dbfaces_person[person])
                     else:
                         logging.debug(f"Could not find person '{person}' in database")
+                photos_sets.append(person_set)
 
             if from_date or to_date:
                 dsel = self._dbphotos

osxphotos/placeinfo.py

@@ -0,0 +1,626 @@
+""" 
+    PlaceInfo class
+    Provides reverse geolocation info for photos 
+    
+    See https://developer.apple.com/documentation/corelocation/clplacemark
+    for additional documentation on reverse geolocation data
+"""
+from abc import ABC, abstractmethod
+from collections import namedtuple  # pylint: disable=syntax-error
+
+import yaml
+from bpylist import archiver
+
+# postal address information, returned by PlaceInfo.address
+PostalAddress = namedtuple(
+    "PostalAddress",
+    [
+        "street",
+        "sub_locality",
+        "city",
+        "sub_administrative_area",
+        "state_province",
+        "postal_code",
+        "country",
+        "iso_country_code",
+    ],
+)
+
+# PlaceNames tuple returned by PlaceInfo.names
+# order of fields 0 - 17 is mapped to placeType value in
+# PLRevGeoLocationInfo.mapInfo.sortedPlaceInfos
+# field 18 is combined bodies of water (ocean + inland_water)
+# and maps to Photos <= 4, RKPlace.type == 44
+# (Photos <= 4 doesn't have ocean or inland_water types)
+# The fields named "field0", etc. appear to be unused
+PlaceNames = namedtuple(
+    "PlaceNames",
+    [
+        "field0",
+        "country",  # The name of the country associated with the placemark.
+        "state_province",  # administrativeArea, The state or province associated with the placemark.
+        "sub_administrative_area",  # Additional administrative area information for the placemark.
+        "city",  # locality, The city associated with the placemark.
+        "field5",
+        "additional_city_info",  # subLocality, Additional city-level information for the placemark.
+        "ocean",  # The name of the ocean associated with the placemark.
+        "area_of_interest",  # areasOfInterest, The relevant areas of interest associated with the placemark.
+        "inland_water",  # The name of the inland water body associated with the placemark.
+        "field10",
+        "region",  # The geographic region associated with the placemark.
+        "sub_throughfare",  # Additional street-level information for the placemark.
+        "field13",
+        "postal_code",  # The postal code associated with the placemark.
+        "field15",
+        "field16",
+        "street_address",  # throughfare, The street address associated with the placemark.
+        "body_of_water",  # RKPlace.type == 44, appears to be any body of water (ocean or inland)
+    ],
+)
+
+# The following classes represent Photo Library Reverse Geolocation Info as stored
+# in ZADDITIONALASSETATTRIBUTES.ZREVERSELOCATIONDATA
+# These classes are used by bpylist.archiver to unarchive the serialized objects
+class PLRevGeoLocationInfo:
+    """ The top level reverse geolocation object """
+
+    def __init__(
+        self,
+        addressString,
+        countryCode,
+        mapItem,
+        isHome,
+        compoundNames,
+        compoundSecondaryNames,
+        version,
+        geoServiceProvider,
+        postalAddress,
+    ):
+        self.addressString = addressString
+        self.countryCode = countryCode
+        self.mapItem = mapItem
+        self.isHome = isHome
+        self.compoundNames = compoundNames
+        self.compoundSecondaryNames = compoundSecondaryNames
+        self.version = version
+        self.geoServiceProvider = geoServiceProvider
+        self.postalAddress = postalAddress
+
+    def __eq__(self, other):
+        for field in [
+            "addressString",
+            "countryCode",
+            "isHome",
+            "compoundNames",
+            "compoundSecondaryNames",
+            "version",
+            "geoServiceProvider",
+            "postalAddress",
+        ]:
+            if getattr(self, field) != getattr(other, field):
+                return False
+        return True
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        return f"addressString: {self.addressString}, countryCode: {self.countryCode}, isHome: {self.isHome}, mapItem: {self.mapItem}, postalAddress: {self.postalAddress}"
+
+    @staticmethod
+    def encode_archive(obj, archive):
+        archive.encode("addressString", obj.addressString)
+        archive.encode("countryCode", obj.countryCode)
+        archive.encode("mapItem", obj.mapItem)
+        archive.encode("isHome", obj.isHome)
+        archive.encode("compoundNames", obj.compoundNames)
+        archive.encode("compoundSecondaryNames", obj.compoundSecondaryNames)
+        archive.encode("version", obj.version)
+        archive.encode("geoServiceProvider", obj.geoServiceProvider)
+        archive.encode("postalAddress", obj.postalAddress)
+
+    @staticmethod
+    def decode_archive(archive):
+        addressString = archive.decode("addressString")
+        countryCode = archive.decode("countryCode")
+        mapItem = archive.decode("mapItem")
+        isHome = archive.decode("isHome")
+        compoundNames = archive.decode("compoundNames")
+        compoundSecondaryNames = archive.decode("compoundSecondaryNames")
+        version = archive.decode("version")
+        geoServiceProvider = archive.decode("geoServiceProvider")
+        postalAddress = archive.decode("postalAddress")
+        return PLRevGeoLocationInfo(
+            addressString,
+            countryCode,
+            mapItem,
+            isHome,
+            compoundNames,
+            compoundSecondaryNames,
+            version,
+            geoServiceProvider,
+            postalAddress,
+        )
+
+
+class PLRevGeoMapItem:
+    """ Stores the list of place names, organized by area """
+
+    def __init__(self, sortedPlaceInfos, finalPlaceInfos):
+        self.sortedPlaceInfos = sortedPlaceInfos
+        self.finalPlaceInfos = finalPlaceInfos
+
+    def __eq__(self, other):
+        for field in ["sortedPlaceInfos", "finalPlaceInfos"]:
+            if getattr(self, field) != getattr(other, field):
+                return False
+        return True
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        sortedPlaceInfos = []
+        finalPlaceInfos = []
+        for place in self.sortedPlaceInfos:
+            sortedPlaceInfos.append(str(place))
+        for place in self.finalPlaceInfos:
+            finalPlaceInfos.append(str(place))
+        return (
+            f"finalPlaceInfos: {finalPlaceInfos}, sortedPlaceInfos: {sortedPlaceInfos}"
+        )
+
+    @staticmethod
+    def encode_archive(obj, archive):
+        archive.encode("sortedPlaceInfos", obj.sortedPlaceInfos)
+        archive.encode("finalPlaceInfos", obj.finalPlaceInfos)
+
+    @staticmethod
+    def decode_archive(archive):
+        sortedPlaceInfos = archive.decode("sortedPlaceInfos")
+        finalPlaceInfos = archive.decode("finalPlaceInfos")
+        return PLRevGeoMapItem(sortedPlaceInfos, finalPlaceInfos)
+
+
+class PLRevGeoMapItemAdditionalPlaceInfo:
+    """ Additional info about individual places """
+
+    def __init__(self, area, name, placeType, dominantOrderType):
+        self.area = area
+        self.name = name
+        self.placeType = placeType
+        self.dominantOrderType = dominantOrderType
+
+    def __eq__(self, other):
+        for field in ["area", "name", "placeType", "dominantOrderType"]:
+            if getattr(self, field) != getattr(other, field):
+                return False
+        return True
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        return f"area: {self.area}, name: {self.name}, placeType: {self.placeType}"
+
+    @staticmethod
+    def encode_archive(obj, archive):
+        archive.encode("area", obj.area)
+        archive.encode("name", obj.name)
+        archive.encode("placeType", obj.placeType)
+        archive.encode("dominantOrderType", obj.dominantOrderType)
+
+    @staticmethod
+    def decode_archive(archive):
+        area = archive.decode("area")
+        name = archive.decode("name")
+        placeType = archive.decode("placeType")
+        dominantOrderType = archive.decode("dominantOrderType")
+        return PLRevGeoMapItemAdditionalPlaceInfo(
+            area, name, placeType, dominantOrderType
+        )
+
+
+class CNPostalAddress:
+    """ postal address for the reverse geolocation info """
+
+    def __init__(
+        self,
+        _ISOCountryCode,
+        _city,
+        _country,
+        _postalCode,
+        _state,
+        _street,
+        _subAdministrativeArea,
+        _subLocality,
+    ):
+        self._ISOCountryCode = _ISOCountryCode
+        self._city = _city
+        self._country = _country
+        self._postalCode = _postalCode
+        self._state = _state
+        self._street = _street
+        self._subAdministrativeArea = _subAdministrativeArea
+        self._subLocality = _subLocality
+
+    def __eq__(self, other):
+        for field in [
+            "_ISOCountryCode",
+            "_city",
+            "_country",
+            "_postalCode",
+            "_state",
+            "_street",
+            "_subAdministrativeArea",
+            "_subLocality",
+        ]:
+            if getattr(self, field) != getattr(other, field):
+                return False
+        return True
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        return ", ".join(
+            map(
+                str,
+                [
+                    self._street,
+                    self._city,
+                    self._subLocality,
+                    self._subAdministrativeArea,
+                    self._state,
+                    self._postalCode,
+                    self._country,
+                    self._ISOCountryCode,
+                ],
+            )
+        )
+
+    @staticmethod
+    def encode_archive(obj, archive):
+        archive.encode("_ISOCountryCode", obj._ISOCountryCode)
+        archive.encode("_country", obj._country)
+        archive.encode("_city", obj._city)
+        archive.encode("_postalCode", obj._postalCode)
+        archive.encode("_state", obj._state)
+        archive.encode("_street", obj._street)
+        archive.encode("_subAdministrativeArea", obj._subAdministrativeArea)
+        archive.encode("_subLocality", obj._subLocality)
+
+    @staticmethod
+    def decode_archive(archive):
+        _ISOCountryCode = archive.decode("_ISOCountryCode")
+        _country = archive.decode("_country")
+        _city = archive.decode("_city")
+        _postalCode = archive.decode("_postalCode")
+        _state = archive.decode("_state")
+        _street = archive.decode("_street")
+        _subAdministrativeArea = archive.decode("_subAdministrativeArea")
+        _subLocality = archive.decode("_subLocality")
+
+        return CNPostalAddress(
+            _ISOCountryCode,
+            _city,
+            _country,
+            _postalCode,
+            _state,
+            _street,
+            _subAdministrativeArea,
+            _subLocality,
+        )
+
+
+# register the classes with bpylist.archiver
+archiver.update_class_map({"CNPostalAddress": CNPostalAddress})
+archiver.update_class_map(
+    {"PLRevGeoMapItemAdditionalPlaceInfo": PLRevGeoMapItemAdditionalPlaceInfo}
+)
+archiver.update_class_map({"PLRevGeoMapItem": PLRevGeoMapItem})
+archiver.update_class_map({"PLRevGeoLocationInfo": PLRevGeoLocationInfo})
+
+
+class PlaceInfo(ABC):
+    @property
+    @abstractmethod
+    def address_str(self):
+        pass
+
+    @property
+    @abstractmethod
+    def country_code(self):
+        pass
+
+    @property
+    @abstractmethod
+    def ishome(self):
+        pass
+
+    @property
+    @abstractmethod
+    def name(self):
+        pass
+
+    @property
+    @abstractmethod
+    def names(self):
+        pass
+
+    @property
+    @abstractmethod
+    def address(self):
+        pass
+
+
+class PlaceInfo4(PlaceInfo):
+    """ Reverse geolocation place info for a photo (Photos <= 4) """
+
+    def __init__(self, place_names, country_code):
+        """ place_names: list of place name tuples in ascending order by area 
+            tuple fields are: modelID, place name, place type, area, e.g.
+            [(5, "St James's Park", 45, 0), 
+            (4, 'Westminster', 16, 22097376), 
+            (3, 'London', 4, 1596146816), 
+            (2, 'England', 2, 180406091776), 
+            (1, 'United Kingdom', 1, 414681432064)] 
+            country_code: two letter country code for the country
+        """
+        self._place_names = place_names
+        self._country_code = country_code
+        self._process_place_info()
+
+    @property
+    def address_str(self):
+        return None
+
+    @property
+    def country_code(self):
+        return self._country_code
+
+    @property
+    def ishome(self):
+        return None
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def names(self):
+        return self._names
+
+    @property
+    def address(self):
+        return PostalAddress(None, None, None, None, None, None, None, None)
+
+    def __eq__(self, other):
+        if not isinstance(other, type(self)):
+            return False
+        else:
+            return (
+                self._place_names == other._place_names
+                and self._country_code == other._country_code
+            )
+
+    def _process_place_info(self):
+        """ Process place_names to set self._name and self._names """
+        places = self._place_names
+
+        # build a dictionary where key is placetype
+        places_dict = {}
+        for p in places:
+            # places in format:
+            # [(5, "St James's Park", 45, 0), ]
+            #   0: modelID
+            #   1: name
+            #   2: type
+            #   3: area
+            try:
+                places_dict[p[2]].append((p[1], p[3]))
+            except KeyError:
+                places_dict[p[2]] = [(p[1], p[3])]
+
+        # build list to populate PlaceNames tuple
+        # initialize with empty lists for each field in PlaceNames
+        place_info = [[]] * 19
+
+        # add the place names sorted by area (ascending)
+        # in Photos <=4, possible place type values are:
+        # 45: areasOfInterest (The relevant areas of interest associated with the placemark.)
+        # 44: body of water (includes both inlandWater and ocean)
+        # 43: subLocality (Additional city-level information for the placemark.
+        # 16: locality (The city associated with the placemark.)
+        # 4: subAdministrativeArea (Additional administrative area information for the placemark.)
+        # 2: administrativeArea (The state or province associated with the placemark.)
+        # 1: country
+        # mapping = mapping from PlaceNames to field in places_dict
+        # PlaceNames fields map to the placeType value in Photos5 (0..17)
+        # but place type in Photos <=4 has different values
+        # hence (3, 4) means PlaceNames[3] = places_dict[4] (sub_administrative_area)
+        mapping = [(1, 1), (2, 2), (3, 4), (4, 16), (18, 44), (8, 45)]
+        for field5, field4 in mapping:
+            try:
+                place_info[field5] = [
+                    p[0]
+                    for p in sorted(places_dict[field4], key=lambda place: place[1])
+                ]
+            except KeyError:
+                pass
+
+        place_names = PlaceNames(*place_info)
+        self._names = place_names
+
+        # build the name as it appears in Photos
+        # the length of the name is at most 3 fields and appears to be based on available
+        # reverse geolocation data in the following order (left to right, joined by ',')
+        # always has country if available then either area of interest and city OR
+        # city and state
+        # e.g. 4, 2, 1 OR 8, 4, 1
+        # 8 (45): area_of_interest
+        # 4 (16): locality / city
+        # 2 (2): administrative area (state/province)
+        # 1 (1): country
+        name_list = []
+        if place_names[8]:
+            name_list.append(place_names[8][0])
+            if place_names[4]:
+                name_list.append(place_names[4][0])
+        elif place_names[4]:
+            name_list.append(place_names[4][0])
+            if place_names[2]:
+                name_list.append(place_names[2][0])
+        elif place_names[2]:
+            name_list.append(place_names[2][0])
+
+        # add country
+        if place_names[1]:
+            name_list.append(place_names[1][0])
+
+        name = ", ".join(name_list)
+        self._name = name if name != "" else None
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        info = {
+            "name": self.name,
+            "names": self.names,
+            "country_code": self.country_code,
+        }
+        strval = "PlaceInfo(" + ", ".join([f"{k}='{v}'" for k, v in info.items()]) + ")"
+        return strval
+
+
+class PlaceInfo5(PlaceInfo):
+    """ Reverse geolocation place info for a photo (Photos >= 5) """
+
+    def __init__(self, revgeoloc_bplist):
+        """ 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()
+
+    @property
+    def address_str(self):
+        """ returns the postal address as a string """
+        return self._plrevgeoloc.addressString
+
+    @property
+    def country_code(self):
+        """ returns the country code """
+        return self._plrevgeoloc.countryCode
+
+    @property
+    def ishome(self):
+        """ returns True if place is user's home address """
+        return self._plrevgeoloc.isHome
+
+    @property
+    def name(self):
+        """ returns local place name """
+        return self._name
+
+    @property
+    def names(self):
+        """ returns PlaceNames tuple with detailed reverse geolocation place names """
+        return self._names
+
+    @property
+    def address(self):
+        addr = self._plrevgeoloc.postalAddress
+        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,
+        )
+        return address
+
+    def _process_place_info(self):
+        """ Process sortedPlaceInfos to set self._name and self._names """
+        places = self._plrevgeoloc.mapItem.sortedPlaceInfos
+
+        # build a dictionary where key is placetype
+        places_dict = {}
+        for p in places:
+            try:
+                places_dict[p.placeType].append((p.name, p.area))
+            except KeyError:
+                places_dict[p.placeType] = [(p.name, p.area)]
+
+        # build list to populate PlaceNames tuple
+        place_info = []
+        for field in range(18):
+            try:
+                # add the place names sorted by area (ascending)
+                place_info.append(
+                    [
+                        p[0]
+                        for p in sorted(places_dict[field], key=lambda place: place[1])
+                    ]
+                )
+            except:
+                place_info.append([])
+
+        # fill in body_of_water for compatibility with Photos <= 4
+        place_info.append(place_info[7] + place_info[9])
+
+        place_names = PlaceNames(*place_info)
+        self._names = place_names
+
+        # build the name as it appears in Photos
+        # the length of the name is variable and appears to be based on available
+        # reverse geolocation data in the following order (left to right, joined by ',')
+        # 8: area_of_interest
+        # 11: region (I've only seen this applied to islands)
+        # 4: locality / city
+        # 2: administrative area (state/province)
+        # 1: country
+        # 9: inland_water
+        # 7: ocean
+        name = ", ".join(
+            [
+                p[0]
+                for p in [
+                    place_names[8],  # area of interest
+                    place_names[11],  # region (I've only seen this applied to islands)
+                    place_names[4],  # locality / city
+                    place_names[2],  # administrative area (state/province)
+                    place_names[1],  # country
+                    place_names[9],  # inland_water
+                    place_names[7],  # ocean
+                ]
+                if p and p[0]
+            ]
+        )
+        self._name = name if name != "" else None
+
+    def __eq__(self, other):
+        if not isinstance(other, type(self)):
+            return False
+        else:
+            return self._plrevgeoloc == other._plrevgeoloc
+
+    def __ne__(self, other):
+        return not self.__eq__(other)
+
+    def __str__(self):
+        info = {
+            "name": self.name,
+            "names": self.names,
+            "country_code": self.country_code,
+            "ishome": self.ishome,
+            "address_str": self.address_str,
+            "address": str(self.address),
+        }
+        strval = "PlaceInfo(" + ", ".join([f"{k}='{v}'" for k, v in info.items()]) + ")"
+        return strval

osxphotos/template.py

@@ -0,0 +1,424 @@
+""" Custom template system for osxphotos """
+
+# Rolled my own template system because:
+# 1. Needed to handle multiple values (e.g. album, keyword)
+# 2. Needed to handle default values if template not found
+# 3. Didn't want user to need to know python (e.g. by using Mako which is
+#    already used elsewhere in this project)
+# 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 pathlib
+import re
+from typing import Tuple, List  # pylint: disable=syntax-error
+
+from .photoinfo import PhotoInfo
+from ._constants import _UNKNOWN_PERSON
+
+# Permitted substitutions (each of these returns a single value or None)
+TEMPLATE_SUBSTITUTIONS = {
+    "{name}": "Filename of the photo",
+    "{original_name}": "Photo's original filename when imported to Photos",
+    "{title}": "Title of the photo",
+    "{descr}": "Description of the photo",
+    "{created.date}": "Photo's creation date in ISO format, e.g. '2020-03-22'",
+    "{created.year}": "4-digit year of file creation time",
+    "{created.yy}": "2-digit year of file creation time",
+    "{created.mm}": "2-digit month of the file creation time (zero padded)",
+    "{created.month}": "Month name in user's locale of the file creation time",
+    "{created.mon}": "Month abbreviation in the user's locale of the file creation time",
+    "{created.doy}": "3-digit day of year (e.g Julian day) of file creation time, starting from 1 (zero padded)",
+    "{modified.date}": "Photo's modification date in ISO format, e.g. '2020-03-22'",
+    "{modified.year}": "4-digit year of file modification time",
+    "{modified.yy}": "2-digit year of file modification time",
+    "{modified.mm}": "2-digit month of the file modification time (zero padded)",
+    "{modified.month}": "Month name in user's locale of the file modification time",
+    "{modified.mon}": "Month abbreviation in the user's locale of the file modification time",
+    "{modified.doy}": "3-digit day of year (e.g Julian day) of file modification time, starting from 1 (zero padded)",
+    "{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",
+    "{place.name.state_province}": "State or province name from the photo's reverse geolocation data",
+    "{place.name.city}": "City or locality name from the photo's reverse geolocation data",
+    "{place.name.area_of_interest}": "Area of interest name (e.g. landmark or public place) from the photo's reverse geolocation data",
+    "{place.address}": "Postal address from the photo's reverse geolocation data, e.g. '2007 18th St NW, Washington, DC 20009, United States'",
+    "{place.address.street}": "Street part of the postal address, e.g. '2007 18th St NW'",
+    "{place.address.city}": "City part of the postal address, e.g. 'Washington'",
+    "{place.address.state_province}": "State/province part of the postal address, e.g. 'DC'",
+    "{place.address.postal_code}": "Postal code part of the postal address, e.g. '20009'",
+    "{place.address.country}": "Country name of the postal address, e.g. 'United States'",
+    "{place.address.country_code}": "ISO country code of the postal address, e.g. 'US'",
+}
+
+# Permitted multi-value substitutions (each of these returns None or 1 or more values)
+TEMPLATE_SUBSTITUTIONS_MULTI_VALUED = {
+    "{album}": "Album(s) photo is contained in",
+    "{keyword}": "Keyword(s) assigned to photo",
+    "{person}": "Person(s) / face(s) in a photo",
+}
+
+# Just the multi-valued substitution names without the braces
+MULTI_VALUE_SUBSTITUTIONS = [
+    field.replace("{", "").replace("}", "")
+    for field in TEMPLATE_SUBSTITUTIONS_MULTI_VALUED.keys()
+]
+
+
+def get_template_value(lookup, photo):
+    """ lookup template value (single-value template substitutions) for use in make_subst_function
+        lookup: value to find a match for
+        photo: PhotoInfo object whose data will be used for value substitutions
+        returns: either the matching template value (which may be None)
+        raises: KeyError if no rule exists for lookup """
+
+    # must be a valid keyword
+    if lookup == "name":
+        return pathlib.Path(photo.filename).stem
+
+    if lookup == "original_name":
+        return pathlib.Path(photo.original_filename).stem
+
+    if lookup == "title":
+        return photo.title
+
+    if lookup == "descr":
+        return photo.description
+
+    if lookup == "created.date":
+        return DateTimeFormatter(photo.date).date
+
+    if lookup == "created.year":
+        return DateTimeFormatter(photo.date).year
+
+    if lookup == "created.yy":
+        return DateTimeFormatter(photo.date).yy
+
+    if lookup == "created.mm":
+        return DateTimeFormatter(photo.date).mm
+
+    if lookup == "created.month":
+        return DateTimeFormatter(photo.date).month
+
+    if lookup == "created.mon":
+        return DateTimeFormatter(photo.date).mon
+
+    if lookup == "created.doy":
+        return DateTimeFormatter(photo.date).doy
+
+    if lookup == "modified.date":
+        return (
+            DateTimeFormatter(photo.date_modified).date if photo.date_modified else None
+        )
+
+    if lookup == "modified.year":
+        return (
+            DateTimeFormatter(photo.date_modified).year if photo.date_modified else None
+        )
+
+    if lookup == "modified.yy":
+        return (
+            DateTimeFormatter(photo.date_modified).yy if photo.date_modified else None
+        )
+
+    if lookup == "modified.mm":
+        return (
+            DateTimeFormatter(photo.date_modified).mm if photo.date_modified else None
+        )
+
+    if lookup == "modified.month":
+        return (
+            DateTimeFormatter(photo.date_modified).month
+            if photo.date_modified
+            else None
+        )
+
+    if lookup == "modified.mon":
+        return (
+            DateTimeFormatter(photo.date_modified).mon if photo.date_modified else None
+        )
+
+    if lookup == "modified.doy":
+        return (
+            DateTimeFormatter(photo.date_modified).doy if photo.date_modified else None
+        )
+
+    if lookup == "place.name":
+        return photo.place.name if photo.place else None
+
+    if lookup == "place.country_code":
+        return photo.place.country_code if photo.place else None
+
+    if lookup == "place.name.country":
+        return (
+            photo.place.names.country[0]
+            if photo.place and photo.place.names.country
+            else None
+        )
+
+    if lookup == "place.name.state_province":
+        return (
+            photo.place.names.state_province[0]
+            if photo.place and photo.place.names.state_province
+            else None
+        )
+
+    if lookup == "place.name.city":
+        return (
+            photo.place.names.city[0]
+            if photo.place and photo.place.names.city
+            else None
+        )
+
+    if lookup == "place.name.area_of_interest":
+        return (
+            photo.place.names.area_of_interest[0]
+            if photo.place and photo.place.names.area_of_interest
+            else None
+        )
+
+    if lookup == "place.address":
+        return (
+            photo.place.address_str if photo.place and photo.place.address_str else None
+        )
+
+    if lookup == "place.address.street":
+        return (
+            photo.place.address.street
+            if photo.place and photo.place.address.street
+            else None
+        )
+
+    if lookup == "place.address.city":
+        return (
+            photo.place.address.city
+            if photo.place and photo.place.address.city
+            else None
+        )
+
+    if lookup == "place.address.state_province":
+        return (
+            photo.place.address.state_province
+            if photo.place and photo.place.address.state_province
+            else None
+        )
+
+    if lookup == "place.address.postal_code":
+        return (
+            photo.place.address.postal_code
+            if photo.place and photo.place.address.postal_code
+            else None
+        )
+
+    if lookup == "place.address.country":
+        return (
+            photo.place.address.country
+            if photo.place and photo.place.address.country
+            else None
+        )
+
+    if lookup == "place.address.country_code":
+        return (
+            photo.place.address.iso_country_code
+            if photo.place and photo.place.address.iso_country_code
+            else None
+        )
+
+    # if here, didn't get a match
+    raise KeyError(f"No rule for processing {lookup}")
+
+
+def render_filepath_template(template, photo, none_str="_"):
+    """ render a filename or directory template 
+        template: str template 
+        photo: PhotoInfo object
+        none_str: str to use default for None values, default is '_' """
+
+    # the rendering happens in two phases:
+    # phase 1: handle all the single-value template substitutions
+    #          results in a single string with all the template fields replaced
+    # phase 2: loop through all the multi-value template substitutions
+    #          could result in multiple strings
+    #          e.g. if template is "{album}/{person}" and there are 2 albums and 3 persons in the photo
+    #          there would be 6 possible renderings (2 albums x 3 persons)
+
+    # regex to find {template_field,optional_default} in strings
+    # for explanation of regex see https://regex101.com/r/4JJg42/1
+    # pylint: disable=anomalous-backslash-in-string
+    regex = r"(?<!\{)\{([^\\,}]+)(,{0,1}(([\w\-. ]+))?)(?=\}(?!\}))\}"
+
+    if type(template) is not str:
+        raise TypeError(f"template must be type str, not {type(template)}")
+
+    if type(photo) is not PhotoInfo:
+        raise TypeError(f"photo must be type osxphotos.PhotoInfo, not {type(photo)}")
+
+    def make_subst_function(photo, none_str, get_func=get_template_value):
+        """ returns: substitution function for use in re.sub 
+            photo: a PhotoInfo object
+            none_str: value to use if substitution lookup is None and no default provided
+            get_func: function that gets the substitution value for a given template field
+                      default is get_template_value which handles the single-value fields """
+
+        # closure to capture photo, none_str in subst
+        def subst(matchobj):
+            groups = len(matchobj.groups())
+            if groups == 4:
+                try:
+                    val = get_func(matchobj.group(1), photo)
+                except KeyError:
+                    return matchobj.group(0)
+
+                if val is None:
+                    return (
+                        matchobj.group(3) if matchobj.group(3) is not None else none_str
+                    )
+                else:
+                    return val
+            else:
+                raise ValueError(
+                    f"Unexpected number of groups: expected 4, got {groups}"
+                )
+
+        return subst
+
+    subst_func = make_subst_function(photo, none_str)
+
+    # do the replacements
+    rendered = re.sub(regex, subst_func, template)
+
+    # do multi-valued placements
+    # start with the single string from phase 1 above then loop through all
+    # multi-valued fields and all values for each of those fields
+    # rendered_strings will be updated as each field is processed
+    # for example: if two albums, two keywords, and one person and template is:
+    # "{created.year}/{album}/{keyword}/{person}"
+    # rendered strings would do the following:
+    # start (created.year filled in phase 1)
+    #   ['2011/{album}/{keyword}/{person}']
+    # after processing albums:
+    #   ['2011/Album1/{keyword}/{person}',
+    #    '2011/Album2/{keyword}/{person}',]
+    # after processing keywords:
+    #   ['2011/Album1/keyword1/{person}',
+    #    '2011/Album1/keyword2/{person}',
+    #    '2011/Album2/keyword1/{person}',
+    #    '2011/Album2/keyword2/{person}',]
+    # after processing person:
+    #   ['2011/Album1/keyword1/person1',
+    #    '2011/Album1/keyword2/person1',
+    #    '2011/Album2/keyword1/person1',
+    #    '2011/Album2/keyword2/person1',]
+
+    rendered_strings = set([rendered])
+    for field in MULTI_VALUE_SUBSTITUTIONS:
+        if field == "album":
+            values = photo.albums
+        elif field == "keyword":
+            values = photo.keywords
+        elif field == "person":
+            values = photo.persons
+            # remove any _UNKNOWN_PERSON values
+            values = [val for val in values if val != _UNKNOWN_PERSON]
+        else:
+            raise ValueError(f"Unhandleded template value: {field}")
+
+        # If no values, insert None so code below will substite none_str for None
+        values = values or [None]
+
+        # Build a regex that matches only the field being processed
+        re_str = r"(?<!\\)\{(" + field + r")(,{0,1}(([\w\-. ]+))?)\}"
+        regex_multi = re.compile(re_str)
+
+        # holds each of the new rendered_strings, set() to avoid duplicates
+        new_strings = set()
+
+        for str_template in rendered_strings:
+            for val in values:
+
+                def get_template_value_multi(lookup_value, photo):
+                    """ Closure passed to make_subst_function get_func 
+                        Capture val and field in the closure 
+                        Allows make_subst_function to be re-used w/o modification """
+                    if lookup_value == field:
+                        return val
+                    else:
+                        raise KeyError(f"Unexpected value: {lookup_value}")
+
+                subst = make_subst_function(
+                    photo, none_str, get_func=get_template_value_multi
+                )
+                new_string = regex_multi.sub(subst, str_template)
+                new_strings.add(new_string)
+
+        # update rendered_strings for the next field to process
+        rendered_strings = new_strings
+
+    # find any {fields} that weren't replaced
+    unmatched = []
+    for rendered_str in rendered_strings:
+        unmatched.extend(
+            [
+                no_match[0]
+                for no_match in re.findall(regex, rendered_str)
+                if no_match[0] not in unmatched
+            ]
+        )
+
+    # fix any escaped curly braces
+    rendered_strings = [
+        rendered_str.replace("{{", "{").replace("}}", "}")
+        for rendered_str in rendered_strings
+    ]
+
+    return rendered_strings, unmatched
+
+
+class DateTimeFormatter:
+    """ provides property access to formatted datetime.datetime strftime values """
+
+    def __init__(self, dt: datetime.datetime):
+        self.dt = dt
+
+    @property
+    def date(self):
+        """ ISO date in form 2020-03-22 """
+        date = self.dt.date().isoformat()
+        return date
+
+    @property
+    def year(self):
+        """ 4 digit year """
+        year = f"{self.dt.year}"
+        return year
+
+    @property
+    def yy(self):
+        """ 2 digit year """
+        yy = f"{self.dt.strftime('%y')}"
+        return yy
+
+    @property
+    def mm(self):
+        """ 2 digit month """
+        mm = f"{self.dt.strftime('%m')}"
+        return mm
+
+    @property
+    def month(self):
+        """ Month as locale's full name """
+        month = f"{self.dt.strftime('%B')}"
+        return month
+
+    @property
+    def mon(self):
+        """ Month as locale's abbreviated name """
+        mon = f"{self.dt.strftime('%b')}"
+        return mon
+
+    @property
+    def doy(self):
+        """ Julian day of year starting from 001 """
+        doy = f"{self.dt.strftime('%j')}"
+        return doy

osxphotos/utils.py

@@ -1,12 +1,13 @@
 import glob
 import logging
 import os.path
+import pathlib
 import platform
 import sqlite3
 import subprocess
+import sys
 import tempfile
 import urllib.parse
-import pathlib
 from plistlib import load as plistload
 
 import CoreFoundation
@@ -113,10 +114,14 @@ def _dd_to_dms(dd):
     return int(deg_), int(min_), sec_
 
 
-def _copy_file(src, dest):
+def _copy_file(src, dest, norsrc=False):
     """ Copies a file from src path to dest path 
         src: source path as string 
         dest: destination path as string
+        norsrc: (bool) if True, uses --norsrc flag with ditto so it will not copy
+                resource fork or extended attributes.  May be useful on volumes that
+                don't work with extended attributes (likely only certain SMB mounts)
+                default is False
         Uses ditto to perform copy; will silently overwrite dest if it exists
         Raises exception if copy fails or either path is None """
 
@@ -124,19 +129,24 @@ def _copy_file(src, dest):
         raise ValueError("src and dest must not be None", src, dest)
 
     if not os.path.isfile(src):
-        raise ValueError("src file does not appear to exist", src)
+        raise FileNotFoundError("src file does not appear to exist", src)
+
+    if norsrc:
+        command = ["/usr/bin/ditto", "--norsrc", src, dest]
+    else:
+        command = ["/usr/bin/ditto", src, dest]
 
     # if error on copy, subprocess will raise CalledProcessError
     try:
-        subprocess.run(
-            ["/usr/bin/ditto", src, dest], check=True, stderr=subprocess.PIPE
-        )
+        result = subprocess.run(command, check=True, stderr=subprocess.PIPE)
     except subprocess.CalledProcessError as e:
         logging.critical(
             f"ditto returned error: {e.returncode} {e.stderr.decode(sys.getfilesystemencoding()).rstrip()}"
         )
         raise e
 
+    return result.returncode
+
 
 def dd_to_dms_str(lat, lon):
     """ convert latitude, longitude in degrees to degrees, minutes, seconds as string """
@@ -218,6 +228,8 @@ def get_last_library_path():
 
     if photosurlref is not None:
         # use CFURLCreateByResolvingBookmarkData to de-serialize bookmark data into a CFURLRef
+        # pylint: disable=no-member
+        # pylint: disable=undefined-variable
         photosurl = CoreFoundation.CFURLCreateByResolvingBookmarkData(
             kCFAllocatorDefault, photosurlref, 0, None, None, None, None
         )
@@ -255,7 +267,7 @@ def list_photo_libraries():
     # On older MacOS versions, mdfind appears to ignore some libraries
     # glob to find libraries in ~/Pictures then mdfind to find all the others
     # TODO: make this more robust
-    lib_list = glob.glob(f"{str(Path.home())}/Pictures/*.photoslibrary")
+    lib_list = glob.glob(f"{str(pathlib.Path.home())}/Pictures/*.photoslibrary")
 
     # On older OS, may not get all libraries so make sure we get the last one
     last_lib = get_last_library_path()
@@ -327,7 +339,8 @@ def _export_photo_uuid_applescript(
                   If filestem.ext exists, it wil be overwritten
         original: (boolean) if True, export original image; default = True
         edited: (boolean) if True, export edited photo; default = False
-                will produce an error if image does not have edits/adjustments 
+                If photo not edited and edited=True, will still export the original image
+                caller must verify image has been edited
         *Note*: must be called with either edited or original but not both, 
                 will raise error if called with both edited and original = True
         live_photo: (boolean) if True, export associated .mov live photo; default = False
@@ -448,7 +461,7 @@ def _db_is_locked(dbname):
         conn.close()
         logging.debug(f"{dbname} is not locked")
         locked = False
-    except Exception as e:
+    except:
         logging.debug(f"{dbname} is locked")
         locked = True
 

requirements.txt

@@ -1,23 +1,36 @@
+altgraph==0.17
 ansimarkup==1.4.0
+appdirs==1.4.3
 astroid==2.2.5
 atomicwrites==1.3.0
 attrs==19.1.0
 better-exceptions-fork==0.2.1.post6
+# bpylist2==2.0.3;python_version<"3.8"
+https://github.com/RhetTbull/bpylist/releases/download/v2.0.3/bpylist2-2.0.3.tar.gz#egg=bpylist2;python_version<"3.8"
+bpylist2==3.0.0;python_version>="3.8"
 certifi==2019.3.9
 Click==7.0
 colorama==0.4.1
 coverage==4.5.4
-importlib-metadata==0.18
+importlib-metadata>=0.18
 isort==4.3.20
 lazy-object-proxy==1.4.1
 loguru==0.2.5
+macholib==1.14
+Mako==1.1.1
+MarkupSafe==1.1.1
 mccabe==0.6.1
+modulegraph==0.18
 more-itertools==7.2.0
--e git+https://github.com/RhetTbull/osxphotos.git@0271b8ad9daf8b2fb80ce81e894478370e421379#egg=osxphotos
 packaging==19.0
+pathspec==0.7.0
+pathvalidate==2.2.1
 pluggy==0.12.0
 py==1.8.0
+py2app==0.21
 Pygments==2.4.2
+PyInstaller==3.6
+pyinstaller-setuptools==2019.3
 pylint==2.3.1
 pyobjc==6.0.1
 pyobjc-core==6.0.1
@@ -134,13 +147,12 @@ pyobjc-framework-VideoToolbox==6.0.1
 pyobjc-framework-Vision==6.0.1
 pyobjc-framework-WebKit==6.0.1
 pyparsing==2.4.1.1
-pytest==5.3.1
-pytest-cov==2.8.1
-pytest-sugar==0.9.2
 PyYAML==5.1.2
+regex==2020.2.20
 six==1.12.0
 termcolor==1.1.0
+toml==0.10.0
+typed-ast==1.4.1
 wcwidth==0.1.7
 wrapt==1.11.1
 zipp==0.5.2
-Mako==1.1.1

setup.py

@@ -61,7 +61,15 @@ setup(
         "Programming Language :: Python :: 3.6",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    install_requires=["pyobjc>=6.0.1", "Click>=7", "PyYAML>=5.1.2", "Mako>=1.1.1"],
+    install_requires=[
+        "pyobjc>=6.0.1",
+        "Click>=7",
+        "PyYAML>=5.1.2",
+        "Mako>=1.1.1",
+        "bpylist2==2.0.3;python_version<'3.8'",
+        "bpylist2==3.0.0;python_version>='3.8'",
+        "pathvalidate==2.2.1",
+    ],
     entry_points={"console_scripts": ["osxphotos=osxphotos.__main__:cli"]},
     include_package_data=True,
 )

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

@@ -3,8 +3,8 @@
 <plist version="1.0">
 <dict>
 	<key>PhotoAnalysisGraphLastBackgroundGraphRebuildJobDate</key>
-	<date>2020-01-29T06:24:15Z</date>
+	<date>2020-03-27T04:00:09Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundMemoryGenerationJobDate</key>
-	<date>2020-01-29T13:44:20Z</date>
+	<date>2020-03-27T04:00:10Z</date>
 </dict>
 </plist>

tests/Test-10.14.6.photoslibrary/private/com.apple.photomodel/appPrivateData.plist

@@ -5,7 +5,7 @@
 	<key>LithiumMessageTracer</key>
 	<dict>
 		<key>LastReportedDate</key>
-		<date>2020-01-19T14:48:46Z</date>
+		<date>2020-03-15T20:19:24Z</date>
 	</dict>
 </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-01-29T06:24:08Z</date>
+	<date>2020-03-27T03:59:54Z</date>
 </dict>
 </plist>

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

@@ -24,7 +24,7 @@
 	<key>SnapshotCompletedDate</key>
 	<date>2019-07-27T13:16:43Z</date>
 	<key>SnapshotLastValidated</key>
-	<date>2020-01-29T06:26:14Z</date>
+	<date>2020-03-27T04:02:59Z</date>
 	<key>SnapshotTables</key>
 	<dict/>
 </dict>

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

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

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

@@ -3,24 +3,24 @@
 <plist version="1.0">
 <dict>
 	<key>BackgroundHighlightCollection</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:25Z</date>
 	<key>BackgroundHighlightEnrichment</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:24Z</date>
 	<key>BackgroundJobAssetRevGeocode</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:26Z</date>
 	<key>BackgroundJobSearch</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:26Z</date>
 	<key>BackgroundPeopleSuggestion</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:23Z</date>
 	<key>BackgroundUserBehaviorProcessor</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-10T06:04:05Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphConsistencyUpdateJobDateKey</key>
-	<date>2020-03-14T06:33:02Z</date>
+	<date>2020-04-11T01:34:33Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundGraphRebuildJobDate</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-10T06:04:04Z</date>
 	<key>PhotoAnalysisGraphLastBackgroundMemoryGenerationJobDate</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-11T01:34:26Z</date>
 	<key>SiriPortraitDonation</key>
-	<date>2020-03-14T06:33:01Z</date>
+	<date>2020-04-10T06:04:05Z</date>
 </dict>
 </plist>

tests/Test-10.15.1.photoslibrary/private/com.apple.photoanalysisd/caches/vision/PhotoAnalysisServicePreferences.plist

@@ -3,8 +3,8 @@
 <plist version="1.0">
 <dict>
 	<key>FaceIDModelLastGenerationKey</key>
-	<date>2020-03-14T06:33:02Z</date>
+	<date>2020-04-10T06:04:06Z</date>
 	<key>LastContactClassificationKey</key>
-	<date>2020-03-14T06:33:03Z</date>
+	<date>2020-04-10T06:04:08Z</date>
 </dict>
 </plist>

tests/Test-10.15.1.photoslibrary/private/com.apple.photoanalysisd/caches/vision/faceWorkerState.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>IncrementalPersonProcessingStage</key>
-	<integer>6</integer>
+	<integer>0</integer>
 	<key>PersonBuilderLastMinimumFaceGroupSizeForCreatingMergeCandidates</key>
 	<integer>15</integer>
 	<key>PersonBuilderMergeCandidatesEnabled</key>

tests/Test-10.15.4.photoslibrary/database/DataModelVersion.plist

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>LibrarySchemaVersion</key>
+	<integer>5001</integer>
+	<key>MetaSchemaVersion</key>
+	<integer>3</integer>
+</dict>
+</plist>

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

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>hostname</key>
+	<string>Rhets-MacBook-Pro.local</string>
+	<key>hostuuid</key>
+	<string>9575E48B-8D5F-5654-ABAC-4431B1167324</string>
+	<key>pid</key>
+	<integer>1440</integer>
+	<key>processname</key>
+	<string>photolibraryd</string>
+	<key>uid</key>
+	<integer>501</integer>
+</dict>
+</plist>

tests/Test-10.15.4.photoslibrary/database/search/searchMetadata.plist

@@ -0,0 +1,188 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BlacklistedMeaningsByMeaning</key>
+	<dict/>
+	<key>MePersonUUID</key>
+	<string>39488755-78C0-40B2-B378-EDA280E1823C</string>
+	<key>SceneWhitelist</key>
+	<array>
+		<string>Graduation</string>
+		<string>Aquarium</string>
+		<string>Food</string>
+		<string>Ice Skating</string>
+		<string>Mountain</string>
+		<string>Cliff</string>
+		<string>Basketball</string>
+		<string>Tennis</string>
+		<string>Jewelry</string>
+		<string>Cheese</string>
+		<string>Softball</string>
+		<string>Football</string>
+		<string>Circus</string>
+		<string>Jet Ski</string>
+		<string>Playground</string>
+		<string>Carousel</string>
+		<string>Paint Ball</string>
+		<string>Windsurfing</string>
+		<string>Sailboat</string>
+		<string>Sunbathing</string>
+		<string>Dam</string>
+		<string>Fireplace</string>
+		<string>Flower</string>
+		<string>Scuba</string>
+		<string>Hiking</string>
+		<string>Cetacean</string>
+		<string>Pier</string>
+		<string>Bowling</string>
+		<string>Snowboarding</string>
+		<string>Zoo</string>
+		<string>Snowmobile</string>
+		<string>Theater</string>
+		<string>Boat</string>
+		<string>Casino</string>
+		<string>Car</string>
+		<string>Diving</string>
+		<string>Cycling</string>
+		<string>Musical Instrument</string>
+		<string>Board Game</string>
+		<string>Castle</string>
+		<string>Sunset Sunrise</string>
+		<string>Martial Arts</string>
+		<string>Motocross</string>
+		<string>Submarine</string>
+		<string>Cat</string>
+		<string>Snow</string>
+		<string>Kiteboarding</string>
+		<string>Squash</string>
+		<string>Geyser</string>
+		<string>Music</string>
+		<string>Archery</string>
+		<string>Desert</string>
+		<string>Blackjack</string>
+		<string>Fireworks</string>
+		<string>Sportscar</string>
+		<string>Feline</string>
+		<string>Soccer</string>
+		<string>Museum</string>
+		<string>Baby</string>
+		<string>Fencing</string>
+		<string>Railroad</string>
+		<string>Nascar</string>
+		<string>Sky Surfing</string>
+		<string>Bird</string>
+		<string>Games</string>
+		<string>Baseball</string>
+		<string>Dressage</string>
+		<string>Snorkeling</string>
+		<string>Pyramid</string>
+		<string>Kite</string>
+		<string>Rowboat</string>
+		<string>Golf</string>
+		<string>Watersports</string>
+		<string>Lightning</string>
+		<string>Canyon</string>
+		<string>Auditorium</string>
+		<string>Night Sky</string>
+		<string>Karaoke</string>
+		<string>Skiing</string>
+		<string>Parade</string>
+		<string>Forest</string>
+		<string>Hot Air Balloon</string>
+		<string>Dragon Parade</string>
+		<string>Easter Egg</string>
+		<string>Monument</string>
+		<string>Jungle</string>
+		<string>Thanksgiving</string>
+		<string>Jockey Horse</string>
+		<string>Stadium</string>
+		<string>Airplane</string>
+		<string>Ballet</string>
+		<string>Yoga</string>
+		<string>Coral Reef</string>
+		<string>Skating</string>
+		<string>Wrestling</string>
+		<string>Bicycle</string>
+		<string>Tattoo</string>
+		<string>Amusement Park</string>
+		<string>Canoe</string>
+		<string>Cheerleading</string>
+		<string>Ping Pong</string>
+		<string>Fishing</string>
+		<string>Magic</string>
+		<string>Reptile</string>
+		<string>Winter Sport</string>
+		<string>Waterfall</string>
+		<string>Train</string>
+		<string>Bonsai</string>
+		<string>Surfing</string>
+		<string>Dog</string>
+		<string>Cake</string>
+		<string>Sledding</string>
+		<string>Sandcastle</string>
+		<string>Glacier</string>
+		<string>Lighthouse</string>
+		<string>Equestrian</string>
+		<string>Rafting</string>
+		<string>Shore</string>
+		<string>Hockey</string>
+		<string>Santa Claus</string>
+		<string>Formula One Car</string>
+		<string>Sport</string>
+		<string>Vehicle</string>
+		<string>Boxing</string>
+		<string>Rollerskating</string>
+		<string>Underwater</string>
+		<string>Orchestra</string>
+		<string>Carnival</string>
+		<string>Rocket</string>
+		<string>Skateboarding</string>
+		<string>Helicopter</string>
+		<string>Performance</string>
+		<string>Oktoberfest</string>
+		<string>Water Polo</string>
+		<string>Skate Park</string>
+		<string>Animal</string>
+		<string>Nightclub</string>
+		<string>String Instrument</string>
+		<string>Dinosaur</string>
+		<string>Gymnastics</string>
+		<string>Cricket</string>
+		<string>Volcano</string>
+		<string>Lake</string>
+		<string>Aurora</string>
+		<string>Dancing</string>
+		<string>Concert</string>
+		<string>Rock Climbing</string>
+		<string>Hang Glider</string>
+		<string>Rodeo</string>
+		<string>Fish</string>
+		<string>Art</string>
+		<string>Motorcycle</string>
+		<string>Volleyball</string>
+		<string>Wake Boarding</string>
+		<string>Badminton</string>
+		<string>Motor Sport</string>
+		<string>Sumo</string>
+		<string>Parasailing</string>
+		<string>Skydiving</string>
+		<string>Kickboxing</string>
+		<string>Pinata</string>
+		<string>Foosball</string>
+		<string>Go Kart</string>
+		<string>Poker</string>
+		<string>Kayak</string>
+		<string>Swimming</string>
+		<string>Atv</string>
+		<string>Beach</string>
+		<string>Dartboard</string>
+		<string>Athletics</string>
+		<string>Camping</string>
+		<string>Tornado</string>
+		<string>Billiards</string>
+		<string>Rugby</string>
+		<string>Airshow</string>
+	</array>
+</dict>
+</plist>

tests/Test-10.15.4.photoslibrary/database/search/searchProgress.plist

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>insertAlbum</key>
+	<array/>
+	<key>insertAsset</key>
+	<array/>
+	<key>insertHighlight</key>
+	<array/>
+	<key>insertMemory</key>
+	<array/>
+	<key>insertMoment</key>
+	<array/>
+	<key>removeAlbum</key>
+	<array/>
+	<key>removeAsset</key>
+	<array/>
+	<key>removeHighlight</key>
+	<array/>
+	<key>removeMemory</key>
+	<array/>
+	<key>removeMoment</key>
+	<array/>
+</dict>
+</plist>

tests/Test-10.15.4.photoslibrary/database/search/searchSystemInfo.plist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>embeddingVersion</key>
+	<string>1</string>
+	<key>localeIdentifier</key>
+	<string>en_US</string>
+	<key>sceneTaxonomySHA</key>
+	<string>87914a047c69fbe8013fad2c70fa70c6c03b08b56190fe4054c880e6b9f57cc3</string>
+	<key>searchIndexVersion</key>
+	<string>10</string>
+</dict>
+</plist>

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

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>MigrationService</key>
+	<dict>
+		<key>State</key>
+		<integer>4</integer>
+	</dict>
+	<key>MigrationService.LastCompletedTask</key>
+	<integer>12</integer>
+	<key>MigrationService.ValidationCounts</key>
+	<dict>
+		<key>MigrationDetectedFaceprint</key>
+		<integer>6</integer>
+		<key>MigrationManagedAsset</key>
+		<integer>0</integer>
+		<key>MigrationSceneClassification</key>
+		<integer>44</integer>
+		<key>MigrationUnmanagedAdjustment</key>
+		<integer>0</integer>
+		<key>RDVersion.cloudLocalState.CPLIsNotPushed</key>
+		<integer>7</integer>
+	</dict>
+</dict>
+</plist>

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

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CollapsedSidebarSectionIdentifiers</key>
+	<array/>
+	<key>ExpandedSidebarItemIdentifiers</key>
+	<array>
+		<string>92D68107-B6C7-453B-96D2-97B0F26D5B8B/L0/020</string>
+	</array>
+	<key>Photos</key>
+	<dict>
+		<key>CollapsedSidebarSectionIdentifiers</key>
+		<array/>
+		<key>ExpandedSidebarItemIdentifiers</key>
+		<array>
+			<string>TopLevelAlbums</string>
+			<string>TopLevelSlideshows</string>
+		</array>
+		<key>IPXWorkspaceControllerZoomLevelsKey</key>
+		<dict>
+			<key>kZoomLevelIdentifierAlbums</key>
+			<integer>7</integer>
+			<key>kZoomLevelIdentifierVersions</key>
+			<integer>7</integer>
+		</dict>
+		<key>lastAddToDestination</key>
+		<dict>
+			<key>key</key>
+			<integer>1</integer>
+			<key>lastKnownDisplayName</key>
+			<string>September 28, 2018</string>
+			<key>type</key>
+			<string>album</string>
+			<key>uuid</key>
+			<string>DFFKmHt3Tk+AGzZLe2Xq+g</string>
+		</dict>
+		<key>lastKnownItemCounts</key>
+		<dict>
+			<key>other</key>
+			<integer>0</integer>
+			<key>photos</key>
+			<integer>7</integer>
+			<key>videos</key>
+			<integer>0</integer>
+		</dict>
+	</dict>
+</dict>
+</plist>