Added test for try/except block in cli export

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -213,6 +213,33 @@
         "example",
         "ideas"
       ]
+    },
+    {
+      "login": "kaduskj",
+      "name": "kaduskj",
+      "avatar_url": "https://avatars.githubusercontent.com/u/983067?v=4",
+      "profile": "https://github.com/kaduskj",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "mkirkland4874",
+      "name": "mkirkland4874",
+      "avatar_url": "https://avatars.githubusercontent.com/u/36466711?v=4",
+      "profile": "https://github.com/mkirkland4874",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "jcommisso07",
+      "name": "Joseph Commisso",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3111054?v=4",
+      "profile": "https://github.com/jcommisso07",
+      "contributions": [
+        "data"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/tests.yml

@@ -4,13 +4,13 @@ on: [push, pull_request]
 
 jobs:
   build:
-
-    runs-on: macOS-latest
+    runs-on: ${{ matrix.os }}
     if: "!contains(github.event.head_commit.message, '[skip ci]')"
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7, 3.8]
+        os: [macos-10.15]
+        python-version: [3.7, 3.8, 3.9]
 
     steps:
     - uses: actions/checkout@v1
@@ -21,6 +21,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
+        pip install -r dev_requirements.txt
         pip install -r requirements.txt
    # - name: Lint with flake8
    #   run: |
@@ -31,6 +32,4 @@ jobs:
        # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        pip install pytest
-        pip install pytest-mock
         python -m pytest tests/

.gitignore

@@ -15,3 +15,4 @@ osxphotos.egg-info/
 cli.spec
 *.pyc
 docsrc/_build/
+venv/

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile=black
+multi_line_output=3

CONTRIBUTING.md

@@ -0,0 +1,15 @@
+# Contributing
+
+Contributions of all kinds are welcome!  You don't need to know python to contribute to this project. For example, documentation updates are just as welcome as code!
+
+Please explore open [issues](https://github.com/RhetTbull/osxphotos/issues), [discussions](https://github.com/RhetTbull/osxphotos/discussions), and the project [wiki](https://github.com/RhetTbull/osxphotos/wiki) to learn more about the project.
+
+If you want to contribute source code, I recommend you explore the [wiki](https://github.com/RhetTbull/osxphotos/wiki/Structure-of-the-code) to learn about the source structure first.
+
+See the [README.md](tests/README.md) in the tests directory before running any tests.
+
+## Code of Conduct
+
+Be nice to each other.  Treat everyone with dignity and respect.
+
+Abusive behavior of any kind will not be tolerated here.

README.md

@@ -3,9 +3,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![tests](https://github.com/RhetTbull/osxphotos/workflows/Tests/badge.svg)](https://github.com/RhetTbull/osxphotos/workflows/Tests/badge.svg)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/osxphotos)
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-22-orange.svg?style=flat)](#contributors)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat)](#contributors)
 
 OSXPhotos provides the ability to interact with and query Apple's Photos.app library on macOS. You can query the Photos library database — for example, file name, file path, and metadata such as keywords/tags, persons/faces, albums, etc. You can also easily export both the original and edited photos.
 
@@ -35,6 +33,7 @@ OSXPhotos provides the ability to interact with and query Apple's Photos.app lib
   + [AdjustmentsInfo](#adjustmentsinfo)
   + [Raw Photos](#raw-photos)
   + [Template System](#template-system)
+  + [ExifTool](#exiftoolExifTool)
   + [Utility Functions](#utility-functions)
 * [Examples](#examples)
 * [Related Projects](#related-projects)
@@ -49,11 +48,14 @@ OSXPhotos provides the ability to interact with and query Apple's Photos.app lib
 
 ## Supported operating systems
 
-Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) until macOS Big Sur (10.16/11.1).
+Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) until macOS Big Sur (10.16/11.3).
+
+If you have access to the macOS 12 / Monterey beta and would like to help ensure osxphotos is compatible, please visit the [Discussions](https://github.com/RhetTbull/osxphotos/discussions) page and let me know!
 
 | macOS Version     | macOS name | Photos.app version |
 | ----------------- |------------|:-------------------|
-| 10.16, 11.0-11.2  | Big Sur    | 6.0 ✅             |
+| 12.0              | Monterey   | ?.0 UNKNOWN        |
+| 10.16, 11.0-11.4  | Big Sur    | 6.0 ✅             |
 | 10.15.1 - 10.15.7 | Catalina   | 5.0 ✅             |
 | 10.14.5, 10.14.6  | Mojave     | 4.0 ✅             |
 | 10.13.6           | High Sierra| 3.0 ✅             |
@@ -117,6 +119,7 @@ This package will install a command line utility called `osxphotos` that allows
 
 ```
 > osxphotos
+
 Usage: osxphotos [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -145,6 +148,8 @@ Commands:
   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...
+  repl      Run interactive osxphotos shell
+  tutorial  Display osxphotos tutorial.
 ```
 
 To get help on a specific command, use `osxphotos help <command_name>`
@@ -163,6 +168,10 @@ To get help on a specific command, use `osxphotos help <command_name>`
 
 `osxphotos query --keyword Kids --json ~/Pictures/Photos\ Library.photoslibrary >results.json`
 
+#### Find all videos larger than 200MB and add them to an album named "Big Videos" in Photos, creating the album if necessary
+
+`osxphotos query --only-movies --min-size 200MB --add-to-album "Big Videos"`
+
 ### Tutorial
 <!-- OSXPHOTOS-TUTORIAL:START --><!-- OSXPHOTOS-TUTORIAL-HEADER:START --><!-- OSXPHOTOS-TUTORIAL-HEADER:END -->
 
@@ -477,6 +486,40 @@ Then the next to you run osxphotos, you can simply do this:
 
 The configuration file is a plain text file in [TOML](https://toml.io/en/) format so the `.toml` extension is standard but you can name the file anything you like. 
 
+#### Run commands on exported photos for post-processing
+
+You can use the `--post-command` option to run one or more commands against exported files. The `--post-command` option takes two arguments: CATEGORY and COMMAND.  CATEGORY is a string that describes which category of file to run the command against.  The available categories are described in the help text available via: `osxphotos help export`. For example, the `exported` category includes all exported photos and the `skipped` category includes all photos that were skipped when running export with `--update`.  COMMAND is an osxphotos template string which will be rendered then passed to the shell for execution.  
+
+For example, the following command generates a log of all exported files and their associated keywords:
+
+`osxphotos export /path/to/export --post-command exported "echo {shell_quote,{filepath}{comma}{,+keyword,}} >> {shell_quote,{export_dir}/exported.txt}"`
+
+The special template field `{shell_quote}` ensures a string is properly quoted for execution in the shell.  For example, it's possible that a file path or keyword in this example has a space in the value and if not properly quoted, this would cause an error in the execution of the command. When running commands, the template `{filepath}` is set to the full path of the exported file and `{export_dir}` is set to the full path of the base export directory.  
+
+Explanation of the template string:
+
+```txt
+{shell_quote,{filepath}{comma}{,+keyword,}}
+ │            │         │      │        │
+ │            │         │      |        │
+ └──> quote everything after comma for proper execution in the shell
+              │         │      │        │
+              └───> filepath of the exported file
+                       │       │        │
+                       └───> insert a comma 
+                               │        │
+                               └───> join the list of keywords together with a ","
+                                        │
+                                        └───> if no keywords, insert nothing (empty string: "")
+```
+
+Another example: if you had `exiftool` installed and wanted to wipe all metadata from all exported files, you could use the following:
+
+`osxphotos export /path/to/export --post-command exported "/usr/local/bin/exiftool -all= {filepath|shell_quote}"`
+
+This command uses the `|shell_quote` template filter instead of the `{shell_quote}` template because the only thing that needs to be quoted is the path to the exported file. Template filters filter the value of the rendered template field.  A number of other filters are available and are described in the help text. 
+
+
 #### An example from an actual osxphotos user
 
 Here's a comprehensive use case from an actual osxphotos user that integrates many of the concepts discussed in this tutorial (thank-you Philippe for contributing this!):
@@ -580,6 +623,12 @@ Options:
   --no-place                      Search for photos with no associated place
                                   name info (no reverse geolocation info)
 
+  --location                      Search for photos with associated location
+                                  info (e.g. GPS coordinates)
+
+  --no-location                   Search for photos with no associated location
+                                  info (e.g. no GPS coordinates)
+
   --label LABEL                   Search for photos with image classification
                                   label LABEL (Photos 5 only). If more than one
                                   label, treated as "OR", e.g. find photos
@@ -672,6 +721,15 @@ Options:
                                   albums.
 
   --not-in-album                  Search for photos that are not in any albums.
+  --duplicate                     Search for photos with possible duplicates.
+                                  osxphotos will compare signatures of photos,
+                                  evaluating date created, size, height, width,
+                                  and edited status to find *possible*
+                                  duplicates. This does not compare images byte-
+                                  for-byte nor compare hashes but should find
+                                  photos imported multiple times or duplicated
+                                  within Photos.
+
   --min-size SIZE                 Search for photos with size >= SIZE bytes. The
                                   size evaluated is the photo's original size
                                   (when imported to Photos). Size may be
@@ -710,6 +768,23 @@ Options:
                                   additional documentation on the PhotoInfo
                                   class.
 
+  --query-function filename.py::function
+                                  Run function to filter photos. Use this in
+                                  format: --query-function filename.py::function
+                                  where filename.py is a python file you've
+                                  created and function is the name of the
+                                  function in the python file you want to call.
+                                  Your function will be passed a list of
+                                  PhotoInfo objects and is expected to return a
+                                  filtered list of PhotoInfo objects. You may
+                                  use more than one function by repeating the
+                                  --query-function option with a different
+                                  value. Your query function will be called
+                                  after all other query options have been
+                                  evaluated. See https://github.com/RhetTbull/os
+                                  xphotos/blob/master/examples/query_function.py
+                                  for example of how to use this option.
+
   --missing                       Export only photos missing from the Photos
                                   library; must be used with --download-missing.
 
@@ -787,11 +862,11 @@ Options:
   --skip-live                     Do not export the associated live video
                                   component of a live photo.
 
-  --skip-raw                      Do not export associated raw images of a
-                                  RAW+JPEG pair.  Note: this does not skip raw
-                                  photos if the raw photo does not have an
-                                  associated jpeg image (e.g. the raw file was
-                                  imported to Photos without a jpeg preview).
+  --skip-raw                      Do not export associated RAW image of a
+                                  RAW+JPEG pair.  Note: this does not skip RAW
+                                  photos if the RAW photo does not have an
+                                  associated JPEG image (e.g. the RAW file was
+                                  imported to Photos without a JPEG preview).
 
   --current-name                  Use photo's current filename instead of
                                   original filename for export.  Note: Starting
@@ -799,15 +874,43 @@ Options:
                                   import.  By default, photos are exported with
                                   the the original name they had before import.
 
-  --convert-to-jpeg               Convert all non-jpeg images (e.g. raw, HEIC,
-                                  PNG, etc) to JPEG upon export.  Only works if
-                                  your Mac has a GPU.
+  --convert-to-jpeg               Convert all non-JPEG images (e.g. RAW, HEIC,
+                                  PNG, etc) to JPEG upon export. Note: does not
+                                  convert the RAW component of a RAW+JPEG pair
+                                  as the associated JPEG image will be exported.
+                                  You can use --skip-raw to skip exporting the
+                                  associated RAW image of a RAW+JPEG pair. See
+                                  also --jpeg-quality and --jpeg-ext. Only works
+                                  if your Mac has a GPU (thus may not work on
+                                  virtual machines).
 
   --jpeg-quality FLOAT RANGE      Value in range 0.0 to 1.0 to use with
                                   --convert-to-jpeg. A value of 1.0 specifies
                                   best quality, a value of 0.0 specifies maximum
                                   compression. Defaults to 1.0
 
+  --preview                       Export preview image generated by Photos. This
+                                  is a lower-resolution image used by Photos to
+                                  quickly preview the image. See also --preview-
+                                  suffix and --preview-if-missing.
+
+  --preview-if-missing            Export preview image generated by Photos if
+                                  the actual photo file is missing from the
+                                  library. This may be helpful if photos were
+                                  not copied to the Photos library and the
+                                  original photo is missing. See also --preview-
+                                  suffix and --preview.
+
+  --preview-suffix SUFFIX         Optional suffix template for naming preview
+                                  photos.  Default name for preview photos is in
+                                  form 'photoname_preview.ext'. For example,
+                                  with '--preview-suffix _low_res', the preview
+                                  photo would be named 'photoname_low_res.ext'.
+                                  The default suffix is '_preview'. Multi-value
+                                  templates (see Templating System) are not
+                                  permitted with --preview-suffix. See also
+                                  --preview and --preview-if-missing.
+
   --download-missing              Attempt to download missing photos from
                                   iCloud. The current implementation uses
                                   Applescript to interact with Photos to export
@@ -1080,6 +1183,38 @@ Options:
                                   know how well it will work on large export
                                   sets.
 
+  --post-command CATEGORY COMMAND
+                                  Run COMMAND on exported files of category
+                                  CATEGORY.  CATEGORY can be one of: exported,
+                                  new, updated, skipped, missing, exif_updated,
+                                  touched, converted_to_jpeg,
+                                  sidecar_json_written, sidecar_json_skipped,
+                                  sidecar_exiftool_written,
+                                  sidecar_exiftool_skipped, sidecar_xmp_written,
+                                  sidecar_xmp_skipped, error. COMMAND is an
+                                  osxphotos template string, for example: '--
+                                  post-command exported "echo
+                                  {filepath|shell_quote} >>
+                                  {export_dir}/exported.txt"', which appends the
+                                  full path of all exported files to the file
+                                  'exported.txt'. You can run more than one
+                                  command by repeating the '--post-command'
+                                  option with different arguments. See Post
+                                  Command below.
+
+  --post-function filename.py::function
+                                  Run function on exported files. Use this in
+                                  format: --post-function filename.py::function
+                                  where filename.py is a python file you've
+                                  created and function is the name of the
+                                  function in the python file you want to call.
+                                  The function will be passed information about
+                                  the photo that's been exported and a list of
+                                  all exported files associated with the photo.
+                                  You can run more than one function by
+                                  repeating the '--post-function' option with
+                                  different arguments. See Post Function below.
+
   --exportdb EXPORTDB_FILE        Specify alternate name for database file which
                                   stores state information for export and
                                   --update. If --exportdb is not specified,
@@ -1247,6 +1382,8 @@ Valid filters are:
  • braces: Enclose value in curly braces, e.g. 'value => '{value}'.             
  • parens: Enclose value in parentheses, e.g. 'value' => '(value')              
  • brackets: Enclose value in brackets, e.g. 'value' => '[value]'               
+ • shell_quote: Quotes the value for safe usage in the shell, e.g. My file.jpeg 
+   => 'My file.jpeg'; only adds quotes if needed.                               
  • function: Run custom python function to filter value; use in format          
    'function:/path/to/file.py::function_name'. See example at https://github.com
    /RhetTbull/osxphotos/blob/master/examples/template_filter.py                 
@@ -1639,6 +1776,8 @@ Substitution                    Description
 {lf}                            A line feed: '\n', alias for {newline}
 {cr}                            A carriage return: '\r'
 {crlf}                          a carriage return + line feed: '\r\n'
+{osxphotos_version}             The osxphotos version, e.g. '0.42.59'
+{osxphotos_cmd_line}            The full command line used to run osxphotos
 
 The following substitutions may result in multiple values. Thus if specified for
 --directory these could result in multiple copies of a photo being being
@@ -1705,6 +1844,11 @@ Substitution             Description
                          https://rhettbull.github.io/osxphotos/ for additional
                          documentation on the PhotoInfo class.
 
+{shell_quote}            Use in form '{shell_quote,TEMPLATE}'; quotes the
+                         rendered TEMPLATE value(s) for safe usage in the
+                         shell, e.g. My file.jpeg => 'My file.jpeg'; only adds
+                         quotes if needed.
+
 {function}               Execute a python function from an external file and
                          use return value as template substitution. Use in
                          format: {function:file.py::function_name} where
@@ -1716,6 +1860,115 @@ Substitution             Description
                          example of how to implement a template function.
 
 
+The following substitutions are file or directory paths. You can access various
+parts of the path using the following modifiers:
+
+{path.parent}: the parent directory
+{path.name}: the name of the file or final sub-directory
+{path.stem}: the name of the file without the extension
+{path.suffix}: the suffix of the file including the leading '.'
+
+For example, if the field {export_dir} is '/Shared/Backup/Photos':
+{export_dir.parent} is '/Shared/Backup'
+
+If the field {filepath} is '/Shared/Backup/Photos/IMG_1234.JPG':
+{filepath.parent} is '/Shared/Backup/Photos'
+{filepath.name} is 'IMG_1234.JPG'
+{filepath.stem} is 'IMG_1234'
+{filepath.suffix} is '.JPG'
+
+Substitution  Description
+{export_dir}  The full path to the export directory
+{filepath}    The full path to the exported file
+
+
+** Post Command **
+You can run commands on the exported photos for post-processing using the '--
+post-command' option. '--post-command' is passed a CATEGORY and a COMMAND.
+COMMAND is an osxphotos template string which will be rendered and passed to the
+shell for execution. CATEGORY is the category of file to pass to COMMAND. The
+following categories are available:
+
+Catgory                   Description
+exported                  All exported files
+new                       When used with '--update', all newly exported files
+updated                   When used with '--update', all files which were
+                          previously exported but updated this time
+
+skipped                   When used with '--update', all files which were
+                          skipped (because they were previously exported and
+                          didn't change)
+
+missing                   All files which were not exported because they were
+                          missing from the Photos library
+
+exif_updated              When used with '--exiftool', all files on which
+                          exiftool updated the metadata
+
+touched                   When used with '--touch-file', all files where the
+                          date was touched
+
+converted_to_jpeg         When used with '--convert-to-jpeg', all files which
+                          were converted to jpeg
+
+sidecar_json_written      When used with '--sidecar json', all JSON sidecar
+                          files which were written
+
+sidecar_json_skipped      When used with '--sidecar json' and '--update', all
+                          JSON sidecar files which were skipped
+
+sidecar_exiftool_written  When used with '--sidecar exiftool', all exiftool
+                          sidecar files which were written
+
+sidecar_exiftool_skipped  When used with '--sidecar exiftool' and '--update,
+                          all exiftool sidecar files which were skipped
+
+sidecar_xmp_written       When used with '--sidecar xmp', all XMP sidecar
+                          files which were written
+
+sidecar_xmp_skipped       When used with '--sidecar xmp' and '--update', all
+                          XMP sidecar files which were skipped
+
+error                     All files which produced an error during export
+
+In addition to all normal template fields, the template fields '{filepath}' and
+'{export_dir}' will be available to your command template. Both of these are
+path-type templates which means their various parts can be accessed using the
+available properties, e.g. '{filepath.name}' provides just the file name without
+path and '{filepath.suffix}' is the file extension (suffix) of the file. When
+using paths in your command template, it is important to properly quote the
+paths as they will be passed to the shell and path names may contain spaces.
+Both the '{shell_quote}' template and the '|shell_quote' template filter are
+available for this purpose.  For example, the following command outputs the full
+path of newly exported files to file 'new.txt':
+
+--post-command new "echo {filepath.name|shell_quote} >> {shell_quote,{export_dir}/exported.txt}"
+
+In the above command, the 'shell_quote' filter is used to ensure
+'{filepath.name}' is properly quoted and the '{shell_quote}' template ensures
+the constructed path of '{exported_dir}/exported.txt' is properly quoted. If
+'{filepath.name}' is 'IMG 1234.jpeg' and '{export_dir}' is '/Volumes/Photo
+Export', the command thus renders to:
+
+echo 'IMG 1234.jpeg' >> '/Volumes/Photo Export/exported.txt'
+
+It is highly recommended that you run osxphotos with '--dry-run --verbose' first
+to ensure your commands are as expected. This will not actually run the commands
+but will print out the exact command string which would be executed.
+
+
+** Post Function **
+You can run your own python functions on the exported photos for post-processing
+using the '--post-function' option. '--post-function' is passed the name a
+python file and the name of the function in the file to call using format
+'filename.py::function_name'. See the example function at
+https://github.com/RhetTbull/osxphotos/blob/master/examples/post_function.py You
+may specify multiple functions to run by repeating the --post-function option.
+All post functions will be called immediately after export of each photo and
+immediately before any --post-command commands. Post functions will not be
+called if the --dry-run flag is set.
+
+
 
 ```
 <!-- OSXPHOTOS-EXPORT-USAGE:END -->
@@ -2217,6 +2470,9 @@ Returns the original filename of the photo when it was imported to Photos.  **No
 #### `date`
 Returns the create date of the photo as a datetime.datetime object
 
+#### `date_added`
+Returns the date the photo was added to the Photos library as a timezone aware datetime.datetime object, or None if the data added cannot be determined
+
 #### `date_modified`
 Returns the modification date of the photo as a datetime.datetime object or None if photo has no modification date
 
@@ -2255,6 +2511,23 @@ Returns the absolute path to the edited photo on disk as a string.  If the photo
 
 **Note**: will also return None if the edited photo is missing on disk. 
 
+#### `path_derivatives`
+Returns list of paths to any derivative preview images associated with the photo. The list of returned paths is sorted in descieding order by size (the largest, presumably highest quality) preview image will be the first element in the returned list. These will be named something like this on Photos 5+: 
+
+- `F19E06B8-A712-4B5C-907A-C007D37BDA16_1_101_o.jpeg`
+- `F19E06B8-A712-4B5C-907A-C007D37BDA16_1_102_o.jpeg`
+- `F19E06B8-A712-4B5C-907A-C007D37BDA16_1_105_c.jpeg`
+
+On Photos <=4, they'll be named something like:
+
+- `UNADJUSTEDNONRAW_mini_6.jpg`
+- `UNADJUSTEDNONRAW_thumb_6.jpg`
+- `Y6OofYkbR96spbS6XgwOQw_mini_1.jpg`
+
+I've not yet decoded the suffixes to know which preview is used for which purpose but in general, if you look for the largest file, you'll get the highest resolution preview. Note that video files and Live images may have both a `.mov` video preview as well as a `.jpeg` still-image preview (the JPEG file is the one Photos displays as the "cover" for the video.)
+
+Returns empty list if no preview images are found.
+
 #### `path_raw`
 Returns the absolute path to the associated raw photo on disk as a string, if photo is part of a RAW+JPEG pair, otherwise returns None.  See [notes on Raw Photos](#raw-photos).
 
@@ -2417,6 +2690,9 @@ Returns the path to the live video component of a [live photo](#live_photo). If
 
 **Note**: will also return None if the live video component is missing on disk. It's possible that the original photo may be on disk ([ismissing](#ismissing)==False) but the video component is missing, likely because it has not been downloaded from iCloud.
 
+#### `path_edited_live_photo`
+Returns the path to the edited live video component of an edited [live photo](#live_photo). If photo is not a live photo or not edited, returns None.
+
 #### `portrait`
 Returns True if photo was taken in iPhone portrait mode, otherwise False.
 
@@ -2478,7 +2754,7 @@ Returns an [ExifInfo](#exifinfo) object with EXIF details from the Photos databa
 See also `exiftool`.
 
 #### `exiftool`
-Returns an ExifTool object for the photo which provides an interface to [exiftool](https://exiftool.org/) allowing you to read or write the actual EXIF data in the image file inside the Photos library.  If [exif_info](#exif-info) doesn't give you all the data you need, you can use `exiftool` to read the entire EXIF contents of the image.
+Returns an [ExifToolCaching](#exiftoolExifTool) object for the photo which provides an interface to [exiftool](https://exiftool.org/) allowing you to read the actual EXIF data in the image file inside the Photos library.  If [exif_info](#exif-info) doesn't give you all the data you need, you can use `exiftool` to read the entire EXIF contents of the image.
 
 If the file is missing from the library (e.g. not downloaded from iCloud), returns None. 
 
@@ -2491,7 +2767,7 @@ exiftool must be installed in the path for this to work.  If exiftool cannot be
 >>>
 ```
 
-`ExifTool` provides the following methods:
+`ExifToolCaching` provides the following methods:
 
 - `asdict(tag_groups=True)`: returns all EXIF metadata found in the file as a dictionary in following form (Note: this shows just a subset of available metadata).  See [exiftool](https://exiftool.org/) documentation to understand which metadata keys are available. If `tag_groups` is True (default) dict keys are in form "GROUP:TAG", e.g. "IPTC:Keywords". If `tag_groups` is False, dict keys do not have group names, e.g. "Keywords".
 
@@ -2509,14 +2785,7 @@ exiftool must be installed in the path for this to work.  If exiftool cannot be
 
 - `json()`: returns same information as `asdict()` but as a serialized JSON string.
 
-- `setvalue(tag, value)`: write to the EXIF data in the photo file. To delete a tag, use setvalue with value = `None`. For example:
-```python
-photo.exiftool.setvalue("XMP:Title", "Title of photo")
-```
-- `addvalues(tag, *values)`: Add one or more value(s) to tag.  For a tag that accepts multiple values, like "IPTC:Keywords", this will add the values as additional list values.  However, for tags which are not usually lists, such as "EXIF:ISO" this will literally add the new value to the old value which is probably not the desired effect.  Be sure you understand the behavior of the individual tag before using this. For example:
-```python
-photo.exiftool.addvalues("IPTC:Keywords", "vacation", "beach")
-```
+The `ExifToolCaching` class caches values read from the photo via `exiftool` and is read-only.  This speeds access to the underlying EXIF data but any changes made to the EXIF data in the image will not be reflected in subsequent calls to `exiftool`.  In practice, the images in the Photos Library should not be modified after import so this is unlikely to cause any issues.
 
 **Caution**: I caution against writing new EXIF data to photos in the Photos library because this will overwrite the original copy of the photo and could adversely affect how Photos behaves.  `exiftool.asdict()` is useful for getting access to all the photos information but if you want to write new EXIF data, I recommend you export the photo first then write the data.  [PhotoInfo.export()](#export) does this if called with `exiftool=True`.
 
@@ -2525,6 +2794,9 @@ Returns a [ScoreInfo](#scoreinfo) data class object which provides access to the
 
 **Note**: Valid only for Photos 5; returns None for earlier Photos versions.
 
+#### `duplicates`
+Returns list of PhotoInfo objects for *possible* duplicates or empty list if no matching duplicates.  Photos are considered possible duplicates if the photo's original file size, date created, height, and width match another those of another photo.  This does not do a byte-for-byte comparison or compute a hash which makes it fast and allows for identification of possible duplicates even if originals are not downloaded from iCloud.  The signature-based approach should be robust enough to match duplicates created either through the "duplicate photo" menu item or imported twice into the library but you should not rely on this 100% for identification of all duplicates.
+
 #### `json()`
 Returns a JSON representation of all photo info.
 
@@ -2532,11 +2804,11 @@ Returns a JSON representation of all photo info.
 Returns a dictionary representation of all photo info.
 
 #### `export()`
-`export(dest, *filename, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)`
+`export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=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.  **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).
+- 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)
 - export_as_hardlink: boolean; if True (default=False), will hardlink files instead of copying them
 - overwrite: boolean; if True (default=False), will overwrite files if they alreay exist
@@ -3152,6 +3424,7 @@ Valid filters are:
 - braces: Enclose value in curly braces, e.g. 'value => '{value}'.
 - parens: Enclose value in parentheses, e.g. 'value' => '(value')
 - brackets: Enclose value in brackets, e.g. 'value' => '[value]'
+- shell_quote: Quotes the value for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.
 - function: Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py
 <!-- OSXPHOTOS-FILTER-TABLE:END -->
 
@@ -3328,6 +3601,8 @@ The following template field substitutions are availabe for use the templating s
 |{lf}|A line feed: '\n', alias for {newline}|
 |{cr}|A carriage return: '\r'|
 |{crlf}|a carriage return + line feed: '\r\n'|
+|{osxphotos_version}|The osxphotos version, e.g. '0.42.59'|
+|{osxphotos_cmd_line}|The full command line used to run osxphotos|
 |{album}|Album(s) photo is contained in|
 |{folder_album}|Folder path + album photo is contained in. e.g. 'Folder/Subfolder/Album' or just 'Album' if no enclosing folder|
 |{keyword}|Keyword(s) assigned to photo|
@@ -3341,9 +3616,70 @@ The following template field substitutions are availabe for use the templating s
 |{searchinfo.venue}|Venues associated with a photo, e.g. name of restaurant; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
 |{searchinfo.venue_type}|Venue types associated with a photo, e.g. 'Restaurant'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
 |{photo}|Provides direct access to the PhotoInfo object for the photo. Must be used in format '{photo.property}' where 'property' represents a PhotoInfo property. For example: '{photo.favorite}' is the same as '{favorite}' and '{photo.place.name}' is the same as '{place.name}'. '{photo}' provides access to properties that are not available as separate template fields but it assumes some knowledge of the underlying PhotoInfo class.  See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.|
+|{shell_quote}|Use in form '{shell_quote,TEMPLATE}'; quotes the rendered TEMPLATE value(s) for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.|
 |{function}|Execute a python function from an external file and use return value as template substitution. Use in format: {function:file.py::function_name} where 'file.py' is the name of the python file and 'function_name' is the name of the function to call. The function will be passed the PhotoInfo object for the photo. See https://github.com/RhetTbull/osxphotos/blob/master/examples/template_function.py for an example of how to implement a template function.|
 <!-- OSXPHOTOS-TEMPLATE-TABLE:END -->
 
+### <a name="exiftoolExifTool">ExifTool</a>
+
+osxphotos includes its own `exiftool` library that can be accessed via `osxphotos.exiftool`:
+
+```python
+>>> from osxphotos.exiftool import ExifTool
+>>> exiftool = ExifTool("/Users/rhet/Downloads/test.jpeg")
+>>> exifdict = exiftool.asdict()
+>>> exifdict["EXIF:Make"]
+'Canon'
+>>> exiftool.setvalue("IPTC:Keywords","Keyword1")
+True
+>>> exiftool.asdict()["IPTC:Keywords"]
+'Keyword1'
+>>> exiftool.addvalues("IPTC:Keywords","Keyword2","Keyword3")
+True
+>>> exiftool.asdict()["IPTC:Keywords"]
+['Keyword1', 'Keyword2', 'Keyword3']
+```
+
+`ExifTool(filepath, exiftool=None)`
+
+- `filepath`: str, path to photo
+- `exiftool`: str, optional path to `exiftool`; if not provided, will look for `exiftool` in the system path
+
+#### ExifTool methods
+
+- `asdict(tag_groups=True)`: returns all EXIF metadata found in the file as a dictionary in following form (Note: this shows just a subset of available metadata).  See [exiftool](https://exiftool.org/) documentation to understand which metadata keys are available. If `tag_groups` is True (default) dict keys are in form "GROUP:TAG", e.g. "IPTC:Keywords". If `tag_groups` is False, dict keys do not have group names, e.g. "Keywords".
+
+```python
+{'Composite:Aperture': 2.2,
+ 'Composite:GPSPosition': '-34.9188916666667 138.596861111111',
+ 'Composite:ImageSize': '2754 2754',
+ 'EXIF:CreateDate': '2017:06:20 17:18:56',
+ 'EXIF:LensMake': 'Apple',
+ 'EXIF:LensModel': 'iPhone 6s back camera 4.15mm f/2.2',
+ 'EXIF:Make': 'Apple',
+ 'XMP:Title': 'Elder Park',
+}
+```
+
+- `json()`: returns same information as `asdict()` but as a serialized JSON string.
+
+- `setvalue(tag, value)`: write to the EXIF data in the photo file. To delete a tag, use setvalue with value = `None`. For example:
+```python
+photo.exiftool.setvalue("XMP:Title", "Title of photo")
+```
+- `addvalues(tag, *values)`: Add one or more value(s) to tag.  For a tag that accepts multiple values, like "IPTC:Keywords", this will add the values as additional list values.  However, for tags which are not usually lists, such as "EXIF:ISO" this will literally add the new value to the old value which is probably not the desired effect.  Be sure you understand the behavior of the individual tag before using this. For example:
+```python
+photo.exiftool.addvalues("IPTC:Keywords", "vacation", "beach")
+```
+
+osxphotos.exiftool also provides an `ExifToolCaching` class which caches all metadata after the first call to `exiftool`. This can significantly speed up repeated access to the metadata but should only be used if you do not intend to modify the file's metadata.
+
+[`PhotoInfo.exiftool`](#exiftool) returns an `ExifToolCaching` instance for the original image in the Photos library.
+
+#### Implementation Note
+
+`ExifTool()` runs `exiftool` as a subprocess using the `-stay_open True` flag to keep the process running in the background.  The subprocess will be cleaned up when your main script terminates.  `ExifTool()` uses a singleton pattern to ensure that only one instance of `exiftool` is created.  Multiple instances of `ExifTool()` will all use the same `exiftool` subprocess.
+
 ### Utility Functions
 
 The following functions are located in osxphotos.utils
@@ -3480,6 +3816,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   </tr>
   <tr>
     <td align="center"><a href="http://blog.dewost.com/"><img src="https://avatars.githubusercontent.com/u/17090228?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Philippe Dewost</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/commits?author=pdewost" title="Documentation">📖</a> <a href="#example-pdewost" title="Examples">💡</a> <a href="#ideas-pdewost" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/kaduskj"><img src="https://avatars.githubusercontent.com/u/983067?v=4?s=75" width="75px;" alt=""/><br /><sub><b>kaduskj</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/issues?q=author%3Akaduskj" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/mkirkland4874"><img src="https://avatars.githubusercontent.com/u/36466711?v=4?s=75" width="75px;" alt=""/><br /><sub><b>mkirkland4874</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/issues?q=author%3Amkirkland4874" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/jcommisso07"><img src="https://avatars.githubusercontent.com/u/3111054?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Joseph Commisso</b></sub></a><br /><a href="#data-jcommisso07" title="Data">🔣</a></td>
   </tr>
 </table>
 
@@ -3501,7 +3840,7 @@ My goal is make osxphotos as reliable and comprehensive as possible.  The test s
 
 ## Implementation Notes
 
-This package works by creating a copy of the sqlite3 database that photos uses to store data about the photos library. The class PhotosDB then queries this database to extract information about the photos such as persons (faces identified in the photos), albums, keywords, etc.  If your library is large, the database can be hundreds of MB in size and the copy read then  can take many 10s of seconds to complete.  Once copied, the entire database is processed and an in-memory data structure is created meaning all subsequent accesses of the PhotosDB object occur much more quickly. 
+This package works by creating a copy of the sqlite3 database that photos uses to store data about the photos library. The class PhotosDB then queries this database to extract information about the photos such as persons (faces identified in the photos), albums, keywords, etc.  If your library is large, the database can be hundreds of MB in size and the copy read then can take many 10s of seconds to complete.  Once copied, the entire database is processed and an in-memory data structure is created meaning all subsequent accesses of the PhotosDB object occur much more quickly. The database processing code is rather ugly (though it works and is well tested).  Were I to start this project today, I'd likely use something like SQLAlchemy to map Python objects to the underlying SQL database instead of the way osxphotos does things today.
 
 If apple changes the database format this will likely break.
 
@@ -3520,6 +3859,7 @@ For additional details about how osxphotos is implemented or if you would like t
 - [Rich](https://github.com/willmcgugan/rich)
 - [textx](https://github.com/textX/textX)
 - [bitmath](https://github.com/tbielawa/bitmath)
+- [more-itertools](https://github.com/more-itertools/more-itertools)
 
 
 ## Acknowledgements

README.rst

@@ -16,8 +16,9 @@ You can also easily export both the original and edited photos.
 Supported operating systems
 ---------------------------
 
-Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) until macOS Catalina (10.15.7). 
-Beta support for macOS Big Sur (10.16.01/11.01).
+Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) through macOS Big Sur (11.3).
+
+If you have access to macOS 12 / Monterey beta and would like to help ensure osxphotos is compatible, please contact me via GitHub.
 
 This package will read Photos databases for any supported version on any supported macOS version.  
 E.g. you can read a database created with Photos 5.0 on MacOS 10.15 on a machine running macOS 10.12 and vice versa.
@@ -109,6 +110,8 @@ Alternatively, you can also run the command line utility like this: ``python3 -m
      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...
+     repl      Run interactive osxphotos shell
+     tutorial  Display osxphotos tutorial.
 
 To get help on a specific command, use ``osxphotos help <command_name>``
 
@@ -146,6 +149,11 @@ export default library using 'country name/year' as output directory (but use "N
 
 ``osxphotos export ~/Desktop/export --directory "{place.name.country,NoCountry}/{created.year}"  --person-keyword --album-keyword --keyword-template "{created.year}" --exiftool --update --verbose``
 
+find all videos larger than 200MB and add them to Photos album "Big Videos" creating the album if necessary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+``osxphotos query --only-movies --min-size 200MB --add-to-album "Big Videos"``
+
 Example uses of the package
 ---------------------------
 

dev_requirements.txt

@@ -0,0 +1,7 @@
+pytest==6.2.4
+pytest-mock==3.6.1
+Sphinx==4.0.2
+sphinx-rtd-theme==0.5.2
+wheel==0.36.2
+twine==3.4.1
+pyinstaller==4.3

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 5342827b9d06cfc608d1a286ed0f5c3f
+config: 210ecd9d654dea5d4c21627449ca1d63
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; osxphotos 0.42.14 documentation</title>
+    <title>Overview: module code &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>

docs/_modules/osxphotos/photoinfo/_photoinfo_export.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos.photoinfo._photoinfo_export &#8212; osxphotos 0.41.10 documentation</title>
+    <title>osxphotos.photoinfo._photoinfo_export &#8212; osxphotos 0.42.17 documentation</title>
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -122,6 +122,9 @@
         <span class="n">xattr_skipped</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
         <span class="n">deleted_files</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
         <span class="n">deleted_directories</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">exported_album</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">skipped_album</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
+        <span class="n">missing_album</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
     <span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">exported</span> <span class="o">=</span> <span class="n">exported</span> <span class="ow">or</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">new</span> <span class="o">=</span> <span class="n">new</span> <span class="ow">or</span> <span class="p">[]</span>
@@ -144,6 +147,9 @@
         <span class="bp">self</span><span class="o">.</span><span class="n">xattr_skipped</span> <span class="o">=</span> <span class="n">xattr_skipped</span> <span class="ow">or</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">deleted_files</span> <span class="o">=</span> <span class="n">deleted_files</span> <span class="ow">or</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">deleted_directories</span> <span class="o">=</span> <span class="n">deleted_directories</span> <span class="ow">or</span> <span class="p">[]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">exported_album</span> <span class="o">=</span> <span class="n">exported_album</span> <span class="ow">or</span> <span class="p">[]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">skipped_album</span> <span class="o">=</span> <span class="n">skipped_album</span> <span class="ow">or</span> <span class="p">[]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">missing_album</span> <span class="o">=</span> <span class="n">missing_album</span> <span class="ow">or</span> <span class="p">[]</span>
 
     <span class="k">def</span> <span class="nf">all_files</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot; return all filenames contained in results &quot;&quot;&quot;</span>
@@ -190,6 +196,10 @@
         <span class="bp">self</span><span class="o">.</span><span class="n">exiftool_error</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">exiftool_error</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">deleted_files</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">deleted_files</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">deleted_directories</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">deleted_directories</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">exported_album</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">exported_album</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">skipped_album</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">skipped_album</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">missing_album</span> <span class="o">+=</span> <span class="n">other</span><span class="o">.</span><span class="n">missing_album</span>
+
         <span class="k">return</span> <span class="bp">self</span>
 
     <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -214,6 +224,9 @@
             <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,exiftool_error=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">exiftool_error</span><span class="si">}</span><span class="s2">&quot;</span>
             <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,deleted_files=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">deleted_files</span><span class="si">}</span><span class="s2">&quot;</span>
             <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,deleted_directories=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">deleted_directories</span><span class="si">}</span><span class="s2">&quot;</span>
+            <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,exported_album=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">exported_album</span><span class="si">}</span><span class="s2">&quot;</span>
+            <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,skipped_album=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">skipped_album</span><span class="si">}</span><span class="s2">&quot;</span>
+            <span class="o">+</span> <span class="sa">f</span><span class="s2">&quot;,missing_album=</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">missing_album</span><span class="si">}</span><span class="s2">&quot;</span>
             <span class="o">+</span> <span class="s2">&quot;)&quot;</span>
         <span class="p">)</span>
 
@@ -654,7 +667,11 @@
                 <span class="p">)</span>
             <span class="n">edited_name</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path_edited</span><span class="p">)</span><span class="o">.</span><span class="n">name</span>
             <span class="n">edited_suffix</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="n">edited_name</span><span class="p">)</span><span class="o">.</span><span class="n">suffix</span>
-            <span class="n">fname</span> <span class="o">=</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">original_filename</span><span class="p">)</span><span class="o">.</span><span class="n">stem</span> <span class="o">+</span> <span class="n">edited_identifier</span> <span class="o">+</span> <span class="n">edited_suffix</span>
+            <span class="n">fname</span> <span class="o">=</span> <span class="p">(</span>
+                <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">original_filename</span><span class="p">)</span><span class="o">.</span><span class="n">stem</span>
+                <span class="o">+</span> <span class="n">edited_identifier</span>
+                <span class="o">+</span> <span class="n">edited_suffix</span>
+            <span class="p">)</span>
         <span class="k">else</span><span class="p">:</span>
             <span class="n">fname</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">original_filename</span>
 
@@ -1687,7 +1704,7 @@
             <span class="n">exif</span><span class="p">[</span><span class="s2">&quot;QuickTime:ModifyDate&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime_tz_to_utc</span><span class="p">(</span>
                 <span class="bp">self</span><span class="o">.</span><span class="n">date_modified</span>
             <span class="p">)</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y:%m:</span><span class="si">%d</span><span class="s2"> %H:%M:%S&quot;</span><span class="p">)</span>
-    
+
     <span class="c1"># remove any new lines in any fields</span>
     <span class="k">for</span> <span class="n">field</span><span class="p">,</span> <span class="n">val</span> <span class="ow">in</span> <span class="n">exif</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
         <span class="k">if</span> <span class="nb">type</span><span class="p">(</span><span class="n">val</span><span class="p">)</span> <span class="o">==</span> <span class="nb">str</span><span class="p">:</span>

docs/_modules/osxphotos/photoinfo/photoinfo.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos.photoinfo.photoinfo &#8212; osxphotos 0.42.12 documentation</title>
+    <title>osxphotos.photoinfo.photoinfo &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -521,7 +521,7 @@
         <span class="k">try</span><span class="p">:</span>
             <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_burst_album_info</span>
         <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
-            <span class="n">burst_album_info</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">album_info</span><span class="p">)</span> 
+            <span class="n">burst_album_info</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">album_info</span><span class="p">)</span>
             <span class="k">for</span> <span class="n">photo</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">burst_photos</span><span class="p">:</span>
                 <span class="k">if</span> <span class="n">photo</span><span class="o">.</span><span class="n">burst_key</span><span class="p">:</span>
                     <span class="n">burst_album_info</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">photo</span><span class="o">.</span><span class="n">album_info</span><span class="p">)</span>
@@ -637,6 +637,23 @@
         <span class="k">else</span><span class="p">:</span>
             <span class="k">return</span> <span class="kc">None</span>
 
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">date_added</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Date photo was added to the database &quot;&quot;&quot;</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_date_added</span>
+        <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
+            <span class="n">added_date</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_info</span><span class="p">[</span><span class="s2">&quot;added_date&quot;</span><span class="p">]</span>
+            <span class="k">if</span> <span class="n">added_date</span><span class="p">:</span>
+                <span class="n">seconds</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_info</span><span class="p">[</span><span class="s2">&quot;imageTimeZoneOffsetSeconds&quot;</span><span class="p">]</span> <span class="ow">or</span> <span class="mi">0</span>
+                <span class="n">delta</span> <span class="o">=</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">seconds</span><span class="o">=</span><span class="n">seconds</span><span class="p">)</span>
+                <span class="n">tz</span> <span class="o">=</span> <span class="n">timezone</span><span class="p">(</span><span class="n">delta</span><span class="p">)</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_date_added</span> <span class="o">=</span> <span class="n">added_date</span><span class="o">.</span><span class="n">astimezone</span><span class="p">(</span><span class="n">tz</span><span class="o">=</span><span class="n">tz</span><span class="p">)</span>
+            <span class="k">else</span><span class="p">:</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_date_added</span> <span class="o">=</span> <span class="kc">None</span>
+
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_date_added</span>
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">location</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot; returns (latitude, longitude) as float in degrees or None &quot;&quot;&quot;</span>
@@ -834,6 +851,60 @@
 
         <span class="k">return</span> <span class="n">photopath</span>
 
+    <span class="nd">@property</span>
+    <span class="k">def</span> <span class="nf">path_derivatives</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first) &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">_db_version</span> <span class="o">&lt;=</span> <span class="n">_PHOTOS_4_VERSION</span><span class="p">:</span>
+            <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path_derivatives_4</span><span class="p">()</span>
+
+        <span class="n">directory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_uuid</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>  <span class="c1"># first char of uuid</span>
+        <span class="n">derivative_path</span> <span class="o">=</span> <span class="p">(</span>
+            <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">_library_path</span><span class="p">)</span>
+            <span class="o">/</span> <span class="s2">&quot;resources&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;derivatives&quot;</span>
+            <span class="o">/</span> <span class="n">directory</span>
+        <span class="p">)</span>
+        <span class="n">files</span> <span class="o">=</span> <span class="n">derivative_path</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">uuid</span><span class="si">}</span><span class="s2">*.*&quot;</span><span class="p">)</span>
+        <span class="n">files</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span><span class="p">)</span>
+        <span class="c1"># return list of filename but skip .THM files (these are actually low-res thumbnails in JPEG format but with .THM extension)</span>
+        <span class="k">return</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span> <span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">suffix</span> <span class="o">!=</span> <span class="s2">&quot;.THM&quot;</span><span class="p">]</span>
+
+    <span class="k">def</span> <span class="nf">_path_derivatives_4</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot; Return paths to all derivative (preview) files for Photos &lt;= 4&quot;&quot;&quot;</span>
+        <span class="n">modelid</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_info</span><span class="p">[</span><span class="s2">&quot;masterModelID&quot;</span><span class="p">]</span>
+        <span class="k">if</span> <span class="n">modelid</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">return</span> <span class="p">[]</span>
+        <span class="n">folder_id</span><span class="p">,</span> <span class="n">file_id</span> <span class="o">=</span> <span class="n">_get_resource_loc</span><span class="p">(</span><span class="n">modelid</span><span class="p">)</span>
+        <span class="n">derivatives_root</span> <span class="o">=</span> <span class="p">(</span>
+            <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_db</span><span class="o">.</span><span class="n">_library_path</span><span class="p">)</span>
+            <span class="o">/</span> <span class="s2">&quot;resources&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;proxies&quot;</span>
+            <span class="o">/</span> <span class="s2">&quot;derivatives&quot;</span>
+            <span class="o">/</span> <span class="n">folder_id</span>
+        <span class="p">)</span>
+
+        <span class="c1"># photos appears to usually be in &quot;00&quot; subfolder but</span>
+        <span class="c1"># could be elsewhere--I haven&#39;t figured out this logic yet</span>
+        <span class="c1"># first see if it&#39;s in 00</span>
+
+        <span class="n">derivatives_path</span> <span class="o">=</span> <span class="n">derivatives_root</span> <span class="o">/</span> <span class="s2">&quot;00&quot;</span> <span class="o">/</span> <span class="n">file_id</span>
+        <span class="k">if</span> <span class="n">derivatives_path</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
+            <span class="n">files</span> <span class="o">=</span> <span class="n">derivatives_path</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s2">&quot;*&quot;</span><span class="p">)</span>
+            <span class="n">files</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span><span class="p">)</span>
+            <span class="k">return</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
+
+        <span class="c1"># didn&#39;t find derivatives path</span>
+        <span class="k">for</span> <span class="n">subdir</span> <span class="ow">in</span> <span class="n">derivatives_root</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s2">&quot;*&quot;</span><span class="p">):</span>
+            <span class="k">if</span> <span class="n">subdir</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
+                <span class="n">derivatives_path</span> <span class="o">=</span> <span class="n">derivatives_root</span> <span class="o">/</span> <span class="n">subdir</span> <span class="o">/</span> <span class="n">file_id</span>
+                <span class="k">if</span> <span class="n">derivatives_path</span><span class="o">.</span><span class="n">is_dir</span><span class="p">():</span>
+                    <span class="n">files</span> <span class="o">=</span> <span class="n">derivatives_path</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="s2">&quot;*&quot;</span><span class="p">)</span>
+                    <span class="n">files</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">files</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">f</span><span class="p">:</span> <span class="n">f</span><span class="o">.</span><span class="n">stat</span><span class="p">()</span><span class="o">.</span><span class="n">st_size</span><span class="p">)</span>
+                    <span class="k">return</span> <span class="p">[</span><span class="nb">str</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span> <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files</span><span class="p">]</span>
+
+        <span class="c1"># didn&#39;t find a derivatives path</span>
+        <span class="k">return</span> <span class="p">[]</span>
+
     <span class="nd">@property</span>
     <span class="k">def</span> <span class="nf">panorama</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="sd">&quot;&quot;&quot; Returns True if photo is a panorama, otherwise False &quot;&quot;&quot;</span>

docs/_modules/osxphotos/photosdb/photosdb.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos.photosdb.photosdb &#8212; osxphotos 0.42.14 documentation</title>
+    <title>osxphotos.photosdb.photosdb &#8212; osxphotos 0.42.19 documentation</title>
     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
@@ -933,7 +933,8 @@
 <span class="sd">                    RKVersion.subType,</span>
 <span class="sd">                    RKVersion.inTrashDate,</span>
 <span class="sd">                    RKVersion.showInLibrary,</span>
-<span class="sd">                    RKMaster.fileIsReference</span>
+<span class="sd">                    RKMaster.fileIsReference,</span>
+<span class="sd">                    RKMaster.importGroupUuid</span>
 <span class="sd">                    FROM RKVersion, RKMaster</span>
 <span class="sd">                    WHERE RKVersion.masterUuid = RKMaster.uuid&quot;&quot;&quot;</span>
             <span class="p">)</span>
@@ -964,7 +965,8 @@
 <span class="sd">                    RKVersion.subType,</span>
 <span class="sd">                    RKVersion.inTrashDate,</span>
 <span class="sd">                    RKVersion.showInLibrary,</span>
-<span class="sd">                    RKMaster.fileIsReference</span>
+<span class="sd">                    RKMaster.fileIsReference,</span>
+<span class="sd">                    RKMaster.importGroupUuid</span>
 <span class="sd">                    FROM RKVersion, RKMaster</span>
 <span class="sd">                    WHERE RKVersion.masterUuid = RKMaster.uuid&quot;&quot;&quot;</span>
             <span class="p">)</span>
@@ -1014,6 +1016,7 @@
         <span class="c1"># 41    RKVersion.inTrashDate</span>
         <span class="c1"># 42    RKVersion.showInLibrary -- is item visible in library (e.g. non-selected burst images are not visible)</span>
         <span class="c1"># 43    RKMaster.fileIsReference -- file is reference (imported without copying to Photos library)</span>
+        <span class="c1"># 44    RKMaster.importGroupUuid -- to get date added from RKImportGroup</span>
 
         <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">c</span><span class="p">:</span>
             <span class="n">uuid</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
@@ -1207,7 +1210,7 @@
 
             <span class="c1"># import session not yet handled for Photos 4</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;import_session&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
-            <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;import_uuid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;import_uuid&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">44</span><span class="p">]</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;fok_import_session&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
 
         <span class="c1"># get additional details from RKMaster, needed for RAW processing</span>
@@ -1397,11 +1400,17 @@
 
         <span class="c1"># get the place data</span>
         <span class="n">place_data</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
-            <span class="s2">&quot;SELECT modelID, defaultName, type, area &quot;</span> <span class="s2">&quot;FROM RKPlace &quot;</span>
+            <span class="s2">&quot;SELECT modelID, defaultName, type, area FROM RKPlace&quot;</span>
         <span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
         <span class="n">places</span> <span class="o">=</span> <span class="p">{</span><span class="n">p</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span> <span class="n">p</span> <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">place_data</span><span class="p">}</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_db_places</span> <span class="o">=</span> <span class="n">places</span>
 
+        <span class="c1"># get import data</span>
+        <span class="n">import_data</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
+            <span class="s2">&quot;SELECT modelID, uuid, name, importDate from RKImportGroup&quot;</span>
+        <span class="p">)</span><span class="o">.</span><span class="n">fetchall</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_db_import_group</span> <span class="o">=</span> <span class="p">{</span><span class="n">i</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">i</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">import_data</span><span class="p">}</span>
+
         <span class="k">for</span> <span class="n">uuid</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">:</span>
             <span class="c1"># get placeId which is then used to lookup defaultName</span>
             <span class="n">place_ids_query</span> <span class="o">=</span> <span class="n">c</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span>
@@ -1435,6 +1444,17 @@
             <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;placeNames&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">place_names</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;reverse_geolocation&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>  <span class="c1"># Photos 5</span>
 
+            <span class="c1"># add date added</span>
+            <span class="k">try</span><span class="p">:</span>
+                <span class="n">import_session</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_db_import_group</span><span class="p">[</span>
+                    <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;import_uuid&quot;</span><span class="p">]</span>
+                <span class="p">]</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;added_date&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span>
+                    <span class="n">import_session</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">+</span> <span class="n">TIME_DELTA</span>
+                <span class="p">)</span>
+            <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">,</span> <span class="ne">KeyError</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">_dbphotos</span><span class="p">[</span><span class="n">uuid</span><span class="p">][</span><span class="s2">&quot;added_date&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">1970</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+
         <span class="c1"># build album_titles dictionary</span>
         <span class="k">for</span> <span class="n">album_id</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbalbum_details</span><span class="p">:</span>
             <span class="n">title</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_dbalbum_details</span><span class="p">[</span><span class="n">album_id</span><span class="p">][</span><span class="s2">&quot;title&quot;</span><span class="p">]</span>
@@ -1900,7 +1920,8 @@
 <span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZADJUSTMENTTIMESTAMP,</span>
 <span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZVISIBILITYSTATE,</span>
 <span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZTRASHEDDATE,</span>
-<span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZSAVEDASSETTYPE</span>
+<span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZSAVEDASSETTYPE,</span>
+<span class="s2">                </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZADDEDDATE</span>
 <span class="s2">                FROM </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2"> </span>
 <span class="s2">                JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.Z_PK </span>
 <span class="s2">                ORDER BY </span><span class="si">{</span><span class="n">asset_table</span><span class="si">}</span><span class="s2">.ZUUID  &quot;&quot;&quot;</span>
@@ -1948,6 +1969,7 @@
         <span class="c1"># 38   ZGENERICASSET.ZVISIBILITYSTATE -- 0 if visible, 2 if not (e.g. a burst image)</span>
         <span class="c1"># 39   ZGENERICASSET.ZTRASHEDDATE -- date item placed in the trash or null if not in trash</span>
         <span class="c1"># 40   ZGENERICASSET.ZSAVEDASSETTYPE -- how item imported</span>
+        <span class="c1"># 41   ZGENERICASSET.ZADDEDDATE -- date item added to the library</span>
 
         <span class="k">for</span> <span class="n">row</span> <span class="ow">in</span> <span class="n">c</span><span class="p">:</span>
             <span class="n">uuid</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
@@ -2127,6 +2149,11 @@
             <span class="n">info</span><span class="p">[</span><span class="s2">&quot;saved_asset_type&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">40</span><span class="p">]</span>
             <span class="n">info</span><span class="p">[</span><span class="s2">&quot;isreference&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">row</span><span class="p">[</span><span class="mi">40</span><span class="p">]</span> <span class="o">==</span> <span class="mi">10</span>
 
+            <span class="k">try</span><span class="p">:</span>
+                <span class="n">info</span><span class="p">[</span><span class="s2">&quot;added_date&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">row</span><span class="p">[</span><span class="mi">41</span><span class="p">]</span> <span class="o">+</span> <span class="n">TIME_DELTA</span><span class="p">)</span>
+            <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">TypeError</span><span class="p">):</span>
+                <span class="n">info</span><span class="p">[</span><span class="s2">&quot;added_date&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">1970</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
+
             <span class="c1"># initialize import session info which will be filled in later</span>
             <span class="c1"># not every photo has an import session so initialize all records now</span>
             <span class="n">info</span><span class="p">[</span><span class="s2">&quot;import_session&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>

docs/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: '0.42.14',
+    VERSION: '0.42.20',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

docs/cli.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos command line interface (CLI) &#8212; osxphotos 0.42.14 documentation</title>
+    <title>osxphotos command line interface (CLI) &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -1455,6 +1455,12 @@ if more than one option is provided, they are treated as “AND”
 <dd><p>Search for photos that are not in iCloud (have not been synched)</p>
 </dd></dl>
 
+<dl class="std option">
+<dt id="cmdoption-osxphotos-query-add-to-album">
+<code class="sig-name descname"><span class="pre">--add-to-album</span></code><code class="sig-prename descclassname"> <span class="pre">&lt;ALBUM&gt;</span></code><a class="headerlink" href="#cmdoption-osxphotos-query-add-to-album" title="Permalink to this definition">¶</a></dt>
+<dd><p>Add all photos from query to album ALBUM in Photos. Album ALBUM will be created if it doesn’t exist.  All photos in the query results will be added to this album. This only works if the Photos library being queried is the last-opened (default) library in Photos. This feature is currently experimental.  I don’t know how well it will work on large query sets.</p>
+</dd></dl>
+
 <p class="rubric">Arguments</p>
 <dl class="std option">
 <dt id="cmdoption-osxphotos-query-arg-PHOTOS_LIBRARY">

docs/genindex.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; osxphotos 0.42.14 documentation</title>
+    <title>Index &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -83,6 +83,13 @@
 
       <ul>
         <li><a href="cli.html#cmdoption-osxphotos-export-add-skipped-to-album">osxphotos-export command line option</a>
+</li>
+      </ul></li>
+      <li>
+    --add-to-album &lt;ALBUM&gt;
+
+      <ul>
+        <li><a href="cli.html#cmdoption-osxphotos-query-add-to-album">osxphotos-query command line option</a>
 </li>
       </ul></li>
       <li>
@@ -1210,6 +1217,8 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="reference.html#osxphotos.PhotoInfo.date">date() (osxphotos.PhotoInfo property)</a>
+</li>
+      <li><a href="reference.html#osxphotos.PhotoInfo.date_added">date_added() (osxphotos.PhotoInfo property)</a>
 </li>
       <li><a href="reference.html#osxphotos.PhotoInfo.date_modified">date_modified() (osxphotos.PhotoInfo property)</a>
 </li>
@@ -1825,6 +1834,8 @@
     osxphotos-query command line option
 
       <ul>
+        <li><a href="cli.html#cmdoption-osxphotos-query-add-to-album">--add-to-album &lt;ALBUM&gt;</a>
+</li>
         <li><a href="cli.html#cmdoption-osxphotos-query-album">--album &lt;ALBUM&gt;</a>
 </li>
         <li><a href="cli.html#cmdoption-osxphotos-query-burst">--burst</a>
@@ -1981,6 +1992,8 @@
       <li><a href="reference.html#osxphotos.PhotoInfo.panorama">panorama() (osxphotos.PhotoInfo property)</a>
 </li>
       <li><a href="reference.html#osxphotos.PhotoInfo.path">path() (osxphotos.PhotoInfo property)</a>
+</li>
+      <li><a href="reference.html#osxphotos.PhotoInfo.path_derivatives">path_derivatives() (osxphotos.PhotoInfo property)</a>
 </li>
       <li><a href="reference.html#osxphotos.PhotoInfo.path_edited">path_edited() (osxphotos.PhotoInfo property)</a>
 </li>

docs/index.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Welcome to osxphotos’s documentation! &#8212; osxphotos 0.42.14 documentation</title>
+    <title>Welcome to osxphotos’s documentation! &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -150,6 +150,10 @@ Alternatively, you can also run the command line utility like this: <code class=
 <h4>export default library using ‘country name/year’ as output directory (but use “NoCountry/year” if country not specified), add persons, album names, and year as keywords, write exif metadata to files when exporting, update only changed files, print verbose ouput<a class="headerlink" href="#export-default-library-using-country-name-year-as-output-directory-but-use-nocountry-year-if-country-not-specified-add-persons-album-names-and-year-as-keywords-write-exif-metadata-to-files-when-exporting-update-only-changed-files-print-verbose-ouput" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">~/Desktop/export</span> <span class="pre">--directory</span> <span class="pre">&quot;{place.name.country,NoCountry}/{created.year}&quot;</span>&#160; <span class="pre">--person-keyword</span> <span class="pre">--album-keyword</span> <span class="pre">--keyword-template</span> <span class="pre">&quot;{created.year}&quot;</span> <span class="pre">--exiftool</span> <span class="pre">--update</span> <span class="pre">--verbose</span></code></p>
 </div>
+<div class="section" id="find-all-videos-larger-than-200mb-and-add-them-to-photos-album-big-videos-creating-the-album-if-necessary">
+<h4>find all videos larger than 200MB and add them to Photos album “Big Videos” creating the album if necessary<a class="headerlink" href="#find-all-videos-larger-than-200mb-and-add-them-to-photos-album-big-videos-creating-the-album-if-necessary" title="Permalink to this headline">¶</a></h4>
+<p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">query</span> <span class="pre">--only-movies</span> <span class="pre">--min-size</span> <span class="pre">200MB</span> <span class="pre">--add-to-album</span> <span class="pre">&quot;Big</span> <span class="pre">Videos&quot;</span></code></p>
+</div>
 </div>
 </div>
 <div class="section" id="example-uses-of-the-package">

docs/modules.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos &#8212; osxphotos 0.42.14 documentation</title>
+    <title>osxphotos &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

docs/reference.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos package &#8212; osxphotos 0.42.14 documentation</title>
+    <title>osxphotos package &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
@@ -732,6 +732,12 @@ self is not included in the returned list</p>
 <dd><p>image creation date as timezone aware datetime object</p>
 </dd></dl>
 
+<dl class="py method">
+<dt id="osxphotos.PhotoInfo.date_added">
+<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">date_added</span></code><a class="headerlink" href="#osxphotos.PhotoInfo.date_added" title="Permalink to this definition">¶</a></dt>
+<dd><p>Date photo was added to the database</p>
+</dd></dl>
+
 <dl class="py method">
 <dt id="osxphotos.PhotoInfo.date_modified">
 <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">date_modified</span></code><a class="headerlink" href="#osxphotos.PhotoInfo.date_modified" title="Permalink to this definition">¶</a></dt>
@@ -1130,6 +1136,12 @@ Photos 5 mangles filenames upon import</p>
 <dd><p>absolute path on disk of the original picture</p>
 </dd></dl>
 
+<dl class="py method">
+<dt id="osxphotos.PhotoInfo.path_derivatives">
+<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">path_derivatives</span></code><a class="headerlink" href="#osxphotos.PhotoInfo.path_derivatives" title="Permalink to this definition">¶</a></dt>
+<dd><p>Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)</p>
+</dd></dl>
+
 <dl class="py method">
 <dt id="osxphotos.PhotoInfo.path_edited">
 <em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">path_edited</span></code><a class="headerlink" href="#osxphotos.PhotoInfo.path_edited" title="Permalink to this definition">¶</a></dt>

docs/search.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; osxphotos 0.42.14 documentation</title>
+    <title>Search &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     

docs/tutorial.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Export your photos &#8212; osxphotos 0.42.14 documentation</title>
+    <title>Export your photos &#8212; osxphotos 0.42.20 documentation</title>
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>

examples/post_function.py

@@ -0,0 +1,54 @@
+""" Example function for use with osxphotos export --post-function option """
+
+from osxphotos import PhotoInfo, ExportResults
+
+
+def post_function(
+    photo: PhotoInfo, results: ExportResults, verbose: callable, **kwargs
+):
+    """Call this with osxphotos export /path/to/export --post-function post_function.py::post_function
+        This will get called immediately after the photo has been exported
+
+    Args:
+        photo: PhotoInfo instance for the photo that's just been exported
+        results: ExportResults instance with information about the files associated with the exported photo
+        verbose: A function to print verbose output if --verbose is set; if --verbose is not set, acts as a no-op (nothing gets printed)
+        **kwargs: reserved for future use; recommend you include **kwargs so your function still works if additional arguments are added in future versions
+
+    Notes:
+        Use verbose(str) instead of print if you want your function to conditionally output text depending on --verbose flag
+        Any string printed with verbose that contains "warning" or "error" (case-insensitive) will be printed with the appropriate warning or error color
+        Will not be called if --dry-run flag is enabled
+        Will be called immediately after export and before any --post-command commands are executed
+    """
+
+    # ExportResults has the following properties
+    # fields with filenames contain the full path to the file
+    # exported: list of all files exported
+    # new: list of all new files exported (--update)
+    # updated: list of all files updated (--update)
+    # skipped: list of all files skipped (--update)
+    # exif_updated: list of all files that were updated with --exiftool
+    # touched: list of all files that had date updated with --touch-file
+    # converted_to_jpeg: list of files converted to jpeg with --convert-to-jpeg
+    # sidecar_json_written: list of all JSON sidecar files written
+    # sidecar_json_skipped: list of all JSON sidecar files skipped (--update)
+    # sidecar_exiftool_written: list of all exiftool sidecar files written
+    # sidecar_exiftool_skipped: list of all exiftool sidecar files skipped (--update)
+    # sidecar_xmp_written: list of all XMP sidecar files written
+    # sidecar_xmp_skipped: list of all XMP sidecar files skipped (--update)
+    # missing: list of all missing files
+    # error: list tuples of (filename, error) for any errors generated during export
+    # exiftool_warning: list of tuples of (filename, warning) for any warnings generated by exiftool with --exiftool
+    # exiftool_error: list of tuples of (filename, error) for any errors generated by exiftool with --exiftool
+    # xattr_written: list of files that had extended attributes written
+    # xattr_skipped: list of files that where extended attributes were skipped (--update)
+    # deleted_files: list of deleted files
+    # deleted_directories: list of deleted directories
+    # exported_album: list of tuples of (filename, album_name) for exported files added to album with --add-exported-to-album
+    # skipped_album: list of tuples of (filename, album_name) for skipped files added to album with --add-skipped-to-album
+    # missing_album: list of tuples of (filename, album_name) for missing files added to album with --add-missing-to-album
+
+    for filename in results.exported:
+        # do your processing here
+        verbose(f"post_function: {photo.original_filename} exported as {filename}")

examples/query_function.py

@@ -0,0 +1,31 @@
+""" example function for osxphotos --query-function """
+
+from typing import List
+
+from osxphotos import PhotoInfo
+
+
+# call this with --query-function examples/query_function.py::best_selfies
+def best_selfies(photos: List[PhotoInfo]) -> List[PhotoInfo]:
+    """your query function should take a list of PhotoInfo objects and return a list of PhotoInfo objects (or empty list)"""
+    # this example finds your best selfie for every year
+
+    # get list of selfies sorted by date
+    photos = sorted([p for p in photos if p.selfie], key=lambda p: p.date)
+    if not photos:
+        return []
+
+    start_year = photos[0].date.year
+    stop_year = photos[-1].date.year
+    best_selfies = []
+    for year in range(start_year, stop_year + 1):
+        # find best selfie each year as determined by overall aesthetic score
+        selfies = sorted(
+            [p for p in photos if p.date.year == year],
+            key=lambda p: p.score.overall,
+            reverse=True,
+        )
+        if selfies:
+            best_selfies.append(selfies[0])
+
+    return best_selfies

osxphotos.spec

@@ -8,41 +8,50 @@ import importlib
 pathex = os.getcwd()
 
 # include necessary data files
-datas=[('osxphotos/templates/xmp_sidecar.mako', 'osxphotos/templates'), ('osxphotos/templates/xmp_sidecar_beta.mako', 'osxphotos/templates'), ('osxphotos/phototemplate.tx', 'osxphotos'), ('osxphotos/phototemplate.md', 'osxphotos')]
-package_imports = [['photoscript', ['photoscript.applescript']]]
+datas = [
+    ("osxphotos/templates/xmp_sidecar.mako", "osxphotos/templates"),
+    ("osxphotos/templates/xmp_sidecar_beta.mako", "osxphotos/templates"),
+    ("osxphotos/phototemplate.tx", "osxphotos"),
+    ("osxphotos/phototemplate.md", "osxphotos"),
+    ("osxphotos/tutorial.md", "osxphotos"),
+]
+package_imports = [["photoscript", ["photoscript.applescript"]]]
 for package, files in package_imports:
     proot = os.path.dirname(importlib.import_module(package).__file__)
     datas.extend((os.path.join(proot, f), package) for f in files)
 
 block_cipher = None
 
-a = Analysis(['cli.py'],
-             pathex=[pathex],
-             binaries=[],
-             datas=datas,
-             hiddenimports=['pkg_resources.py2_warn'],
-             hookspath=[],
-             runtime_hooks=[],
-             excludes=[],
-             win_no_prefer_redirects=False,
-             win_private_assemblies=False,
-             cipher=block_cipher,
-             noarchive=False)
+a = Analysis(
+    ["cli.py"],
+    pathex=[pathex],
+    binaries=[],
+    datas=datas,
+    hiddenimports=["pkg_resources.py2_warn"],
+    hookspath=[],
+    runtime_hooks=[],
+    excludes=[],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher,
+    noarchive=False,
+)
 
-pyz = PYZ(a.pure, a.zipped_data,
-             cipher=block_cipher)
+pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
 
-exe = EXE(pyz,
-          a.scripts,
-          a.binaries,
-          a.zipfiles,
-          a.datas,
-          [],
-          name='osxphotos',
-          debug=False,
-          bootloader_ignore_signals=False,
-          strip=False,
-          upx=True,
-          upx_exclude=[],
-          runtime_tmpdir=None,
-          console=True )
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    [],
+    name="osxphotos",
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=True,
+)

osxphotos/__init__.py

@@ -1,5 +1,6 @@
 from ._version import __version__
-from .photoinfo import PhotoInfo
+from .exiftool import ExifTool
+from .photoinfo import ExportResults, PhotoInfo
 from .photosdb import PhotosDB
 from .photosdb._photosdb_process_comments import CommentInfo, LikeInfo
 from .phototemplate import PhotoTemplate
@@ -7,5 +8,4 @@ from .queryoptions import QueryOptions
 from .utils import _debug, _get_logger, _set_debug
 
 # TODO: Add test for imageTimeZoneOffsetSeconds = None
-# TODO: Add test for __str__ and to_json
 # TODO: Add special albums and magic albums

osxphotos/_applescript/__init__.py

@@ -1,162 +0,0 @@
-""" applescript -- Easy-to-use Python wrapper for NSAppleScript """
-
-import sys
-
-from Foundation import NSAppleScript, NSAppleEventDescriptor, NSURL, \
-		NSAppleScriptErrorMessage, NSAppleScriptErrorBriefMessage, \
-		NSAppleScriptErrorNumber, NSAppleScriptErrorAppName, NSAppleScriptErrorRange
-
-from .aecodecs import Codecs, fourcharcode, AEType, AEEnum
-from . import kae
-
-__all__ = ['AppleScript', 'ScriptError', 'AEType', 'AEEnum', 'kMissingValue', 'kae']
-
-
-######################################################################
-
-
-class AppleScript:
-	""" Represents a compiled AppleScript. The script object is persistent; its handlers may be called multiple times and its top-level properties will retain current state until the script object's disposal.
-	
-	
-	"""
-
-	_codecs = Codecs()
-	
-	def __init__(self, source=None, path=None):
-		"""
-			source : str | None -- AppleScript source code
-			path : str | None -- full path to .scpt/.applescript file
-			
-			Notes:
-			
-			- Either the path or the source argument must be provided.
-			
-			- If the script cannot be read/compiled, a ScriptError is raised.
-		"""
-		if path:
-			url = NSURL.fileURLWithPath_(path)
-			self._script, errorinfo = NSAppleScript.alloc().initWithContentsOfURL_error_(url, None)
-			if errorinfo:
-				raise ScriptError(errorinfo)
-		elif source:
-			self._script = NSAppleScript.alloc().initWithSource_(source)
-		else:
-			raise ValueError("Missing source or path argument.")
-		if not self._script.isCompiled():
-			errorinfo = self._script.compileAndReturnError_(None)[1]
-			if errorinfo:
-				raise ScriptError(errorinfo)
-	
-	def __repr__(self):
-		s = self.source
-		return 'AppleScript({})'.format(repr(s) if len(s) < 100 else '{}...{}'.format(repr(s)[:80], repr(s)[-17:]))
-	
-	##
-	
-	def _newevent(self, suite, code, args):
-		evt = NSAppleEventDescriptor.appleEventWithEventClass_eventID_targetDescriptor_returnID_transactionID_(
-						fourcharcode(suite), fourcharcode(code), NSAppleEventDescriptor.nullDescriptor(), 0, 0)
-		evt.setDescriptor_forKeyword_(self._codecs.pack(args), fourcharcode(kae.keyDirectObject))
-		return evt
-	
-	def _unpackresult(self, result, errorinfo):
-		if not result:
-			raise ScriptError(errorinfo)
-		return self._codecs.unpack(result)
-
-	##
-	
-	source = property(lambda self: str(self._script.source()), doc="str -- the script's source code")
-	
-	def run(self, *args):
-		""" Run the script, optionally passing arguments to its run handler.
-			
-				args : anything -- arguments to pass to script, if any; see also supported type mappings documentation
-				Result : anything | None -- the script's return value, if any
-			
-			Notes:
-			
-			- The run handler must be explicitly declared in order to pass arguments.
-			
-			- AppleScript will ignore excess arguments. Passing insufficient arguments will result in an error.
-			
-			- If execution fails, a ScriptError is raised.
-		"""
-		if args:
-			evt = self._newevent(kae.kCoreEventClass, kae.kAEOpenApplication, args)
-			return self._unpackresult(*self._script.executeAppleEvent_error_(evt, None))
-		else:
-			return self._unpackresult(*self._script.executeAndReturnError_(None))
-	
-	def call(self, name, *args):
-		""" Call the specified user-defined handler.
-				
-				name : str -- the handler's name (case-sensitive)
-				args : anything -- arguments to pass to script, if any; see documentation for supported types
-				Result : anything | None -- the script's return value, if any
-			
-			Notes:
-			
-			- The handler's name must be a user-defined identifier, not an AppleScript keyword; e.g. 'myCount' is acceptable; 'count' is not.
-			
-			- AppleScript will ignore excess arguments. Passing insufficient arguments will result in an error.
-			
-			- If execution fails, a ScriptError is raised.
-		"""
-		evt = self._newevent(kae.kASAppleScriptSuite, kae.kASPrepositionalSubroutine, args)
-		evt.setDescriptor_forKeyword_(NSAppleEventDescriptor.descriptorWithString_(name), 
-						fourcharcode(kae.keyASSubroutineName))
-		return self._unpackresult(*self._script.executeAppleEvent_error_(evt, None))
-
-
-##
-
-
-class ScriptError(Exception):
-	""" Indicates an AppleScript compilation/execution error. """
-	
-	def __init__(self, errorinfo):
-		self._errorinfo = dict(errorinfo)
-	
-	def __repr__(self):
-		return 'ScriptError({})'.format(self._errorinfo)
-	
-	@property
-	def message(self):
-		""" str -- the error message """
-		msg = self._errorinfo.get(NSAppleScriptErrorMessage)
-		if not msg:
-			msg = self._errorinfo.get(NSAppleScriptErrorBriefMessage, 'Script Error')
-		return msg
-	
-	number = property(lambda self: self._errorinfo.get(NSAppleScriptErrorNumber),
-			doc="int | None -- the error number, if given")
-	
-	appname = property(lambda self: self._errorinfo.get(NSAppleScriptErrorAppName),
-			doc="str | None -- the name of the application that reported the error, where relevant")
-	
-	@property
-	def range(self):
-		""" (int, int) -- the start and end points (1-indexed) within the source code where the error occurred """
-		range = self._errorinfo.get(NSAppleScriptErrorRange)
-		if range:
-			start = range.rangeValue().location
-			end = start + range.rangeValue().length
-			return (start, end)
-		else:
-			return None
-	
-	def __str__(self):
-		msg = self.message
-		for s, v in [(' ({})', self.number), (' app={!r}', self.appname), (' range={0[0]}-{0[1]}', self.range)]:
-			if v is not None:
-				msg += s.format(v)
-		return msg.encode('ascii', 'replace') if sys.version_info.major < 3 else msg # 2.7 compatibility
-
-
-##
-
-
-kMissingValue = AEType(kae.cMissingValue) # convenience constant
-

osxphotos/_applescript/aecodecs.py

@@ -1,269 +0,0 @@
-""" aecodecs -- Convert from common Python types to Apple Event Manager types and vice-versa. """
-
-import datetime, struct, sys
-
-from Foundation import NSAppleEventDescriptor, NSURL
-
-from . import kae
-
-
-__all__ = ['Codecs', 'AEType', 'AEEnum']
-
-
-######################################################################
-
-
-def fourcharcode(code):
-	""" Convert four-char code for use in NSAppleEventDescriptor methods.
-		
-		code : bytes -- four-char code, e.g. b'utxt'
-		Result : int -- OSType, e.g. 1970567284
-	"""
-	return struct.unpack('>I', code)[0]
-
-
-#######
-
-
-class Codecs:
-	""" Implements mappings for common Python types with direct AppleScript equivalents. Used by AppleScript class. """
-
-	kMacEpoch = datetime.datetime(1904, 1, 1)
-	kUSRF = fourcharcode(kae.keyASUserRecordFields)
-
-	def __init__(self):
-		# Clients may add/remove/replace encoder and decoder items:
-		self.encoders = {
-				NSAppleEventDescriptor.class__(): self.packdesc,
-				type(None): self.packnone,
-				bool: self.packbool,
-				int: self.packint,
-				float: self.packfloat,
-				bytes: self.packbytes,
-				str: self.packstr,
-				list: self.packlist,
-				tuple: self.packlist,
-				dict: self.packdict,
-				datetime.datetime: self.packdatetime,
-				AEType: self.packtype,
-				AEEnum: self.packenum,
-		}
-		if sys.version_info.major < 3: # 2.7 compatibility
-			self.encoders[unicode] = self.packstr
-		
-		self.decoders = {fourcharcode(k): v for k, v in {
-				kae.typeNull: self.unpacknull,
-				kae.typeBoolean: self.unpackboolean,
-				kae.typeFalse: self.unpackboolean,
-				kae.typeTrue: self.unpackboolean,
-				kae.typeSInt32: self.unpacksint32,
-				kae.typeIEEE64BitFloatingPoint: self.unpackfloat64,
-				kae.typeUTF8Text: self.unpackunicodetext,
-				kae.typeUTF16ExternalRepresentation: self.unpackunicodetext,
-				kae.typeUnicodeText: self.unpackunicodetext,
-				kae.typeLongDateTime: self.unpacklongdatetime,
-				kae.typeAEList: self.unpackaelist,
-				kae.typeAERecord: self.unpackaerecord,
-				kae.typeAlias: self.unpackfile,
-				kae.typeFSS: self.unpackfile,
-				kae.typeFSRef: self.unpackfile,
-				kae.typeFileURL: self.unpackfile,
-				kae.typeType: self.unpacktype,
-				kae.typeEnumeration: self.unpackenumeration,
-		}.items()}
-	
-	def pack(self, data):
-		"""Pack Python data.
-			data : anything -- a Python value
-			Result : NSAppleEventDescriptor -- an AE descriptor, or error if no encoder exists for this type of data
-		"""
-		try:
-			return self.encoders[data.__class__](data) # quick lookup by type/class
-		except (KeyError, AttributeError) as e:
-			for type, encoder in self.encoders.items(): # slower but more thorough lookup that can handle subtypes/subclasses
-				if isinstance(data, type):
-					return encoder(data)
-		raise TypeError("Can't pack data into an AEDesc (unsupported type): {!r}".format(data))
-	
-	def unpack(self, desc):
-		"""Unpack an Apple event descriptor.
-			desc : NSAppleEventDescriptor
-			Result : anything -- a Python value, or the original NSAppleEventDescriptor if no decoder is found
-		"""
-		decoder = self.decoders.get(desc.descriptorType())
-		# unpack known type
-		if decoder:
-			return decoder(desc)
-		# if it's a record-like desc, unpack as dict with an extra AEType(b'pcls') key containing the desc type
-		rec = desc.coerceToDescriptorType_(fourcharcode(kae.typeAERecord))
-		if rec:
-			rec = self.unpackaerecord(rec)
-			rec[AEType(kae.pClass)] = AEType(struct.pack('>I', desc.descriptorType()))
-			return rec
-		# return as-is
-		return desc
-	
-	##
-	
-	def _packbytes(self, desctype, data):
-		return NSAppleEventDescriptor.descriptorWithDescriptorType_bytes_length_(
-			fourcharcode(desctype), data, len(data))
-	
-	def packdesc(self, val):
-		return val
-	
-	def packnone(self, val):
-		return NSAppleEventDescriptor.nullDescriptor()
-	
-	def packbool(self, val):
-		return NSAppleEventDescriptor.descriptorWithBoolean_(int(val))
-	
-	def packint(self, val):
-		if (-2**31) <= val < (2**31):
-			return NSAppleEventDescriptor.descriptorWithInt32_(val)
-		else:
-			return self.pack(float(val))
-	
-	def packfloat(self, val):
-		return self._packbytes(kae.typeFloat, struct.pack('d', val))
-	
-	def packbytes(self, val):
-		return self._packbytes(kae.typeData, val)
-	
-	def packstr(self, val):
-		return NSAppleEventDescriptor.descriptorWithString_(val)
-	
-	def packdatetime(self, val):
-		delta = val - self.kMacEpoch
-		sec = delta.days * 3600 * 24 + delta.seconds
-		return self._packbytes(kae.typeLongDateTime, struct.pack('q', sec))
-	
-	def packlist(self, val):
-		lst = NSAppleEventDescriptor.listDescriptor()
-		for item in val:
-			lst.insertDescriptor_atIndex_(self.pack(item), 0)
-		return lst
-	
-	def packdict(self, val):
-		record = NSAppleEventDescriptor.recordDescriptor()
-		usrf = desctype = None
-		for key, value in val.items():
-			if isinstance(key, AEType):
-				if key.code == kae.pClass and isinstance(value, AEType): # AS packs records that contain a 'class' property by coercing the packed record to the descriptor type specified by the property's value (assuming it's an AEType)
-					desctype = value
-				else:
-					record.setDescriptor_forKeyword_(self.pack(value), fourcharcode(key.code))
-			else:
-				if not usrf:
-					usrf = NSAppleEventDescriptor.listDescriptor()
-				usrf.insertDescriptor_atIndex_(self.pack(key), 0)
-				usrf.insertDescriptor_atIndex_(self.pack(value), 0)
-		if usrf:
-			record.setDescriptor_forKeyword_(usrf, self.kUSRF)
-		if desctype:
-			newrecord = record.coerceToDescriptorType_(fourcharcode(desctype.code))
-			if newrecord:
-				record = newrecord
-			else: # coercion failed for some reason, so pack as normal key-value pair
-				record.setDescriptor_forKeyword_(self.pack(desctype), fourcharcode(key.code))
-		return record
-	
-	def packtype(self, val):
-		return NSAppleEventDescriptor.descriptorWithTypeCode_(fourcharcode(val.code))
-	
-	def packenum(self, val): 
-		return NSAppleEventDescriptor.descriptorWithEnumCode_(fourcharcode(val.code))
-	
-	#######
-	
-	def unpacknull(self, desc):
-		return None
-	
-	def unpackboolean(self, desc):
-		return desc.booleanValue()
-	
-	def unpacksint32(self, desc):
-		return desc.int32Value()
-	
-	def unpackfloat64(self, desc):
-		return struct.unpack('d', bytes(desc.data()))[0]
-	
-	def unpackunicodetext(self, desc):
-		return desc.stringValue()
-	
-	def unpacklongdatetime(self, desc):
-		return self.kMacEpoch + datetime.timedelta(seconds=struct.unpack('q', bytes(desc.data()))[0])
-	
-	def unpackaelist(self, desc):
-		return [self.unpack(desc.descriptorAtIndex_(i + 1)) for i in range(desc.numberOfItems())]
-	
-	def unpackaerecord(self, desc):
-		dct = {}
-		for i in range(desc.numberOfItems()):
-			key = desc.keywordForDescriptorAtIndex_(i + 1)
-			value = desc.descriptorForKeyword_(key)
-			if key == self.kUSRF:
-				lst = self.unpackaelist(value)
-				for i in range(0, len(lst), 2):
-					dct[lst[i]] = lst[i+1]
-			else:
-				dct[AEType(struct.pack('>I', key))] = self.unpack(value)
-		return dct
-	
-	def unpacktype(self, desc):
-		return AEType(struct.pack('>I', desc.typeCodeValue()))
-	
-	def unpackenumeration(self, desc):
-		return AEEnum(struct.pack('>I', desc.enumCodeValue()))
-	
-	def unpackfile(self, desc):
-		url = bytes(desc.coerceToDescriptorType_(fourcharcode(kae.typeFileURL)).data()).decode('utf8')
-		return NSURL.URLWithString_(url).path()
-
-
-#######
-
-
-class AETypeBase:
-	""" Base class for AEType and AEEnum.
-	
-		Notes:
-		
-		- Hashable and comparable, so may be used as keys in dictionaries that map to AE records.
-	"""
-	
-	def __init__(self, code):
-		"""
-			code : bytes -- four-char code, e.g. b'utxt'
-		"""
-		if not isinstance(code, bytes):
-			raise TypeError('invalid code (not a bytes object): {!r}'.format(code))
-		elif len(code) != 4:
-			raise ValueError('invalid code (not four bytes long): {!r}'.format(code))
-		self._code = code
-	
-	code = property(lambda self:self._code, doc="bytes -- four-char code, e.g. b'utxt'")
-	
-	def __hash__(self): 
-		return hash(self._code)
-	
-	def __eq__(self, val):
-		return val.__class__ == self.__class__ and val.code == self._code
-	
-	def __ne__(self, val):
-		return not self == val
-		
-	def __repr__(self):
-		return "{}({!r})".format(self.__class__.__name__, self._code)
-
-
-##
-
-
-class AEType(AETypeBase):
-	"""An AE type. Maps to an AppleScript type class, e.g. AEType(b'utxt') <=> 'unicode text'."""
-
-
-class AEEnum(AETypeBase):
-	"""An AE enumeration. Maps to an AppleScript constant, e.g. AEEnum(b'yes ') <=> 'yes'."""
-

osxphotos/_constants.py

@@ -34,11 +34,12 @@ _PHOTOS_3_VERSION = "3301"
 
 # versions 5.0 and later have a different database structure
 _PHOTOS_4_VERSION = "4025"  # latest Mojove version on 10.14.6
-_PHOTOS_5_VERSION = "6000"  # seems to be current on 10.15.1 through 10.15.6
+_PHOTOS_5_VERSION = "6000"  # seems to be current on 10.15.1 through 10.15.7 (also Big Sur and Monterey which switch to model version)
 
 # Ranges for model version by Photos version
 _PHOTOS_5_MODEL_VERSION = [13000, 13999]
 _PHOTOS_6_MODEL_VERSION = [14000, 14999]
+_PHOTOS_7_MODEL_VERSION = [15000, 15999]  # Monterey developer preview is 15134
 
 # some table names differ between Photos 5 and Photos 6
 _DB_TABLE_NAMES = {
@@ -49,6 +50,10 @@ _DB_TABLE_NAMES = {
         "ALBUM_SORT_ORDER": "Z_26ASSETS.Z_FOK_34ASSETS",
         "IMPORT_FOK": "ZGENERICASSET.Z_FOK_IMPORTSESSION",
         "DEPTH_STATE": "ZGENERICASSET.ZDEPTHSTATES",
+        "UTI_ORIGINAL": "ZINTERNALRESOURCE.ZUNIFORMTYPEIDENTIFIER",
+        "ASSET_ALBUM_JOIN": "Z_26ASSETS.Z_26ALBUMS",
+        "ASSET_ALBUM_TABLE": "Z_26ASSETS",
+        "HDR_TYPE": "ZCUSTOMRENDEREDVALUE",
     },
     6: {
         "ASSET": "ZASSET",
@@ -57,6 +62,22 @@ _DB_TABLE_NAMES = {
         "ALBUM_SORT_ORDER": "Z_26ASSETS.Z_FOK_3ASSETS",
         "IMPORT_FOK": "null",
         "DEPTH_STATE": "ZASSET.ZDEPTHTYPE",
+        "UTI_ORIGINAL": "ZINTERNALRESOURCE.ZUNIFORMTYPEIDENTIFIER",
+        "ASSET_ALBUM_JOIN": "Z_26ASSETS.Z_26ALBUMS",
+        "ASSET_ALBUM_TABLE": "Z_26ASSETS",
+        "HDR_TYPE": "ZCUSTOMRENDEREDVALUE",
+    },
+    7: {
+        "ASSET": "ZASSET",
+        "KEYWORD_JOIN": "Z_1KEYWORDS.Z_38KEYWORDS",
+        "ALBUM_JOIN": "Z_27ASSETS.Z_3ASSETS",
+        "ALBUM_SORT_ORDER": "Z_27ASSETS.Z_FOK_3ASSETS",
+        "IMPORT_FOK": "null",
+        "DEPTH_STATE": "ZASSET.ZDEPTHTYPE",
+        "UTI_ORIGINAL": "ZINTERNALRESOURCE.ZCOMPACTUTI",
+        "ASSET_ALBUM_JOIN": "Z_27ASSETS.Z_27ALBUMS",
+        "ASSET_ALBUM_TABLE": "Z_27ASSETS",
+        "HDR_TYPE": "ZHDRTYPE",
     },
 }
 
@@ -70,6 +91,8 @@ _TESTED_OS_VERSIONS = [
     ("11", "0"),
     ("11", "1"),
     ("11", "2"),
+    ("11", "3"),
+    ("11", "4"),
 ]
 
 # Photos 5 has persons who are empty string if unidentified face
@@ -187,6 +210,9 @@ DEFAULT_EDITED_SUFFIX = "_edited"
 # Default suffix to add to original images
 DEFAULT_ORIGINAL_SUFFIX = ""
 
+# Default suffix to add to preview images
+DEFAULT_PREVIEW_SUFFIX = "_preview"
+
 # Colors for print CLI messages
 CLI_COLOR_ERROR = "red"
 CLI_COLOR_WARNING = "yellow"
@@ -212,8 +238,31 @@ EXTENDED_ATTRIBUTE_NAMES_QUOTED = [f"'{x}'" for x in EXTENDED_ATTRIBUTE_NAMES]
 OSXPHOTOS_EXPORT_DB = ".osxphotos_export.db"
 
 # bit flags for burst images ("burstPickType")
-BURST_NOT_SELECTED = 0b10 # 2: burst image is not selected
-BURST_DEFAULT_PICK = 0b100 # 4: burst image is the one Photos picked to be key image before any selections made
-BURST_SELECTED = 0b1000 # 8: burst image is selected
-BURST_KEY = 0b10000 # 16: burst image is the key photo (top of burst stack)
-BURST_UNKNOWN = 0b100000 # 32: this is almost always set with BURST_DEFAULT_PICK and never if BURST_DEFAULT_PICK is not set.  I think this has something to do with what algorithm Photos used to pick the default image
+BURST_NOT_SELECTED = 0b10  # 2: burst image is not selected
+BURST_DEFAULT_PICK = 0b100  # 4: burst image is the one Photos picked to be key image before any selections made
+BURST_SELECTED = 0b1000  # 8: burst image is selected
+BURST_KEY = 0b10000  # 16: burst image is the key photo (top of burst stack)
+BURST_UNKNOWN = 0b100000  # 32: this is almost always set with BURST_DEFAULT_PICK and never if BURST_DEFAULT_PICK is not set.  I think this has something to do with what algorithm Photos used to pick the default image
+
+LIVE_VIDEO_EXTENSIONS = [".mov"]
+
+# categories that --post-command can be used with; these map to ExportResults fields
+POST_COMMAND_CATEGORIES = {
+    "exported": "All exported files",
+    "new": "When used with '--update', all newly exported files",
+    "updated": "When used with '--update', all files which were previously exported but updated this time",
+    "skipped": "When used with '--update', all files which were skipped (because they were previously exported and didn't change)",
+    "missing": "All files which were not exported because they were missing from the Photos library",
+    "exif_updated": "When used with '--exiftool', all files on which exiftool updated the metadata",
+    "touched": "When used with '--touch-file', all files where the date was touched",
+    "converted_to_jpeg": "When used with '--convert-to-jpeg', all files which were converted to jpeg",
+    "sidecar_json_written": "When used with '--sidecar json', all JSON sidecar files which were written",
+    "sidecar_json_skipped": "When used with '--sidecar json' and '--update', all JSON sidecar files which were skipped",
+    "sidecar_exiftool_written": "When used with '--sidecar exiftool', all exiftool sidecar files which were written",
+    "sidecar_exiftool_skipped": "When used with '--sidecar exiftool' and '--update, all exiftool sidecar files which were skipped",
+    "sidecar_xmp_written": "When used with '--sidecar xmp', all XMP sidecar files which were written",
+    "sidecar_xmp_skipped": "When used with '--sidecar xmp' and '--update', all XMP sidecar files which were skipped",
+    "error": "All files which produced an error during export",
+    # "deleted_files": "When used with '--cleanup', all files deleted during the export",
+    # "deleted_directories": "When used with '--cleanup', all directories deleted during the export",
+}

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.42.14"
+__version__ = "0.42.59"

osxphotos/cli_help.py

@@ -1,6 +1,7 @@
 """Help text helper class for osxphotos CLI """
 
 import io
+import pathlib
 import re
 
 import click
@@ -12,16 +13,19 @@ from ._constants import (
     EXTENDED_ATTRIBUTE_NAMES,
     EXTENDED_ATTRIBUTE_NAMES_QUOTED,
     OSXPHOTOS_EXPORT_DB,
+    POST_COMMAND_CATEGORIES,
 )
 from .phototemplate import (
     TEMPLATE_SUBSTITUTIONS,
     TEMPLATE_SUBSTITUTIONS_MULTI_VALUED,
+    TEMPLATE_SUBSTITUTIONS_PATHLIB,
     get_template_help,
 )
 
 
+# TODO: The following help text could probably be done as mako template
 class ExportCommand(click.Command):
-    """ Custom click.Command that overrides get_help() to show additional help info for export """
+    """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)
@@ -65,7 +69,9 @@ class ExportCommand(click.Command):
             + f"rebuilding the '{OSXPHOTOS_EXPORT_DB}' database."
         )
         formatter.write("\n\n")
-        formatter.write(rich_text("[bold]** Extended Attributes **[/bold]", width=formatter.width))
+        formatter.write(
+            rich_text("[bold]** Extended Attributes **[/bold]", width=formatter.width)
+        )
         formatter.write("\n")
         formatter.write_text(
             """
@@ -99,7 +105,9 @@ The following attributes may be used with '--xattr-template':
             "For additional information on extended attributes see: https://developer.apple.com/documentation/coreservices/file_metadata/mditem/common_metadata_attribute_keys"
         )
         formatter.write("\n\n")
-        formatter.write(rich_text("[bold]** Templating System **[/bold]", width=formatter.width))
+        formatter.write(
+            rich_text("[bold]** Templating System **[/bold]", width=formatter.width)
+        )
         formatter.write("\n")
         formatter.write(template_help(width=formatter.width))
         formatter.write("\n")
@@ -128,7 +136,11 @@ The following attributes may be used with '--xattr-template':
             + "an error and the script will abort."
         )
         formatter.write("\n")
-        formatter.write(rich_text("[bold]** Template Substitutions **[/bold]", width=formatter.width))
+        formatter.write(
+            rich_text(
+                "[bold]** Template Substitutions **[/bold]", width=formatter.width
+            )
+        )
         formatter.write("\n")
         templ_tuples = [("Substitution", "Description")]
         templ_tuples.extend((k, v) for k, v in TEMPLATE_SUBSTITUTIONS.items())
@@ -151,21 +163,127 @@ The following attributes may be used with '--xattr-template':
         )
 
         formatter.write_dl(templ_tuples)
+
+        formatter.write("\n")
+        formatter.write_text(
+            "The following substitutions are file or directory paths. "
+            + "You can access various parts of the path using the following modifiers:"
+        )
+        formatter.write("\n")
+        formatter.write("{path.parent}: the parent directory\n")
+        formatter.write("{path.name}: the name of the file or final sub-directory\n")
+        formatter.write("{path.stem}: the name of the file without the extension\n")
+        formatter.write(
+            "{path.suffix}: the suffix of the file including the leading '.'\n"
+        )
+        formatter.write("\n")
+        formatter.write(
+            "For example, if the field {export_dir} is '/Shared/Backup/Photos':\n"
+        )
+        formatter.write("{export_dir.parent} is '/Shared/Backup'\n")
+        formatter.write("\n")
+        formatter.write(
+            "If the field {filepath} is '/Shared/Backup/Photos/IMG_1234.JPG':\n"
+        )
+        formatter.write("{filepath.parent} is '/Shared/Backup/Photos'\n")
+        formatter.write("{filepath.name} is 'IMG_1234.JPG'\n")
+        formatter.write("{filepath.stem} is 'IMG_1234'\n")
+        formatter.write("{filepath.suffix} is '.JPG'\n")
+        formatter.write("\n")
+        templ_tuples = [("Substitution", "Description")]
+        templ_tuples.extend((k, v) for k, v in TEMPLATE_SUBSTITUTIONS_PATHLIB.items())
+
+        formatter.write_dl(templ_tuples)
+
+        formatter.write("\n\n")
+        formatter.write(
+            rich_text("[bold]** Post Command **[/bold]", width=formatter.width)
+        )
+        formatter.write_text(
+            "You can run commands on the exported photos for post-processing "
+            + "using the '--post-command' option. '--post-command' is passed a CATEGORY and a COMMAND. "
+            + "COMMAND is an osxphotos template string which will be rendered and passed to the shell "
+            + "for execution. CATEGORY is the category of file to pass to COMMAND. "
+            + "The following categories are available: "
+        )
+        formatter.write("\n")
+        templ_tuples = [("Catgory", "Description")]
+        templ_tuples.extend((k, v) for k, v in POST_COMMAND_CATEGORIES.items())
+        formatter.write_dl(templ_tuples)
+        formatter.write("\n")
+        formatter.write_text(
+            "In addition to all normal template fields, the template fields "
+            + "'{filepath}' and '{export_dir}' will be available to your command template. "
+            + "Both of these are path-type templates which means their various parts can be accessed using "
+            + "the available properties, e.g. '{filepath.name}' provides just the file name without path "
+            + "and '{filepath.suffix}' is the file extension (suffix) of the file. "
+            + "When using paths in your command template, it is important to properly quote the paths "
+            + "as they will be passed to the shell and path names may contain spaces. "
+            + "Both the '{shell_quote}' template and the '|shell_quote' template filter are available for "
+            + "this purpose.  For example, the following command outputs the full path of newly exported files to file 'new.txt': "
+        )
+        formatter.write("\n")
+        formatter.write(
+            '--post-command new "echo {filepath.name|shell_quote} >> {shell_quote,{export_dir}/exported.txt}"'
+        )
+        formatter.write("\n\n")
+        formatter.write_text(
+            "In the above command, the 'shell_quote' filter is used to ensure '{filepath.name}' is properly quoted "
+            + "and the '{shell_quote}' template ensures the constructed path of '{exported_dir}/exported.txt' is properly quoted. "
+            "If '{filepath.name}' is 'IMG 1234.jpeg' and '{export_dir}' is '/Volumes/Photo Export', the command "
+            "thus renders to: "
+        )
+        formatter.write("\n")
+        formatter.write("echo 'IMG 1234.jpeg' >> '/Volumes/Photo Export/exported.txt'")
+        formatter.write("\n\n")
+        formatter.write_text(
+            "It is highly recommended that you run osxphotos with '--dry-run --verbose' "
+            + "first to ensure your commands are as expected. This will not actually run the commands but will "
+            + "print out the exact command string which would be executed."
+        )
+        formatter.write("\n\n")
+        formatter.write(
+            rich_text("[bold]** Post Function **[/bold]", width=formatter.width)
+        )
+        formatter.write_text(
+            "You can run your own python functions on the exported photos for post-processing "
+            + "using the '--post-function' option. '--post-function' is passed the name a python file "
+            + "and the name of the function in the file to call using format 'filename.py::function_name'. "
+            + "See the example function at https://github.com/RhetTbull/osxphotos/blob/master/examples/post_function.py "
+            + "You may specify multiple functions to run by repeating the --post-function option. "
+            + "All post functions will be called immediately after export of each photo and immediately before any --post-command commands. "
+            + "Post functions will not be called if the --dry-run flag is set."
+        )
+        formatter.write("\n")
+
         help_text += formatter.getvalue()
         return help_text
 
 
 def template_help(width=78):
-    """Return formatted string for template system """
+    """Return formatted string for template system"""
     sio = io.StringIO()
     console = Console(file=sio, force_terminal=True, width=width)
-    template_help_md = strip_md_links(get_template_help())
+    template_help_md = strip_md_header_and_links(get_template_help())
     console.print(Markdown(template_help_md))
     help_str = sio.getvalue()
     sio.close()
     return help_str
 
 
+def tutorial_help(width=78):
+    """Return formatted string for tutorial"""
+    sio = io.StringIO()
+    console = Console(file=sio, force_terminal=True, width=width)
+    help_md = get_tutorial_text()
+    help_md = strip_html_comments(help_md)
+    help_md = strip_md_links(help_md)
+    console.print(Markdown(help_md))
+    help_str = sio.getvalue()
+    sio.close()
+    return help_str
+
+
 def rich_text(text, width=78):
     """Return rich formatted text"""
     sio = io.StringIO()
@@ -176,16 +294,16 @@ def rich_text(text, width=78):
     return rich_text
 
 
-def strip_md_links(md):
-    """strip markdown links from markdown text md
-    
+def strip_md_header_and_links(md):
+    """strip markdown headers and links from markdown text md
+
     Args:
         md: str, markdown text
-    
-    Returns:
-        str with markdown links removed
 
-    Note: This uses a very basic regex that likely fails on all sorts of edge cases 
+    Returns:
+        str with markdown headers and links removed
+
+    Note: This uses a very basic regex that likely fails on all sorts of edge cases
     but works for the links in the osxphotos docs
     """
     links = r"(?:[*#])|\[(.*?)\]\(.+?\)"
@@ -195,3 +313,36 @@ def strip_md_links(md):
 
     return re.sub(links, subfn, md)
 
+
+def strip_md_links(md):
+    """strip markdown links from markdown text md
+
+    Args:
+        md: str, markdown text
+
+    Returns:
+        str with markdown links removed
+
+    Note: This uses a very basic regex that likely fails on all sorts of edge cases
+    but works for the links in the osxphotos docs
+    """
+    links = r"\[(.*?)\]\(.+?\)"
+
+    def subfn(match):
+        return match.group(1)
+
+    return re.sub(links, subfn, md)
+
+
+def strip_html_comments(text):
+    """Strip html comments from text (which doesn't need to be valid HTML)"""
+    return re.sub(r"<!--(.|\s|\n)*?-->", "", text)
+
+
+def get_tutorial_text():
+    """Load tutorial text from file"""
+    # TODO: would be better to use importlib.abc.ResourceReader but I can't find a single example of how to do this
+    help_file = pathlib.Path(__file__).parent / "tutorial.md"
+    with open(help_file, "r") as fd:
+        md = fd.read()
+    return md

osxphotos/exiftool.py

@@ -6,19 +6,30 @@
     If these aren't important to you, I highly recommend you use Sven Marnach's excellent 
     pyexiftool: https://github.com/smarnach/pyexiftool which provides more functionality """
 
+import atexit
 import json
 import logging
 import os
 import re
 import shutil
 import subprocess
-from functools import lru_cache  # pylint: disable=syntax-error
 from abc import ABC, abstractmethod
+from functools import lru_cache  # pylint: disable=syntax-error
 
 # exiftool -stay_open commands outputs this EOF marker after command is run
 EXIFTOOL_STAYOPEN_EOF = "{ready}"
 EXIFTOOL_STAYOPEN_EOF_LEN = len(EXIFTOOL_STAYOPEN_EOF)
 
+# list of exiftool processes to cleanup when exiting or when terminate is called
+EXIFTOOL_PROCESSES = []
+
+
+@atexit.register
+def terminate_exiftool():
+    """Terminate any running ExifTool subprocesses; call this to cleanup when done using ExifTool """
+    for proc in EXIFTOOL_PROCESSES:
+        proc._stop_proc()
+
 
 @lru_cache(maxsize=1)
 def get_exiftool_path():
@@ -67,7 +78,8 @@ class _ExifToolProc:
         if self._process_running:
             return self._process
         else:
-            raise ValueError("exiftool process is not running")
+            self._start_proc()
+            return self._process
 
     @property
     def pid(self):
@@ -105,30 +117,30 @@ class _ExifToolProc:
         )
         self._process_running = True
 
+        EXIFTOOL_PROCESSES.append(self)
+
     def _stop_proc(self):
         """ stop the exiftool process if it's running, otherwise, do nothing """
 
         if not self._process_running:
             return
 
-        self._process.stdin.write(b"-stay_open\n")
-        self._process.stdin.write(b"False\n")
-        self._process.stdin.flush()
+        try:
+            self._process.stdin.write(b"-stay_open\n")
+            self._process.stdin.write(b"False\n")
+            self._process.stdin.flush()
+        except Exception as e:
+            pass
+
         try:
             self._process.communicate(timeout=5)
         except subprocess.TimeoutExpired:
-            logging.warning(
-                f"exiftool pid {self._process.pid} did not exit, killing it"
-            )
             self._process.kill()
             self._process.communicate()
 
         del self._process
         self._process_running = False
 
-    def __del__(self):
-        self._stop_proc()
-
 
 class ExifTool:
     """ Basic exiftool interface for reading and writing EXIF tags """
@@ -154,9 +166,12 @@ class ExifTool:
         # if running as a context manager, self._context_mgr will be True
         self._context_mgr = False
         self._exiftoolproc = _ExifToolProc(exiftool=exiftool)
-        self._process = self._exiftoolproc.process
         self._read_exif()
 
+    @property
+    def _process(self):
+        return self._exiftoolproc.process
+
     def setvalue(self, tag, value):
         """Set tag to value(s); if value is None, will delete tag
 
@@ -186,7 +201,7 @@ class ExifTool:
             return True
         else:
             _, _, error = self.run_commands(*command)
-            return error is None
+            return error == ""
 
     def addvalues(self, tag, *values):
         """Add one or more value(s) to tag
@@ -228,7 +243,7 @@ class ExifTool:
             return True
         else:
             _, _, error = self.run_commands(*command)
-            return error is None
+            return error == ""
 
     def run_commands(self, *commands, no_file=False):
         """Run commands in the exiftool process and return result.

osxphotos/imageconverter.py

@@ -121,6 +121,6 @@ class ImageConverter:
                 return True
             else:
                 raise ImageConversionError(
-                    "Error converting file {input_path} to jpeg at {output_path}: {error}"
+                    f"Error converting file {input_path} to jpeg at {output_path}: {error}"
                 )
 

osxphotos/path_utils.py

@@ -6,22 +6,22 @@ from ._constants import MAX_DIRNAME_LEN, MAX_FILENAME_LEN
 
 
 def sanitize_filepath(filepath):
-    """ sanitize a filepath """
+    """sanitize a filepath"""
     return pathvalidate.sanitize_filepath(filepath, platform="macos")
 
 
 def is_valid_filepath(filepath):
-    """ returns True if a filepath is valid otherwise False """
+    """returns True if a filepath is valid otherwise False"""
     return pathvalidate.is_valid_filepath(filepath, platform="macos")
 
 
 def sanitize_filename(filename, replacement=":"):
-    """ replace any illegal characters in a filename and truncate filename if needed
+    """replace any illegal characters in a filename and truncate filename if needed
 
     Args:
         filename: str, filename to sanitze
         replacement: str, value to replace any illegal characters with; default = ":"
-    
+
     Returns:
         filename with any illegal characters replaced by replacement and truncated if necessary
     """
@@ -46,12 +46,12 @@ def sanitize_filename(filename, replacement=":"):
 
 
 def sanitize_dirname(dirname, replacement=":"):
-    """ replace any illegal characters in a directory name and truncate directory name if needed
+    """replace any illegal characters in a directory name and truncate directory name if needed
 
     Args:
-        dirname: str, directory name to sanitze
-        replacement: str, value to replace any illegal characters with; default = ":"
-    
+        dirname: str, directory name to sanitize
+        replacement: str, value to replace any illegal characters with; default = ":"; if None, no replacement occurs
+
     Returns:
         dirname with any illegal characters replaced by replacement and truncated if necessary
     """
@@ -61,19 +61,20 @@ def sanitize_dirname(dirname, replacement=":"):
 
 
 def sanitize_pathpart(pathpart, replacement=":"):
-    """ replace any illegal characters in a path part (either directory or filename without extension) and truncate name if needed
+    """replace any illegal characters in a path part (either directory or filename without extension) and truncate name if needed
 
     Args:
-        pathpart: str, path part to sanitze
-        replacement: str, value to replace any illegal characters with; default = ":"
-    
+        pathpart: str, path part to sanitize
+        replacement: str, value to replace any illegal characters with; default = ":"; if None, no replacement occurs
+
     Returns:
         pathpart with any illegal characters replaced by replacement and truncated if necessary
     """
     if pathpart:
-        pathpart = pathpart.replace("/", replacement)
+        pathpart = (
+            pathpart.replace("/", replacement) if replacement is not None else pathpart
+        )
         if len(pathpart) > MAX_DIRNAME_LEN:
             drop = len(pathpart) - MAX_DIRNAME_LEN
             pathpart = pathpart[:-drop]
     return pathpart
-

osxphotos/photoinfo/__init__.py

@@ -7,4 +7,4 @@ PhotosDB.photos() returns a list of PhotoInfo objects
 from ._photoinfo_exifinfo import ExifInfo
 from ._photoinfo_export import ExportResults
 from ._photoinfo_scoreinfo import ScoreInfo
-from .photoinfo import PhotoInfo
+from .photoinfo import PhotoInfo, PhotoInfoNone

osxphotos/photoinfo/_photoinfo_exiftool.py

@@ -3,13 +3,13 @@
 import logging
 import os
 
-from ..exiftool import ExifTool, get_exiftool_path
+from ..exiftool import ExifToolCaching, get_exiftool_path
 
 
 @property
 def exiftool(self):
-    """ Returns an ExifTool object for the photo
-        requires that exiftool (https://exiftool.org/) be installed
+    """ Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
+        Requires that exiftool (https://exiftool.org/) be installed
         If exiftool not installed, logs warning and returns None
         If photo path is missing, returns None
     """
@@ -20,7 +20,7 @@ def exiftool(self):
         try:
             exiftool_path = self._db._exiftool_path or get_exiftool_path()
             if self.path is not None and os.path.isfile(self.path):
-                exiftool = ExifTool(self.path, exiftool=exiftool_path)
+                exiftool = ExifToolCaching(self.path, exiftool=exiftool_path)
             else:
                 exiftool = None
         except FileNotFoundError:

osxphotos/photoinfo/photoinfo.py

@@ -3,7 +3,6 @@ PhotoInfo class
 Represents a single photo in the Photos library and provides access to the photo's attributes
 PhotosDB.photos() returns a list of PhotoInfo objects
 """
-
 import dataclasses
 import datetime
 import json
@@ -12,6 +11,7 @@ import os
 import os.path
 import pathlib
 from datetime import timedelta, timezone
+from typing import Optional
 
 import yaml
 
@@ -34,9 +34,10 @@ from .._constants import (
 from ..adjustmentsinfo import AdjustmentsInfo
 from ..albuminfo import AlbumInfo, ImportInfo
 from ..personinfo import FaceInfo, PersonInfo
-from ..phototemplate import PhotoTemplate
+from ..phototemplate import PhotoTemplate, RenderOptions
 from ..placeinfo import PlaceInfo4, PlaceInfo5
-from ..utils import _debug, _get_resource_loc, findfiles, get_preferred_uti_extension
+from ..uti import get_preferred_uti_extension, get_uti_for_extension
+from ..utils import _debug, _get_resource_loc, findfiles
 
 
 class PhotoInfo:
@@ -46,30 +47,31 @@ class PhotoInfo:
     """
 
     # import additional methods
-    from ._photoinfo_searchinfo import (
-        search_info,
-        search_info_normalized,
-        labels,
-        labels_normalized,
-        SearchInfo,
-    )
-    from ._photoinfo_exifinfo import exif_info, ExifInfo
+    from ._photoinfo_comments import comments, likes
+    from ._photoinfo_exifinfo import ExifInfo, exif_info
     from ._photoinfo_exiftool import exiftool
     from ._photoinfo_export import (
-        export,
-        export2,
-        _export_photo,
+        ExportResults,
         _exiftool_dict,
         _exiftool_json_sidecar,
+        _export_photo,
+        _export_photo_with_photos_export,
         _get_exif_keywords,
         _get_exif_persons,
         _write_exif_data,
         _write_sidecar,
         _xmp_sidecar,
-        ExportResults,
+        export,
+        export2,
+    )
+    from ._photoinfo_scoreinfo import ScoreInfo, score
+    from ._photoinfo_searchinfo import (
+        SearchInfo,
+        labels,
+        labels_normalized,
+        search_info,
+        search_info_normalized,
     )
-    from ._photoinfo_scoreinfo import score, ScoreInfo
-    from ._photoinfo_comments import comments, likes
 
     def __init__(self, db=None, uuid=None, info=None):
         self._uuid = uuid
@@ -77,9 +79,12 @@ class PhotoInfo:
         self._db = db
         self._verbose = self._db._verbose
 
+        # TODO: remove this once refactor of PhotoExporter is done
+        self._render_options = RenderOptions()
+
     @property
     def filename(self):
-        """ filename of the picture """
+        """filename of the picture"""
         if (
             self._db._db_version <= _PHOTOS_4_VERSION
             and self.has_raw
@@ -107,7 +112,7 @@ class PhotoInfo:
 
     @property
     def date(self):
-        """ image creation date as timezone aware datetime object """
+        """image creation date as timezone aware datetime object"""
         return self._info["imageDate"]
 
     @property
@@ -133,52 +138,22 @@ class PhotoInfo:
 
     @property
     def tzoffset(self):
-        """ timezone offset from UTC in seconds """
+        """timezone offset from UTC in seconds"""
         return self._info["imageTimeZoneOffsetSeconds"]
 
     @property
     def path(self):
-        """ absolute path on disk of the original picture """
+        """absolute path on disk of the original picture"""
         try:
             return self._path
         except AttributeError:
             self._path = None
             photopath = None
-            # TODO: should path try to return path even if ismissing?
             if self._info["isMissing"] == 1:
                 return photopath  # path would be meaningless until downloaded
 
             if self._db._db_version <= _PHOTOS_4_VERSION:
-                if self._info["has_raw"]:
-                    # return the path to JPEG even if RAW is original
-                    vol = (
-                        self._db._dbvolumes[self._info["raw_pair_info"]["volumeId"]]
-                        if self._info["raw_pair_info"]["volumeId"] is not None
-                        else None
-                    )
-                    if vol is not None:
-                        photopath = os.path.join(
-                            "/Volumes", vol, self._info["raw_pair_info"]["imagePath"]
-                        )
-                    else:
-                        photopath = os.path.join(
-                            self._db._masters_path,
-                            self._info["raw_pair_info"]["imagePath"],
-                        )
-                else:
-                    vol = self._info["volume"]
-                    if vol is not None:
-                        photopath = os.path.join(
-                            "/Volumes", vol, self._info["imagePath"]
-                        )
-                    else:
-                        photopath = os.path.join(
-                            self._db._masters_path, self._info["imagePath"]
-                        )
-                if not os.path.isfile(photopath):
-                    photopath = None
-                self._path = photopath
-                return photopath
+                return self._path_4()
 
             if self._info["shared"]:
                 # shared photo
@@ -208,9 +183,40 @@ class PhotoInfo:
             self._path = photopath
             return photopath
 
+    def _path_4(self):
+        """return path for photo on Photos <= version 4"""
+        if self._info["has_raw"]:
+            # return the path to JPEG even if RAW is original
+            vol = (
+                self._db._dbvolumes[self._info["raw_pair_info"]["volumeId"]]
+                if self._info["raw_pair_info"]["volumeId"] is not None
+                else None
+            )
+            if vol is not None:
+                photopath = os.path.join(
+                    "/Volumes", vol, self._info["raw_pair_info"]["imagePath"]
+                )
+            else:
+                photopath = os.path.join(
+                    self._db._masters_path,
+                    self._info["raw_pair_info"]["imagePath"],
+                )
+        else:
+            vol = self._info["volume"]
+            if vol is not None:
+                photopath = os.path.join("/Volumes", vol, self._info["imagePath"])
+            else:
+                photopath = os.path.join(
+                    self._db._masters_path, self._info["imagePath"]
+                )
+        if not os.path.isfile(photopath):
+            photopath = None
+        self._path = photopath
+        return photopath
+
     @property
     def path_edited(self):
-        """ absolute path on disk of the edited picture """
+        """absolute path on disk of the edited picture"""
         """ None if photo has not been edited """
 
         try:
@@ -224,7 +230,7 @@ class PhotoInfo:
             return self._path_edited
 
     def _path_edited_5(self):
-        """ return path_edited for Photos >= 5 """
+        """return path_edited for Photos >= 5"""
         # In Photos 5.0 / Catalina / MacOS 10.15:
         # edited photos appear to always be converted to .jpeg and stored in
         # library_name/resources/renders/X/UUID_1_201_a.jpeg
@@ -247,14 +253,10 @@ class PhotoInfo:
             filename = None
             if self._info["type"] == _PHOTO_TYPE:
                 # it's a photo
-                if self._db._photos_ver == 5:
-                    filename = f"{self._uuid}_1_201_a.jpeg"
+                if self._db._photos_ver != 5 and self.uti == "public.heic":
+                    filename = f"{self._uuid}_1_201_a.heic"
                 else:
-                    # could be a heic or a jpeg
-                    if self.uti == "public.heic":
-                        filename = f"{self._uuid}_1_201_a.heic"
-                    else:
-                        filename = f"{self._uuid}_1_201_a.jpeg"
+                    filename = f"{self._uuid}_1_201_a.jpeg"
             elif self._info["type"] == _MOVIE_TYPE:
                 # it's a movie
                 filename = f"{self._uuid}_2_0_a.mov"
@@ -282,7 +284,7 @@ class PhotoInfo:
         return photopath
 
     def _path_edited_4(self):
-        """ return path_edited for Photos <= 4 """
+        """return path_edited for Photos <= 4"""
 
         if self._db._db_version > _PHOTOS_4_VERSION:
             raise RuntimeError("Wrong database format!")
@@ -340,9 +342,40 @@ class PhotoInfo:
 
         return photopath
 
+    @property
+    def path_edited_live_photo(self):
+        """return path to edited version of live photo movie; only valid for Photos 5+"""
+        if self._db._db_version < _PHOTOS_5_VERSION:
+            return None
+
+        try:
+            return self._path_edited_live_photo
+        except AttributeError:
+            self._path_edited_live_photo = self._path_edited_5_live_photo()
+            return self._path_edited_live_photo
+
+    def _path_edited_5_live_photo(self):
+        """return path_edited_live_photo for Photos >= 5"""
+        if self._db._db_version < _PHOTOS_5_VERSION:
+            raise RuntimeError("Wrong database format!")
+
+        if self.live_photo and self._info["hasAdjustments"]:
+            library = self._db._library_path
+            directory = self._uuid[0]  # first char of uuid
+            filename = f"{self._uuid}_2_100_a.mov"
+            photopath = os.path.join(
+                library, "resources", "renders", directory, filename
+            )
+            if not os.path.isfile(photopath):
+                photopath = None
+        else:
+            photopath = None
+
+        return photopath
+
     @property
     def path_raw(self):
-        """ absolute path of associated RAW image or None if there is not one """
+        """absolute path of associated RAW image or None if there is not one"""
 
         # In Photos 5, raw is in same folder as original but with _4.ext
         # Unless "Copy Items to the Photos Library" is not checked
@@ -369,60 +402,72 @@ class PhotoInfo:
         #     return photopath
 
         if self._db._db_version <= _PHOTOS_4_VERSION:
-            vol = self._info["raw_info"]["volume"]
-            if vol is not None:
-                photopath = os.path.join(
-                    "/Volumes", vol, self._info["raw_info"]["imagePath"]
-                )
-            else:
-                photopath = os.path.join(
-                    self._db._masters_path, self._info["raw_info"]["imagePath"]
-                )
-            if not os.path.isfile(photopath):
-                logging.debug(
-                    f"MISSING PATH: RAW photo for UUID {self._uuid} should be at {photopath} but does not appear to exist"
-                )
-                photopath = None
-        else:
+            return self._path_raw_4()
+
+        if not self.isreference:
             filestem = pathlib.Path(self._info["filename"]).stem
-            raw_ext = get_preferred_uti_extension(self._info["UTI_raw"])
+            # raw_ext = get_preferred_uti_extension(self._info["UTI_raw"])
 
             if self._info["directory"].startswith("/"):
                 filepath = self._info["directory"]
             else:
                 filepath = os.path.join(self._db._masters_path, self._info["directory"])
 
-            glob_str = f"{filestem}*.{raw_ext}"
+            # raw files have same name as original but with _4.raw_ext appended
+            # I believe the _4 maps to PHAssetResourceTypeAlternatePhoto = 4
+            # see: https://developer.apple.com/documentation/photokit/phassetresourcetype/phassetresourcetypealternatephoto?language=objc
+            glob_str = f"{filestem}_4*"
             raw_file = findfiles(glob_str, filepath)
-            if len(raw_file) != 1:
-                # Note: In Photos Version 5.0 (141.19.150), images not copied to Photos Library
-                # that are missing do not always trigger is_missing = True as happens
-                # in earlier version so it's possible for this check to fail, if so, return None
-                logging.debug(f"Error getting path to RAW file: {filepath}/{glob_str}")
+            if not raw_file:
                 photopath = None
             else:
-                photopath = os.path.join(filepath, raw_file[0])
-                if not os.path.isfile(photopath):
-                    logging.debug(
-                        f"MISSING PATH: RAW photo for UUID {self._uuid} should be at {photopath} but does not appear to exist"
-                    )
-                    photopath = None
+                photopath = pathlib.Path(filepath) / raw_file[0]
+                photopath = str(photopath) if photopath.is_file() else None
+        else:
+            # is a reference
+            try:
+                photopath = (
+                    pathlib.Path("/Volumes")
+                    / self._info["raw_volume"]
+                    / self._info["raw_relative_path"]
+                )
+                photopath = str(photopath) if photopath.is_file() else None
+            except KeyError:
+                # don't have the path details
+                photopath = None
 
         return photopath
 
+    def _path_raw_4(self):
+        """Return path_raw for Photos <= version 4"""
+        vol = self._info["raw_info"]["volume"]
+        if vol is not None:
+            photopath = os.path.join(
+                "/Volumes", vol, self._info["raw_info"]["imagePath"]
+            )
+        else:
+            photopath = os.path.join(
+                self._db._masters_path, self._info["raw_info"]["imagePath"]
+            )
+        if not os.path.isfile(photopath):
+            logging.debug(
+                f"MISSING PATH: RAW photo for UUID {self._uuid} should be at {photopath} but does not appear to exist"
+            )
+            photopath = None
+
     @property
     def description(self):
-        """ long / extended description of picture """
+        """long / extended description of picture"""
         return self._info["extendedDescription"]
 
     @property
     def persons(self):
-        """ list of persons in picture """
+        """list of persons in picture"""
         return [self._db._dbpersons_pk[pk]["fullname"] for pk in self._info["persons"]]
 
     @property
     def person_info(self):
-        """ list of PersonInfo objects for person in picture """
+        """list of PersonInfo objects for person in picture"""
         try:
             return self._personinfo
         except AttributeError:
@@ -433,7 +478,7 @@ class PhotoInfo:
 
     @property
     def face_info(self):
-        """ list of FaceInfo objects for faces in picture """
+        """list of FaceInfo objects for faces in picture"""
         try:
             return self._faceinfo
         except AttributeError:
@@ -447,7 +492,7 @@ class PhotoInfo:
 
     @property
     def albums(self):
-        """ list of albums picture is contained in """
+        """list of albums picture is contained in"""
         try:
             return self._albums
         except AttributeError:
@@ -459,7 +504,7 @@ class PhotoInfo:
 
     @property
     def burst_albums(self):
-        """If photo is burst photo, list of albums it is contained in as well as any albums the key photo is contained in, otherwise returns self.albums """
+        """If photo is burst photo, list of albums it is contained in as well as any albums the key photo is contained in, otherwise returns self.albums"""
         try:
             return self._burst_albums
         except AttributeError:
@@ -472,7 +517,7 @@ class PhotoInfo:
 
     @property
     def album_info(self):
-        """ list of AlbumInfo objects representing albums the photo is contained in """
+        """list of AlbumInfo objects representing albums the photo is contained in"""
         try:
             return self._album_info
         except AttributeError:
@@ -484,11 +529,11 @@ class PhotoInfo:
 
     @property
     def burst_album_info(self):
-        """ If photo is a burst photo, returns list of AlbumInfo objects representing albums the photo is contained in as well as albums the burst key photo is contained in, otherwise returns self.album_info. """
+        """If photo is a burst photo, returns list of AlbumInfo objects representing albums the photo is contained in as well as albums the burst key photo is contained in, otherwise returns self.album_info."""
         try:
             return self._burst_album_info
         except AttributeError:
-            burst_album_info = list(self.album_info) 
+            burst_album_info = list(self.album_info)
             for photo in self.burst_photos:
                 if photo.burst_key:
                     burst_album_info.extend(photo.album_info)
@@ -497,7 +542,7 @@ class PhotoInfo:
 
     @property
     def import_info(self):
-        """ ImportInfo object representing import session for the photo or None if no import session """
+        """ImportInfo object representing import session for the photo or None if no import session"""
         try:
             return self._import_info
         except AttributeError:
@@ -510,17 +555,17 @@ class PhotoInfo:
 
     @property
     def keywords(self):
-        """ list of keywords for picture """
+        """list of keywords for picture"""
         return self._info["keywords"]
 
     @property
     def title(self):
-        """ name / title of picture """
+        """name / title of picture"""
         return self._info["name"]
 
     @property
     def uuid(self):
-        """ UUID of picture """
+        """UUID of picture"""
         return self._uuid
 
     @property
@@ -538,12 +583,12 @@ class PhotoInfo:
 
     @property
     def hasadjustments(self):
-        """ True if picture has adjustments / edits """
+        """True if picture has adjustments / edits"""
         return self._info["hasAdjustments"] == 1
 
     @property
     def adjustments(self):
-        """ Returns AdjustmentsInfo class for adjustment data or None if no adjustments; Photos 5+ only """
+        """Returns AdjustmentsInfo class for adjustment data or None if no adjustments; Photos 5+ only"""
         if self._db._db_version <= _PHOTOS_4_VERSION:
             return None
 
@@ -567,32 +612,32 @@ class PhotoInfo:
 
     @property
     def external_edit(self):
-        """ Returns True if picture was edited outside of Photos using external editor """
+        """Returns True if picture was edited outside of Photos using external editor"""
         return self._info["adjustmentFormatID"] == "com.apple.Photos.externalEdit"
 
     @property
     def favorite(self):
-        """ True if picture is marked as favorite """
+        """True if picture is marked as favorite"""
         return self._info["favorite"] == 1
 
     @property
     def hidden(self):
-        """ True if picture is hidden """
+        """True if picture is hidden"""
         return self._info["hidden"] == 1
 
     @property
     def visible(self):
-        """ True if picture is visble """
+        """True if picture is visble"""
         return self._info["visible"]
 
     @property
     def intrash(self):
-        """ True if picture is in trash ('Recently Deleted' folder)"""
+        """True if picture is in trash ('Recently Deleted' folder)"""
         return self._info["intrash"]
 
     @property
     def date_trashed(self):
-        """ Date asset was placed in the trash or None """
+        """Date asset was placed in the trash or None"""
         # TODO: add add_timezone(dt, offset_seconds) to datetime_utils
         # also update date_modified
         trasheddate = self._info["trasheddate"]
@@ -604,9 +649,26 @@ class PhotoInfo:
         else:
             return None
 
+    @property
+    def date_added(self):
+        """Date photo was added to the database"""
+        try:
+            return self._date_added
+        except AttributeError:
+            added_date = self._info["added_date"]
+            if added_date:
+                seconds = self._info["imageTimeZoneOffsetSeconds"] or 0
+                delta = timedelta(seconds=seconds)
+                tz = timezone(delta)
+                self._date_added = added_date.astimezone(tz=tz)
+            else:
+                self._date_added = None
+
+            return self._date_added
+
     @property
     def location(self):
-        """ returns (latitude, longitude) as float in degrees or None """
+        """returns (latitude, longitude) as float in degrees or None"""
         return (self._latitude, self._longitude)
 
     @property
@@ -640,13 +702,23 @@ class PhotoInfo:
         """Returns Uniform Type Identifier (UTI) for the original image
         for example: public.jpeg or com.apple.quicktime-movie
         """
-        if self._db._db_version <= _PHOTOS_4_VERSION and self._info["has_raw"]:
-            return self._info["raw_pair_info"]["UTI"]
-        elif self.shared:
-            # TODO: need reliable way to get original UTI for shared
-            return self.uti
-        else:
-            return self._info["UTI_original"]
+        try:
+            return self._uti_original
+        except AttributeError:
+            if self._db._db_version <= _PHOTOS_4_VERSION and self._info["has_raw"]:
+                self._uti_original = self._info["raw_pair_info"]["UTI"]
+            elif self.shared:
+                # TODO: need reliable way to get original UTI for shared
+                self._uti_original = self.uti
+            elif self._db._photos_ver >= 7:
+                # Monterey+
+                self._uti_original = get_uti_for_extension(
+                    pathlib.Path(self.original_filename).suffix
+                )
+            else:
+                self._uti_original = self._info["UTI_original"]
+
+            return self._uti_original
 
     @property
     def uti_edited(self):
@@ -665,7 +737,14 @@ class PhotoInfo:
         for example: com.canon.cr2-raw-image
         Returns None if no associated RAW image
         """
-        return self._info["UTI_raw"]
+        if self._db._photos_ver < 7:
+            return self._info["UTI_raw"]
+
+        rawpath = self.path_raw
+        if rawpath:
+            return get_uti_for_extension(pathlib.Path(rawpath).suffix)
+        else:
+            return None
 
     @property
     def ismovie(self):
@@ -702,27 +781,27 @@ class PhotoInfo:
 
     @property
     def isreference(self):
-        """ Returns True if photo is a reference (not copied to the Photos library), otherwise False """
+        """Returns True if photo is a reference (not copied to the Photos library), otherwise False"""
         return self._info["isreference"]
 
     @property
     def burst(self):
-        """ Returns True if photo is part of a Burst photo set, otherwise False """
+        """Returns True if photo is part of a Burst photo set, otherwise False"""
         return self._info["burst"]
 
     @property
     def burst_selected(self):
-        """ Returns True if photo is a burst photo and has been selected from the burst set by the user, otherwise False """
+        """Returns True if photo is a burst photo and has been selected from the burst set by the user, otherwise False"""
         return bool(self._info["burstPickType"] & BURST_SELECTED)
 
     @property
     def burst_key(self):
-        """ Returns True if photo is a burst photo and is the key image for the burst set (the image that Photos shows on top of the burst stack), otherwise False """
+        """Returns True if photo is a burst photo and is the key image for the burst set (the image that Photos shows on top of the burst stack), otherwise False"""
         return bool(self._info["burstPickType"] & BURST_KEY)
 
     @property
     def burst_default_pick(self):
-        """ Returns True if photo is a burst image and is the photo that Photos selected as the default image for the burst set, otherwise False """
+        """Returns True if photo is a burst image and is the photo that Photos selected as the default image for the burst set, otherwise False"""
         return bool(self._info["burstPickType"] & BURST_DEFAULT_PICK)
 
     @property
@@ -742,7 +821,7 @@ class PhotoInfo:
 
     @property
     def live_photo(self):
-        """ Returns True if photo is a live photo, otherwise False """
+        """Returns True if photo is a live photo, otherwise False"""
         return self._info["live_photo"]
 
     @property
@@ -801,44 +880,113 @@ class PhotoInfo:
 
         return photopath
 
+    @property
+    def path_derivatives(self):
+        """Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)"""
+        try:
+            return self._path_derivatives
+        except AttributeError:
+            if self._db._db_version <= _PHOTOS_4_VERSION:
+                self._path_derivatives = self._path_derivatives_4()
+                return self._path_derivatives
+
+            directory = self._uuid[0]  # first char of uuid
+            derivative_path = (
+                pathlib.Path(self._db._library_path)
+                / "resources"
+                / "derivatives"
+                / directory
+            )
+            files = derivative_path.glob(f"{self.uuid}*.*")
+            files = sorted(files, reverse=True, key=lambda f: f.stat().st_size)
+            # return list of filename but skip .THM files (these are actually low-res thumbnails in JPEG format but with .THM extension)
+            derivatives = [
+                str(filename) for filename in files if filename.suffix != ".THM"
+            ]
+            if (
+                self.isphoto
+                and len(derivatives) > 1
+                and derivatives[0].endswith(".mov")
+            ):
+                derivatives[1], derivatives[0] = derivatives[0], derivatives[1]
+
+            self._path_derivatives = derivatives
+            return self._path_derivatives
+
+    def _path_derivatives_4(self):
+        """Return paths to all derivative (preview) files for Photos <= 4"""
+        modelid = self._info["modelID"]
+        if modelid is None:
+            return []
+        folder_id, file_id = _get_resource_loc(modelid)
+        derivatives_root = (
+            pathlib.Path(self._db._library_path)
+            / "resources"
+            / "proxies"
+            / "derivatives"
+            / folder_id
+        )
+
+        # photos appears to usually be in "00" subfolder but
+        # could be elsewhere--I haven't figured out this logic yet
+        # first see if it's in 00
+
+        derivatives_path = derivatives_root / "00" / file_id
+        if derivatives_path.is_dir():
+            files = derivatives_path.glob("*")
+            files = sorted(files, reverse=True, key=lambda f: f.stat().st_size)
+            return [str(filename) for filename in files]
+
+        # didn't find derivatives path
+        for subdir in derivatives_root.glob("*"):
+            if subdir.is_dir():
+                derivatives_path = derivatives_root / subdir / file_id
+                if derivatives_path.is_dir():
+                    files = derivatives_path.glob("*")
+                    files = sorted(files, reverse=True, key=lambda f: f.stat().st_size)
+                    return [str(filename) for filename in files]
+
+        # didn't find a derivatives path
+        return []
+
     @property
     def panorama(self):
-        """ Returns True if photo is a panorama, otherwise False """
+        """Returns True if photo is a panorama, otherwise False"""
         return self._info["panorama"]
 
     @property
     def slow_mo(self):
-        """ Returns True if photo is a slow motion video, otherwise False """
+        """Returns True if photo is a slow motion video, otherwise False"""
         return self._info["slow_mo"]
 
     @property
     def time_lapse(self):
-        """ Returns True if photo is a time lapse video, otherwise False """
+        """Returns True if photo is a time lapse video, otherwise False"""
         return self._info["time_lapse"]
 
     @property
     def hdr(self):
-        """ Returns True if photo is an HDR photo, otherwise False """
+        """Returns True if photo is an HDR photo, otherwise False"""
         return self._info["hdr"]
 
     @property
     def screenshot(self):
-        """ Returns True if photo is an HDR photo, otherwise False """
+        """Returns True if photo is an HDR photo, otherwise False"""
         return self._info["screenshot"]
 
     @property
     def portrait(self):
-        """ Returns True if photo is a portrait, otherwise False """
+        """Returns True if photo is a portrait, otherwise False"""
         return self._info["portrait"]
 
     @property
     def selfie(self):
-        """ Returns True if photo is a selfie (front facing camera), otherwise False """
+        """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 """
+        """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
@@ -866,12 +1014,12 @@ class PhotoInfo:
 
     @property
     def has_raw(self):
-        """ returns True if photo has an associated raw image (that is, it's a RAW+JPEG pair), otherwise False """
+        """returns True if photo has an associated raw image (that is, it's a RAW+JPEG pair), otherwise False"""
         return self._info["has_raw"]
 
     @property
     def israw(self):
-        """ returns True if photo is a raw image. For images with an associated RAW+JPEG pair, see has_raw """
+        """returns True if photo is a raw image. For images with an associated RAW+JPEG pair, see has_raw"""
         return "raw-image" in self.uti_original
 
     @property
@@ -883,17 +1031,17 @@ class PhotoInfo:
 
     @property
     def height(self):
-        """ returns height of the current photo version in pixels """
+        """returns height of the current photo version in pixels"""
         return self._info["height"]
 
     @property
     def width(self):
-        """ returns width of the current photo version in pixels """
+        """returns width of the current photo version in pixels"""
         return self._info["width"]
 
     @property
     def orientation(self):
-        """ returns EXIF orientation of the current photo version as int or 0 if current orientation cannot be determined """
+        """returns EXIF orientation of the current photo version as int or 0 if current orientation cannot be determined"""
         if self._db._db_version <= _PHOTOS_4_VERSION:
             return self._info["orientation"]
 
@@ -909,76 +1057,63 @@ class PhotoInfo:
 
     @property
     def original_height(self):
-        """ returns height of the original photo version in pixels """
+        """returns height of the original photo version in pixels"""
         return self._info["original_height"]
 
     @property
     def original_width(self):
-        """ returns width of the original photo version in pixels """
+        """returns width of the original photo version in pixels"""
         return self._info["original_width"]
 
     @property
     def original_orientation(self):
-        """ returns EXIF orientation of the original photo version as int """
+        """returns EXIF orientation of the original photo version as int"""
         return self._info["original_orientation"]
 
     @property
     def original_filesize(self):
-        """ returns filesize of original photo in bytes as int """
+        """returns filesize of original photo in bytes as int"""
         return self._info["original_filesize"]
 
+    @property
+    def duplicates(self):
+        """return list of PhotoInfo objects for possible duplicates (matching signature of original size, date, height, width) or empty list if no matching duplicates"""
+        signature = self._db._duplicate_signature(self.uuid)
+        duplicates = []
+        try:
+            for uuid in self._db._db_signatures[signature]:
+                if uuid != self.uuid:
+                    # found a possible duplicate
+                    duplicates.append(self._db.get_photo(uuid))
+        except KeyError:
+            # don't expect this to happen as the signature should be in db
+            logging.warning(f"Did not find signature for {self.uuid} in _db_signatures")
+        return duplicates
+
     def render_template(
-        self,
-        template_str,
-        none_str="_",
-        path_sep=None,
-        expand_inplace=False,
-        inplace_sep=None,
-        filename=False,
-        dirname=False,
-        strip=False,
-        edited=False,
+        self, template_str: str, options: Optional[RenderOptions] = None
     ):
         """Renders a template string for PhotoInfo instance using PhotoTemplate
 
         Args:
             template_str: a template string with fields to render
-            none_str: a str to use if template field renders to None, default is "_".
-            path_sep: a single character str to use as path separator when joining
-                fields like folder_album; if not provided, defaults to os.path.sep
-            expand_inplace: expand multi-valued substitutions in-place as a single string
-                instead of returning individual strings
-            inplace_sep: optional string to use as separator between multi-valued keywords
-                with expand_inplace; default is ','
-            filename: if True, template output will be sanitized to produce valid file name
-            dirname: if True, template output will be sanitized to produce valid directory name
-            strip: if True, strips leading/trailing white space from resulting template
-            edited: if True, sets {edited_version} field to True, otherwise it gets set to False; set if you want template evaluated for edited version
+            options: a RenderOptions instance
 
         Returns:
             ([rendered_strings], [unmatched]): tuple of list of rendered strings and list of unmatched template values
         """
+        options = options or RenderOptions()
         template = PhotoTemplate(self, exiftool_path=self._db._exiftool_path)
-        return template.render(
-            template_str,
-            none_str=none_str,
-            path_sep=path_sep,
-            expand_inplace=expand_inplace,
-            inplace_sep=inplace_sep,
-            filename=filename,
-            dirname=dirname,
-            strip=strip,
-            edited_version=edited,
-        )
+        return template.render(template_str, options)
 
     @property
     def _longitude(self):
-        """ Returns longitude, in degrees """
+        """Returns longitude, in degrees"""
         return self._info["longitude"]
 
     @property
     def _latitude(self):
-        """ Returns latitude, in degrees """
+        """Returns latitude, in degrees"""
         return self._info["latitude"]
 
     def _get_album_uuids(self):
@@ -1016,7 +1151,7 @@ class PhotoInfo:
         return f"osxphotos.{self.__class__.__name__}(db={self._db}, uuid='{self._uuid}', info={self._info})"
 
     def __str__(self):
-        """ string representation of PhotoInfo object """
+        """string representation of PhotoInfo object"""
 
         date_iso = self.date.isoformat()
         date_modified_iso = (
@@ -1079,7 +1214,7 @@ class PhotoInfo:
         return yaml.dump(info, sort_keys=False)
 
     def asdict(self):
-        """ return dict representation """
+        """return dict representation"""
 
         folders = {album.title: album.folder_names for album in self.album_info}
         exif = dataclasses.asdict(self.exif_info) if self.exif_info else {}
@@ -1155,7 +1290,7 @@ class PhotoInfo:
         }
 
     def json(self):
-        """ Return JSON representation """
+        """Return JSON representation"""
 
         def default(o):
             if isinstance(o, (datetime.date, datetime.datetime)):
@@ -1164,7 +1299,7 @@ class PhotoInfo:
         return json.dumps(self.asdict(), sort_keys=True, default=default)
 
     def __eq__(self, other):
-        """ Compare two PhotoInfo objects for equality """
+        """Compare two PhotoInfo objects for equality"""
         # Can't just compare the two __dicts__ because some methods (like albums)
         # memoize their value once called in an instance variable (e.g. self._albums)
         if isinstance(other, self.__class__):
@@ -1176,5 +1311,19 @@ class PhotoInfo:
         return False
 
     def __ne__(self, other):
-        """ Compare two PhotoInfo objects for inequality """
+        """Compare two PhotoInfo objects for inequality"""
         return not self.__eq__(other)
+
+    def __hash__(self):
+        """Make PhotoInfo hashable"""
+        return hash(self.uuid)
+
+
+class PhotoInfoNone:
+    """mock class that returns None for all attributes"""
+
+    def __init__(self):
+        pass
+
+    def __getattribute__(self, name):
+        return None

osxphotos/photokit.py

@@ -34,7 +34,8 @@ from Foundation import NSNotificationCenter, NSObject
 from PyObjCTools import AppHelper
 
 from .fileutil import FileUtil
-from .utils import _get_os_version, get_preferred_uti_extension, increment_filename
+from .uti import get_preferred_uti_extension
+from .utils import _get_os_version, increment_filename
 
 # NOTE: This requires user have granted access to the terminal (e.g. Terminal.app or iTerm)
 # to access Photos.  This should happen automatically the first time it's called. I've
@@ -64,7 +65,7 @@ MIN_SLEEP = 0.015
 
 ### utility functions
 def NSURL_to_path(url):
-    """ Convert URL string as represented by NSURL to a path string """
+    """Convert URL string as represented by NSURL to a path string"""
     nsurl = Foundation.NSURL.alloc().initWithString_(
         Foundation.NSString.alloc().initWithString_(str(url))
     )
@@ -74,7 +75,7 @@ def NSURL_to_path(url):
 
 
 def path_to_NSURL(path):
-    """ Convert path string to NSURL """
+    """Convert path string to NSURL"""
     pathstr = Foundation.NSString.alloc().initWithString_(str(path))
     url = Foundation.NSURL.fileURLWithPath_(pathstr)
     pathstr.dealloc()
@@ -82,10 +83,10 @@ def path_to_NSURL(path):
 
 
 def check_photokit_authorization():
-    """ Check authorization to use user's Photos Library
+    """Check authorization to use user's Photos Library
 
     Returns:
-       True if user has authorized access to the Photos library, otherwise False 
+       True if user has authorized access to the Photos library, otherwise False
     """
 
     auth_status = Photos.PHPhotoLibrary.authorizationStatus()
@@ -93,7 +94,7 @@ def check_photokit_authorization():
 
 
 def request_photokit_authorization():
-    """ Request authorization to user's Photos Library
+    """Request authorization to user's Photos Library
 
     Returns:
         authorization status
@@ -135,39 +136,39 @@ def request_photokit_authorization():
 
 ### exceptions
 class PhotoKitError(Exception):
-    """Base class for exceptions in this module. """
+    """Base class for exceptions in this module."""
 
     pass
 
 
 class PhotoKitFetchFailed(PhotoKitError):
-    """Exception raised for errors in the input. """
+    """Exception raised for errors in the input."""
 
     pass
 
 
 class PhotoKitAuthError(PhotoKitError):
-    """Exception raised if unable to authorize use of PhotoKit. """
+    """Exception raised if unable to authorize use of PhotoKit."""
 
     pass
 
 
 class PhotoKitExportError(PhotoKitError):
-    """Exception raised if unable to export asset. """
+    """Exception raised if unable to export asset."""
 
     pass
 
 
 class PhotoKitMediaTypeError(PhotoKitError):
-    """ Exception raised if an unknown mediaType() is encountered """
+    """Exception raised if an unknown mediaType() is encountered"""
 
     pass
 
 
 ### helper classes
 class ImageData:
-    """ Simple class to hold the data passed to the handler for 
-        requestImageDataAndOrientationForAsset_options_resultHandler_ 
+    """Simple class to hold the data passed to the handler for
+    requestImageDataAndOrientationForAsset_options_resultHandler_
     """
 
     def __init__(
@@ -181,8 +182,7 @@ class ImageData:
 
 
 class AVAssetData:
-    """ Simple class to hold the data passed to the handler for 
-    """
+    """Simple class to hold the data passed to the handler for"""
 
     def __init__(self):
         self.asset = None
@@ -192,7 +192,7 @@ class AVAssetData:
 
 
 class PHAssetResourceData:
-    """ Simple class to hold data from 
+    """Simple class to hold data from
     requestDataForAssetResource:options:dataReceivedHandler:completionHandler:
     """
 
@@ -211,8 +211,8 @@ class PHAssetResourceData:
 
 
 class PhotoKitNotificationDelegate(NSObject):
-    """ Handles notifications from NotificationCenter;
-        used with asynchronous PhotoKit requests to stop event loop when complete
+    """Handles notifications from NotificationCenter;
+    used with asynchronous PhotoKit requests to stop event loop when complete
     """
 
     def liveNotification_(self, note):
@@ -226,11 +226,11 @@ class PhotoKitNotificationDelegate(NSObject):
 
 ### main class implementation
 class PhotoAsset:
-    """ PhotoKit PHAsset representation """
+    """PhotoKit PHAsset representation"""
 
     def __init__(self, manager, phasset):
-        """ Return a PhotoAsset object
-        
+        """Return a PhotoAsset object
+
         Args:
             manager = ImageManager object
             phasset: a PHAsset object
@@ -241,32 +241,32 @@ class PhotoAsset:
 
     @property
     def phasset(self):
-        """ Return PHAsset instance """
+        """Return PHAsset instance"""
         return self._phasset
 
     @property
     def uuid(self):
-        """ Return local identifier (UUID) of PHAsset """
+        """Return local identifier (UUID) of PHAsset"""
         return self._phasset.localIdentifier()
 
     @property
     def isphoto(self):
-        """ Return True if asset is photo (image), otherwise False """
+        """Return True if asset is photo (image), otherwise False"""
         return self.media_type == Photos.PHAssetMediaTypeImage
 
     @property
     def ismovie(self):
-        """ Return True if asset is movie (video), otherwise False """
+        """Return True if asset is movie (video), otherwise False"""
         return self.media_type == Photos.PHAssetMediaTypeVideo
 
     @property
     def isaudio(self):
-        """ Return True if asset is audio, otherwise False """
+        """Return True if asset is audio, otherwise False"""
         return self.media_type == Photos.PHAssetMediaTypeAudio
 
     @property
     def original_filename(self):
-        """ Return original filename asset was imported with """
+        """Return original filename asset was imported with"""
         resources = self._resources()
         for resource in resources:
             if (
@@ -278,10 +278,22 @@ class PhotoAsset:
                 return resource.originalFilename()
         return None
 
+    @property
+    def raw_filename(self):
+        """Return RAW filename for RAW+JPEG photos or None if no RAW asset"""
+        resources = self._resources()
+        for resource in resources:
+            if (
+                self.isphoto
+                and resource.type() == Photos.PHAssetResourceTypeAlternatePhoto
+            ):
+                return resource.originalFilename()
+        return None
+
     @property
     def hasadjustments(self):
-        """ Check to see if a PHAsset has adjustment data associated with it
-            Returns False if no adjustments, True if any adjustments """
+        """Check to see if a PHAsset has adjustment data associated with it
+        Returns False if no adjustments, True if any adjustments"""
 
         # reference: https://developer.apple.com/documentation/photokit/phassetresource/1623988-assetresourcesforasset?language=objc
 
@@ -298,112 +310,112 @@ class PhotoAsset:
 
     @property
     def media_type(self):
-        """ media type such as image or video """
+        """media type such as image or video"""
         return self.phasset.mediaType()
 
     @property
     def media_subtypes(self):
-        """ media subtype """
+        """media subtype"""
         return self.phasset.mediaSubtypes()
 
     @property
     def panorama(self):
-        """ return True if asset is panorama, otherwise False """
+        """return True if asset is panorama, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypePhotoPanorama)
 
     @property
     def hdr(self):
-        """ return True if asset is HDR, otherwise False """
+        """return True if asset is HDR, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypePhotoHDR)
 
     @property
     def screenshot(self):
-        """ return True if asset is screenshot, otherwise False """
+        """return True if asset is screenshot, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypePhotoScreenshot)
 
     @property
     def live(self):
-        """ return True if asset is live, otherwise False """
+        """return True if asset is live, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypePhotoLive)
 
     @property
     def streamed(self):
-        """ return True if asset is streamed video, otherwise False """
+        """return True if asset is streamed video, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypeVideoStreamed)
 
     @property
     def slow_mo(self):
-        """ return True if asset is slow motion (high frame rate) video, otherwise False """
+        """return True if asset is slow motion (high frame rate) video, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypeVideoHighFrameRate)
 
     @property
     def time_lapse(self):
-        """ return True if asset is time lapse video, otherwise False """
+        """return True if asset is time lapse video, otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypeVideoTimelapse)
 
     @property
     def portrait(self):
-        """ return True if asset is portrait (depth effect), otherwise False """
+        """return True if asset is portrait (depth effect), otherwise False"""
         return bool(self.media_subtypes & Photos.PHAssetMediaSubtypePhotoDepthEffect)
 
     @property
     def burstid(self):
-        """ return burstIdentifier of image if image is burst photo otherwise None """
+        """return burstIdentifier of image if image is burst photo otherwise None"""
         return self.phasset.burstIdentifier()
 
     @property
     def burst(self):
-        """ return True if image is burst otherwise False """
+        """return True if image is burst otherwise False"""
         return bool(self.burstid)
 
     @property
     def source_type(self):
-        """ the means by which the asset entered the user's library """
+        """the means by which the asset entered the user's library"""
         return self.phasset.sourceType()
 
     @property
     def pixel_width(self):
-        """ width in pixels """
+        """width in pixels"""
         return self.phasset.pixelWidth()
 
     @property
     def pixel_height(self):
-        """ height in pixels """
+        """height in pixels"""
         return self.phasset.pixelHeight()
 
     @property
     def date(self):
-        """ date asset was created """
+        """date asset was created"""
         return self.phasset.creationDate()
 
     @property
     def date_modified(self):
-        """ date asset was modified """
+        """date asset was modified"""
         return self.phasset.modificationDate()
 
     @property
     def location(self):
-        """ location of the asset """
+        """location of the asset"""
         return self.phasset.location()
 
     @property
     def duration(self):
-        """ duration of the asset """
+        """duration of the asset"""
         return self.phasset.duration()
 
     @property
     def favorite(self):
-        """ True if asset is favorite, otherwise False """
+        """True if asset is favorite, otherwise False"""
         return self.phasset.isFavorite()
 
     @property
     def hidden(self):
-        """ True if asset is hidden, otherwise False """
+        """True if asset is hidden, otherwise False"""
         return self.phasset.isHidden()
 
     def metadata(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return dict of asset metadata
-        
+        """Return dict of asset metadata
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
@@ -411,17 +423,28 @@ class PhotoAsset:
         return imagedata.metadata
 
     def uti(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return UTI of asset
-        
+        """Return UTI of asset
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
         imagedata = self._request_image_data(version=version)
         return imagedata.uti
 
+    def uti_raw(self):
+        """Return UTI of RAW component of RAW+JPEG pair"""
+        resources = self._resources()
+        for resource in resources:
+            if (
+                self.isphoto
+                and resource.type() == Photos.PHAssetResourceTypeAlternatePhoto
+            ):
+                return resource.uniformTypeIdentifier()
+        return None
+
     def url(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return URL of asset
-        
+        """Return URL of asset
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
@@ -429,8 +452,8 @@ class PhotoAsset:
         return str(imagedata.info["PHImageFileURLKey"])
 
     def path(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return path of asset
-        
+        """Return path of asset
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
@@ -439,8 +462,8 @@ class PhotoAsset:
         return url.fileSystemRepresentation().decode("utf-8")
 
     def orientation(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return orientation of asset
-        
+        """Return orientation of asset
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
@@ -449,8 +472,8 @@ class PhotoAsset:
 
     @property
     def degraded(self, version=PHOTOS_VERSION_CURRENT):
-        """ Return True if asset is degraded version 
-        
+        """Return True if asset is degraded version
+
         Args:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
         """
@@ -458,15 +481,21 @@ class PhotoAsset:
         return imagedata.info["PHImageResultIsDegradedKey"]
 
     def export(
-        self, dest, filename=None, version=PHOTOS_VERSION_CURRENT, overwrite=False
+        self,
+        dest,
+        filename=None,
+        version=PHOTOS_VERSION_CURRENT,
+        overwrite=False,
+        raw=False,
     ):
-        """ Export image to path
+        """Export image to path
 
         Args:
             dest: str, path to destination directory
             filename: str, optional name of exported file; if not provided, defaults to asset's original filename
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
             overwrite: bool, if True, overwrites destination file if it already exists; default is False
+            raw: bool, if True, export RAW component of RAW+JPEG pair, default is False
 
         Returns:
             List of path to exported image(s)
@@ -491,11 +520,28 @@ class PhotoAsset:
 
             output_file = None
             if self.isphoto:
-                imagedata = self._request_image_data(version=version)
-                if not imagedata.image_data:
-                    raise PhotoKitExportError("Could not get image data")
-
-                ext = get_preferred_uti_extension(imagedata.uti)
+                # will hold exported image data and needs to be cleaned up at end
+                imagedata = None
+                if raw:
+                    # export the raw component
+                    resources = self._resources()
+                    for resource in resources:
+                        if resource.type() == Photos.PHAssetResourceTypeAlternatePhoto:
+                            data = self._request_resource_data(resource)
+                            ext = pathlib.Path(self.raw_filename).suffix[1:]
+                            break
+                    else:
+                        raise PhotoKitExportError(
+                            "Could not get image data for RAW photo"
+                        )
+                else:
+                    # TODO: if user has selected use RAW as original, this returns the RAW
+                    # can get the jpeg with resource.type() == Photos.PHAssetResourceTypePhoto
+                    imagedata = self._request_image_data(version=version)
+                    if not imagedata.image_data:
+                        raise PhotoKitExportError("Could not get image data")
+                    ext = get_preferred_uti_extension(imagedata.uti)
+                    data = imagedata.image_data
 
                 output_file = dest / f"{filename.stem}.{ext}"
 
@@ -503,7 +549,9 @@ class PhotoAsset:
                     output_file = pathlib.Path(increment_filename(output_file))
 
                 with open(output_file, "wb") as fd:
-                    fd.write(imagedata.image_data)
+                    fd.write(data)
+
+                if imagedata:
                     del imagedata
             elif self.ismovie:
                 videodata = self._request_video_data(version=version)
@@ -525,14 +573,14 @@ class PhotoAsset:
             return [str(output_file)]
 
     def _request_image_data(self, version=PHOTOS_VERSION_ORIGINAL):
-        """ Request image data and metadata for self._phasset 
-            
+        """Request image data and metadata for self._phasset
+
         Args:
             version: which version to request
-                     PHOTOS_VERSION_ORIGINAL (default), request original highest fidelity version 
+                     PHOTOS_VERSION_ORIGINAL (default), request original highest fidelity version
                      PHOTOS_VERSION_CURRENT, request current version with all edits
                      PHOTOS_VERSION_UNADJUSTED, request highest quality unadjusted version
-        
+
         Returns:
             ImageData instance
 
@@ -562,8 +610,8 @@ class PhotoAsset:
             event = threading.Event()
 
             def handler(imageData, dataUTI, orientation, info):
-                """ result handler for requestImageDataAndOrientationForAsset_options_resultHandler_ 
-                    all returned by the request is set as properties of nonlocal data (Fetchdata object) """
+                """result handler for requestImageDataAndOrientationForAsset_options_resultHandler_
+                all returned by the request is set as properties of nonlocal data (Fetchdata object)"""
 
                 nonlocal requestdata
 
@@ -593,19 +641,63 @@ class PhotoAsset:
             del requestdata
             return data
 
+    def _request_resource_data(self, resource):
+        """Request asset resource data (either photo or video component)
+
+        Args:
+            resource: PHAssetResource to request
+
+        Raises:
+        """
+
+        with objc.autorelease_pool():
+            resource_manager = Photos.PHAssetResourceManager.defaultManager()
+            options = Photos.PHAssetResourceRequestOptions.alloc().init()
+            options.setNetworkAccessAllowed_(True)
+
+            requestdata = PHAssetResourceData()
+            event = threading.Event()
+
+            def handler(data):
+                """result handler for requestImageDataAndOrientationForAsset_options_resultHandler_
+                all returned by the request is set as properties of nonlocal data (Fetchdata object)"""
+
+                nonlocal requestdata
+
+                requestdata.data += data
+
+            def completion_handler(error):
+                if error:
+                    raise PhotoKitExportError(
+                        "Error requesting data for asset resource"
+                    )
+                event.set()
+
+            resource_manager.requestDataForAssetResource_options_dataReceivedHandler_completionHandler_(
+                resource, options, handler, completion_handler
+            )
+
+            event.wait()
+
+            # not sure why this is needed -- some weird ref count thing maybe
+            # if I don't do this, memory leaks
+            data = copy.copy(requestdata.data)
+            del requestdata
+            return data
+
     def _make_result_handle_(self, data):
-        """ Make handler function and threading event to use with 
-            requestImageDataAndOrientationForAsset_options_resultHandler_ 
-            data: Fetchdata class to hold resulting metadata 
-            returns: handler function, threading.Event() instance 
-            Following call to requestImageDataAndOrientationForAsset_options_resultHandler_, 
-            data will hold data from the fetch """
+        """Make handler function and threading event to use with
+        requestImageDataAndOrientationForAsset_options_resultHandler_
+        data: Fetchdata class to hold resulting metadata
+        returns: handler function, threading.Event() instance
+        Following call to requestImageDataAndOrientationForAsset_options_resultHandler_,
+        data will hold data from the fetch"""
 
         event = threading.Event()
 
         def handler(imageData, dataUTI, orientation, info):
-            """ result handler for requestImageDataAndOrientationForAsset_options_resultHandler_ 
-                all returned by the request is set as properties of nonlocal data (Fetchdata object) """
+            """result handler for requestImageDataAndOrientationForAsset_options_resultHandler_
+            all returned by the request is set as properties of nonlocal data (Fetchdata object)"""
 
             nonlocal data
 
@@ -626,14 +718,14 @@ class PhotoAsset:
         return handler, event
 
     def _resources(self):
-        """ Return list of PHAssetResource for object """
+        """Return list of PHAssetResource for object"""
         resources = Photos.PHAssetResource.assetResourcesForAsset_(self.phasset)
         return [resources.objectAtIndex_(idx) for idx in range(resources.count())]
 
 
 class SlowMoVideoExporter(NSObject):
     def initWithAVAsset_path_(self, avasset, path):
-        """ init helper class for exporting slow-mo video
+        """init helper class for exporting slow-mo video
 
         Args:
             avasset: AVAsset
@@ -648,15 +740,17 @@ class SlowMoVideoExporter(NSObject):
         return self
 
     def exportSlowMoVideo(self):
-        """ export slow-mo video with AVAssetExportSession
-        
+        """export slow-mo video with AVAssetExportSession
+
         Returns:
             path to exported file
         """
 
         with objc.autorelease_pool():
-            exporter = AVFoundation.AVAssetExportSession.alloc().initWithAsset_presetName_(
-                self.avasset, AVFoundation.AVAssetExportPresetHighestQuality
+            exporter = (
+                AVFoundation.AVAssetExportSession.alloc().initWithAsset_presetName_(
+                    self.avasset, AVFoundation.AVAssetExportPresetHighestQuality
+                )
             )
             exporter.setOutputURL_(self.url)
             exporter.setOutputFileType_(AVFoundation.AVFileTypeQuickTimeMovie)
@@ -665,7 +759,7 @@ class SlowMoVideoExporter(NSObject):
             self.done = False
 
             def handler():
-                """ result handler for exportAsynchronouslyWithCompletionHandler """
+                """result handler for exportAsynchronouslyWithCompletionHandler"""
                 self.done = True
 
             exporter.exportAsynchronouslyWithCompletionHandler_(handler)
@@ -699,7 +793,7 @@ class SlowMoVideoExporter(NSObject):
 
 
 class VideoAsset(PhotoAsset):
-    """ PhotoKit PHAsset representation of video asset """
+    """PhotoKit PHAsset representation of video asset"""
 
     # TODO: doesn't work for slow-mo videos
     # see https://stackoverflow.com/questions/26152396/how-to-access-nsdata-nsurl-of-slow-motion-videos-using-photokit
@@ -709,7 +803,7 @@ class VideoAsset(PhotoAsset):
     def export(
         self, dest, filename=None, version=PHOTOS_VERSION_CURRENT, overwrite=False
     ):
-        """ Export video to path
+        """Export video to path
 
         Args:
             dest: str, path to destination directory
@@ -765,7 +859,7 @@ class VideoAsset(PhotoAsset):
     def _export_slow_mo(
         self, dest, filename=None, version=PHOTOS_VERSION_CURRENT, overwrite=False
     ):
-        """ Export slow-motion video to path
+        """Export slow-motion video to path
 
         Args:
             dest: str, path to destination directory
@@ -814,14 +908,14 @@ class VideoAsset(PhotoAsset):
 
     # todo: rewrite this with NotificationCenter and App event loop?
     def _request_video_data(self, version=PHOTOS_VERSION_ORIGINAL):
-        """ Request video data for self._phasset 
-            
+        """Request video data for self._phasset
+
         Args:
             version: which version to request
-                     PHOTOS_VERSION_ORIGINAL (default), request original highest fidelity version 
+                     PHOTOS_VERSION_ORIGINAL (default), request original highest fidelity version
                      PHOTOS_VERSION_CURRENT, request current version with all edits
                      PHOTOS_VERSION_UNADJUSTED, request highest quality unadjusted version
-        
+
         Raises:
             ValueError if passed invalid value for version
         """
@@ -843,7 +937,7 @@ class VideoAsset(PhotoAsset):
             event = threading.Event()
 
             def handler(asset, audiomix, info):
-                """ result handler for requestAVAssetForVideo:asset options:options resultHandler """
+                """result handler for requestAVAssetForVideo:asset options:options resultHandler"""
                 nonlocal requestdata
 
                 requestdata.asset = asset
@@ -865,8 +959,8 @@ class VideoAsset(PhotoAsset):
 
 
 class LivePhotoRequest(NSObject):
-    """ Manage requests for live photo assets
-        See: https://developer.apple.com/documentation/photokit/phimagemanager/1616984-requestlivephotoforasset?language=objc
+    """Manage requests for live photo assets
+    See: https://developer.apple.com/documentation/photokit/phimagemanager/1616984-requestlivephotoforasset?language=objc
     """
 
     def initWithManager_Asset_(self, manager, asset):
@@ -879,7 +973,7 @@ class LivePhotoRequest(NSObject):
         return self
 
     def requestLivePhotoResources(self, version=PHOTOS_VERSION_CURRENT):
-        """ return the photos and video components of a live video as [PHAssetResource] """
+        """return the photos and video components of a live video as [PHAssetResource]"""
 
         with objc.autorelease_pool():
             options = Photos.PHLivePhotoRequestOptions.alloc().init()
@@ -897,7 +991,7 @@ class LivePhotoRequest(NSObject):
             self.live_photo = None
 
             def handler(result, info):
-                """ result handler for requestLivePhotoForAsset:targetSize:contentMode:options:resultHandler: """
+                """result handler for requestLivePhotoForAsset:targetSize:contentMode:options:resultHandler:"""
                 if not info["PHImageResultIsDegradedKey"]:
                     self.live_photo = result
                     self.info = info
@@ -939,7 +1033,7 @@ class LivePhotoRequest(NSObject):
 
 
 class LivePhotoAsset(PhotoAsset):
-    """ Represents a live photo """
+    """Represents a live photo"""
 
     def export(
         self,
@@ -950,7 +1044,7 @@ class LivePhotoAsset(PhotoAsset):
         photo=True,
         video=True,
     ):
-        """ Export image to path
+        """Export image to path
 
         Args:
             dest: str, path to destination directory
@@ -1061,50 +1155,6 @@ class LivePhotoAsset(PhotoAsset):
             request.dealloc()
             return exported
 
-    def _request_resource_data(self, resource):
-        """ Request asset resource data (either photo or video component)
-            
-        Args:
-            resource: PHAssetResource to request
-        
-        Raises:
-        """
-
-        with objc.autorelease_pool():
-            resource_manager = Photos.PHAssetResourceManager.defaultManager()
-            options = Photos.PHAssetResourceRequestOptions.alloc().init()
-            options.setNetworkAccessAllowed_(True)
-
-            requestdata = PHAssetResourceData()
-            event = threading.Event()
-
-            def handler(data):
-                """ result handler for requestImageDataAndOrientationForAsset_options_resultHandler_ 
-                    all returned by the request is set as properties of nonlocal data (Fetchdata object) """
-
-                nonlocal requestdata
-
-                requestdata.data += data
-
-            def completion_handler(error):
-                if error:
-                    raise PhotoKitExportError(
-                        "Error requesting data for asset resource"
-                    )
-                event.set()
-
-            resource_manager.requestDataForAssetResource_options_dataReceivedHandler_completionHandler_(
-                resource, options, handler, completion_handler
-            )
-
-            event.wait()
-
-            # not sure why this is needed -- some weird ref count thing maybe
-            # if I don't do this, memory leaks
-            data = copy.copy(requestdata.data)
-            del requestdata
-            return data
-
     # def request_image_data(self, version=PHOTOS_VERSION_CURRENT):
     #     # Returns an NSImage which isn't overly useful
     #     # https://developer.apple.com/documentation/photokit/phimagemanager/1616964-requestimageforasset?language=objc
@@ -1142,12 +1192,12 @@ class LivePhotoAsset(PhotoAsset):
 
 
 class PhotoLibrary:
-    """ Interface to PhotoKit PHImageManager and PHPhotoLibrary """
+    """Interface to PhotoKit PHImageManager and PHPhotoLibrary"""
 
     def __init__(self):
-        """ Initialize ImageManager instance.  Requests authorization to use the 
+        """Initialize ImageManager instance.  Requests authorization to use the
         Photos library if authorization has not already been granted.
-        
+
         Raises:
             PhotoKitAuthError if unable to authorize access to PhotoKit
         """
@@ -1166,7 +1216,7 @@ class PhotoLibrary:
         self._phimagemanager = Photos.PHCachingImageManager.defaultManager()
 
     def request_authorization(self):
-        """ Request authorization to user's Photos Library
+        """Request authorization to user's Photos Library
 
         Returns:
             authorization status
@@ -1176,7 +1226,7 @@ class PhotoLibrary:
         return self.auth_status
 
     def fetch_uuid_list(self, uuid_list):
-        """ fetch PHAssets with uuids in uuid_list
+        """fetch PHAssets with uuids in uuid_list
 
         Args:
             uuid_list: list of str (UUID of image assets to fetch)
@@ -1205,7 +1255,7 @@ class PhotoLibrary:
                 )
 
     def fetch_uuid(self, uuid):
-        """ fetch PHAsset with uuid = uuid
+        """fetch PHAsset with uuid = uuid
 
         Args:
             uuid: str; UUID of image asset to fetch
@@ -1223,8 +1273,8 @@ class PhotoLibrary:
             raise PhotoKitFetchFailed(f"Fetch did not return result for uuid {uuid}")
 
     def fetch_burst_uuid(self, burstid, all=False):
-        """ fetch PhotoAssets with burst ID = burstid 
-        
+        """fetch PhotoAssets with burst ID = burstid
+
         Args:
             burstid: str, burst UUID
             all: return all burst assets; if False returns only those selected by the user (including the "key photo" even if user hasn't manually selected it)
@@ -1253,11 +1303,11 @@ class PhotoLibrary:
             )
 
     def _asset_factory(self, phasset):
-        """ creates a PhotoAsset, VideoAsset, or LivePhotoAsset
+        """creates a PhotoAsset, VideoAsset, or LivePhotoAsset
 
         Args:
-            phasset: PHAsset object 
-        
+            phasset: PHAsset object
+
         Returns:
             PhotoAsset, VideoAsset, or LivePhotoAsset depending on type of PHAsset
         """

osxphotos/photosalbum.py

@@ -1,7 +1,10 @@
 """ PhotosAlbum class to create an album in default Photos library and add photos to it """
 
-from typing import Optional
+from typing import List, Optional
+
 import photoscript
+from more_itertools import chunked
+
 from .photoinfo import PhotoInfo
 from .utils import noop
 
@@ -25,50 +28,18 @@ class PhotosAlbum:
             f"Added {photo.original_filename} ({photo.uuid}) to album {self.name}"
         )
 
+    def add_list(self, photo_list: List[PhotoInfo]):
+        photos = []
+        for p in photo_list:
+            try:
+                photos.append(photoscript.Photo(p.uuid))
+            except Exception as e:
+                self.verbose(f"Error creating Photo object for photo {p.uuid}: {e}")
+        for photolist in chunked(photos, 10):
+            self.album.add(photolist)
+        photo_len = len(photos)
+        photo_word = "photos" if photo_len > 1 else "photo"
+        self.verbose(f"Added {photo_len} {photo_word} to album {self.name}")
+
     def photos(self):
         return self.album.photos()
-
-
-# def add_photo_to_album(photo, album_pairs, results):
-#     # todo: class PhotoAlbum
-#     # keeps a name, maintains state
-#     """ add photo to album(s) as defined in album_pairs
-
-#     Args:
-#         photo: PhotoInfo object
-#         album_pairs: list of tuples with [(album name, results_list)]
-#         results: ExportResults object
-
-#     Returns:
-#         updated ExportResults object
-#     """
-#     for album, result_list in album_pairs:
-#         try:
-#                 if album_export is None:
-#                     # first time fetching the album, see if it exists already
-#                     album_export = photos_library.album(
-#                         add_exported_to_album
-#                     )
-#                     if album_export is None:
-#                         # album doesn't exist, so create it
-#                         verbose_(
-#                             f"Creating Photos album '{add_exported_to_album}'"
-#                         )
-#                         album_export = photos_library.create_album(
-#                             add_exported_to_album
-#                         )
-#                 exported_photo = photoscript.Photo(p.uuid)
-#                 album_export.add([exported_photo])
-#                 verbose_(
-#                     f"Added {p.original_filename} ({p.uuid}) to album {add_exported_to_album}"
-#                 )
-#                 exported_album = [
-#                     (filename, add_exported_to_album)
-#                     for filename in export_results.exported
-#                 ]
-#                 export_results.exported_album = exported_album
-#             if
-#         except Exception as e:
-#             click.echo(
-#                 f"Error adding photo {p.original_filename} ({p.uuid}) to album {add_exported_to_album}"
-#             )

osxphotos/photosdb/photosdb.py

@@ -11,6 +11,7 @@ import platform
 import re
 import sys
 import tempfile
+from collections import OrderedDict
 from datetime import datetime, timedelta, timezone
 from pprint import pformat
 from typing import List
@@ -43,6 +44,7 @@ from ..datetime_utils import datetime_has_tz, datetime_naive_to_local
 from ..fileutil import FileUtil
 from ..personinfo import PersonInfo
 from ..photoinfo import PhotoInfo
+from ..phototemplate import RenderOptions
 from ..queryoptions import QueryOptions
 from ..utils import (
     _check_file_exists,
@@ -62,29 +64,29 @@ from .photosdb_utils import get_db_model_version, get_db_version
 
 
 class PhotosDB:
-    """ Processes a Photos.app library database to extract information about photos """
+    """Processes a Photos.app library database to extract information about photos"""
 
     # import additional methods
+    from ._photosdb_process_comments import _process_comments
     from ._photosdb_process_exif import _process_exifinfo
     from ._photosdb_process_faceinfo import _process_faceinfo
+    from ._photosdb_process_scoreinfo import _process_scoreinfo
     from ._photosdb_process_searchinfo import (
         _process_searchinfo,
         labels,
-        labels_normalized,
         labels_as_dict,
+        labels_normalized,
         labels_normalized_as_dict,
     )
-    from ._photosdb_process_scoreinfo import _process_scoreinfo
-    from ._photosdb_process_comments import _process_comments
 
     def __init__(self, dbfile=None, verbose=None, exiftool=None):
-        """ Create a new PhotosDB object.
+        """Create a new PhotosDB object.
 
         Args:
             dbfile: specify full path to photos library or photos.db; if None, will attempt to locate last library opened by Photos.
             verbose: optional callable function to use for printing verbose text during processing; if None (default), does not print output.
             exiftool: optional path to exiftool for methods that require this (e.g. PhotoInfo.exiftool); if not provided, will search PATH
-        
+
         Raises:
             FileNotFoundError if dbfile is not a valid Photos library.
             TypeError if verbose is not None and not callable.
@@ -240,6 +242,13 @@ class PhotosDB:
         # Will hold the primary key of root folder
         self._folder_root_pk = None
 
+        # Dict to hold signatures for finding possible duplicates
+        # key is tuple of (original_filesize, date) and value is list of uuids that match that signature
+        self._db_signatures = {}
+
+        # Dict to hold information on volume names (Photos 5+)
+        self._db_filesystem_volumes = {}
+
         if _debug():
             logging.debug(f"dbfile = {dbfile}")
 
@@ -322,7 +331,7 @@ class PhotosDB:
 
     @property
     def keywords_as_dict(self):
-        """ return keywords as dict of keyword, count in reverse sorted order (descending) """
+        """return keywords as dict of keyword, count in reverse sorted order (descending)"""
         keywords = {
             k: len(self._dbkeywords_keyword[k]) for k in self._dbkeywords_keyword.keys()
         }
@@ -332,7 +341,7 @@ class PhotosDB:
 
     @property
     def persons_as_dict(self):
-        """ return persons as dict of person, count in reverse sorted order (descending) """
+        """return persons as dict of person, count in reverse sorted order (descending)"""
         persons = {}
         for pk in self._dbfaces_pk:
             fullname = self._dbpersons_pk[pk]["fullname"]
@@ -345,7 +354,7 @@ class PhotosDB:
 
     @property
     def albums_as_dict(self):
-        """ return albums as dict of albums, count in reverse sorted order (descending) """
+        """return albums as dict of albums, count in reverse sorted order (descending)"""
         albums = {}
         album_keys = self._get_album_uuids(shared=False)
         for album in album_keys:
@@ -362,8 +371,8 @@ class PhotosDB:
 
     @property
     def albums_shared_as_dict(self):
-        """ returns shared albums as dict of albums, count in reverse sorted order (descending)
-            valid only on Photos 5; on Photos <= 4, prints warning and returns empty dict """
+        """returns shared albums as dict of albums, count in reverse sorted order (descending)
+        valid only on Photos 5; on Photos <= 4, prints warning and returns empty dict"""
 
         albums = {}
         album_keys = self._get_album_uuids(shared=True)
@@ -381,19 +390,19 @@ class PhotosDB:
 
     @property
     def keywords(self):
-        """ return list of keywords found in photos database """
+        """return list of keywords found in photos database"""
         keywords = self._dbkeywords_keyword.keys()
         return list(keywords)
 
     @property
     def persons(self):
-        """ return list of persons found in photos database """
+        """return list of persons found in photos database"""
         persons = {self._dbpersons_pk[k]["fullname"] for k in self._dbfaces_pk}
         return list(persons)
 
     @property
     def person_info(self):
-        """ return list of PersonInfo objects for each person in the photos database """
+        """return list of PersonInfo objects for each person in the photos database"""
         try:
             return self._person_info
         except AttributeError:
@@ -404,7 +413,7 @@ class PhotosDB:
 
     @property
     def folder_info(self):
-        """ return list FolderInfo objects representing top-level folders in the photos database """
+        """return list FolderInfo objects representing top-level folders in the photos database"""
         if self._db_version <= _PHOTOS_4_VERSION:
             folders = [
                 FolderInfo(db=self, uuid=folder)
@@ -425,7 +434,7 @@ class PhotosDB:
 
     @property
     def folders(self):
-        """ return list of top-level folder names in the photos database """
+        """return list of top-level folder names in the photos database"""
         if self._db_version <= _PHOTOS_4_VERSION:
             folder_names = [
                 folder["name"]
@@ -446,7 +455,7 @@ class PhotosDB:
 
     @property
     def album_info(self):
-        """ return list of AlbumInfo objects for each album in the photos database """
+        """return list of AlbumInfo objects for each album in the photos database"""
         try:
             return self._album_info
         except AttributeError:
@@ -458,8 +467,8 @@ class PhotosDB:
 
     @property
     def album_info_shared(self):
-        """ return list of AlbumInfo objects for each shared album in the photos database
-            only valid for Photos 5; on Photos <= 4, prints warning and returns empty list """
+        """return list of AlbumInfo objects for each shared album in the photos database
+        only valid for Photos 5; on Photos <= 4, prints warning and returns empty list"""
         # if _dbalbum_details[key]["cloudownerhashedpersonid"] is not None, then it's a shared album
         try:
             return self._album_info_shared
@@ -472,7 +481,7 @@ class PhotosDB:
 
     @property
     def albums(self):
-        """ return list of albums found in photos database """
+        """return list of albums found in photos database"""
 
         # Could be more than one album with same name
         # Right now, they are treated as same album and photos are combined from albums with same name
@@ -485,8 +494,8 @@ class PhotosDB:
 
     @property
     def albums_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 """
+        """return list of shared albums found in photos database
+        only valid for Photos 5; on Photos <= 4, prints warning and returns empty list"""
 
         # Could be more than one album with same name
         # Right now, they are treated as same album and photos are combined from albums with same name
@@ -501,7 +510,7 @@ class PhotosDB:
 
     @property
     def import_info(self):
-        """ return list of ImportInfo objects for each import session in the database """
+        """return list of ImportInfo objects for each import session in the database"""
         try:
             return self._import_info
         except AttributeError:
@@ -513,21 +522,21 @@ class PhotosDB:
 
     @property
     def db_version(self):
-        """ return the database version as stored in LiGlobals table """
+        """return the database version as stored in LiGlobals table"""
         return self._db_version
 
     @property
     def db_path(self):
-        """ returns path to the Photos library database PhotosDB was initialized with """
+        """returns path to the Photos library database PhotosDB was initialized with"""
         return os.path.abspath(self._dbfile)
 
     @property
     def library_path(self):
-        """ returns path to the Photos library PhotosDB was initialized with """
+        """returns path to the Photos library PhotosDB was initialized with"""
         return self._library_path
 
     def get_db_connection(self):
-        """ Get connection to the working copy of the Photos database 
+        """Get connection to the working copy of the Photos database
 
         Returns:
             tuple of (connection, cursor) to sqlite3 database
@@ -535,7 +544,7 @@ class PhotosDB:
         return _open_sql_file(self._tmp_db)
 
     def _copy_db_file(self, fname):
-        """ copies the sqlite database file to a temp file """
+        """copies the sqlite database file to a temp file"""
         """ returns the name of the temp file """
         """ If sqlite shared memory and write-ahead log files exist, those are copied too """
         # required because python's sqlite3 implementation can't read a locked file
@@ -587,13 +596,15 @@ class PhotosDB:
     #     return dest_path
 
     def _process_database4(self):
-        """ process the Photos database to extract info
-            works on Photos version <= 4.0 """
+        """process the Photos database to extract info
+        works on Photos version <= 4.0"""
 
         verbose = self._verbose
         verbose("Processing database.")
         verbose(f"Database version: {self._db_version}.")
 
+        self._photos_ver = 4  # only used in Photos 5+
+
         (conn, c) = _open_sql_file(self._tmp_db)
 
         # get info to associate persons with photos
@@ -900,7 +911,8 @@ class PhotosDB:
                     RKVersion.subType,
                     RKVersion.inTrashDate,
                     RKVersion.showInLibrary,
-                    RKMaster.fileIsReference
+                    RKMaster.fileIsReference,
+                    RKMaster.importGroupUuid
                     FROM RKVersion, RKMaster
                     WHERE RKVersion.masterUuid = RKMaster.uuid"""
             )
@@ -931,7 +943,8 @@ class PhotosDB:
                     RKVersion.subType,
                     RKVersion.inTrashDate,
                     RKVersion.showInLibrary,
-                    RKMaster.fileIsReference
+                    RKMaster.fileIsReference,
+                    RKMaster.importGroupUuid
                     FROM RKVersion, RKMaster
                     WHERE RKVersion.masterUuid = RKMaster.uuid"""
             )
@@ -981,6 +994,7 @@ class PhotosDB:
         # 41    RKVersion.inTrashDate
         # 42    RKVersion.showInLibrary -- is item visible in library (e.g. non-selected burst images are not visible)
         # 43    RKMaster.fileIsReference -- file is reference (imported without copying to Photos library)
+        # 44    RKMaster.importGroupUuid -- to get date added from RKImportGroup
 
         for row in c:
             uuid = row[0]
@@ -1174,9 +1188,16 @@ class PhotosDB:
 
             # import session not yet handled for Photos 4
             self._dbphotos[uuid]["import_session"] = None
-            self._dbphotos[uuid]["import_uuid"] = None
+            self._dbphotos[uuid]["import_uuid"] = row[44]
             self._dbphotos[uuid]["fok_import_session"] = None
 
+            # compute signatures for finding possible duplicates
+            signature = self._duplicate_signature(uuid)
+            try:
+                self._db_signatures[signature].append(uuid)
+            except KeyError:
+                self._db_signatures[signature] = [uuid]
+
         # get additional details from RKMaster, needed for RAW processing
         verbose("Processing additional photo details.")
         c.execute(
@@ -1364,11 +1385,17 @@ class PhotosDB:
 
         # get the place data
         place_data = c.execute(
-            "SELECT modelID, defaultName, type, area " "FROM RKPlace "
+            "SELECT modelID, defaultName, type, area FROM RKPlace"
         ).fetchall()
         places = {p[0]: p for p in place_data}
         self._db_places = places
 
+        # get import data
+        import_data = c.execute(
+            "SELECT modelID, uuid, name, importDate from RKImportGroup"
+        ).fetchall()
+        self._db_import_group = {i[1]: i for i in import_data}
+
         for uuid in self._dbphotos:
             # get placeId which is then used to lookup defaultName
             place_ids_query = c.execute(
@@ -1402,6 +1429,17 @@ class PhotosDB:
             self._dbphotos[uuid]["placeNames"] = place_names
             self._dbphotos[uuid]["reverse_geolocation"] = None  # Photos 5
 
+            # add date added
+            try:
+                import_session = self._db_import_group[
+                    self._dbphotos[uuid]["import_uuid"]
+                ]
+                self._dbphotos[uuid]["added_date"] = datetime.fromtimestamp(
+                    import_session[3] + TIME_DELTA
+                )
+            except (ValueError, TypeError, KeyError):
+                self._dbphotos[uuid]["added_date"] = datetime(1970, 1, 1)
+
         # build album_titles dictionary
         for album_id in self._dbalbum_details:
             title = self._dbalbum_details[album_id]["title"]
@@ -1512,15 +1550,15 @@ class PhotosDB:
             logging.debug(pformat(self._dbphotos_burst))
 
     def _build_album_folder_hierarchy_4(self, uuid, folders=None):
-        """ recursively build folder/album hierarchy
-            uuid: parent uuid of the album being processed 
-                 (parent uuid is a folder in RKFolders)
-            folders: dict holding the folder hierarchy 
-            NOTE: This implementation is different than _build_album_folder_hierarchy_5 
-            which takes the uuid of the album being processed.  Here uuid is the parent uuid
-            of the parent folder album because in Photos <=4, folders are in RKFolders and 
-            albums in RKAlbums.  In Photos 5, folders are just special albums 
-            with kind = _PHOTOS_5_FOLDER_KIND """
+        """recursively build folder/album hierarchy
+        uuid: parent uuid of the album being processed
+             (parent uuid is a folder in RKFolders)
+        folders: dict holding the folder hierarchy
+        NOTE: This implementation is different than _build_album_folder_hierarchy_5
+        which takes the uuid of the album being processed.  Here uuid is the parent uuid
+        of the parent folder album because in Photos <=4, folders are in RKFolders and
+        albums in RKAlbums.  In Photos 5, folders are just special albums
+        with kind = _PHOTOS_5_FOLDER_KIND"""
 
         parent_uuid = self._dbfolder_details[uuid]["parentFolderUuid"]
 
@@ -1543,11 +1581,11 @@ class PhotosDB:
         return folders
 
     def _process_database5(self):
-        """ process the Photos database to extract info 
-            works on Photos version 5 and version 6
+        """process the Photos database to extract info
+        works on Photos version 5 and version 6
 
-            This is a big hairy 700 line function that should probably be refactored
-            but it works so don't touch it.
+        This is a big hairy 700 line function that should probably be refactored
+        but it works so don't touch it.
         """
 
         if _debug():
@@ -1562,10 +1600,14 @@ class PhotosDB:
         verbose(f"Database version: {self._db_version}, {photos_ver}.")
         asset_table = _DB_TABLE_NAMES[photos_ver]["ASSET"]
         keyword_join = _DB_TABLE_NAMES[photos_ver]["KEYWORD_JOIN"]
+        asset_album_table = _DB_TABLE_NAMES[photos_ver]["ASSET_ALBUM_TABLE"]
         album_join = _DB_TABLE_NAMES[photos_ver]["ALBUM_JOIN"]
         album_sort = _DB_TABLE_NAMES[photos_ver]["ALBUM_SORT_ORDER"]
+        asset_album_join = _DB_TABLE_NAMES[photos_ver]["ASSET_ALBUM_JOIN"]
         import_fok = _DB_TABLE_NAMES[photos_ver]["IMPORT_FOK"]
         depth_state = _DB_TABLE_NAMES[photos_ver]["DEPTH_STATE"]
+        uti_original_column = _DB_TABLE_NAMES[photos_ver]["UTI_ORIGINAL"]
+        hdr_type_column = _DB_TABLE_NAMES[photos_ver]["HDR_TYPE"]
 
         # Look for all combinations of persons and pictures
         if _debug():
@@ -1595,7 +1637,11 @@ class PhotosDB:
 
         for person in c:
             pk = person[0]
-            fullname = person[2] if person[2] != "" else _UNKNOWN_PERSON
+            fullname = (
+                person[2]
+                if (person[2] != "" and person[2] is not None)
+                else _UNKNOWN_PERSON
+            )
             self._dbpersons_pk[pk] = {
                 "pk": pk,
                 "uuid": person[1],
@@ -1681,8 +1727,8 @@ class PhotosDB:
                 {asset_table}.ZUUID,
                 {album_sort}
                 FROM {asset_table} 
-                JOIN Z_26ASSETS ON {album_join} = {asset_table}.Z_PK 
-                JOIN ZGENERICALBUM ON ZGENERICALBUM.Z_PK = Z_26ASSETS.Z_26ALBUMS
+                JOIN {asset_album_table} ON {album_join} = {asset_table}.Z_PK 
+                JOIN ZGENERICALBUM ON ZGENERICALBUM.Z_PK = {asset_album_join}
             """
         )
 
@@ -1849,7 +1895,7 @@ class PhotosDB:
                 {asset_table}.ZAVALANCHEUUID,
                 {asset_table}.ZAVALANCHEPICKTYPE,
                 {asset_table}.ZKINDSUBTYPE,
-                {asset_table}.ZCUSTOMRENDEREDVALUE,
+                {asset_table}.{hdr_type_column},
                 ZADDITIONALASSETATTRIBUTES.ZCAMERACAPTUREDEVICE,
                 {asset_table}.ZCLOUDASSETGUID,
                 ZADDITIONALASSETATTRIBUTES.ZREVERSELOCATIONDATA,
@@ -1867,7 +1913,8 @@ class PhotosDB:
                 {asset_table}.ZADJUSTMENTTIMESTAMP,
                 {asset_table}.ZVISIBILITYSTATE,
                 {asset_table}.ZTRASHEDDATE,
-                {asset_table}.ZSAVEDASSETTYPE
+                {asset_table}.ZSAVEDASSETTYPE,
+                {asset_table}.ZADDEDDATE
                 FROM {asset_table} 
                 JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
                 ORDER BY {asset_table}.ZUUID  """
@@ -1915,6 +1962,7 @@ class PhotosDB:
         # 38   ZGENERICASSET.ZVISIBILITYSTATE -- 0 if visible, 2 if not (e.g. a burst image)
         # 39   ZGENERICASSET.ZTRASHEDDATE -- date item placed in the trash or null if not in trash
         # 40   ZGENERICASSET.ZSAVEDASSETTYPE -- how item imported
+        # 41   ZGENERICASSET.ZADDEDDATE -- date item added to the library
 
         for row in c:
             uuid = row[0]
@@ -2094,6 +2142,11 @@ class PhotosDB:
             info["saved_asset_type"] = row[40]
             info["isreference"] = row[40] == 10
 
+            try:
+                info["added_date"] = datetime.fromtimestamp(row[41] + TIME_DELTA)
+            except (ValueError, TypeError):
+                info["added_date"] = datetime(1970, 1, 1)
+
             # initialize import session info which will be filled in later
             # not every photo has an import session so initialize all records now
             info["import_session"] = None
@@ -2114,6 +2167,13 @@ class PhotosDB:
 
             self._dbphotos[uuid] = info
 
+            # compute signatures for finding possible duplicates
+            signature = self._duplicate_signature(uuid)
+            try:
+                self._db_signatures[signature].append(uuid)
+            except KeyError:
+                self._db_signatures[signature] = [uuid]
+
             # # if row[19] is not None and ((row[20] == 2) or (row[20] == 4)):
             # # burst photo
             # if row[19] is not None:
@@ -2199,20 +2259,33 @@ class PhotosDB:
 
         # Get info on remote/local availability for photos in shared albums
         # Also get UTI of original image (zdatastoresubtype = 1)
-        c.execute(
-            f""" SELECT 
+        if self._photos_ver >= 7:
+            sql_missing = f""" SELECT 
                 {asset_table}.ZUUID, 
                 ZINTERNALRESOURCE.ZLOCALAVAILABILITY, 
                 ZINTERNALRESOURCE.ZREMOTEAVAILABILITY,
                 ZINTERNALRESOURCE.ZDATASTORESUBTYPE,
-                ZINTERNALRESOURCE.ZUNIFORMTYPEIDENTIFIER,
+                {uti_original_column},
+                null 
+                FROM {asset_table}
+                JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
+                JOIN ZINTERNALRESOURCE ON ZINTERNALRESOURCE.ZASSET = ZADDITIONALASSETATTRIBUTES.ZASSET 
+                WHERE  ZDATASTORESUBTYPE = 1 OR ZDATASTORESUBTYPE = 3 """
+        else:
+            sql_missing = f""" SELECT 
+                {asset_table}.ZUUID, 
+                ZINTERNALRESOURCE.ZLOCALAVAILABILITY, 
+                ZINTERNALRESOURCE.ZREMOTEAVAILABILITY,
+                ZINTERNALRESOURCE.ZDATASTORESUBTYPE,
+                {uti_original_column},
                 ZUNIFORMTYPEIDENTIFIER.ZIDENTIFIER
                 FROM {asset_table}
                 JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
                 JOIN ZINTERNALRESOURCE ON ZINTERNALRESOURCE.ZASSET = ZADDITIONALASSETATTRIBUTES.ZASSET 
                 JOIN ZUNIFORMTYPEIDENTIFIER ON ZUNIFORMTYPEIDENTIFIER.Z_PK = ZINTERNALRESOURCE.ZUNIFORMTYPEIDENTIFIER 
                 WHERE  ZDATASTORESUBTYPE = 1 OR ZDATASTORESUBTYPE = 3 """
-        )
+
+        c.execute(sql_missing)
 
         # Order of results:
         # 0 {asset_table}.ZUUID,
@@ -2272,20 +2345,36 @@ class PhotosDB:
 
         # get information about associted RAW images
         # RAW images have ZDATASTORESUBTYPE = 17
-        c.execute(
-            f""" SELECT
+        if self._photos_ver >= 7:
+            sql_raw = f""" SELECT
+                {asset_table}.ZUUID,
+                ZINTERNALRESOURCE.ZDATALENGTH, 
+                null,
+                ZINTERNALRESOURCE.ZDATASTORESUBTYPE,
+                ZINTERNALRESOURCE.ZRESOURCETYPE,
+                ZINTERNALRESOURCE.ZFILESYSTEMBOOKMARK
+                FROM {asset_table}
+                JOIN ZINTERNALRESOURCE ON ZINTERNALRESOURCE.ZASSET = ZADDITIONALASSETATTRIBUTES.ZASSET
+                JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
+                WHERE ZINTERNALRESOURCE.ZDATASTORESUBTYPE = 17
+            """
+        else:
+            sql_raw = f""" SELECT
                 {asset_table}.ZUUID,
                 ZINTERNALRESOURCE.ZDATALENGTH, 
                 ZUNIFORMTYPEIDENTIFIER.ZIDENTIFIER,
                 ZINTERNALRESOURCE.ZDATASTORESUBTYPE,
-                ZINTERNALRESOURCE.ZRESOURCETYPE
+                ZINTERNALRESOURCE.ZRESOURCETYPE,
+                ZINTERNALRESOURCE.ZFILESYSTEMBOOKMARK
                 FROM {asset_table}
                 JOIN ZINTERNALRESOURCE ON ZINTERNALRESOURCE.ZASSET = ZADDITIONALASSETATTRIBUTES.ZASSET
                 JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
                 JOIN ZUNIFORMTYPEIDENTIFIER ON ZUNIFORMTYPEIDENTIFIER.Z_PK =  ZINTERNALRESOURCE.ZUNIFORMTYPEIDENTIFIER
                 WHERE ZINTERNALRESOURCE.ZDATASTORESUBTYPE = 17
-        """
-        )
+            """
+
+        c.execute(sql_raw)
+
         for row in c:
             uuid = row[0]
             if uuid in self._dbphotos:
@@ -2294,6 +2383,33 @@ class PhotosDB:
                 self._dbphotos[uuid]["UTI_raw"] = row[2]
                 self._dbphotos[uuid]["datastore_subtype"] = row[3]
                 self._dbphotos[uuid]["resource_type"] = row[4]
+                self._dbphotos[uuid]["raw_bookmark"] = row[5]
+
+        # get paths for the relative imports for RAW+JPEG images
+        c.execute(
+            f""" SELECT
+            {asset_table}.ZUUID,
+            ZFILESYSTEMVOLUME.ZNAME,
+            ZFILESYSTEMBOOKMARK.ZPATHRELATIVETOVOLUME
+            FROM {asset_table} 
+            JOIN ZINTERNALRESOURCE ON ZINTERNALRESOURCE.ZASSET = ZADDITIONALASSETATTRIBUTES.ZASSET
+            JOIN ZADDITIONALASSETATTRIBUTES ON ZADDITIONALASSETATTRIBUTES.ZASSET = {asset_table}.Z_PK 
+            JOIN ZFILESYSTEMBOOKMARK ON ZFILESYSTEMBOOKMARK.ZRESOURCE = ZINTERNALRESOURCE.Z_PK
+            JOIN ZFILESYSTEMVOLUME ON ZFILESYSTEMVOLUME.Z_PK = ZINTERNALRESOURCE.ZFILESYSTEMVOLUME
+            WHERE ZINTERNALRESOURCE.ZDATASTORESUBTYPE = 17
+            """
+        )
+
+        # path to the raw image will be /Volumes/ZFILESYSTEMVOLUME.ZNAME/ZFILESYSTEMBOOKMARK.ZPATHRELATIVETOVOLUME
+        # 0: {asset_table}.ZUUID, -- UUID
+        # 1: ZFILESYSTEMVOLUME.ZNAME, -- name of the volume
+        # 2: ZFILESYSTEMBOOKMARK.ZPATHRELATIVETOVOLUME -- path to the raw image
+
+        for row in c:
+            uuid = row[0]
+            if uuid in self._dbphotos:
+                self._dbphotos[uuid]["raw_volume"] = row[1]
+                self._dbphotos[uuid]["raw_relative_path"] = row[2]
 
         # add faces and keywords to photo data
         for uuid in self._dbphotos:
@@ -2399,9 +2515,9 @@ class PhotosDB:
             logging.debug(pformat(self._dbphotos_burst))
 
     def _build_album_folder_hierarchy_5(self, uuid, folders=None):
-        """ recursively build folder/album hierarchy
-            uuid: uuid of the album/folder being processed
-            folders: dict holding the folder hierarchy """
+        """recursively build folder/album hierarchy
+        uuid: uuid of the album/folder being processed
+        folders: dict holding the folder hierarchy"""
 
         # get parent uuid
         parent = self._dbalbum_details[uuid]["parentfolder"]
@@ -2422,17 +2538,17 @@ class PhotosDB:
         return folders
 
     def _album_folder_hierarchy_list(self, album_uuid):
-        """ return appropriate album_folder_hierarchy_list for the _db_version """
+        """return appropriate album_folder_hierarchy_list for the _db_version"""
         if self._db_version <= _PHOTOS_4_VERSION:
             return self._album_folder_hierarchy_list_4(album_uuid)
         else:
             return self._album_folder_hierarchy_list_5(album_uuid)
 
     def _album_folder_hierarchy_list_4(self, album_uuid):
-        """ return hierarchical list of folder names album_uuid is contained in
-            the folder list is in form:
-            ["Top level folder", "sub folder 1", "sub folder 2"]
-            returns empty list of album is not in any folders """
+        """return hierarchical list of folder names album_uuid is contained in
+        the folder list is in form:
+        ["Top level folder", "sub folder 1", "sub folder 2"]
+        returns empty list of album is not in any folders"""
         try:
             folders = self._dbalbum_folders[album_uuid]
         except KeyError:
@@ -2440,7 +2556,7 @@ class PhotosDB:
             return []
 
         def _recurse_folder_hierarchy(folders, hierarchy=[]):
-            """ recursively walk the folders dict to build list of folder hierarchy """
+            """recursively walk the folders dict to build list of folder hierarchy"""
             if not folders:
                 # empty folder dict (album has no folder hierarchy)
                 return []
@@ -2466,10 +2582,10 @@ class PhotosDB:
         return hierarchy
 
     def _album_folder_hierarchy_list_5(self, album_uuid):
-        """ return hierarchical list of folder names album_uuid is contained in
-            the folder list is in form:
-            ["Top level folder", "sub folder 1", "sub folder 2"]
-            returns empty list of album is not in any folders """
+        """return hierarchical list of folder names album_uuid is contained in
+        the folder list is in form:
+        ["Top level folder", "sub folder 1", "sub folder 2"]
+        returns empty list of album is not in any folders"""
         try:
             folders = self._dbalbum_folders[album_uuid]
         except KeyError:
@@ -2477,7 +2593,7 @@ class PhotosDB:
             return []
 
         def _recurse_folder_hierarchy(folders, hierarchy=[]):
-            """ recursively walk the folders dict to build list of folder hierarchy """
+            """recursively walk the folders dict to build list of folder hierarchy"""
 
             if not folders:
                 # empty folder dict (album has no folder hierarchy)
@@ -2509,15 +2625,15 @@ class PhotosDB:
             return self._album_folder_hierarchy_folderinfo_5(album_uuid)
 
     def _album_folder_hierarchy_folderinfo_4(self, album_uuid):
-        """ return hierarchical list of FolderInfo objects album_uuid is contained in
-            ["Top level folder", "sub folder 1", "sub folder 2"]
-            returns empty list of album is not in any folders """
+        """return hierarchical list of FolderInfo objects album_uuid is contained in
+        ["Top level folder", "sub folder 1", "sub folder 2"]
+        returns empty list of album is not in any folders"""
         # title = photosdb._dbalbum_details[album_uuid]["title"]
         folders = self._dbalbum_folders[album_uuid]
         # logging.warning(f"uuid = {album_uuid}, folder = {folders}")
 
         def _recurse_folder_hierarchy(folders, hierarchy=[]):
-            """ recursively walk the folders dict to build list of folder hierarchy """
+            """recursively walk the folders dict to build list of folder hierarchy"""
             # logging.warning(f"folders={folders},hierarchy = {hierarchy}")
             if not folders:
                 # empty folder dict (album has no folder hierarchy)
@@ -2543,14 +2659,14 @@ class PhotosDB:
         return hierarchy
 
     def _album_folder_hierarchy_folderinfo_5(self, album_uuid):
-        """ return hierarchical list of FolderInfo objects album_uuid is contained in
-            ["Top level folder", "sub folder 1", "sub folder 2"]
-            returns empty list of album is not in any folders """
+        """return hierarchical list of FolderInfo objects album_uuid is contained in
+        ["Top level folder", "sub folder 1", "sub folder 2"]
+        returns empty list of album is not in any folders"""
         # title = photosdb._dbalbum_details[album_uuid]["title"]
         folders = self._dbalbum_folders[album_uuid]
 
         def _recurse_folder_hierarchy(folders, hierarchy=[]):
-            """ recursively walk the folders dict to build list of folder hierarchy """
+            """recursively walk the folders dict to build list of folder hierarchy"""
 
             if not folders:
                 # empty folder dict (album has no folder hierarchy)
@@ -2575,19 +2691,19 @@ class PhotosDB:
         return hierarchy
 
     def _get_album_uuids(self, shared=False, import_session=False):
-        """ Return list of album UUIDs found in photos database
-        
+        """Return list of album UUIDs found in photos database
+
             Filters out albums in the trash and any special album types
-        
+
         Args:
             shared: boolean; if True, returns shared albums, else normal albums
             import_session: boolean, if True, returns import session albums, else normal or shared albums
             Note: flags (shared, import_session) are mutually exclusive
-        
+
         Raises:
             ValueError: raised if mutually exclusive flags passed
 
-        Returns: list of album UUIDs 
+        Returns: list of album UUIDs
         """
         if shared and import_session:
             raise ValueError(
@@ -2639,14 +2755,14 @@ class PhotosDB:
         return album_list
 
     def _get_albums(self, shared=False):
-        """ Return list of album titles found in photos database
+        """Return list of album titles found in photos database
             Albums may have duplicate titles -- these will be treated as a single album.
-        
+
             Filters out albums in the trash and any special album types
 
         Args:
             shared: boolean; if True, returns shared albums, else normal albums
-        
+
         Returns: list of album names
         """
 
@@ -2665,7 +2781,7 @@ class PhotosDB:
         to_date=None,
         intrash=False,
     ):
-        """ Return a list of PhotoInfo objects
+        """Return a list of PhotoInfo objects
         If called with no args, returns the entire database of photos
         If called with args, returns photos matching the args (e.g. keywords, persons, etc.)
         If more than one arg, returns photos matching all the criteria (e.g. keywords AND persons)
@@ -2680,10 +2796,10 @@ class PhotosDB:
             persons: list of persons to search for
             albums: list of album names to search for
             images: if True, returns image files, if False, does not return images; default is True
-            movies: if True, returns movie files, if False, does not return movies; default is True 
+            movies: if True, returns movie files, if False, does not return movies; default is True
             from_date: return photos with creation date >= from_date (datetime.datetime object, default None)
             to_date: return photos with creation date <= to_date (datetime.datetime object, default None)
-            intrash: if True, returns only images in "Recently deleted items" folder, 
+            intrash: if True, returns only images in "Recently deleted items" folder,
                      if False returns only photos that aren't deleted; default is False
 
         Returns:
@@ -2790,7 +2906,7 @@ class PhotosDB:
         return photoinfo
 
     def get_photo(self, uuid):
-        """ Returns a single photo matching uuid
+        """Returns a single photo matching uuid
 
         Arguments:
             uuid: the UUID of photo to get
@@ -2805,7 +2921,7 @@ class PhotosDB:
 
     # TODO: add to docs and test
     def photos_by_uuid(self, uuids):
-        """ Returns a list of photos with UUID in uuids.
+        """Returns a list of photos with UUID in uuids.
             Does not generate error if invalid or missing UUID passed.
             This is faster than using PhotosDB.photos if you have list of UUIDs.
             Returns photos regardless of intrash state.
@@ -3157,11 +3273,12 @@ class PhotosDB:
 
         if options.regex:
             flags = re.IGNORECASE if options.ignore_case else 0
+            render_options = RenderOptions(none_str="")
             for regex, template in options.regex:
                 regex = re.compile(regex, flags)
                 photo_list = []
                 for p in photos:
-                    rendered, _ = p.render_template(template, none_str="")
+                    rendered, _ = p.render_template(template, render_options)
                     for value in rendered:
                         if regex.search(value):
                             photo_list.append(p)
@@ -3176,8 +3293,54 @@ class PhotosDB:
                 except Exception as e:
                     raise ValueError(f"Invalid query_eval CRITERIA: {e}")
 
+        if options.duplicate:
+            no_date = datetime(1970, 1, 1)
+            tz = timezone(timedelta(0))
+            no_date = no_date.astimezone(tz=tz)
+            photos = sorted(
+                [p for p in photos if p.duplicates],
+                key=lambda x: x.date_added or no_date,
+            )
+            # gather all duplicates but ensure each uuid is only represented once
+            photodict = OrderedDict()
+            for p in photos:
+                if p.uuid not in photodict:
+                    photodict[p.uuid] = p
+                    for d in sorted(
+                        p.duplicates, key=lambda x: x.date_added or no_date
+                    ):
+                        if d.uuid not in photodict:
+                            photodict[d.uuid] = d
+            photos = list(photodict.values())
+
+            # filter for deleted as photo.duplicates will include photos in the trash
+            if not (options.deleted or options.deleted_only):
+                photos = [p for p in photos if not p.intrash]
+            if options.deleted_only:
+                photos = [p for p in photos if p.intrash]
+
+        if options.location:
+            photos = [p for p in photos if p.location != (None, None)]
+        elif options.no_location:
+            photos = [p for p in photos if p.location == (None, None)]
+
+        if options.function:
+            for function in options.function:
+                photos = function[0](photos)
+
         return photos
 
+    def _duplicate_signature(self, uuid):
+        """Compute a signature for finding possible duplicates"""
+        return (
+            self._dbphotos[uuid]["original_filesize"],
+            self._dbphotos[uuid]["imageDate"],
+            self._dbphotos[uuid]["height"],
+            self._dbphotos[uuid]["width"],
+            self._dbphotos[uuid]["UTI"],
+            self._dbphotos[uuid]["hasAdjustments"],
+        )
+
     def __repr__(self):
         return f"osxphotos.{self.__class__.__name__}(dbfile='{self.db_path}')"
 
@@ -3189,8 +3352,8 @@ class PhotosDB:
         return False
 
     def __len__(self):
-        """ Returns number of photos in the database
-            Includes recently deleted photos and non-selected burst images
+        """Returns number of photos in the database
+        Includes recently deleted photos and non-selected burst images
         """
         return len(self._dbphotos)
 
@@ -3220,4 +3383,4 @@ def _get_photos_by_attribute(photos, attribute, values, ignore_case):
     else:
         for x in values:
             photos_search.extend(p for p in photos if x in getattr(p, attribute))
-    return photos_search
+    return list(set(photos_search))

osxphotos/photosdb/photosdb_utils.py

@@ -6,6 +6,7 @@ import plistlib
 from .._constants import (
     _PHOTOS_5_MODEL_VERSION,
     _PHOTOS_6_MODEL_VERSION,
+    _PHOTOS_7_MODEL_VERSION,
     _TESTED_DB_VERSIONS,
 )
 from ..utils import _open_sql_file
@@ -73,12 +74,12 @@ def get_db_model_version(db_file):
 
     model_ver = get_model_version(db_file)
     if _PHOTOS_5_MODEL_VERSION[0] <= model_ver <= _PHOTOS_5_MODEL_VERSION[1]:
-        db_ver = 5
+        return 5
     elif _PHOTOS_6_MODEL_VERSION[0] <= model_ver <= _PHOTOS_6_MODEL_VERSION[1]:
-        db_ver = 6
+        return 6
+    elif _PHOTOS_7_MODEL_VERSION[0] <= model_ver <= _PHOTOS_7_MODEL_VERSION[1]:
+        return 7
     else:
         logging.warning(f"Unknown model version: {model_ver}")
         # cross our fingers and try latest version
-        db_ver = 6
-
-    return db_ver
+        return 7

osxphotos/phototemplate.md

@@ -39,6 +39,7 @@ Valid filters are:
 - braces: Enclose value in curly braces, e.g. 'value => '{value}'.
 - parens: Enclose value in parentheses, e.g. 'value' => '(value')
 - brackets: Enclose value in brackets, e.g. 'value' => '[value]'
+- shell_quote: Quotes the value for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.
 - function: Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py
 <!-- OSXPHOTOS-FILTER-TABLE:END -->
 

osxphotos/phototemplate.py

@@ -4,14 +4,21 @@ import datetime
 import locale
 import os
 import pathlib
+import shlex
+import sys
+from dataclasses import dataclass
+from typing import Optional
 
 from textx import TextXSyntaxError, metamodel_from_file
 
 from ._constants import _UNKNOWN_PERSON
+from ._version import __version__
 from .datetime_formatter import DateTimeFormatter
 from .exiftool import ExifToolCaching
 from .path_utils import sanitize_dirname, sanitize_filename, sanitize_pathpart
-from .utils import load_function
+from .utils import expand_and_validate_filepath, load_function
+
+# TODO: a lot of values are passed from function to function like path_sep--make these all class properties
 
 # ensure locale set to user's locale
 locale.setlocale(locale.LC_ALL, "")
@@ -134,6 +141,13 @@ TEMPLATE_SUBSTITUTIONS = {
     "{lf}": r"A line feed: '\n', alias for {newline}",
     "{cr}": r"A carriage return: '\r'",
     "{crlf}": r"a carriage return + line feed: '\r\n'",
+    "{osxphotos_version}": f"The osxphotos version, e.g. '{__version__}'",
+    "{osxphotos_cmd_line}": "The full command line used to run osxphotos",
+}
+
+TEMPLATE_SUBSTITUTIONS_PATHLIB = {
+    "{export_dir}": "The full path to the export directory",
+    "{filepath}": "The full path to the exported file",
 }
 
 # Permitted multi-value substitutions (each of these returns None or 1 or more values)
@@ -160,6 +174,7 @@ TEMPLATE_SUBSTITUTIONS_MULTI_VALUED = {
     + "For example: '{photo.favorite}' is the same as '{favorite}' and '{photo.place.name}' is the same as '{place.name}'. "
     + "'{photo}' provides access to properties that are not available as separate template fields but it assumes some knowledge of "
     + "the underlying PhotoInfo class.  See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.",
+    "{shell_quote}": "Use in form '{shell_quote,TEMPLATE}'; quotes the rendered TEMPLATE value(s) for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.",
     "{function}": "Execute a python function from an external file and use return value as template substitution. "
     + "Use in format: {function:file.py::function_name} where 'file.py' is the name of the python file and 'function_name' is the name of the function to call. "
     + "The function will be passed the PhotoInfo object for the photo. "
@@ -175,7 +190,8 @@ FILTER_VALUES = {
     "braces": "Enclose value in curly braces, e.g. 'value => '{value}'.",
     "parens": "Enclose value in parentheses, e.g. 'value' => '(value')",
     "brackets": "Enclose value in brackets, e.g. 'value' => '[value]'",
-    "function": "Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py"
+    "shell_quote": "Quotes the value for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.",
+    "function": "Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py",
 }
 
 # Just the substitutions without the braces
@@ -183,13 +199,18 @@ SINGLE_VALUE_SUBSTITUTIONS = [
     field.replace("{", "").replace("}", "") for field in TEMPLATE_SUBSTITUTIONS
 ]
 
-# Just the multi-valued substitution names without the braces
+PATHLIB_SUBSTITUTIONS = [
+    field.replace("{", "").replace("}", "") for field in TEMPLATE_SUBSTITUTIONS_PATHLIB
+]
+
 MULTI_VALUE_SUBSTITUTIONS = [
     field.replace("{", "").replace("}", "")
     for field in TEMPLATE_SUBSTITUTIONS_MULTI_VALUED
 ]
 
-FIELD_NAMES = SINGLE_VALUE_SUBSTITUTIONS + MULTI_VALUE_SUBSTITUTIONS
+FIELD_NAMES = (
+    SINGLE_VALUE_SUBSTITUTIONS + MULTI_VALUE_SUBSTITUTIONS + PATHLIB_SUBSTITUTIONS
+)
 
 # default values for string manipulation template options
 INPLACE_DEFAULT = ","
@@ -213,20 +234,53 @@ PUNCTUATION = {
 }
 
 
+@dataclass
+class RenderOptions:
+    """Options for PhotoTemplate.render
+
+    template: str template
+    none_str: str to use default for None values, default is '_'
+    path_sep: optional string to use as path separator, default is os.path.sep
+    expand_inplace: expand multi-valued substitutions in-place as a single string
+        instead of returning individual strings
+    inplace_sep: optional string to use as separator between multi-valued keywords
+    with expand_inplace; default is ','
+    filename: if True, template output will be sanitized to produce valid file name
+    dirname: if True, template output will be sanitized to produce valid directory name
+    strip: if True, strips leading/trailing whitespace from rendered templates
+    edited_version: set to True if you want {edited_version} to resolve to True (e.g. exporting edited version of photo)
+    export_dir: set to the export directory if you want to evalute {export_dir} template
+    filepath: set to value for filepath of the exported photo if you want to evaluate {filepath} template
+    quote: quote path templates for execution in the shell
+    """
+
+    none_str: str = "_"
+    path_sep: Optional[str] = PATH_SEP_DEFAULT
+    expand_inplace: bool = False
+    inplace_sep: Optional[str] = INPLACE_DEFAULT
+    filename: bool = False
+    dirname: bool = False
+    strip: bool = False
+    edited_version: bool = False
+    export_dir: Optional[str] = None
+    filepath: Optional[str] = None
+    quote: bool = False
+
+
 class PhotoTemplateParser:
-    """Parser for PhotoTemplate """
+    """Parser for PhotoTemplate"""
 
     # implemented as Singleton
 
     def __new__(cls, *args, **kwargs):
-        """ create new object or return instance of already created singleton """
+        """create new object or return instance of already created singleton"""
         if not hasattr(cls, "instance") or not cls.instance:
             cls.instance = super().__new__(cls)
 
         return cls.instance
 
     def __init__(self):
-        """ return existing singleton or create a new one """
+        """return existing singleton or create a new one"""
 
         if hasattr(self, "metamodel"):
             return
@@ -234,15 +288,15 @@ class PhotoTemplateParser:
         self.metamodel = metamodel_from_file(OTL_GRAMMAR_MODEL, skipws=False)
 
     def parse(self, template_statement):
-        """Parse a template_statement string """
+        """Parse a template_statement string"""
         return self.metamodel.model_from_str(template_statement)
 
 
 class PhotoTemplate:
-    """ PhotoTemplate class to render a template string from a PhotoInfo object """
+    """PhotoTemplate class to render a template string from a PhotoInfo object"""
 
     def __init__(self, photo, exiftool_path=None):
-        """ Inits PhotoTemplate class with photo
+        """Inits PhotoTemplate class with photo
 
         Args:
             photo: a PhotoInfo instance.
@@ -258,49 +312,51 @@ class PhotoTemplate:
         # get parser singleton
         self.parser = PhotoTemplateParser()
 
-        # should {edited_version} render True?
-        self.edited_version = False
+        # initialize render options
+        # this will be done in render() but for testing, some of the lookup functions are called directly
+        options = RenderOptions()
+        self.path_sep = options.path_sep
+        self.inplace_sep = options.inplace_sep
+        self.edited_version = options.edited_version
+        self.none_str = options.none_str
+        self.expand_inplace = options.expand_inplace
+        self.filename = options.filename
+        self.dirname = options.dirname
+        self.strip = options.strip
+        self.export_dir = options.export_dir
+        self.filepath = options.filepath
+        self.quote = options.quote
 
     def render(
         self,
-        template,
-        none_str="_",
-        path_sep=None,
-        expand_inplace=False,
-        inplace_sep=None,
-        filename=False,
-        dirname=False,
-        strip=False,
-        edited_version=False,
+        template: str,
+        options: RenderOptions,
     ):
-        """ Render a filename or directory template 
+        """Render a filename or directory template
 
         Args:
-            template: str template 
-            none_str: str to use default for None values, default is '_' 
-            path_sep: optional string to use as path separator, default is os.path.sep
-            expand_inplace: expand multi-valued substitutions in-place as a single string 
-                instead of returning individual strings
-            inplace_sep: optional string to use as separator between multi-valued keywords
-            with expand_inplace; default is ','
-            filename: if True, template output will be sanitized to produce valid file name
-            dirname: if True, template output will be sanitized to produce valid directory name 
-            strip: if True, strips leading/trailing whitespace from rendered templates
-            edited_version: set to True if you want {edited_version} to resolve to True (e.g. exporting edited version of photo)
+            template: str template
+            options: a RenderOptions instance
 
         Returns:
             ([rendered_strings], [unmatched]): tuple of list of rendered strings and list of unmatched template values
         """
 
-        if path_sep is None:
-            path_sep = PATH_SEP_DEFAULT
-
-        if inplace_sep is None:
-            inplace_sep = INPLACE_DEFAULT
-
         if type(template) is not str:
             raise TypeError(f"template must be type str, not {type(template)}")
 
+        self.path_sep = options.path_sep
+        self.inplace_sep = options.inplace_sep
+        self.edited_version = options.edited_version
+        self.none_str = options.none_str
+        self.expand_inplace = options.expand_inplace
+        self.filename = options.filename
+        self.dirname = options.dirname
+        self.strip = options.strip
+        self.export_dir = options.export_dir
+        self.filepath = options.filepath
+        self.quote = options.quote
+
         try:
             model = self.parser.parse(template)
         except TextXSyntaxError as e:
@@ -310,53 +366,29 @@ class PhotoTemplate:
             # empty string
             return [], []
 
-        self.edited_version = edited_version
-
-        return self._render_statement(
-            model,
-            none_str=none_str,
-            path_sep=path_sep,
-            expand_inplace=expand_inplace,
-            inplace_sep=inplace_sep,
-            filename=filename,
-            dirname=dirname,
-            strip=strip,
-        )
+        return self._render_statement(model)
 
     def _render_statement(
         self,
         statement,
-        none_str="_",
         path_sep=None,
-        expand_inplace=False,
-        inplace_sep=None,
-        filename=False,
-        dirname=False,
-        strip=False,
     ):
+        path_sep = path_sep or self.path_sep
         results = []
         unmatched = []
         for ts in statement.template_strings:
             results, unmatched = self._render_template_string(
-                ts,
-                none_str=none_str,
-                path_sep=path_sep,
-                expand_inplace=expand_inplace,
-                inplace_sep=inplace_sep,
-                filename=filename,
-                dirname=dirname,
-                results=results,
-                unmatched=unmatched,
+                ts, results=results, unmatched=unmatched, path_sep=path_sep
             )
 
         rendered_strings = results
 
-        if filename:
+        if self.filename:
             rendered_strings = [
                 sanitize_filename(rendered_str) for rendered_str in rendered_strings
             ]
 
-        if strip:
+        if self.strip:
             rendered_strings = [
                 rendered_str.strip() for rendered_str in rendered_strings
             ]
@@ -366,16 +398,11 @@ class PhotoTemplate:
     def _render_template_string(
         self,
         ts,
-        none_str="_",
-        path_sep=None,
-        expand_inplace=False,
-        inplace_sep=None,
-        filename=False,
-        dirname=False,
+        path_sep,
         results=None,
         unmatched=None,
     ):
-        """Render a TemplateString object """
+        """Render a TemplateString object"""
 
         results = results or [""]
         unmatched = unmatched or []
@@ -383,7 +410,8 @@ class PhotoTemplate:
         if ts.template:
             # have a template field to process
             field = ts.template.field
-            if field not in FIELD_NAMES and not field.startswith("photo"):
+            field_part = field.split(".")[0]
+            if field not in FIELD_NAMES and field_part not in FIELD_NAMES:
                 unmatched.append(field)
                 return [], unmatched
 
@@ -410,12 +438,7 @@ class PhotoTemplate:
                 if ts.template.bool.value is not None:
                     bool_val, u = self._render_statement(
                         ts.template.bool.value,
-                        none_str=none_str,
                         path_sep=path_sep,
-                        expand_inplace=expand_inplace,
-                        inplace_sep=inplace_sep,
-                        filename=filename,
-                        dirname=dirname,
                     )
                     unmatched.extend(u)
                 else:
@@ -431,12 +454,7 @@ class PhotoTemplate:
                 if ts.template.default.value is not None:
                     default, u = self._render_statement(
                         ts.template.default.value,
-                        none_str=none_str,
                         path_sep=path_sep,
-                        expand_inplace=expand_inplace,
-                        inplace_sep=inplace_sep,
-                        filename=filename,
-                        dirname=dirname,
                     )
                     unmatched.extend(u)
                 else:
@@ -453,12 +471,7 @@ class PhotoTemplate:
                     # conditional value is also a TemplateString
                     conditional_value, u = self._render_statement(
                         ts.template.conditional.value,
-                        none_str=none_str,
                         path_sep=path_sep,
-                        expand_inplace=expand_inplace,
-                        inplace_sep=inplace_sep,
-                        filename=filename,
-                        dirname=dirname,
                     )
                     unmatched.extend(u)
                 else:
@@ -474,10 +487,8 @@ class PhotoTemplate:
                 vals = self.get_template_value(
                     field,
                     default=default,
-                    delim=delim or inplace_sep,
-                    path_sep=path_sep,
-                    filename=filename,
-                    dirname=dirname,
+                    # delim=delim or self.inplace_sep,
+                    # path_sep=path_sep,
                 )
             elif field == "exiftool":
                 if subfield is None:
@@ -485,7 +496,7 @@ class PhotoTemplate:
                         "SyntaxError: GROUP:NAME subfield must not be null with {exiftool:GROUP:NAME}'"
                     )
                 vals = self.get_template_value_exiftool(
-                    subfield, filename=filename, dirname=dirname
+                    subfield,
                 )
             elif field == "function":
                 if subfield is None:
@@ -493,20 +504,22 @@ class PhotoTemplate:
                         "SyntaxError: filename and function must not be null with {function::filename.py:function_name}"
                     )
                 vals = self.get_template_value_function(
-                    subfield, filename=filename, dirname=dirname
+                    subfield,
                 )
             elif field in MULTI_VALUE_SUBSTITUTIONS or field.startswith("photo"):
                 vals = self.get_template_value_multi(
-                    field, path_sep=path_sep, filename=filename, dirname=dirname
+                    field, path_sep=path_sep, default=default
                 )
+            elif field.split(".")[0] in PATHLIB_SUBSTITUTIONS:
+                vals = self.get_template_value_pathlib(field)
             else:
                 unmatched.append(field)
                 return [], unmatched
 
             vals = [val for val in vals if val is not None]
 
-            if expand_inplace or delim is not None:
-                sep = delim if delim is not None else inplace_sep
+            if self.expand_inplace or delim is not None:
+                sep = delim if delim is not None else self.inplace_sep
                 vals = [sep.join(sorted(vals))]
 
             for filter_ in filters:
@@ -527,7 +540,7 @@ class PhotoTemplate:
                 # have a conditional operator
 
                 def string_test(test_function):
-                    """ Perform string comparison using test_function; closure to capture conditional_value, vals, negation """
+                    """Perform string comparison using test_function; closure to capture conditional_value, vals, negation"""
                     match = False
                     for c in conditional_value:
                         for v in vals:
@@ -542,7 +555,7 @@ class PhotoTemplate:
                         return []
 
                 def comparison_test(test_function):
-                    """ Perform numerical comparisons using test_function; closure to capture conditional_val, vals, negation """
+                    """Perform numerical comparisons using test_function; closure to capture conditional_val, vals, negation"""
                     if len(vals) != 1 or len(conditional_value) != 1:
                         raise ValueError(
                             f"comparison operators may only be used with a single value: {vals} {conditional_value}"
@@ -603,7 +616,7 @@ class PhotoTemplate:
             if is_bool:
                 vals = default if not vals else bool_val
             elif not vals:
-                vals = default or [none_str]
+                vals = default or [self.none_str]
 
             pre = ts.pre or ""
             post = ts.post or ""
@@ -628,29 +641,29 @@ class PhotoTemplate:
         self,
         field,
         default,
-        bool_val=None,
-        delim=None,
-        path_sep=None,
-        filename=False,
-        dirname=False,
+        # bool_val=None,
+        # delim=None,
+        # path_sep=None,
     ):
         """lookup value for template field (single-value template substitutions)
 
         Args:
             field: template field to find value for.
             default: the default value provided by the user
-            bool_val: True value if expression is boolean 
+            bool_val: True value if expression is boolean
             delim: delimiter for expand in place
             path_sep: path separator for fields that are path-like
-            filename: if True, template output will be sanitized to produce valid file name
-            dirname: if True, template output will be sanitized to produce valid directory name 
-        
+
         Returns:
             The matching template value (which may be None).
 
         Raises:
             ValueError if no rule exists for field.
         """
+
+        if self.photo.uuid is None:
+            return []
+
         if field not in FIELD_NAMES:
             raise ValueError(f"SyntaxError: Unknown field: {field}")
 
@@ -908,13 +921,48 @@ class PhotoTemplate:
             value = self.photo.uuid
         elif field in PUNCTUATION:
             value = PUNCTUATION[field]
+        elif field == "osxphotos_version":
+            value = __version__
+        elif field == "osxphotos_cmd_line":
+            value = " ".join(sys.argv)
         else:
             # if here, didn't get a match
             raise ValueError(f"Unhandled template value: {field}")
 
-        if filename:
+        if self.filename:
             value = sanitize_pathpart(value)
-        elif dirname:
+        elif self.dirname:
+            value = sanitize_dirname(value)
+
+        return [value]
+
+    def get_template_value_pathlib(self, field):
+        """lookup value for template pathlib template fields
+
+        Args:
+            field: template field to find value for.
+
+        Returns:
+            The matching template value (which may be None).
+
+        Raises:
+            ValueError if no rule exists for field.
+        """
+        field_stem = field.split(".")[0]
+        if field_stem not in PATHLIB_SUBSTITUTIONS:
+            raise ValueError(f"SyntaxError: Unknown field: {field}")
+
+        field_value = None
+        try:
+            field_value = getattr(self, field_stem)
+        except AttributeError:
+            raise ValueError(f"Unknown path-like field: {field_stem}")
+
+        value = _get_pathlib_value(field, field_value, self.quote)
+
+        if self.filename:
+            value = sanitize_pathpart(value)
+        elif self.dirname:
             value = sanitize_dirname(value)
 
         return [value]
@@ -960,20 +1008,25 @@ class PhotoTemplate:
                 value = ["[" + v + "]" for v in values]
             else:
                 value = ["[" + values + "]"] if values else []
+        elif filter_ == "shell_quote":
+            if values and type(values) == list:
+                value = [shlex.quote(v) for v in values]
+            else:
+                value = [shlex.quote(values)] if values else []
         elif filter_.startswith("function:"):
             value = self.get_template_value_filter_function(filter_, values)
         else:
             value = []
         return value
 
-    def get_template_value_multi(self, field, path_sep, filename=False, dirname=False):
+    def get_template_value_multi(self, field, path_sep, default):
         """lookup value for template field (multi-value template substitutions)
 
         Args:
             field: template field to find value for.
             path_sep: path separator to use for folder_album field
-            dirname: if True, values will be sanitized to be valid directory names; default = False
-        
+            default: value of default field
+
         Returns:
             List of the matching template values or [].
 
@@ -982,6 +1035,10 @@ class PhotoTemplate:
         """
 
         """ return list of values for a multi-valued template field """
+
+        if self.photo.uuid is None:
+            return []
+
         values = []
         if field == "album":
             values = self.photo.burst_albums if self.photo.burst else self.photo.albums
@@ -1005,7 +1062,7 @@ class PhotoTemplate:
             for album in album_info:
                 if album.folder_names:
                     # album in folder
-                    if dirname:
+                    if self.dirname:
                         # being used as a filepath so sanitize each part
                         folder = path_sep.join(
                             sanitize_dirname(f) for f in album.folder_names
@@ -1017,7 +1074,7 @@ class PhotoTemplate:
                     values.append(folder)
                 else:
                     # album not in folder
-                    if dirname:
+                    if self.dirname:
                         values.append(sanitize_dirname(album.title))
                     else:
                         values.append(album.title)
@@ -1035,6 +1092,8 @@ class PhotoTemplate:
             values = (
                 self.photo.search_info.venue_types if self.photo.search_info else []
             )
+        elif field == "shell_quote":
+            values = [shlex.quote(v) for v in default if v]
         elif field.startswith("photo"):
             # provide access to PhotoInfo object
             properties = field.split(".")
@@ -1065,9 +1124,9 @@ class PhotoTemplate:
             raise ValueError(f"Unhandled template value: {field}")
 
         # sanitize directory names if needed, folder_album handled differently above
-        if filename:
+        if self.filename:
             values = [sanitize_pathpart(value) for value in values]
-        elif dirname and field != "folder_album":
+        elif self.dirname and field != "folder_album":
             # skip folder_album because it would have been handled above
             values = [sanitize_dirname(value) for value in values]
 
@@ -1075,9 +1134,15 @@ class PhotoTemplate:
         values = values or []
         return values
 
-    def get_template_value_exiftool(self, subfield, filename=None, dirname=None):
+    def get_template_value_exiftool(
+        self,
+        subfield,
+    ):
         """Get template value for format "{exiftool:EXIF:Model}" """
 
+        if self.photo is None:
+            return []
+
         if not self.photo.path:
             return []
 
@@ -1090,17 +1155,20 @@ class PhotoTemplate:
             values = [str(v) for v in values]
 
             # sanitize directory names if needed
-            if filename:
+            if self.filename:
                 values = [sanitize_pathpart(value) for value in values]
-            elif dirname:
+            elif self.dirname:
                 values = [sanitize_dirname(value) for value in values]
         else:
             values = []
 
         return values
 
-    def get_template_value_function(self, subfield, filename=None, dirname=None):
-        """Get template value from external function """
+    def get_template_value_function(
+        self,
+        subfield,
+    ):
+        """Get template value from external function"""
 
         if "::" not in subfield:
             raise ValueError(
@@ -1109,10 +1177,11 @@ class PhotoTemplate:
 
         filename, funcname = subfield.split("::")
 
-        if not pathlib.Path(filename).is_file():
+        filename_validated = expand_and_validate_filepath(filename)
+        if not filename_validated:
             raise ValueError(f"'{filename}' does not appear to be a file")
 
-        template_func = load_function(filename, funcname)
+        template_func = load_function(filename_validated, funcname)
         values = template_func(self.photo)
 
         if not isinstance(values, (str, list)):
@@ -1123,17 +1192,18 @@ class PhotoTemplate:
             values = [values]
 
         # sanitize directory names if needed
-        if filename:
+        if self.filename:
             values = [sanitize_pathpart(value) for value in values]
-        elif dirname:
-            values = [sanitize_dirname(value) for value in values]
+        elif self.dirname:
+            # sanitize but don't replace any "/" as user function may want to create sub directories
+            values = [sanitize_dirname(value, replacement=None) for value in values]
 
         return values
 
     def get_template_value_filter_function(self, filter_, values):
-        """Filter template value from external function """
+        """Filter template value from external function"""
 
-        filter_ = filter_.replace("function:","")
+        filter_ = filter_.replace("function:", "")
 
         if "::" not in filter_:
             raise ValueError(
@@ -1142,10 +1212,11 @@ class PhotoTemplate:
 
         filename, funcname = filter_.split("::")
 
-        if not pathlib.Path(filename).is_file():
+        filename_validated = expand_and_validate_filepath(filename)
+        if not filename_validated:
             raise ValueError(f"'{filename}' does not appear to be a file")
 
-        template_func = load_function(filename, funcname)
+        template_func = load_function(filename_validated, funcname)
 
         if not isinstance(values, (list, tuple)):
             values = [values]
@@ -1158,9 +1229,8 @@ class PhotoTemplate:
 
         return values
 
-
     def get_photo_video_type(self, default):
-        """ return media type, e.g. photo or video """
+        """return media type, e.g. photo or video"""
         default_dict = parse_default_kv(default, PHOTO_VIDEO_TYPE_DEFAULTS)
         if self.photo.isphoto:
             return default_dict["photo"]
@@ -1168,7 +1238,7 @@ class PhotoTemplate:
             return default_dict["video"]
 
     def get_media_type(self, default):
-        """ return special media type, e.g. slow_mo, panorama, etc., defaults to photo or video if no special type """
+        """return special media type, e.g. slow_mo, panorama, etc., defaults to photo or video if no special type"""
         default_dict = parse_default_kv(default, MEDIA_TYPE_DEFAULTS)
         p = self.photo
         if p.selfie:
@@ -1202,7 +1272,7 @@ class PhotoTemplate:
 
 
 def parse_default_kv(default, default_dict):
-    """ parse a string in form key1=value1;key2=value2,... as used for some template fields
+    """parse a string in form key1=value1;key2=value2,... as used for some template fields
 
     Args:
         default: str, in form 'photo=foto;video=vidéo'
@@ -1227,9 +1297,38 @@ def parse_default_kv(default, default_dict):
 
 
 def get_template_help():
-    """Return help for template system as markdown string """
+    """Return help for template system as markdown string"""
     # TODO: would be better to use importlib.abc.ResourceReader but I can't find a single example of how to do this
     help_file = pathlib.Path(__file__).parent / "phototemplate.md"
     with open(help_file, "r") as fd:
         md = fd.read()
     return md
+
+
+def _get_pathlib_value(field, value, quote):
+    """Get the value for a pathlib.Path type template
+
+    Args:
+        field: the path field, e.g. "filename.stem"
+        value: the value for the path component
+        quote: bool; if true, quotes the returned path for safe execution in the shell
+    """
+    parts = field.split(".")
+
+    if len(parts) == 1:
+        return shlex.quote(value) if quote else value
+
+    if len(parts) > 2:
+        raise ValueError(f"Illegal value for path template: {field}")
+
+    path = parts[0]
+    attribute = parts[1]
+    path = pathlib.Path(value)
+    try:
+        val = getattr(path, attribute)
+        val_str = str(val)
+        if quote:
+            val_str = shlex.quote(val_str)
+        return val_str
+    except AttributeError:
+        raise ValueError("Illegal value for path template: {attribute}")

osxphotos/phototemplate.tx

@@ -63,7 +63,8 @@ SubField:
 ;
 
 SUBFIELD_WORD:
-    /[\.\w:\/]+/
+    /[\.\w:\/\-\~\'\"\%\@\#\^\’]+/
+    /\\\s/?
 ;
 
 Filter:

osxphotos/queryoptions.py

@@ -1,8 +1,9 @@
 """ QueryOptions class for PhotosDB.query """
 
-from dataclasses import dataclass
-from typing import Optional, Iterable, Tuple
 import datetime
+from dataclasses import asdict, dataclass
+from typing import Iterable, List, Optional, Tuple
+
 import bitmath
 
 
@@ -30,7 +31,7 @@ class QueryOptions:
     shared: Optional[bool] = None
     not_shared: Optional[bool] = None
     photos: Optional[bool] = True
-    movies: Optional[bool] = True 
+    movies: Optional[bool] = True
     uti: Optional[Iterable[str]] = None
     burst: Optional[bool] = None
     not_burst: Optional[bool] = None
@@ -78,6 +79,10 @@ class QueryOptions:
     max_size: Optional[bitmath.Byte] = None
     regex: Optional[Iterable[Tuple[str, str]]] = None
     query_eval: Optional[Iterable[str]] = None
+    duplicate: Optional[bool] = None
+    location: Optional[bool] = None
+    no_location: Optional[bool] = None
+    function: Optional[List[Tuple[callable, str]]] = None
 
     def asdict(self):
         return asdict(self)

osxphotos/tutorial.md

@@ -315,6 +315,40 @@ Then the next to you run osxphotos, you can simply do this:
 
 The configuration file is a plain text file in [TOML](https://toml.io/en/) format so the `.toml` extension is standard but you can name the file anything you like. 
 
+### Run commands on exported photos for post-processing
+
+You can use the `--post-command` option to run one or more commands against exported files. The `--post-command` option takes two arguments: CATEGORY and COMMAND.  CATEGORY is a string that describes which category of file to run the command against.  The available categories are described in the help text available via: `osxphotos help export`. For example, the `exported` category includes all exported photos and the `skipped` category includes all photos that were skipped when running export with `--update`.  COMMAND is an osxphotos template string which will be rendered then passed to the shell for execution.  
+
+For example, the following command generates a log of all exported files and their associated keywords:
+
+`osxphotos export /path/to/export --post-command exported "echo {shell_quote,{filepath}{comma}{,+keyword,}} >> {shell_quote,{export_dir}/exported.txt}"`
+
+The special template field `{shell_quote}` ensures a string is properly quoted for execution in the shell.  For example, it's possible that a file path or keyword in this example has a space in the value and if not properly quoted, this would cause an error in the execution of the command. When running commands, the template `{filepath}` is set to the full path of the exported file and `{export_dir}` is set to the full path of the base export directory.  
+
+Explanation of the template string:
+
+```txt
+{shell_quote,{filepath}{comma}{,+keyword,}}
+ │            │         │      │        │
+ │            │         │      |        │
+ └──> quote everything after comma for proper execution in the shell
+              │         │      │        │
+              └───> filepath of the exported file
+                       │       │        │
+                       └───> insert a comma 
+                               │        │
+                               └───> join the list of keywords together with a ","
+                                        │
+                                        └───> if no keywords, insert nothing (empty string: "")
+```
+
+Another example: if you had `exiftool` installed and wanted to wipe all metadata from all exported files, you could use the following:
+
+`osxphotos export /path/to/export --post-command exported "/usr/local/bin/exiftool -all= {filepath|shell_quote}"`
+
+This command uses the `|shell_quote` template filter instead of the `{shell_quote}` template because the only thing that needs to be quoted is the path to the exported file. Template filters filter the value of the rendered template field.  A number of other filters are available and are described in the help text. 
+
+
 ### An example from an actual osxphotos user
 
 Here's a comprehensive use case from an actual osxphotos user that integrates many of the concepts discussed in this tutorial (thank-you Philippe for contributing this!):

osxphotos/uti.py

@@ -0,0 +1,621 @@
+""" get UTI for a given file extension and the preferred extension for a given UTI """
+
+""" Implementation note: runs only on macOS
+
+    On macOS <= 11 (Big Sur), uses objective C CoreServices methods 
+    UTTypeCopyPreferredTagWithClass and UTTypeCreatePreferredIdentifierForTag to retrieve the 
+    UTI and the extension.  These are deprecated in 10.15 (Catalina) and no longer supported on Monterey.
+
+    On Monterey, these calls are replaced with Swift methods that I can't call from python so 
+    this code uses a cached dict of UTI values.  The code first checks to see if the extension or UTI 
+    is available in the cache and if so, returns it. If not, it performs a subprocess call to `mdls` to 
+    retrieve the UTI (by creating a temp file with the correct extension) and returns the UTI.  This only 
+    works for the extension -> UTI lookup. On Monterey, if there is no cached value for UTI -> extension lookup, 
+    returns None.
+
+    It's a bit hacky but best I can think of to make this robust on different versions of macOS.  PRs welcome.
+"""
+
+import csv
+import re
+import subprocess
+import tempfile
+
+import CoreServices
+import objc
+
+from .utils import _get_os_version
+
+# cached values of all the UTIs (< 6 chars long) known to my Mac running macOS 10.15.7
+UTI_CSV = """extension,UTI,preferred_extension,MIME_type
+c,public.c-source,c,None
+f,public.fortran-source,f,None
+h,public.c-header,h,None
+i,public.c-source.preprocessed,i,None
+l,public.lex-source,l,None
+m,public.objective-c-source,m,None
+o,public.object-code,o,None
+r,com.apple.rez-source,r,None
+s,public.assembly-source,s,None
+y,public.yacc-source,y,None
+z,public.z-archive,z,application/x-compress
+aa,com.audible.aa-audiobook,aa,audio/audible
+ai,com.adobe.illustrator.ai-image,ai,None
+as,com.apple.applesingle-archive,as,None
+au,public.au-audio,au,audio/basic
+bz,public.bzip2-archive,bz2,application/x-bzip2
+cc,public.c-plus-plus-source,cp,None
+cp,public.c-plus-plus-source,cp,None
+dv,public.dv-movie,dv,video/x-dv
+gz,org.gnu.gnu-zip-archive,gz,application/x-gzip
+hh,public.c-plus-plus-header,hh,None
+hp,public.c-plus-plus-header,hh,None
+ii,public.c-plus-plus-source.preprocessed,ii,None
+js,com.netscape.javascript-source,js,text/javascript
+lm,public.lex-source,l,None
+mi,public.objective-c-source.preprocessed,mi,None
+mm,public.objective-c-plus-plus-source,mm,None
+pf,com.apple.colorsync-profile,icc,None
+pl,public.perl-script,pl,text/x-perl-script
+pm,public.perl-script,pl,text/x-perl-script
+ps,com.adobe.postscript,ps,application/postscript
+py,public.python-script,py,text/x-python-script
+qt,com.apple.quicktime-movie,mov,video/quicktime
+ra,com.real.realaudio,ram,audio/vnd.rn-realaudio
+rb,public.ruby-script,rb,text/x-ruby-script
+rm,com.real.realmedia,rm,application/vnd.rn-realmedia
+sh,public.shell-script,sh,None
+ts,public.mpeg-2-transport-stream,ts,None
+ul,public.ulaw-audio,ul,None
+uu,public.uuencoded-archive,uu,text/x-uuencode
+wm,com.microsoft.windows-media-wm,wm,video/x-ms-wm
+ym,public.yacc-source,y,None
+aac,public.aac-audio,aac,audio/aac
+aae,com.apple.photos.apple-adjustment-envelope,aae,None
+aaf,org.aafassociation.advanced-authoring-format,aaf,None
+aax,com.audible.aax-audiobook,aax,audio/vnd.audible.aax
+abc,public.alembic,abc,None
+ac3,public.ac3-audio,ac3,audio/ac3
+ada,public.ada-source,ada,None
+adb,public.ada-source,ada,None
+ads,public.ada-source,ada,None
+aif,public.aifc-audio,aifc,audio/aiff
+amr,org.3gpp.adaptive-multi-rate-audio,amr,audio/amr
+app,com.apple.application-bundle,app,None
+arw,com.sony.arw-raw-image,arw,None
+asf,com.microsoft.advanced-systems-format,asf,video/x-ms-asf
+asx,com.microsoft.advanced-stream-redirector,asx,video/x-ms-asx
+avi,public.avi,avi,video/avi
+bdm,public.avchd-content,bdm,None
+bin,com.apple.macbinary-archive,bin,application/macbinary
+bmp,com.microsoft.bmp,bmp,image/bmp
+bwf,com.microsoft.waveform-audio,wav,audio/vnd.wave
+bz2,public.bzip2-archive,bz2,application/x-bzip2
+caf,com.apple.coreaudio-format,caf,None
+cdr,com.apple.disk-image-cdr,dvdr,None
+cel,public.flc-animation,flc,video/flc
+cer,public.x509-certificate,cer,application/x-x509-ca-cert
+cpp,public.c-plus-plus-source,cp,None
+crt,public.x509-certificate,cer,application/x-x509-ca-cert
+crw,com.canon.crw-raw-image,crw,image/x-canon-crw
+cr2,com.canon.cr2-raw-image,cr2,None
+cr3,com.canon.cr3-raw-image,cr3,None
+csh,public.csh-script,csh,None
+css,public.css,css,text/css
+csv,public.comma-separated-values-text,csv,text/csv
+cxx,public.c-plus-plus-source,cp,None
+dae,org.khronos.collada.digital-asset-exchange,dae,None
+dcm,org.nema.dicom,dcm,application/dicom
+dcr,com.kodak.raw-image,dcr,None
+dds,com.microsoft.dds,dds,None
+der,public.x509-certificate,cer,application/x-x509-ca-cert
+dif,public.dv-movie,dv,video/x-dv
+dll,com.microsoft.windows-dynamic-link-library,dll,application/x-msdownload
+dls,public.downloadable-sound,dls,audio/dls
+dmg,com.apple.disk-image-udif,dmg,None
+dng,com.adobe.raw-image,dng,image/x-adobe-dng
+doc,com.microsoft.word.doc,doc,application/msword
+dot,com.microsoft.word.dot,dot,application/msword
+dxo,com.dxo.raw-image,dxo,image/x-dxo-dxo
+ec3,public.enhanced-ac3-audio,eac3,audio/eac3
+edn,com.adobe.edn,edn,None
+efx,com.j2.efx-fax,efx,image/efax
+eml,com.apple.mail.email,eml,message/rfc822
+eps,com.adobe.encapsulated-postscript,eps,None
+erf,com.epson.raw-image,erf,image/x-epson-erf
+etd,com.adobe.etd,etd,None
+exe,com.microsoft.windows-executable,exe,application/x-msdownload
+exp,com.apple.symbol-export,exp,None
+exr,com.ilm.openexr-image,exr,None
+fdf,com.adobe.fdf,fdf,None
+fff,com.hasselblad.fff-raw-image,fff,None
+flc,public.flc-animation,flc,video/flc
+fli,public.flc-animation,flc,video/flc
+flv,com.adobe.flash.video,flv,video/x-flv
+for,public.fortran-source,f,None
+fpx,com.kodak.flashpix-image,fpx,image/fpx
+f4a,com.adobe.flash.video,flv,video/x-flv
+f4b,com.adobe.flash.video,flv,video/x-flv
+f4p,com.adobe.flash.video,flv,video/x-flv
+f4v,com.adobe.flash.video,flv,video/x-flv
+f77,public.fortran-77-source,f77,None
+f90,public.fortran-90-source,f90,None
+f95,public.fortran-95-source,f95,None
+gif,com.compuserve.gif,gif,image/gif
+hdr,public.radiance,pic,None
+hpp,public.c-plus-plus-header,hh,None
+hqx,com.apple.binhex-archive,hqx,application/mac-binhex40
+htm,public.html,html,text/html
+hxx,public.c-plus-plus-header,hh,None
+iba,com.apple.ibooksauthor.pkgbook,iba,None
+icc,com.apple.colorsync-profile,icc,None
+icm,com.apple.colorsync-profile,icc,None
+ico,com.microsoft.ico,ico,image/vnd.microsoft.icon
+ics,com.apple.ical.ics,ics,text/calendar
+iig,com.apple.iig-source,iig,None
+iiq,com.phaseone.raw-image,iiq,None
+img,com.apple.disk-image-ndif,ndif,None
+inl,public.c-plus-plus-inline-header,inl,None
+ipa,com.apple.itunes.ipa,ipa,None
+ipp,public.c-plus-plus-header,hh,None
+ips,com.apple.ips,ips,None
+iso,public.iso-image,iso,None
+ite,com.apple.tv.ite,ite,None
+itl,com.apple.itunes.db,itl,None
+jar,com.sun.java-archive,jar,application/java-archive
+jav,com.sun.java-source,java,None
+jfx,com.j2.jfx-fax,jfx,None
+jpe,public.jpeg,jpeg,image/jpeg
+jpf,public.jpeg-2000,jp2,image/jp2
+jpg,public.jpeg,jpeg,image/jpeg
+jpx,public.jpeg-2000,jp2,image/jp2
+jp2,public.jpeg-2000,jp2,image/jp2
+j2c,public.jpeg-2000,jp2,image/jp2
+j2k,public.jpeg-2000,jp2,image/jp2
+kar,public.midi-audio,midi,audio/midi
+key,com.apple.iwork.keynote.key,key,None
+ksh,public.ksh-script,ksh,None
+kth,com.apple.iwork.keynote.kth,kth,None
+ktx,org.khronos.ktx,ktx,None
+lid,public.dylan-source,dlyan,None
+lmm,public.lex-source,l,None
+log,com.apple.log,log,None
+lpp,public.lex-source,l,None
+lxx,public.lex-source,l,None
+mid,public.midi-audio,midi,audio/midi
+mig,public.mig-source,defs,None
+mii,public.objective-c-plus-plus-source.preprocessed,mii,None
+mjs,com.netscape.javascript-source,js,text/javascript
+mnc,ca.mcgill.mni.bic.mnc,mnc,None
+mos,com.leafamerica.raw-image,mos,None
+mov,com.apple.quicktime-movie,mov,video/quicktime
+mpe,public.mpeg,mpg,video/mpeg
+mpg,public.mpeg,mpg,video/mpeg
+mpo,public.mpo-image,mpo,None
+mp2,public.mp2,mp2,None
+mp3,public.mp3,mp3,audio/mpeg
+mp4,public.mpeg-4,mp4,video/mp4
+mrw,com.konicaminolta.raw-image,mrw,None
+mts,public.avchd-mpeg-2-transport-stream,mts,None
+mxf,org.smpte.mxf,mxf,application/mxf
+m15,public.mpeg,mpg,video/mpeg
+m2v,public.mpeg-2-video,m2v,video/mpeg2
+m3u,public.m3u-playlist,m3u,audio/mpegurl
+m4a,com.apple.m4a-audio,m4a,audio/x-m4a
+m4b,com.apple.protected-mpeg-4-audio-b,m4b,None
+m4p,com.apple.protected-mpeg-4-audio,m4p,None
+m4r,com.apple.mpeg-4-ringtone,m4r,audio/x-m4r
+m4v,com.apple.m4v-video,m4v,video/x-m4v
+m75,public.mpeg,mpg,video/mpeg
+nef,com.nikon.raw-image,nef,None
+nii,gov.nih.nifti-1,nii,None
+nrw,com.nikon.nrw-raw-image,nrw,image/x-nikon-nrw
+obj,public.geometry-definition-format,obj,None
+odb,org.oasis-open.opendocument.database,odb,application/vnd.oasis.opendocument.database
+odc,org.oasis-open.opendocument.chart,odc,application/vnd.oasis.opendocument.chart
+odf,org.oasis-open.opendocument.formula,odf,application/vnd.oasis.opendocument.formula
+odg,org.oasis-open.opendocument.graphics,odg,application/vnd.oasis.opendocument.graphics
+odi,org.oasis-open.opendocument.image,odi,application/vnd.oasis.opendocument.image
+odm,org.oasis-open.opendocument.text-master,odm,application/vnd.oasis.opendocument.text-master
+odp,org.oasis-open.opendocument.presentation,odp,application/vnd.oasis.opendocument.presentation
+ods,org.oasis-open.opendocument.spreadsheet,ods,application/vnd.oasis.opendocument.spreadsheet
+odt,org.oasis-open.opendocument.text,odt,application/vnd.oasis.opendocument.text
+omf,com.avid.open-media-framework,omf,None
+orf,com.olympus.raw-image,orf,None
+otc,public.opentype-collection-font,otc,None
+otf,public.opentype-font,otf,None
+otg,org.oasis-open.opendocument.graphics-template,otg,application/vnd.oasis.opendocument.graphics-template
+oth,org.oasis-open.opendocument.text-web,oth,application/vnd.oasis.opendocument.text-web
+oti,org.oasis-open.opendocument.image-template,oti,application/vnd.oasis.opendocument.image-template
+otp,org.oasis-open.opendocument.presentation-template,otp,application/vnd.oasis.opendocument.presentation-template
+ots,org.oasis-open.opendocument.spreadsheet-template,ots,application/vnd.oasis.opendocument.spreadsheet-template
+ott,org.oasis-open.opendocument.text-template,ott,application/vnd.oasis.opendocument.text-template
+pas,public.pascal-source,pas,None
+pax,public.cpio-archive,cpio,None
+pbm,public.pbm,pbm,None
+pch,public.precompiled-c-header,pch,None
+pct,com.apple.pict,pict,image/pict
+pdf,com.adobe.pdf,pdf,application/pdf
+pef,com.pentax.raw-image,pef,None
+pem,public.x509-certificate,cer,application/x-x509-ca-cert
+pfa,com.adobe.postscript-pfa-font,pfa,None
+pfb,com.adobe.postscript-pfb-font,pfb,None
+pfm,public.pbm,pbm,None
+pfx,com.rsa.pkcs-12,p12,application/x-pkcs12
+pgm,public.pbm,pbm,None
+pgn,com.apple.chess.pgn,pgn,None
+php,public.php-script,php,text/php
+ph3,public.php-script,php,text/php
+ph4,public.php-script,php,text/php
+pic,com.apple.pict,pict,image/pict
+pkg,com.apple.installer-package-archive,pkg,None
+pls,public.pls-playlist,pls,audio/x-scpls
+ply,public.polygon-file-format,ply,None
+png,public.png,png,image/png
+pot,com.microsoft.powerpoint.pot,pot,application/vnd.ms-powerpoint
+ppm,public.pbm,pbm,None
+pps,com.microsoft.powerpoint.pps,pps,application/vnd.ms-powerpoint
+ppt,com.microsoft.powerpoint.ppt,ppt,application/vnd.ms-powerpoint
+psb,com.adobe.photoshop-large-image,psb,None
+psd,com.adobe.photoshop-image,psd,image/vnd.adobe.photoshop
+pvr,public.pvr,pvr,None
+pvt,com.apple.private.live-photo-bundle,pvt,None
+pwl,com.leica.pwl-raw-image,pwl,image/x-leica-pwl
+p12,com.rsa.pkcs-12,p12,application/x-pkcs12
+qti,com.apple.quicktime-image,qtif,image/x-quicktime
+qtz,com.apple.quartz-composer-composition,qtz,application/x-quartzcomposer
+raf,com.fuji.raw-image,raf,None
+ram,com.real.realaudio,ram,audio/vnd.rn-realaudio
+raw,com.panasonic.raw-image,raw,None
+rbw,public.ruby-script,rb,text/x-ruby-script
+rmp,com.apple.music.rmp-playlist,rmp,application/vnd.rn-rn_music_package
+rss,public.rss,rss,application/rss+xml
+rtf,public.rtf,rtf,text/rtf
+rwl,com.leica.rwl-raw-image,rwl,None
+rw2,com.panasonic.rw2-raw-image,rw2,None
+scc,com.scenarist.closed-caption,scc,None
+scn,com.apple.scenekit.scene,scn,None
+sda,org.openoffice.graphics,sxd,application/vnd.sun.xml.draw
+sdc,org.openoffice.spreadsheet,sxc,application/vnd.sun.xml.calc
+sdd,org.openoffice.presentation,sxi,application/vnd.sun.xml.impress
+sdp,org.openoffice.presentation,sxi,application/vnd.sun.xml.impress
+sdv,public.3gpp,3gp,video/3gpp
+sdw,org.openoffice.text,sxw,application/vnd.sun.xml.writer
+sd2,com.digidesign.sd2-audio,sd2,None
+sea,com.stuffit.archive.sit,sit,application/x-stuffit
+sf2,com.soundblaster.soundfont,sf2,None
+sgi,com.sgi.sgi-image,sgi,image/sgi
+sit,com.stuffit.archive.sit,sit,application/x-stuffit
+slm,com.apple.photos.slow-motion-video-sidecar,slm,None
+smf,public.midi-audio,midi,audio/midi
+smi,com.apple.disk-image-smi,smi,None
+snd,public.au-audio,au,audio/basic
+spx,com.apple.systemprofiler.document,spx,None
+srf,com.sony.raw-image,srf,None
+srw,com.samsung.raw-image,srw,None
+sr2,com.sony.sr2-raw-image,sr2,image/x-sony-sr2
+stc,org.openoffice.spreadsheet-template,stc,application/vnd.sun.xml.calc.template
+std,org.openoffice.graphics-template,std,application/vnd.sun.xml.draw.template
+sti,org.openoffice.presentation-template,sti,application/vnd.sun.xml.impress.template
+stl,public.standard-tesselated-geometry-format,stl,None
+stw,org.openoffice.text-template,stw,application/vnd.sun.xml.writer.template
+svg,public.svg-image,svg,image/svg+xml
+sxc,org.openoffice.spreadsheet,sxc,application/vnd.sun.xml.calc
+sxd,org.openoffice.graphics,sxd,application/vnd.sun.xml.draw
+sxg,org.openoffice.text-master,sxg,application/vnd.sun.xml.writer.global
+sxi,org.openoffice.presentation,sxi,application/vnd.sun.xml.impress
+sxm,org.openoffice.formula,sxm,application/vnd.sun.xml.math
+sxw,org.openoffice.text,sxw,application/vnd.sun.xml.writer
+tar,public.tar-archive,tar,application/x-tar
+tbz,public.tar-bzip2-archive,tbz2,None
+tga,com.truevision.tga-image,tga,image/targa
+tgz,org.gnu.gnu-zip-tar-archive,tgz,None
+tif,public.tiff,tiff,image/tiff
+tsv,public.tab-separated-values-text,tsv,text/tab-separated-values
+ttc,public.truetype-collection-font,ttc,None
+ttf,public.truetype-ttf-font,ttf,None
+txt,public.plain-text,txt,text/plain
+ulw,public.ulaw-audio,ul,None
+url,com.microsoft.internet-shortcut,url,None
+usd,com.pixar.universal-scene-description,usd,None
+vcf,public.vcard,vcf,text/directory
+vcs,com.apple.ical.vcs,vcs,text/x-vcalendar
+vfw,public.avi,avi,video/avi
+vtt,org.w3.webvtt,vtt,text/vtt
+war,com.sun.web-application-archive,war,None
+wav,com.microsoft.waveform-audio,wav,audio/vnd.wave
+wax,com.microsoft.windows-media-wax,wax,video/x-ms-wax
+web,com.getdropbox.dropbox.shortcut,web,None
+wma,com.microsoft.windows-media-wma,wma,video/x-ms-wma
+wmp,com.microsoft.windows-media-wmp,wmp,video/x-ms-wmp
+wmv,com.microsoft.windows-media-wmv,wmv,video/x-ms-wmv
+wmx,com.microsoft.windows-media-wmx,wmx,video/x-ms-wmx
+wvx,com.microsoft.windows-media-wvx,wvx,video/x-ms-wvx
+xar,com.apple.xar-archive,xar,None
+xbm,public.xbitmap-image,xbm,image/x-xbitmap
+xfd,public.xfd,xfd,None
+xht,public.xhtml,xhtml,application/xhtml+xml
+xip,com.apple.xip-archive,xip,None
+xla,com.microsoft.excel.xla,xla,None
+xls,com.microsoft.excel.xls,xls,application/vnd.ms-excel
+xlt,com.microsoft.excel.xlt,xlt,application/vnd.ms-excel
+xlw,com.microsoft.excel.xlw,xlw,application/vnd.ms-excel
+xml,public.xml,xml,application/xml
+xmp,com.seriflabs.xmp,xmp,application/rdf+xml
+xpc,com.apple.xpc-service,xpc,None
+yml,public.yaml,yml,application/x-yaml
+ymm,public.yacc-source,y,None
+ypp,public.yacc-source,y,None
+yxx,public.yacc-source,y,None
+zip,public.zip-archive,zip,application/zip
+zsh,public.zsh-script,zsh,None
+3fr,com.hasselblad.3fr-raw-image,3fr,None
+3gp,public.3gpp,3gp,video/3gpp
+3g2,public.3gpp2,3g2,video/3gpp2
+adts,public.aac-audio,aac,audio/aac
+ahap,com.apple.haptics.ahap,ahap,None
+aifc,public.aifc-audio,aifc,audio/aiff
+aiff,public.aifc-audio,aifc,audio/aiff
+astc,org.khronos.astc,astc,None
+avci,public.avci,avci,image/avci
+avcs,public.avcs,avcs,image/avcs
+band,com.apple.garageband.project,band,None
+bash,public.bash-script,bash,None
+bdmv,public.avchd-content,bdm,None
+book,com.apple.ibooksauthor.pkgbook,iba,None
+cdda,public.aifc-audio,aifc,audio/aiff
+chat,com.apple.ichat.transcript,ichat,None
+cpgz,com.apple.bom-compressed-cpio,cpgz,None
+cpio,public.cpio-archive,cpio,None
+dart,com.apple.disk-image-dart,dart,None
+dc42,com.apple.disk-image-dc42,dc42,None
+defs,public.mig-source,defs,None
+dext,com.apple.driver-extension,dext,None
+diff,public.patch-file,patch,None
+dist,com.apple.installer-distribution-package,dist,None
+docm,org.openxmlformats.wordprocessingml.document.macroenabled,docm,application/vnd.ms-word.document.macroenabled.12
+docx,org.openxmlformats.wordprocessingml.document,docx,application/vnd.openxmlformats-officedocument.wordprocessingml.document
+dotm,org.openxmlformats.wordprocessingml.template.macroenabled,dotm,application/vnd.ms-word.template.macroenabled.12
+dotx,org.openxmlformats.wordprocessingml.template,dotx,application/vnd.openxmlformats-officedocument.wordprocessingml.template
+dsym,com.apple.xcode.dsym,dsym,None
+dvdr,com.apple.disk-image-cdr,dvdr,None
+eac3,public.enhanced-ac3-audio,eac3,audio/eac3
+emlx,com.apple.mail.emlx,emlx,None
+enex,com.evernote.enex,enex,None
+epub,org.idpf.epub-container,epub,application/epub+zip
+fh10,com.seriflabs.affinity,fh10,None
+fh11,com.seriflabs.affinity,fh10,None
+flac,org.xiph.flac,flac,audio/flac
+fpbf,com.apple.finder.burn-folder,fpbf,None
+game,com.apple.chess.game,game,None
+gdoc,com.google.gdoc,gdoc,None
+gtar,org.gnu.gnu-tar-archive,gtar,application/x-gtar
+gzip,org.gnu.gnu-zip-archive,gz,application/x-gzip
+hang,com.apple.hangreport,hang,None
+heic,public.heic,heic,image/heic
+heif,public.heif,heif,image/heif
+html,public.html,html,text/html
+hvpl,com.apple.music.visual,hvpl,None
+icbu,com.apple.ical.backup,icbu,None
+icns,com.apple.icns,icns,None
+ipsw,com.apple.itunes.ipsw,ipsw,None
+itlp,com.apple.music.itlp,itlp,None
+itms,com.apple.itunes.store-url,itms,None
+java,com.sun.java-source,java,None
+jnlp,com.sun.java-web-start,jnlp,application/x-java-jnlp-file
+jpeg,public.jpeg,jpeg,image/jpeg
+json,public.json,json,application/json
+latm,public.mp4a-loas,loas,None
+loas,public.mp4a-loas,loas,None
+lpdf,com.apple.localized-pdf-bundle,lpdf,None
+mbox,com.apple.mail.mbox,mbox,None
+menu,com.apple.menu-extra,menu,None
+midi,public.midi-audio,midi,audio/midi
+minc,ca.mcgill.mni.bic.mnc,mnc,None
+mpeg,public.mpeg,mpg,video/mpeg
+mpga,public.mp3,mp3,audio/mpeg
+mpg4,public.mpeg-4,mp4,video/mp4
+mpkg,com.apple.installer-package-archive,pkg,None
+m2ts,public.avchd-mpeg-2-transport-stream,mts,None
+m3u8,public.m3u-playlist,m3u,audio/mpegurl
+ndif,com.apple.disk-image-ndif,ndif,None
+note,com.apple.notes.note,note,None
+php3,public.php-script,php,text/php
+php4,public.php-script,php,text/php
+pict,com.apple.pict,pict,image/pict
+pntg,com.apple.macpaint-image,pntg,None
+potm,org.openxmlformats.presentationml.template.macroenabled,potm,application/vnd.ms-powerpoint.template.macroenabled.12
+potx,org.openxmlformats.presentationml.template,potx,application/vnd.openxmlformats-officedocument.presentationml.template
+ppsm,org.openxmlformats.presentationml.slideshow.macroenabled,ppsm,application/vnd.ms-powerpoint.slideshow.macroenabled.12
+ppsx,org.openxmlformats.presentationml.slideshow,ppsx,application/vnd.openxmlformats-officedocument.presentationml.slideshow
+pptm,org.openxmlformats.presentationml.presentation.macroenabled,pptm,application/vnd.ms-powerpoint.presentation.macroenabled.12
+pptx,org.openxmlformats.presentationml.presentation,pptx,application/vnd.openxmlformats-officedocument.presentationml.presentation
+pset,com.apple.pdf-printer-settings,pset,None
+qtif,com.apple.quicktime-image,qtif,image/x-quicktime
+rmvb,com.real.realmedia-vbr,rmvb,application/vnd.rn-realmedia-vbr
+rtfd,com.apple.rtfd,rtfd,None
+scnz,com.apple.scenekit.scene,scn,None
+scpt,com.apple.applescript.script,scpt,None
+shtm,public.html,html,text/html
+sidx,com.stuffit.archive.sidx,sidx,application/x-stuffitx-index
+sitx,com.stuffit.archive.sitx,sitx,application/x-stuffitx
+spin,com.apple.spinreport,spin,None
+suit,com.apple.font-suitcase,suit,None
+svgz,public.svg-image,svg,image/svg+xml
+tbz2,public.tar-bzip2-archive,tbz2,None
+tcsh,public.tcsh-script,tcsh,None
+term,com.apple.terminal.session,term,None
+text,public.plain-text,txt,text/plain
+tiff,public.tiff,tiff,image/tiff
+tool,com.apple.terminal.shell-script,command,None
+udif,com.apple.disk-image-udif,dmg,None
+ulaw,public.ulaw-audio,ul,None
+usda,com.pixar.universal-scene-description,usd,None
+usdc,com.pixar.universal-scene-description,usd,None
+usdz,com.pixar.universal-scene-description-mobile,usdz,model/vnd.usdz+zip
+vcal,com.apple.ical.vcs,vcs,text/x-vcalendar
+wave,com.microsoft.waveform-audio,wav,audio/vnd.wave
+wdgt,com.apple.dashboard-widget,wdgt,None
+webp,public.webp,webp,None
+xfdf,com.adobe.xfdf,xfdf,None
+xhtm,public.xhtml,xhtml,application/xhtml+xml
+xlsb,com.microsoft.excel.sheet.binary.macroenabled,xlsb,application/vnd.ms-excel.sheet.binary.macroenabled.12
+xlsm,org.openxmlformats.spreadsheetml.sheet.macroenabled,xlsm,application/vnd.ms-excel.sheet.macroenabled.12
+xlsx,org.openxmlformats.spreadsheetml.sheet,xlsx,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
+xltm,org.openxmlformats.spreadsheetml.template.macroenabled,xltm,application/vnd.ms-excel.template.macroenabled.12
+xltx,org.openxmlformats.spreadsheetml.template,xltx,application/vnd.openxmlformats-officedocument.spreadsheetml.template
+yaml,public.yaml,yml,application/x-yaml
+3gpp,public.3gpp,3gp,video/3gpp
+3gp2,public.3gpp2,3g2,video/3gpp2
+abcdg,com.apple.addressbook.group,abcdg,None
+abcdp,com.apple.addressbook.person,abcdp,None
+afpub,com.seriflabs.affinitypublisher.document,afpub,None
+appex,com.apple.application-and-system-extension,appex,None
+avchd,public.avchd-collection,avchd,None
+blank,com.apple.preview.blank,blank,None
+class,com.sun.java-class,class,None
+crash,com.apple.crashreport,crash,None
+dfont,com.apple.truetype-datafork-suitcase-font,dfont,None
+dicom,org.nema.dicom,dcm,application/dicom
+distz,com.apple.installer-distribution-package,dist,None
+dlyan,public.dylan-source,dlyan,None
+dylib,com.apple.mach-o-dylib,dylib,None
+heics,public.heics,heics,image/heic-sequence
+heifs,public.heifs,heifs,image/heif-sequence
+ichat,com.apple.ichat.transcript,ichat,None
+pages,com.apple.iwork.pages.pages,pages,None
+panic,com.apple.panicreport,panic,None
+paper,com.getdropbox.dropbox.paper,paper,None
+patch,public.patch-file,patch,None
+phtml,public.php-script,php,text/php
+plist,com.apple.property-list,plist,None
+saver,com.apple.systempreference.screen-saver,saver,None
+scptd,com.apple.applescript.script-bundle,scptd,None
+sfont,com.apple.cfr-font,sfont,None
+shtml,public.html,html,text/html
+swift,public.swift-source,swift,None
+toast,com.roxio.disk-image-toast,toast,None
+vcard,public.vcard,vcf,text/directory
+wdmon,com.apple.wireless-diagnostics.wdmon,wdmon,None
+xhtml,public.xhtml,xhtml,application/xhtml+xml
+action,com.apple.automator-action,action,None
+afploc,com.apple.afp-internet-location,afploc,None
+"""
+
+# load CSV separated uti data into dictionaries with key of extension and UTI
+EXT_UTI_DICT = {}
+UTI_EXT_DICT = {}
+
+
+def _load_uti_dict():
+    """load an initialize the cached UTI and extension dicts"""
+    _reader = csv.DictReader(UTI_CSV.split("\n"), delimiter=",")
+    for row in _reader:
+        EXT_UTI_DICT[row["extension"]] = row["UTI"]
+        UTI_EXT_DICT[row["UTI"]] = row["preferred_extension"]
+
+
+_load_uti_dict()
+
+# OS version for determining which methods can be used
+OS_VER, OS_MAJOR, _ = (int(x) for x in _get_os_version())
+
+
+def _get_uti_from_mdls(extension):
+    """use mdls to get the UTI for a given extension on systems that don't support UTTypeCreatePreferredIdentifierForTag
+    Returns: UTI or None if UTI cannot be determined"""
+
+    # mdls -name kMDItemContentType foo.3fr
+    # kMDItemContentType = "com.hasselblad.3fr-raw-image"
+
+    with tempfile.NamedTemporaryFile(suffix="." + extension) as temp:
+        output = subprocess.check_output(
+            [
+                "/usr/bin/mdls",
+                "-name",
+                "kMDItemContentType",
+                temp.name,
+            ]
+        ).splitlines()
+        output = output[0].decode("UTF-8") if output else None
+        if not output:
+            return None
+
+        match = re.match(r'kMDItemContentType\s+\=\s+"(.*)"', output)
+        if match:
+            return match.group(1)
+        return None
+
+
+def _get_uti_from_ext_dict(ext):
+    try:
+        return EXT_UTI_DICT[ext]
+    except KeyError:
+        return None
+
+
+def _get_ext_from_uti_dict(uti):
+    try:
+        return UTI_EXT_DICT[uti]
+    except KeyError:
+        return None
+
+
+def get_preferred_uti_extension(uti):
+    """get preferred extension for a UTI type
+    uti: UTI str, e.g. 'public.jpeg'
+    returns: preferred extension as str or None if cannot be determined"""
+
+    if (OS_VER, OS_MAJOR) <= (10, 16):
+        # reference: https://developer.apple.com/documentation/coreservices/1442744-uttypecopypreferredtagwithclass?language=objc
+        # deprecated in Catalina+, likely won't work at all on macOS 12
+        with objc.autorelease_pool():
+            extension = CoreServices.UTTypeCopyPreferredTagWithClass(
+                uti, CoreServices.kUTTagClassFilenameExtension
+            )
+            if extension:
+                return extension
+
+            # on MacOS 10.12, HEIC files are not supported and UTTypeCopyPreferredTagWithClass will return None for HEIC
+            if uti == "public.heic":
+                return "HEIC"
+
+            return None
+
+    return _get_ext_from_uti_dict(uti)
+
+
+def get_uti_for_extension(extension):
+    """get UTI for a given file extension"""
+
+    # accepts extension with or without leading 0
+    if extension[0] == ".":
+        extension = extension[1:]
+
+    if (OS_VER, OS_MAJOR) <= (10, 16):
+        # https://developer.apple.com/documentation/coreservices/1448939-uttypecreatepreferredidentifierf
+        with objc.autorelease_pool():
+            uti = CoreServices.UTTypeCreatePreferredIdentifierForTag(
+                CoreServices.kUTTagClassFilenameExtension, extension, None
+            )
+            if uti:
+                return uti
+
+            # on MacOS 10.12, HEIC files are not supported and UTTypeCopyPreferredTagWithClass will return None for HEIC
+            if extension.lower() == "heic":
+                return "public.heic"
+
+            return None
+
+    uti = _get_uti_from_ext_dict(extension)
+    if uti:
+        return uti
+
+    uti = _get_uti_from_mdls(extension)
+    if uti:
+        # cache the UTI
+        EXT_UTI_DICT[extension.lower()] = uti
+        UTI_EXT_DICT[uti] = extension.lower()
+        return uti
+
+    return None

osxphotos/utils.py

@@ -19,8 +19,6 @@ from plistlib import load as plistload
 from typing import Callable
 
 import CoreFoundation
-import CoreServices
-import objc
 
 from ._constants import UNICODE_FORMAT
 
@@ -38,7 +36,7 @@ if not _DEBUG:
 
 def _get_logger():
     """Used only for testing
-    
+
     Returns:
         logging.Logger object -- logging.Logger object for osxphotos
     """
@@ -46,7 +44,7 @@ def _get_logger():
 
 
 def _set_debug(debug):
-    """ Enable or disable debug logging """
+    """Enable or disable debug logging"""
     global _DEBUG
     _DEBUG = debug
     if debug:
@@ -56,18 +54,18 @@ def _set_debug(debug):
 
 
 def _debug():
-    """ returns True if debugging turned on (via _set_debug), otherwise, false """
+    """returns True if debugging turned on (via _set_debug), otherwise, false"""
     return _DEBUG
 
 
 def noop(*args, **kwargs):
-    """ do nothing (no operation) """
+    """do nothing (no operation)"""
     pass
 
 
 def lineno(filename):
-    """ Returns string with filename and current line number in caller as '(filename): line_num'
-    Will trim filename to just the name, dropping path, if any. """
+    """Returns string with filename and current line number in caller as '(filename): line_num'
+    Will trim filename to just the name, dropping path, if any."""
     line = inspect.currentframe().f_back.f_lineno
     filename = pathlib.Path(filename).name
     return f"{filename}: {line}"
@@ -92,14 +90,14 @@ def _get_os_version():
 
 
 def _check_file_exists(filename):
-    """ returns true if file exists and is not a directory
-        otherwise returns false """
+    """returns true if file exists and is not a directory
+    otherwise returns false"""
     filename = os.path.abspath(filename)
     return os.path.exists(filename) and not os.path.isdir(filename)
 
 
 def _get_resource_loc(model_id):
-    """ returns folder_id and file_id needed to find location of edited photo """
+    """returns folder_id and file_id needed to find location of edited photo"""
     """ and live photos for version <= Photos 4.0 """
     # determine folder where Photos stores edited version
     # edited images are stored in:
@@ -117,7 +115,7 @@ def _get_resource_loc(model_id):
 
 
 def _dd_to_dms(dd):
-    """ convert lat or lon in decimal degrees (dd) to degrees, minutes, seconds """
+    """convert lat or lon in decimal degrees (dd) to degrees, minutes, seconds"""
     """ return tuple of int(deg), int(min), float(sec) """
     dd = float(dd)
     negative = dd < 0
@@ -136,7 +134,7 @@ def _dd_to_dms(dd):
 
 
 def dd_to_dms_str(lat, lon):
-    """ convert latitude, longitude in degrees to degrees, minutes, seconds as string """
+    """convert latitude, longitude in degrees to degrees, minutes, seconds as string"""
     """ 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") """
@@ -165,7 +163,7 @@ def dd_to_dms_str(lat, lon):
 
 
 def get_system_library_path():
-    """ return the path to the system Photos library as string """
+    """return the path to the system Photos library as string"""
     """ only works on MacOS 10.15 """
     """ on earlier versions, returns None """
     _, major, _ = _get_os_version()
@@ -190,8 +188,8 @@ def get_system_library_path():
 
 
 def get_last_library_path():
-    """ returns the path to the last opened Photos library 
-        If a library has never been opened, returns None """
+    """returns the path to the last opened Photos library
+    If a library has never been opened, returns None"""
     plist_file = pathlib.Path(
         str(pathlib.Path.home())
         + "/Library/Containers/com.apple.Photos/Data/Library/Preferences/com.apple.Photos.plist"
@@ -241,7 +239,7 @@ def get_last_library_path():
 
 
 def list_photo_libraries():
-    """ returns list of Photos libraries found on the system """
+    """returns list of Photos libraries found on the system"""
     """ on MacOS < 10.15, this may omit some libraries """
 
     # On 10.15, mdfind appears to find all libraries
@@ -265,22 +263,10 @@ def list_photo_libraries():
     return lib_list
 
 
-def get_preferred_uti_extension(uti):
-    """ get preferred extension for a UTI type
-        uti: UTI str, e.g. 'public.jpeg'
-        returns: preferred extension as str """
-
-    # reference: https://developer.apple.com/documentation/coreservices/1442744-uttypecopypreferredtagwithclass?language=objc
-    with objc.autorelease_pool():
-        return CoreServices.UTTypeCopyPreferredTagWithClass(
-            uti, CoreServices.kUTTagClassFilenameExtension
-        )
-
-
 def findfiles(pattern, path_):
     """Returns list of filenames from path_ matched by pattern
-       shell pattern. Matching is case-insensitive.
-       If 'path_' is invalid/doesn't exist, returns []."""
+    shell pattern. Matching is case-insensitive.
+    If 'path_' is invalid/doesn't exist, returns []."""
     if not os.path.isdir(path_):
         return []
     # See: https://gist.github.com/techtonik/5694830
@@ -289,26 +275,9 @@ def findfiles(pattern, path_):
     return [name for name in os.listdir(path_) if rule.match(name)]
 
 
-# TODO: this doesn't always work, still looking for a way to
-# force Photos to open the library being operated on
-# def _open_photos_library_applescript(library_path):
-#     """ Force Photos to open a specific library
-#         library_path: path to the Photos library """
-#     open_scpt = AppleScript(
-#         f"""
-#         on openLibrary
-#             tell application "Photos"
-# 	          open POSIX file "{library_path}"
-#             end tell
-#         end openLibrary
-#         """
-#     )
-#     open_scpt.run()
-
-
 def _open_sql_file(dbname):
-    """ opens sqlite file dbname in read-only mode
-        returns tuple of (connection, cursor) """
+    """opens sqlite file dbname in read-only mode
+    returns tuple of (connection, cursor)"""
     try:
         dbpath = pathlib.Path(dbname).resolve()
         conn = sqlite3.connect(f"{dbpath.as_uri()}?mode=ro", timeout=1, uri=True)
@@ -319,9 +288,9 @@ def _open_sql_file(dbname):
 
 
 def _db_is_locked(dbname):
-    """ check to see if a sqlite3 db is locked
-        returns True if database is locked, otherwise False
-        dbname: name of database to test """
+    """check to see if a sqlite3 db is locked
+    returns True if database is locked, otherwise False
+    dbname: name of database to test"""
 
     # first, check to see if lock file exists, if so, assume the file is locked
     lock_name = f"{dbname}.lock"
@@ -372,7 +341,7 @@ def _db_is_locked(dbname):
 
 
 def normalize_unicode(value):
-    """ normalize unicode data """
+    """normalize unicode data"""
     if value is not None:
         if isinstance(value, (tuple, list)):
             return tuple(unicodedata.normalize(UNICODE_FORMAT, v) for v in value)
@@ -385,9 +354,9 @@ def normalize_unicode(value):
 
 
 def increment_filename(filepath):
-    """ Return filename (1).ext, etc if filename.ext exists
+    """Return filename (1).ext, etc if filename.ext exists
 
-        If file exists in filename's parent folder with same stem as filename, 
+        If file exists in filename's parent folder with same stem as filename,
         add (1), (2), etc. until a non-existing filename is found.
 
     Args:
@@ -410,8 +379,22 @@ def increment_filename(filepath):
     return str(dest)
 
 
+def expand_and_validate_filepath(path: str) -> str:
+    """validate and expand ~ in filepath, also un-escapes spaces
+
+    Returns:
+        expanded path if path is valid file, else None
+    """
+
+    path = re.sub(r"\\ ", " ", path)
+    path = pathlib.Path(path).expanduser()
+    if path.is_file():
+        return str(path)
+    return None
+
+
 def load_function(pyfile: str, function_name: str) -> Callable:
-    """ Load function_name from python file pyfile """
+    """Load function_name from python file pyfile"""
     module_file = pathlib.Path(pyfile)
     if not module_file.is_file():
         raise FileNotFoundError(f"module {pyfile} does not appear to exist")

requirements.txt

@@ -1,211 +1,22 @@
-aiohttp==4.0.0a1
-altgraph==0.17
-ansimarkup==1.4.0
-appdirs==1.4.3
-appnope==0.1.0
-astroid==2.2.5
-async-timeout==3.0.1
-atomicwrites==1.3.0
-attrs==19.1.0
-backcall==0.1.0
-better-exceptions-fork==0.2.1.post6
-bitmath==1.3.3.1
-bleach==3.3.0
+pyobjc-core==7.2
+pyobjc-framework-AppleScriptKit==7.2
+pyobjc-framework-AppleScriptObjC==7.2
+pyobjc-framework-Photos==7.2
+pyobjc-framework-Quartz==7.2
+pyobjc-framework-AVFoundation==7.2
+pyobjc-framework-CoreServices==7.2
+pyobjc-framework-Metal==7.2
+Click==8.0.1
+PyYAML==5.4.1
+Mako==1.1.4
 bpylist2==3.0.2
-certifi==2020.4.5.1
-cffi==1.14.0
-chardet==3.0.4
-Click==7.0
-colorama==0.4.1
-coverage==4.5.4
-decorator==4.4.2
-distlib==0.3.1
-docutils==0.16
-entrypoints==0.3
-filelock==3.0.12
-idna==2.9
-importlib-metadata==1.6.0
-ipykernel==5.1.4
-ipython==7.13.0
-ipython-genutils==0.2.0
-isort==4.3.20
-jedi==0.16.0
-jupyter-client==6.1.2
-jupyter-core==4.6.3
-keyring==21.2.0
-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
-multidict==4.7.6
-osxmetadata>=0.99.11
-packaging==19.0
-parso==0.6.2
-pathspec==0.7.0
-pathvalidate==2.2.1
-pexpect==4.8.0
-photoscript==0.1.2
-pickleshare==0.7.5
-Pillow==8.1.1
-pkginfo==1.5.0.1
-pluggy==0.12.0
-prompt-toolkit==3.0.4
-psutil==5.7.0
-ptyprocess==0.6.0
-py==1.10.0
-py2app==0.21
-pycparser==2.20
-pyfiglet==0.8.post1
-Pygments==2.7.4
-PyInstaller==3.6
-pyinstaller-setuptools==2019.3
-pylint==2.3.1
-pyobjc==6.2.2
-pyobjc-core==6.2.2
-pyobjc-framework-Accounts==6.2.2
-pyobjc-framework-AddressBook==6.2.2
-pyobjc-framework-AdSupport==6.2.2
-pyobjc-framework-AppleScriptKit==6.2.2
-pyobjc-framework-AppleScriptObjC==6.2.2
-pyobjc-framework-ApplicationServices==6.2.2
-pyobjc-framework-AuthenticationServices==6.2.2
-pyobjc-framework-AutomaticAssessmentConfiguration==6.2.2
-pyobjc-framework-Automator==6.2.2
-pyobjc-framework-AVFoundation==6.2.2
-pyobjc-framework-AVKit==6.2.2
-pyobjc-framework-BusinessChat==6.2.2
-pyobjc-framework-CalendarStore==6.2.2
-pyobjc-framework-CFNetwork==6.2.2
-pyobjc-framework-CloudKit==6.2.2
-pyobjc-framework-Cocoa==6.2.2
-pyobjc-framework-Collaboration==6.2.2
-pyobjc-framework-ColorSync==6.2.2
-pyobjc-framework-Contacts==6.2.2
-pyobjc-framework-ContactsUI==6.2.2
-pyobjc-framework-CoreAudio==6.2.2
-pyobjc-framework-CoreAudioKit==6.2.2
-pyobjc-framework-CoreBluetooth==6.2.2
-pyobjc-framework-CoreData==6.2.2
-pyobjc-framework-CoreHaptics==6.2.2
-pyobjc-framework-CoreLocation==6.2.2
-pyobjc-framework-CoreMedia==6.2.2
-pyobjc-framework-CoreMediaIO==6.2.2
-pyobjc-framework-CoreML==6.2.2
-pyobjc-framework-CoreMotion==6.2.2
-pyobjc-framework-CoreServices==6.2.2
-pyobjc-framework-CoreSpotlight==6.2.2
-pyobjc-framework-CoreText==6.2.2
-pyobjc-framework-CoreWLAN==6.2.2
-pyobjc-framework-CryptoTokenKit==6.2.2
-pyobjc-framework-DeviceCheck==6.2.2
-pyobjc-framework-DictionaryServices==6.2.2
-pyobjc-framework-DiscRecording==6.2.2
-pyobjc-framework-DiscRecordingUI==6.2.2
-pyobjc-framework-DiskArbitration==6.2.2
-pyobjc-framework-DVDPlayback==6.2.2
-pyobjc-framework-EventKit==6.2.2
-pyobjc-framework-ExceptionHandling==6.2.2
-pyobjc-framework-ExecutionPolicy==6.2.2
-pyobjc-framework-ExternalAccessory==6.2.2
-pyobjc-framework-FileProvider==6.2.2
-pyobjc-framework-FileProviderUI==6.2.2
-pyobjc-framework-FinderSync==6.2.2
-pyobjc-framework-FSEvents==6.2.2
-pyobjc-framework-GameCenter==6.2.2
-pyobjc-framework-GameController==6.2.2
-pyobjc-framework-GameKit==6.2.2
-pyobjc-framework-GameplayKit==6.2.2
-pyobjc-framework-ImageCaptureCore==6.2.2
-pyobjc-framework-IMServicePlugIn==6.2.2
-pyobjc-framework-InputMethodKit==6.2.2
-pyobjc-framework-InstallerPlugins==6.2.2
-pyobjc-framework-InstantMessage==6.2.2
-pyobjc-framework-Intents==6.2.2
-pyobjc-framework-IOSurface==6.2.2
-pyobjc-framework-iTunesLibrary==6.2.2
-pyobjc-framework-LatentSemanticMapping==6.2.2
-pyobjc-framework-LaunchServices==6.2.2
-pyobjc-framework-libdispatch==6.2.2
-pyobjc-framework-LinkPresentation==6.2.2
-pyobjc-framework-LocalAuthentication==6.2.2
-pyobjc-framework-MapKit==6.2.2
-pyobjc-framework-MediaAccessibility==6.2.2
-pyobjc-framework-MediaLibrary==6.2.2
-pyobjc-framework-MediaPlayer==6.2.2
-pyobjc-framework-MediaToolbox==6.2.2
-pyobjc-framework-Metal==6.2.2
-pyobjc-framework-MetalKit==6.2.2
-pyobjc-framework-ModelIO==6.2.2
-pyobjc-framework-MultipeerConnectivity==6.2.2
-pyobjc-framework-NaturalLanguage==6.2.2
-pyobjc-framework-NetFS==6.2.2
-pyobjc-framework-Network==6.2.2
-pyobjc-framework-NetworkExtension==6.2.2
-pyobjc-framework-NotificationCenter==6.2.2
-pyobjc-framework-OpenDirectory==6.2.2
-pyobjc-framework-OSAKit==6.2.2
-pyobjc-framework-OSLog==6.2.2
-pyobjc-framework-PencilKit==6.2.2
-pyobjc-framework-Photos==6.2.2
-pyobjc-framework-PhotosUI==6.2.2
-pyobjc-framework-PreferencePanes==6.2.2
-pyobjc-framework-PubSub==6.2
-pyobjc-framework-PushKit==6.2.2
-pyobjc-framework-QTKit==6.0.1
-pyobjc-framework-Quartz==6.2.2
-pyobjc-framework-QuickLookThumbnailing==6.2.2
-pyobjc-framework-SafariServices==6.2.2
-pyobjc-framework-SceneKit==6.2.2
-pyobjc-framework-ScreenSaver==6.2.2
-pyobjc-framework-ScriptingBridge==6.2.2
-pyobjc-framework-SearchKit==6.2.2
-pyobjc-framework-Security==6.2.2
-pyobjc-framework-SecurityFoundation==6.2.2
-pyobjc-framework-SecurityInterface==6.2.2
-pyobjc-framework-ServiceManagement==6.2.2
-pyobjc-framework-Social==6.2.2
-pyobjc-framework-SoundAnalysis==6.2.2
-pyobjc-framework-Speech==6.2.2
-pyobjc-framework-SpriteKit==6.2.2
-pyobjc-framework-StoreKit==6.2.2
-pyobjc-framework-SyncServices==6.2.2
-pyobjc-framework-SystemConfiguration==6.2.2
-pyobjc-framework-SystemExtensions==6.2.2
-pyobjc-framework-UserNotifications==6.2.2
-pyobjc-framework-VideoSubscriberAccount==6.2.2
-pyobjc-framework-VideoToolbox==6.2.2
-pyobjc-framework-Vision==6.2.2
-pyobjc-framework-WebKit==6.2.2
-pyparsing==2.4.1.1
-python-dateutil==2.8.1
-PyYAML==5.4
-pyzmq==18.1.1
-readme-renderer==25.0
-regex==2020.2.20
-requests==2.23.0
-requests-toolbelt==0.9.1
-rich==9.11.1
-six==1.14.0
-termcolor==1.1.0
+pathvalidate==2.4.1
+dataclasses==0.7;python_version<'3.7'
+wurlitzer==2.1.0
+photoscript==0.1.3
+toml==0.10.2
+osxmetadata==0.99.14
 textx==2.3.0
-toml==0.10.0
-tornado==6.0.4
-tox==3.19.0
-tox-conda==0.2.1
-tqdm==4.45.0
-traitlets==4.3.3
-twine==3.1.1
-typed-ast==1.4.1
-typing-extensions==3.7.4.2
-urllib3==1.25.9
-virtualenv==20.0.30
-wcwidth==0.1.9
-webencodings==0.5.1
-wrapt==1.11.1
-wurlitzer==2.0.1
-yarl==1.4.2
-zipp==0.5.2
+rich==10.2.2
+bitmath==1.3.3.1
+more-itertools==8.8.0 

setup.py

@@ -73,20 +73,28 @@ setup(
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
     install_requires=[
-        "pyobjc>=6.2.2",
-        "Click>=7",
-        "PyYAML>=5.1.2",
-        "Mako>=1.1.1",
+        "pyobjc-core==7.2",
+        "pyobjc-framework-AppleScriptKit==7.2",
+        "pyobjc-framework-AppleScriptObjC==7.2",
+        "pyobjc-framework-Photos==7.2",
+        "pyobjc-framework-Quartz==7.2",
+        "pyobjc-framework-AVFoundation==7.2",
+        "pyobjc-framework-CoreServices==7.2",
+        "pyobjc-framework-Metal==7.2",
+        "Click==8.0.1",
+        "PyYAML==5.4.1",
+        "Mako==1.1.4",
         "bpylist2==3.0.2",
-        "pathvalidate==2.2.1",
+        "pathvalidate==2.4.1",
         "dataclasses==0.7;python_version<'3.7'",
-        "wurlitzer>=2.0.1",
-        "photoscript>=0.1.2",
-        "toml>=0.10.0",
-        "osxmetadata>=0.99.13",
+        "wurlitzer==2.1.0",
+        "photoscript==0.1.3",
+        "toml==0.10.2",
+        "osxmetadata==0.99.14",
         "textx==2.3.0",
-        "rich>=9.11.1",
+        "rich==10.2.2",
         "bitmath==1.3.3.1",
+        "more-itertools==8.8.0",
     ],
     entry_points={"console_scripts": ["osxphotos=osxphotos.__main__:cli"]},
     include_package_data=True,

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

@@ -5,7 +5,7 @@
 	<key>LithiumMessageTracer</key>
 	<dict>
 		<key>LastReportedDate</key>
-		<date>2020-04-17T18:39:50Z</date>
+		<date>2021-06-01T17:42:08Z</date>
 	</dict>
 	<key>PXPeopleScreenUnlocked</key>
 	<true/>

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

@@ -11,6 +11,6 @@
 	<key>PLLastRevGeoForcedProviderOutOfDateCheckVersionKey</key>
 	<integer>1</integer>
 	<key>PLLastRevGeoVerFileFetchDateKey</key>
-	<date>2020-04-17T18:39:52Z</date>
+	<date>2021-06-01T17:42:08Z</date>
 </dict>
 </plist>

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

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>LastHistoryRowId</key>
-	<integer>502</integer>
+	<integer>517</integer>
 	<key>LibraryBuildTag</key>
 	<string>E3E46F2A-7168-4973-AB3E-5848F80BFC7D</string>
 	<key>LibrarySchemaVersion</key>

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

@@ -5,9 +5,9 @@
 	<key>hostname</key>
 	<string>Rhets-MacBook-Pro.local</string>
 	<key>hostuuid</key>
-	<string>9575E48B-8D5F-5654-ABAC-4431B1167324</string>
+	<string>585B80BF-8D1F-55EF-A9E8-6CF4E5523959</string>
 	<key>pid</key>
-	<integer>86501</integer>
+	<integer>570</integer>
 	<key>processname</key>
 	<string>photolibraryd</string>
 	<key>uid</key>