Updated README.md [skip ci]

* 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,15 @@
         "example",
         "ideas"
       ]
+    },
+    {
+      "login": "kaduskj",
+      "name": "kaduskj",
+      "avatar_url": "https://avatars.githubusercontent.com/u/983067?v=4",
+      "profile": "https://github.com/kaduskj",
+      "contributions": [
+        "bug"
+      ]
     }
   ],
   "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

@@ -4,7 +4,7 @@
 [![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](https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 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 +35,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 +50,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 +121,7 @@ This package will install a command line utility called `osxphotos` that allows
 
 ```
 > osxphotos
+
 Usage: osxphotos [OPTIONS] COMMAND [ARGS]...
 
 Options:
@@ -145,6 +150,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>`
@@ -481,6 +488,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!):
@@ -575,6 +616,10 @@ Options:
                                   geolocation info
   --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
@@ -646,6 +691,14 @@ Options:
   --in-album                      Search for photos that are in one or more
                                   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
@@ -680,6 +733,22 @@ Options:
                                   https://rhettbull.github.io/osxphotos/ for
                                   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.
   --deleted                       Include photos from the 'Recently Deleted'
@@ -741,19 +810,25 @@ Options:
                                   the library if a photo is a burst photo.
   --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
                                   with Photos 5, all photos are renamed upon
                                   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
@@ -1000,6 +1075,36 @@ Options:
                                   feature is currently experimental.  I don't
                                   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,
@@ -1157,6 +1262,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                 
@@ -1496,7 +1603,7 @@ 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.22'
+{osxphotos_version}             The osxphotos version, e.g. '0.42.46'
 {osxphotos_cmd_line}            The full command line used to run osxphotos
 
 The following substitutions may result in multiple values. Thus if specified for
@@ -1555,6 +1662,10 @@ Substitution             Description
                          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
@@ -1565,6 +1676,103 @@ Substitution             Description
                          /blob/master/examples/template_function.py for an
                          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 -->
@@ -2347,7 +2555,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. 
 
@@ -2360,7 +2568,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".
 
@@ -2378,14 +2586,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`.
 
@@ -2394,6 +2595,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.
 
@@ -3021,6 +3225,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 -->
 
@@ -3197,7 +3402,7 @@ 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.22'|
+|{osxphotos_version}|The osxphotos version, e.g. '0.42.46'|
 |{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|
@@ -3212,9 +3417,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
@@ -3351,6 +3617,7 @@ 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>
   </tr>
 </table>
 
@@ -3391,6 +3658,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>``
 

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

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/_constants.py

@@ -70,6 +70,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
@@ -212,8 +214,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.23"
+__version__ = "0.42.46"

osxphotos/cli.py

@@ -1,5 +1,6 @@
 """Command line interface for osxphotos """
 
+import code
 import csv
 import datetime
 import json
@@ -7,15 +8,16 @@ import os
 import os.path
 import pathlib
 import pprint
+import shlex
+import subprocess
 import sys
 import time
-import unicodedata
 
 import bitmath
 import click
 import osxmetadata
-import photoscript
 import yaml
+from rich import pretty
 
 import osxphotos
 
@@ -33,13 +35,13 @@ from ._constants import (
     EXTENDED_ATTRIBUTE_NAMES_QUOTED,
     OSXPHOTOS_EXPORT_DB,
     OSXPHOTOS_URL,
+    POST_COMMAND_CATEGORIES,
     SIDECAR_EXIFTOOL,
     SIDECAR_JSON,
     SIDECAR_XMP,
-    UNICODE_FORMAT,
 )
 from ._version import __version__
-from .cli_help import ExportCommand
+from .cli_help import ExportCommand, tutorial_help
 from .configoptions import (
     ConfigOptions,
     ConfigOptionsInvalidError,
@@ -52,9 +54,10 @@ from .fileutil import FileUtil, FileUtilNoOp
 from .path_utils import is_valid_filepath, sanitize_filename, sanitize_filepath
 from .photoinfo import ExportResults
 from .photokit import check_photokit_authorization, request_photokit_authorization
-from .queryoptions import QueryOptions
-from .utils import get_preferred_uti_extension
 from .photosalbum import PhotosAlbum
+from .phototemplate import PhotoTemplate, RenderOptions
+from .queryoptions import QueryOptions
+from .utils import get_preferred_uti_extension, load_function, expand_and_validate_filepath
 
 # global variable to control verbose output
 # set via --verbose/-V
@@ -62,7 +65,7 @@ VERBOSE = False
 
 
 def verbose_(*args, **kwargs):
-    """ print output if verbose flag set """
+    """print output if verbose flag set"""
     if VERBOSE:
         styled_args = []
         for arg in args:
@@ -117,7 +120,7 @@ class DateTimeISO8601(click.ParamType):
             return datetime.datetime.fromisoformat(value)
         except Exception:
             self.fail(
-                f"Invalid value for --{param.name}: invalid datetime format {value}. "
+                f"Invalid datetime format {value}. "
                 "Valid format: YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]"
             )
 
@@ -151,12 +154,36 @@ class TimeISO8601(click.ParamType):
             return datetime.time.fromisoformat(value).replace(tzinfo=None)
         except Exception:
             self.fail(
-                f"Invalid value for --{param.name}: invalid time format {value}. "
+                f"Invalid time format {value}. "
                 "Valid format: HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]] "
                 "however, note that timezone will be ignored."
             )
 
 
+class FunctionCall(click.ParamType):
+    name = "FUNCTION"
+
+    def convert(self, value, param, ctx):
+        if "::" not in value:
+            self.fail(
+                f"Could not parse function name from '{value}'. "
+                "Valid format filename.py::function"
+            )
+
+        filename, funcname = value.split("::")
+
+        filename_validated = expand_and_validate_filepath(filename)
+        if not filename_validated:
+            self.fail(f"'{filename}' does not appear to be a file")
+
+        try:
+            function = load_function(filename_validated, funcname)
+        except Exception as e:
+            self.fail(f"Could not load function {funcname} from {filename_validated}")
+
+        return (function, value)
+
+
 # Click CLI object & context settings
 class CLI_Obj:
     def __init__(self, db=None, json=False, debug=False):
@@ -306,6 +333,16 @@ def QUERY_OPTIONS(f):
             is_flag=True,
             help="Search for photos with no associated place name info (no reverse geolocation info)",
         ),
+        o(
+            "--location",
+            is_flag=True,
+            help="Search for photos with associated location info (e.g. GPS coordinates)",
+        ),
+        o(
+            "--no-location",
+            is_flag=True,
+            help="Search for photos with no associated location info (e.g. no GPS coordinates)",
+        ),
         o(
             "--label",
             metavar="LABEL",
@@ -458,6 +495,14 @@ def QUERY_OPTIONS(f):
             is_flag=True,
             help="Search for photos that are not in any albums.",
         ),
+        o(
+            "--duplicate",
+            is_flag=True,
+            help="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.",
+        ),
         o(
             "--min-size",
             metavar="SIZE",
@@ -499,6 +544,18 @@ def QUERY_OPTIONS(f):
             "CRITERIA must be a valid python expression. "
             "See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.",
         ),
+        o(
+            "--query-function",
+            metavar="filename.py::function",
+            multiple=True,
+            type=FunctionCall(),
+            help="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/osxphotos/blob/master/examples/query_function.py for example of how to use this option.",
+        ),
     ]
     for o in options[::-1]:
         f = o(f)
@@ -614,9 +671,9 @@ def cli(ctx, db, json_, debug):
 @click.option(
     "--skip-raw",
     is_flag=True,
-    help="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).",
+    help="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).",
 )
 @click.option(
     "--current-name",
@@ -628,8 +685,11 @@ def cli(ctx, db, json_, debug):
 @click.option(
     "--convert-to-jpeg",
     is_flag=True,
-    help="Convert all non-jpeg images (e.g. raw, HEIC, PNG, etc) "
-    "to JPEG upon export.  Only works if your Mac has a GPU.",
+    help="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).",
 )
 @click.option(
     "--jpeg-quality",
@@ -904,6 +964,31 @@ def cli(ctx, db, json_, debug):
     "This only works if the Photos library being exported is the last-opened (default) library in Photos. "
     "This feature is currently experimental.  I don't know how well it will work on large export sets.",
 )
+@click.option(
+    "--post-command",
+    metavar="CATEGORY COMMAND",
+    nargs=2,
+    type=(click.Choice(POST_COMMAND_CATEGORIES, case_sensitive=False), str),
+    multiple=True,
+    help="Run COMMAND on exported files of category CATEGORY.  CATEGORY can be one of: "
+    f"{', '.join(list(POST_COMMAND_CATEGORIES.keys()))}. "
+    "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.",
+)
+@click.option(
+    "--post-function",
+    metavar="filename.py::function",
+    nargs=1,
+    type=FunctionCall(),
+    multiple=True,
+    help="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.",
+)
 @click.option(
     "--exportdb",
     metavar="EXPORTDB_FILE",
@@ -1042,6 +1127,8 @@ def export(
     original_suffix,
     place,
     no_place,
+    location,
+    no_location,
     has_comment,
     no_comment,
     has_likes,
@@ -1067,6 +1154,10 @@ def export(
     max_size,
     regex,
     query_eval,
+    query_function,
+    duplicate,
+    post_command,
+    post_function,
 ):
     """Export photos from the Photos database.
     Export path DEST is required.
@@ -1198,6 +1289,8 @@ def export(
         original_suffix = cfg.original_suffix
         place = cfg.place
         no_place = cfg.no_place
+        location = cfg.location
+        no_location = cfg.no_location
         has_comment = cfg.has_comment
         no_comment = cfg.no_comment
         has_likes = cfg.has_likes
@@ -1221,6 +1314,10 @@ def export(
         max_size = cfg.max_size
         regex = cfg.regex
         query_eval = cfg.query_eval
+        query_function = cfg.query_function
+        duplicate = cfg.duplicate
+        post_command = cfg.post_command
+        post_function = cfg.post_function
 
         # config file might have changed verbose
         VERBOSE = bool(verbose)
@@ -1255,6 +1352,7 @@ def export(
         ("has_comment", "no_comment"),
         ("has_likes", "no_likes"),
         ("in_album", "not_in_album"),
+        ("location", "no_location"),
     ]
     dependent_options = [
         ("missing", ("download_missing", "use_photos_export")),
@@ -1508,6 +1606,8 @@ def export(
         has_raw=has_raw,
         place=place,
         no_place=no_place,
+        location=location,
+        no_location=no_location,
         label=label,
         deleted=deleted,
         deleted_only=deleted_only,
@@ -1526,6 +1626,8 @@ def export(
         max_size=max_size,
         regex=regex,
         query_eval=query_eval,
+        function=query_function,
+        duplicate=duplicate,
     )
 
     try:
@@ -1539,12 +1641,12 @@ def export(
         else:
             raise ValueError(e)
 
-    if photos:
-        if only_new:
-            # ignore previously exported files
-            previous_uuids = {uuid: 1 for uuid in export_db.get_previous_uuids()}
-            photos = [p for p in photos if p.uuid not in previous_uuids]
+    if photos and only_new:
+        # ignore previously exported files
+        previous_uuids = {uuid: 1 for uuid in export_db.get_previous_uuids()}
+        photos = [p for p in photos if p.uuid not in previous_uuids]
 
+    if photos:
         num_photos = len(photos)
         # TODO: photos or photo appears several times, pull into a separate function
         photo_str = "photos" if num_photos > 1 else "photo"
@@ -1620,6 +1722,30 @@ def export(
                     jpeg_ext=jpeg_ext,
                     replace_keywords=replace_keywords,
                     retry=retry,
+                    export_dir=dest,
+                )
+
+                if post_function:
+                    for function in post_function:
+                        # post function is tuple of (function, filename.py::function_name)
+                        verbose_(f"Calling post-function {function[1]}")
+                        if not dry_run:
+                            try:
+                                function[0](p, export_results, verbose_)
+                            except Exception as e:
+                                click.secho(
+                                    f"Error running post-function {function[1]}: {e}",
+                                    fg=CLI_COLOR_ERROR,
+                                    err=True,
+                                )
+
+                run_post_command(
+                    photo=p,
+                    post_command=post_command,
+                    export_results=export_results,
+                    export_dir=dest,
+                    dry_run=dry_run,
+                    exiftool_path=exiftool_path,
                 )
 
                 if album_export and export_results.exported:
@@ -1688,13 +1814,18 @@ def export(
                         exiftool_merge_keywords=exiftool_merge_keywords,
                         finder_tag_template=finder_tag_template,
                         strip=strip,
+                        export_dir=dest,
                     )
                     results.xattr_written.extend(tags_written)
                     results.xattr_skipped.extend(tags_skipped)
 
                 if xattr_template:
                     xattr_written, xattr_skipped = write_extended_attributes(
-                        p, photo_files, xattr_template, strip=strip
+                        p,
+                        photo_files,
+                        xattr_template,
+                        strip=strip,
+                        export_dir=dest,
                     )
                     results.xattr_written.extend(xattr_written)
                     results.xattr_skipped.extend(xattr_skipped)
@@ -1768,7 +1899,7 @@ def export(
 @click.argument("topic", default=None, required=False, nargs=1)
 @click.pass_context
 def help(ctx, topic, **kw):
-    """ Print help; for help on commands: help <command>. """
+    """Print help; for help on commands: help <command>."""
     if topic is None:
         click.echo(ctx.parent.get_help())
     elif topic in cli.commands:
@@ -1881,6 +2012,8 @@ def query(
     has_raw,
     place,
     no_place,
+    location,
+    no_location,
     label,
     deleted,
     deleted_only,
@@ -1891,10 +2024,12 @@ def query(
     is_reference,
     in_album,
     not_in_album,
+    duplicate,
     min_size,
     max_size,
     regex,
     query_eval,
+    query_function,
     add_to_album,
 ):
     """Query the Photos database using 1 or more search options;
@@ -1923,9 +2058,11 @@ def query(
         label,
         is_reference,
         query_eval,
+        query_function,
         min_size,
         max_size,
         regex,
+        duplicate,
     ]
     exclusive = [
         (favorite, not_favorite),
@@ -1951,6 +2088,7 @@ def query(
         (has_comment, no_comment),
         (has_likes, no_likes),
         (in_album, not_in_album),
+        (location, no_location),
     ]
     # print help if no non-exclusive term or a double exclusive term is given
     if any(all(bb) for bb in exclusive) or not any(
@@ -2036,6 +2174,8 @@ def query(
         has_raw=has_raw,
         place=place,
         no_place=no_place,
+        location=location,
+        no_location=no_location,
         label=label,
         deleted=deleted,
         deleted_only=deleted_only,
@@ -2050,7 +2190,9 @@ def query(
         min_size=min_size,
         max_size=max_size,
         query_eval=query_eval,
+        function=query_function,
         regex=regex,
+        duplicate=duplicate,
     )
 
     try:
@@ -2079,7 +2221,7 @@ def query(
             album_query.add_list(photos)
         except Exception as e:
             click.secho(
-                f"Error adding photos to album {add_to_album}",
+                f"Error adding photos to album {add_to_album}: {e}",
                 fg=CLI_COLOR_ERROR,
                 err=True,
             )
@@ -2233,6 +2375,7 @@ def export_photo(
     jpeg_ext=None,
     replace_keywords=False,
     retry=0,
+    export_dir=None,
 ):
     """Helper function for export that does the actual export
 
@@ -2273,6 +2416,7 @@ def export_photo(
         jpeg_ext: if not None, specify the extension to use for all JPEG images on export
         replace_keywords: if True, --keyword-template replaces keywords instead of adding keywords
         retry: retry up to retry # of times if there's an error
+        export_dir: top-level export directory for {export_dir} template
 
     Returns:
         list of path(s) of exported photo or None if photo was missing
@@ -2336,9 +2480,8 @@ def export_photo(
     rendered_suffix = ""
     if original_suffix:
         try:
-            rendered_suffix, unmatched = photo.render_template(
-                original_suffix, filename=True, strip=strip
-            )
+            options = RenderOptions(filename=True, strip=strip, export_dir=dest)
+            rendered_suffix, unmatched = photo.render_template(original_suffix, options)
         except ValueError as e:
             raise click.BadOptionUsage(
                 "original_suffix",
@@ -2432,6 +2575,7 @@ def export_photo(
             jpeg_ext=jpeg_ext,
             replace_keywords=replace_keywords,
             retry=retry,
+            export_dir=export_dir,
         )
 
     if export_edited and photo.hasadjustments:
@@ -2465,8 +2609,13 @@ def export_photo(
 
             if edited_suffix:
                 try:
+                    options = RenderOptions(
+                        filename=True,
+                        strip=strip,
+                        export_dir=dest,
+                    )
                     rendered_suffix, unmatched = photo.render_template(
-                        edited_suffix, filename=True, strip=strip
+                        edited_suffix, options
                     )
                 except ValueError as e:
                     raise click.BadOptionUsage(
@@ -2531,6 +2680,7 @@ def export_photo(
                 jpeg_ext=jpeg_ext,
                 replace_keywords=replace_keywords,
                 retry=retry,
+                export_dir=export_dir,
             )
 
     return results
@@ -2575,8 +2725,9 @@ def export_photo_with_template(
     jpeg_ext,
     replace_keywords,
     retry,
+    export_dir,
 ):
-    """ Evaluate directory template then export photo to each directory """
+    """Evaluate directory template then export photo to each directory"""
 
     results = ExportResults()
 
@@ -2625,6 +2776,8 @@ def export_photo_with_template(
                 results.missing.append(str(pathlib.Path(dest_path) / filename))
                 continue
 
+        render_options = RenderOptions(export_dir=export_dir)
+
         tries = 0
         while tries <= retry:
             tries += 1
@@ -2662,6 +2815,7 @@ def export_photo_with_template(
                     exiftool_flags=exiftool_option,
                     jpeg_ext=jpeg_ext,
                     replace_keywords=replace_keywords,
+                    render_options=render_options,
                 )
                 for warning_ in export_results.exiftool_warning:
                     verbose_(f"exiftool warning for file {warning_[0]}: {warning_[1]}")
@@ -2723,7 +2877,11 @@ def export_photo_with_template(
 
 
 def get_filenames_from_template(
-    photo, filename_template, original_name, strip=False, edited=False
+    photo,
+    filename_template,
+    original_name,
+    strip=False,
+    edited=False,
 ):
     """get list of export filenames for a photo
 
@@ -2743,13 +2901,13 @@ def get_filenames_from_template(
     if filename_template:
         photo_ext = pathlib.Path(photo.original_filename).suffix
         try:
-            filenames, unmatched = photo.render_template(
-                filename_template,
+            options = RenderOptions(
                 path_sep="_",
                 filename=True,
                 strip=strip,
-                edited=edited,
+                edited_version=edited,
             )
+            filenames, unmatched = photo.render_template(filename_template, options)
         except ValueError as e:
             raise click.BadOptionUsage(
                 "filename_template", f"Invalid template '{filename_template}': {e}"
@@ -2803,9 +2961,8 @@ def get_dirnames_from_template(
     elif directory:
         # got a directory template, render it and check results are valid
         try:
-            dirnames, unmatched = photo.render_template(
-                directory, dirname=True, strip=strip, edited=edited
-            )
+            options = RenderOptions(dirname=True, strip=strip, edited_version=edited)
+            dirnames, unmatched = photo.render_template(directory, options)
         except ValueError as e:
             raise click.BadOptionUsage(
                 "directory", f"Invalid template '{directory}': {e}"
@@ -3086,6 +3243,7 @@ def write_finder_tags(
     exiftool_merge_keywords=None,
     finder_tag_template=None,
     strip=False,
+    export_dir=None,
 ):
     """Write Finder tags (extended attributes) to files; only writes attributes if attributes on file differ from what would be written
 
@@ -3098,6 +3256,7 @@ def write_finder_tags(
         person_keyword: if True, use person in image as keywords
         exiftool_merge_keywords: if True, include any keywords in the exif data of the source image as keywords
         finder_tag_template: list of templates to evaluate for determining Finder tags
+        export_dir: value to use for {export_dir} template
 
     Returns:
         (list of file paths that were updated with new Finder tags, list of file paths skipped because Finder tags didn't need updating)
@@ -3124,12 +3283,13 @@ def write_finder_tags(
         rendered_tags = []
         for template_str in finder_tag_template:
             try:
-                rendered, unmatched = photo.render_template(
-                    template_str,
+                options = RenderOptions(
                     none_str=_OSXPHOTOS_NONE_SENTINEL,
                     path_sep="/",
                     strip=strip,
+                    export_dir=export_dir,
                 )
+                rendered, unmatched = photo.render_template(template_str, options)
             except ValueError as e:
                 raise click.BadOptionUsage(
                     "finder_tag_template",
@@ -3166,13 +3326,16 @@ def write_finder_tags(
     return (written, skipped)
 
 
-def write_extended_attributes(photo, files, xattr_template, strip=False):
-    """ Writes extended attributes to exported files
+def write_extended_attributes(
+    photo, files, xattr_template, strip=False, export_dir=None
+):
+    """Writes extended attributes to exported files
 
     Args:
         photo: a PhotoInfo object
-        xattr_template: list of tuples: (attribute name, attribute template)
-    
+        strip:   xattr_template: list of tuples: (attribute name, attribute template)
+        export_dir: value to use for {export_dir} template
+
     Returns:
         tuple(list of file paths that were updated with new attributes, list of file paths skipped because attributes didn't need updating)
     """
@@ -3180,12 +3343,13 @@ def write_extended_attributes(photo, files, xattr_template, strip=False):
     attributes = {}
     for xattr, template_str in xattr_template:
         try:
-            rendered, unmatched = photo.render_template(
-                template_str,
+            options = RenderOptions(
                 none_str=_OSXPHOTOS_NONE_SENTINEL,
                 path_sep="/",
                 strip=strip,
+                export_dir=export_dir,
             )
+            rendered, unmatched = photo.render_template(template_str, options)
         except ValueError as e:
             raise click.BadOptionUsage(
                 "xattr_template",
@@ -3234,6 +3398,46 @@ def write_extended_attributes(photo, files, xattr_template, strip=False):
     return list(written), [f for f in skipped if f not in written]
 
 
+def run_post_command(
+    photo, post_command, export_results, export_dir, dry_run, exiftool_path
+):
+    # todo: pass in RenderOptions from export? (e.g. so it contains strip, etc?)
+    # todo: need a shell_quote template type:
+    # {shell_quote,{filepath}/foo/bar}
+    # that quotes everything in the default value
+    for category, command_template in post_command:
+        files = getattr(export_results, category)
+        for f in files:
+            # some categories, like error, return a tuple of (file, error str)
+            if isinstance(f, tuple):
+                f = f[0]
+            render_options = RenderOptions(export_dir=export_dir, filepath=f)
+            template = PhotoTemplate(photo, exiftool_path=exiftool_path)
+            command, _ = template.render(command_template, options=render_options)
+            command = command[0] if command else None
+            if command:
+                verbose_(f'Running command: "{command}"')
+                if not dry_run:
+                    args = shlex.split(command)
+                    cwd = pathlib.Path(f).parent
+                    run_error = None
+                    run_results = None
+                    try:
+                        run_results = subprocess.run(command, shell=True, cwd=cwd)
+                    except Exception as e:
+                        run_error = e
+                    finally:
+                        run_error = run_error or run_results.returncode
+                        if run_error:
+                            click.echo(
+                                click.style(
+                                    f'Error running command "{command}": {run_error}',
+                                    fg=CLI_COLOR_ERROR,
+                                ),
+                                err=True,
+                            )
+
+
 @cli.command(hidden=True)
 @DB_OPTION
 @DB_ARGUMENT
@@ -3254,7 +3458,7 @@ def write_extended_attributes(photo, files, xattr_template, strip=False):
 @click.pass_obj
 @click.pass_context
 def debug_dump(ctx, cli_obj, db, photos_library, dump, uuid, verbose):
-    """ Print out debug info """
+    """Print out debug info"""
 
     global VERBOSE
     VERBOSE = bool(verbose)
@@ -3325,7 +3529,7 @@ def debug_dump(ctx, cli_obj, db, photos_library, dump, uuid, verbose):
 @click.pass_obj
 @click.pass_context
 def keywords(ctx, cli_obj, db, json_, photos_library):
-    """ Print out keywords found in the Photos library. """
+    """Print out keywords found in the Photos library."""
 
     # below needed for to make CliRunner work for testing
     cli_db = cli_obj.db if cli_obj is not None else None
@@ -3351,7 +3555,7 @@ def keywords(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def albums(ctx, cli_obj, db, json_, photos_library):
-    """ Print out albums found in the Photos library. """
+    """Print out albums found in the Photos library."""
 
     # below needed for to make CliRunner work for testing
     cli_db = cli_obj.db if cli_obj is not None else None
@@ -3380,7 +3584,7 @@ def albums(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def persons(ctx, cli_obj, db, json_, photos_library):
-    """ Print out persons (faces) found in the Photos library. """
+    """Print out persons (faces) found in the Photos library."""
 
     # below needed for to make CliRunner work for testing
     cli_db = cli_obj.db if cli_obj is not None else None
@@ -3406,7 +3610,7 @@ def persons(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def labels(ctx, cli_obj, db, json_, photos_library):
-    """ Print out image classification labels found in the Photos library. """
+    """Print out image classification labels found in the Photos library."""
 
     # below needed for to make CliRunner work for testing
     cli_db = cli_obj.db if cli_obj is not None else None
@@ -3432,7 +3636,7 @@ def labels(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def info(ctx, cli_obj, db, json_, photos_library):
-    """ Print out descriptive info of the Photos library database. """
+    """Print out descriptive info of the Photos library database."""
 
     db = get_photos_db(*photos_library, db, cli_obj.db)
     if db is None:
@@ -3492,7 +3696,7 @@ def info(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def places(ctx, cli_obj, db, json_, photos_library):
-    """ Print out places found in the Photos library. """
+    """Print out places found in the Photos library."""
 
     # below needed for to make CliRunner work for testing
     cli_db = cli_obj.db if cli_obj is not None else None
@@ -3543,7 +3747,7 @@ def places(ctx, cli_obj, db, json_, photos_library):
 @click.pass_obj
 @click.pass_context
 def dump(ctx, cli_obj, db, json_, deleted, deleted_only, photos_library):
-    """ Print list of all photos & associated info from the Photos library. """
+    """Print list of all photos & associated info from the Photos library."""
 
     db = get_photos_db(*photos_library, db, cli_obj.db)
     if db is None:
@@ -3574,7 +3778,7 @@ def dump(ctx, cli_obj, db, json_, deleted, deleted_only, photos_library):
 @click.pass_obj
 @click.pass_context
 def list_libraries(ctx, cli_obj, json_):
-    """ Print list of Photos libraries found on the system. """
+    """Print list of Photos libraries found on the system."""
 
     # implemented in _list_libraries so it can be called by other CLI functions
     # without errors due to passing ctx and cli_obj
@@ -3621,7 +3825,7 @@ def _list_libraries(json_=False, error=True):
 @click.pass_obj
 @click.pass_context
 def about(ctx, cli_obj):
-    """ Print information about osxphotos including license. """
+    """Print information about osxphotos including license."""
     license = """
 MIT License
 
@@ -3649,3 +3853,87 @@ SOFTWARE.
     click.echo("")
     click.echo(f"Source code available at: {OSXPHOTOS_URL}")
     click.echo(license)
+
+
+@cli.command(name="tutorial")
+@click.argument(
+    "WIDTH",
+    nargs=-1,
+    type=click.INT,
+)
+@click.pass_obj
+@click.pass_context
+def tutorial(ctx, cli_obj, width):
+    """Display osxphotos tutorial."""
+    width = width[0] if width else 100
+    click.echo_via_pager(tutorial_help(width=width))
+
+
+def _show_photo(photo):
+    """open image with default image viewer
+
+    Note: This is for debugging only -- it will actually open any filetype which could
+    be very, very bad.
+
+    Args:
+        photo: PhotoInfo object or a path to a photo on disk
+    """
+    photopath = photo.path if isinstance(photo, osxphotos.PhotoInfo) else photo
+
+    if not os.path.isfile(photopath):
+        return f"'{photopath}' does not appear to be a valid photo path"
+
+    os.system(f"open '{photopath}'")
+
+
+def _load_photos_db(dbpath):
+    print("Loading database")
+    tic = time.perf_counter()
+    photosdb = osxphotos.PhotosDB(dbfile=dbpath, verbose=print)
+    toc = time.perf_counter()
+    tictoc = toc - tic
+    print(f"Done: took {tictoc:0.2f} seconds")
+    return photosdb
+
+
+def _get_photos(photosdb):
+    photos = photosdb.photos(images=True, movies=True)
+    photos.extend(photosdb.photos(images=True, movies=True, intrash=True))
+    return photos
+
+
+@cli.command()
+@DB_OPTION
+@click.pass_obj
+@click.pass_context
+def repl(ctx, cli_obj, db):
+    """Run interactive osxphotos shell"""
+    pretty.install()
+    print(f"python version: {sys.version}")
+    print(f"osxphotos version: {osxphotos._version.__version__}")
+    db = db or get_photos_db()
+    photosdb = _load_photos_db(db)
+    print("Getting photos")
+    tic = time.perf_counter()
+    photos = _get_photos(photosdb)
+    toc = time.perf_counter()
+    tictoc = toc - tic
+
+    # shortcut for helper functions
+    get_photo = photosdb.get_photo
+    show = _show_photo
+
+    print(f"Found {len(photos)} photos in {tictoc:0.2f} seconds")
+    print("The following variables are defined:")
+    print(f"- photosdb: PhotosDB() instance for {photosdb.library_path}")
+    print(
+        f"- photos: list of PhotoInfo objects for all photos in photosdb, including those in the trash"
+    )
+    print(f"\nThe following functions may be helpful:")
+    print(f"- get_photo(uuid): return a PhotoInfo object for photo with uuid")
+    print(f"- show(photo): open a photo object in the default viewer")
+    print(
+        f"- help(object): print help text including list of methods for object; for example, help(PhotosDB)"
+    )
+    print(f"- quit(): exit this interactive shell\n")
+    code.interact(banner="", local=locals())

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

@@ -23,12 +23,14 @@ 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():
     """ return path of exiftool, cache result """
@@ -70,15 +72,14 @@ class _ExifToolProc:
         self._exiftool = exiftool or get_exiftool_path()
         self._start_proc()
 
-        EXIFTOOL_PROCESSES.append(self)
-
     @property
     def process(self):
         """ return the exiftool subprocess """
         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):
@@ -116,15 +117,21 @@ 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:
@@ -134,9 +141,6 @@ class _ExifToolProc:
         del self._process
         self._process_running = False
 
-    def __del__(self):
-        self._stop_proc()
-
 
 class ExifTool:
     """ Basic exiftool interface for reading and writing EXIF tags """
@@ -162,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
 
@@ -194,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
@@ -236,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_export.py

@@ -15,6 +15,7 @@
 # TODO: should this be its own PhotoExporter class?
 # TODO: the various sidecar_json, sidecar_xmp, etc args should all be collapsed to a sidecar param using a bit mask
 
+import dataclasses
 import glob
 import hashlib
 import json
@@ -24,6 +25,7 @@ import pathlib
 import re
 import tempfile
 from collections import namedtuple  # pylint: disable=syntax-error
+from typing import Optional
 
 import photoscript
 from mako.template import Template
@@ -36,6 +38,7 @@ from .._constants import (
     _UNKNOWN_PERSON,
     _XMP_TEMPLATE_NAME,
     _XMP_TEMPLATE_NAME_BETA,
+    LIVE_VIDEO_EXTENSIONS,
     SIDECAR_EXIFTOOL,
     SIDECAR_JSON,
     SIDECAR_XMP,
@@ -51,6 +54,7 @@ from ..photokit import (
     PhotoKitFetchFailed,
     PhotoLibrary,
 )
+from ..phototemplate import RenderOptions
 from ..utils import findfiles, get_preferred_uti_extension, lineno, noop
 
 # retry if use_photos_export fails the first time (which sometimes it does)
@@ -58,13 +62,13 @@ MAX_PHOTOSCRIPT_RETRIES = 3
 
 
 class ExportError(Exception):
-    """ error during export """
+    """error during export"""
 
     pass
 
 
 class ExportResults:
-    """ holds export results for export2 """
+    """holds export results for export2"""
 
     def __init__(
         self,
@@ -119,7 +123,7 @@ class ExportResults:
         self.missing_album = missing_album or []
 
     def all_files(self):
-        """ return all filenames contained in results """
+        """return all filenames contained in results"""
         files = (
             self.exported
             + self.new
@@ -200,7 +204,7 @@ class ExportResults:
 
 # hexdigest is not a class method, don't import this into PhotoInfo
 def hexdigest(strval):
-    """ hexdigest of a string, using blake2b """
+    """hexdigest of a string, using blake2b"""
     h = hashlib.blake2b(digest_size=20)
     h.update(bytes(strval, "utf-8"))
     return h.hexdigest()
@@ -217,6 +221,7 @@ def _export_photo_uuid_applescript(
     timeout=120,
     burst=False,
     dry_run=False,
+    overwrite=False,
 ):
     """Export photo to dest path using applescript to control Photos
     If photo is a live photo, exports both the photo and associated .mov file
@@ -296,6 +301,8 @@ def _export_photo_uuid_applescript(
             # use the name Photos provided
             dest_new = dest / path.name
         if not dry_run:
+            if overwrite and dest_new.exists():
+                FileUtil.unlink(dest_new)
             FileUtil.copy(str(path), str(dest_new))
         exported_paths.append(str(dest_new))
     return exported_paths
@@ -343,13 +350,13 @@ def _check_export_suffix(src, dest, edited):
 
 # not a class method, don't import into PhotoInfo
 def rename_jpeg_files(files, jpeg_ext, fileutil):
-    """ rename any jpeg files in files so that extension matches jpeg_ext
+    """rename any jpeg files in files so that extension matches jpeg_ext
 
     Args:
         files: list of file paths
         jpeg_ext: extension to use for jpeg files found in files, e.g. "jpg"
         fileutil: a FileUtil object
-    
+
     Returns:
         list of files with updated names
 
@@ -389,6 +396,7 @@ def export(
     use_persons_as_keywords=False,
     keyword_template=None,
     description_template=None,
+    render_options: Optional[RenderOptions] = None,
 ):
     """export photo
     dest: must be valid destination path (or exception raised)
@@ -415,7 +423,7 @@ def export(
     sidecar_exiftool: if set will write a json sidecar with data in format readable by exiftool
                 sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. `exiftool -j`)
     sidecar_xmp: if set will write an XMP sidecar with IPTC data
-                sidecar filename will be dest/filename.xmp           
+                sidecar filename will be dest/filename.xmp
     use_photos_export: (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos
     timeout: (int, default=120) timeout in seconds used with use_photos_export
     exiftool: (boolean, default = False); if True, will use exiftool to write metadata to export file
@@ -426,7 +434,8 @@ def export(
     when exporting metadata with exiftool or sidecar
     keyword_template: (list of strings); list of template strings that will be rendered as used as keywords
     description_template: string; optional template string that will be rendered for use as photo description
-    
+    render_options: an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer
+
     Returns: list of photos exported
     """
 
@@ -457,6 +466,7 @@ def export(
         use_persons_as_keywords=use_persons_as_keywords,
         keyword_template=keyword_template,
         description_template=description_template,
+        render_options = render_options,
     )
 
     return results.exported
@@ -499,6 +509,7 @@ def export2(
     persons=True,
     location=True,
     replace_keywords=False,
+    render_options: Optional[RenderOptions] = None
 ):
     """export photo, like export but with update and dry_run options
     dest: must be valid destination path or exception raised
@@ -512,10 +523,10 @@ def export2(
                 reference PhotoInfo.path_edited
     edited: (boolean, default=False); if True will export the edited version of the photo
             (or raise exception if no edited version)
-    live_photo: (boolean, default=False); if True, will also export the associted .mov for live photos
-    raw_photo: (boolean, default=False); if True, will also export the associted RAW photo
+    live_photo: (boolean, default=False); if True, will also export the associated .mov for live photos
+    raw_photo: (boolean, default=False); if True, will also export the associated RAW photo
     export_as_hardlink: (boolean, default=False); if True, will hardlink files instead of copying them
-    overwrite: (boolean, default=False); if True will overwrite files if they alreay exist
+    overwrite: (boolean, default=False); if True will overwrite files if they already exist
     increment: (boolean, default=True); if True, will increment file name until a non-existant name is found
                 if overwrite=False and increment=False, export will fail if destination file already exists
     sidecar: bit field: set to one or more of SIDECAR_XMP, SIDECAR_JSON, SIDECAR_EXIFTOOL
@@ -554,9 +565,10 @@ def export2(
     persons: if True, include persons in exported metadata
     location: if True, include location in exported metadata
     replace_keywords: if True, keyword_template replaces any keywords, otherwise it's additive
+    render_options: optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates
 
-    Returns: ExportResults class 
-        ExportResults has attributes: 
+    Returns: ExportResults class
+        ExportResults has attributes:
         "exported",
         "new",
         "updated",
@@ -576,7 +588,7 @@ def export2(
         "exiftool_warning",
         "exiftool_error",
 
- 
+
     Note: to use dry run mode, you must set dry_run=True and also pass in memory version of export_db,
           and no-op fileutil (e.g. ExportDBInMemory and FileUtilNoOp)
     """
@@ -595,6 +607,8 @@ def export2(
     if verbose is None:
         verbose = self._verbose
 
+    self._render_options = render_options or RenderOptions()
+
     # suffix to add to edited files
     # e.g. name will be filename_edited.jpg
     edited_identifier = "_edited"
@@ -678,6 +692,7 @@ def export2(
             f"destination exists ({dest}); overwrite={overwrite}, increment={increment}"
         )
 
+    self._render_options.filepath = str(dest)
     all_results = ExportResults()
     if not use_photos_export:
         # find the source file on disk and export
@@ -817,139 +832,25 @@ def export2(
                 )
                 all_results += results
     else:
-        # TODO: move this big if/else block to separate functions
-        # e.g. _export_with_photos_export or such
-        # use_photo_export
-        # export live_photo .mov file?
-        live_photo = True if live_photo and self.live_photo else False
-        if edited or self.shared:
-            # exported edited version and not original
-            # shared photos (in shared albums) show up as not having adjustments (not edited)
-            # but Photos is unable to export the "original" as only a jpeg copy is shared in iCloud
-            # so tell Photos to export the current version in this case
-            if filename:
-                # use filename stem provided
-                filestem = dest.stem
-            else:
-                # didn't get passed a filename, add _edited
-                filestem = f"{dest.stem}{edited_identifier}"
-                uti = self.uti_edited if edited and self.uti_edited else self.uti
-                ext = get_preferred_uti_extension(uti)
-                dest = dest.parent / f"{filestem}{ext}"
-
-            if use_photokit:
-                photolib = PhotoLibrary()
-                photo = None
-                try:
-                    photo = photolib.fetch_uuid(self.uuid)
-                except PhotoKitFetchFailed as e:
-                    # if failed to find UUID, might be a burst photo
-                    if self.burst and self._info["burstUUID"]:
-                        bursts = photolib.fetch_burst_uuid(
-                            self._info["burstUUID"], all=True
-                        )
-                        # PhotoKit UUIDs may contain "/L0/001" so only look at beginning
-                        photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
-                        photo = photo[0] if photo else None
-                    if not photo:
-                        all_results.error.append(
-                            (
-                                str(dest),
-                                f"PhotoKitFetchFailed exception exporting photo {self.uuid}: {e} ({lineno(__file__)})",
-                            )
-                        )
-                if photo:
-                    if not dry_run:
-                        try:
-                            exported = photo.export(
-                                dest.parent, dest.name, version=PHOTOS_VERSION_CURRENT
-                            )
-                            all_results.exported.extend(exported)
-                        except Exception as e:
-                            all_results.error.append(
-                                (str(dest), f"{e} ({lineno(__file__)})")
-                            )
-                    else:
-                        # dry_run, don't actually export
-                        all_results.exported.append(str(dest))
-            else:
-                try:
-                    exported = _export_photo_uuid_applescript(
-                        self.uuid,
-                        dest.parent,
-                        filestem=filestem,
-                        original=False,
-                        edited=True,
-                        live_photo=live_photo,
-                        timeout=timeout,
-                        burst=self.burst,
-                        dry_run=dry_run,
-                    )
-                    all_results.exported.extend(exported)
-                except ExportError as e:
-                    all_results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
-        else:
-            # export original version and not edited
-            filestem = dest.stem
-            if use_photokit:
-                photolib = PhotoLibrary()
-                photo = None
-                try:
-                    photo = photolib.fetch_uuid(self.uuid)
-                except PhotoKitFetchFailed:
-                    # if failed to find UUID, might be a burst photo
-                    if self.burst and self._info["burstUUID"]:
-                        bursts = photolib.fetch_burst_uuid(
-                            self._info["burstUUID"], all=True
-                        )
-                        # PhotoKit UUIDs may contain "/L0/001" so only look at beginning
-                        photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
-                        photo = photo[0] if photo else None
-                if photo:
-                    if not dry_run:
-                        try:
-                            exported = photo.export(
-                                dest.parent, dest.name, version=PHOTOS_VERSION_ORIGINAL
-                            )
-                            all_results.exported.extend(exported)
-                        except Exception as e:
-                            all_results.error.append(
-                                (str(dest), f"{e} ({lineno(__file__)})")
-                            )
-                    else:
-                        # dry_run, don't actually export
-                        all_results.exported.append(str(dest))
-            else:
-                try:
-                    exported = _export_photo_uuid_applescript(
-                        self.uuid,
-                        dest.parent,
-                        filestem=filestem,
-                        original=True,
-                        edited=False,
-                        live_photo=live_photo,
-                        timeout=timeout,
-                        burst=self.burst,
-                        dry_run=dry_run,
-                    )
-                    all_results.exported.extend(exported)
-                except ExportError as e:
-                    all_results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
-        if all_results.exported:
-            if jpeg_ext:
-                # use_photos_export (both PhotoKit and AppleScript) don't use the
-                # file extension provided (instead they use extension for UTI)
-                # so if jpeg_ext is set, rename any non-conforming jpegs
-                all_results.exported = rename_jpeg_files(
-                    all_results.exported, jpeg_ext, fileutil
-                )
-            if touch_file:
-                for exported_file in all_results.exported:
-                    all_results.touched.append(exported_file)
-                    ts = int(self.date.timestamp())
-                    fileutil.utime(exported_file, (ts, ts))
-            if update:
-                all_results.new.extend(all_results.exported)
+        self._export_photo_with_photos_export(
+            dest,
+            filename,
+            all_results,
+            fileutil,
+            export_db,
+            use_photokit=use_photokit,
+            dry_run=dry_run,
+            timeout=timeout,
+            jpeg_ext=jpeg_ext,
+            touch_file=touch_file,
+            update=update,
+            overwrite=overwrite,
+            live_photo=live_photo,
+            edited=edited,
+            edited_identifier=edited_identifier,
+            convert_to_jpeg=convert_to_jpeg,
+            jpeg_quality=jpeg_quality,
+        )
 
     # export metadata
     sidecars = []
@@ -1207,6 +1108,197 @@ def export2(
     return all_results
 
 
+def _export_photo_with_photos_export(
+    self,
+    dest,
+    filename,
+    all_results,
+    fileutil,
+    export_db,
+    use_photokit=None,
+    dry_run=None,
+    timeout=None,
+    jpeg_ext=None,
+    touch_file=None,
+    update=None,
+    overwrite=None,
+    live_photo=None,
+    edited=None,
+    edited_identifier=None,
+    convert_to_jpeg=None,
+    jpeg_quality=1.0,
+):
+    # TODO: duplicative code with the if edited/else--remove it
+    # export live_photo .mov file?
+    live_photo = bool(live_photo and self.live_photo)
+    overwrite = overwrite or update
+    if edited or self.shared:
+        # exported edited version and not original
+        # shared photos (in shared albums) show up as not having adjustments (not edited)
+        # but Photos is unable to export the "original" as only a jpeg copy is shared in iCloud
+        # so tell Photos to export the current version in this case
+        if filename:
+            # use filename stem provided
+            filestem = dest.stem
+        else:
+            # didn't get passed a filename, add _edited
+            filestem = f"{dest.stem}{edited_identifier}"
+            uti = self.uti_edited if edited and self.uti_edited else self.uti
+            ext = get_preferred_uti_extension(uti)
+            dest = dest.parent / f"{filestem}{ext}"
+
+        if use_photokit:
+            photolib = PhotoLibrary()
+            photo = None
+            try:
+                photo = photolib.fetch_uuid(self.uuid)
+            except PhotoKitFetchFailed as e:
+                # if failed to find UUID, might be a burst photo
+                if self.burst and self._info["burstUUID"]:
+                    bursts = photolib.fetch_burst_uuid(
+                        self._info["burstUUID"], all=True
+                    )
+                    # PhotoKit UUIDs may contain "/L0/001" so only look at beginning
+                    photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
+                    photo = photo[0] if photo else None
+                if not photo:
+                    all_results.error.append(
+                        (
+                            str(dest),
+                            f"PhotoKitFetchFailed exception exporting photo {self.uuid}: {e} ({lineno(__file__)})",
+                        )
+                    )
+            if photo:
+                if dry_run:
+                    # dry_run, don't actually export
+                    all_results.exported.append(str(dest))
+                else:
+                    try:
+                        exported = photo.export(
+                            dest.parent,
+                            dest.name,
+                            version=PHOTOS_VERSION_CURRENT,
+                            overwrite=overwrite,
+                        )
+                        all_results.exported.extend(exported)
+                    except Exception as e:
+                        all_results.error.append(
+                            (str(dest), f"{e} ({lineno(__file__)})")
+                        )
+        else:
+            try:
+                exported = _export_photo_uuid_applescript(
+                    self.uuid,
+                    dest.parent,
+                    filestem=filestem,
+                    original=False,
+                    edited=True,
+                    live_photo=live_photo,
+                    timeout=timeout,
+                    burst=self.burst,
+                    dry_run=dry_run,
+                    overwrite=overwrite,
+                )
+                all_results.exported.extend(exported)
+            except ExportError as e:
+                all_results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
+    else:
+        # export original version and not edited
+        filestem = dest.stem
+        if use_photokit:
+            photolib = PhotoLibrary()
+            photo = None
+            try:
+                photo = photolib.fetch_uuid(self.uuid)
+            except PhotoKitFetchFailed:
+                # if failed to find UUID, might be a burst photo
+                if self.burst and self._info["burstUUID"]:
+                    bursts = photolib.fetch_burst_uuid(
+                        self._info["burstUUID"], all=True
+                    )
+                    # PhotoKit UUIDs may contain "/L0/001" so only look at beginning
+                    photo = [p for p in bursts if p.uuid.startswith(self.uuid)]
+                    photo = photo[0] if photo else None
+            if photo:
+                if not dry_run:
+                    try:
+                        exported = photo.export(
+                            dest.parent,
+                            dest.name,
+                            version=PHOTOS_VERSION_ORIGINAL,
+                            overwrite=overwrite,
+                        )
+                        all_results.exported.extend(exported)
+                    except Exception as e:
+                        all_results.error.append(
+                            (str(dest), f"{e} ({lineno(__file__)})")
+                        )
+                else:
+                    # dry_run, don't actually export
+                    all_results.exported.append(str(dest))
+        else:
+            try:
+                exported = _export_photo_uuid_applescript(
+                    self.uuid,
+                    dest.parent,
+                    filestem=filestem,
+                    original=True,
+                    edited=False,
+                    live_photo=live_photo,
+                    timeout=timeout,
+                    burst=self.burst,
+                    dry_run=dry_run,
+                    overwrite=overwrite,
+                )
+                all_results.exported.extend(exported)
+            except ExportError as e:
+                all_results.error.append((str(dest), f"{e} ({lineno(__file__)})"))
+    if all_results.exported:
+        for idx, photopath in enumerate(all_results.exported):
+            converted_stat = (None, None, None)
+            photopath = pathlib.Path(photopath)
+            if convert_to_jpeg and self.isphoto:
+                # if passed convert_to_jpeg=True, will assume the photo is a photo and not already a jpeg
+                if photopath.suffix.lower() not in LIVE_VIDEO_EXTENSIONS:
+                    dest_str = photopath.parent / f"{photopath.stem}.jpeg"
+                    fileutil.convert_to_jpeg(
+                        photopath, dest_str, compression_quality=jpeg_quality
+                    )
+                    converted_stat = fileutil.file_sig(dest_str)
+                    fileutil.unlink(photopath)
+                    all_results.exported[idx] = dest_str
+                    all_results.converted_to_jpeg.append(dest_str)
+                    photopath = dest_str
+
+            photopath = str(photopath)
+            export_db.set_data(
+                filename=photopath,
+                uuid=self.uuid,
+                orig_stat=fileutil.file_sig(photopath),
+                exif_stat=(None, None, None),
+                converted_stat=converted_stat,
+                edited_stat=(None, None, None),
+                info_json=self.json(),
+                exif_json=None,
+            )
+
+            # todo: handle signatures
+        if jpeg_ext:
+            # use_photos_export (both PhotoKit and AppleScript) don't use the
+            # file extension provided (instead they use extension for UTI)
+            # so if jpeg_ext is set, rename any non-conforming jpegs
+            all_results.exported = rename_jpeg_files(
+                all_results.exported, jpeg_ext, fileutil
+            )
+        if touch_file:
+            for exported_file in all_results.exported:
+                all_results.touched.append(exported_file)
+                ts = int(self.date.timestamp())
+                fileutil.utime(exported_file, (ts, ts))
+        if update:
+            all_results.new.extend(all_results.exported)
+
+
 def _export_photo(
     self,
     src,
@@ -1501,7 +1593,7 @@ def _exiftool_dict(
         QuickTime:GPSCoordinates
         UserData:GPSCoordinates
 
-    Reference: 
+    Reference:
         https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata-201610_1.pdf
     """
 
@@ -1516,9 +1608,8 @@ def _exiftool_dict(
     )
 
     if description_template is not None:
-        rendered = self.render_template(
-            description_template, expand_inplace=True, inplace_sep=", "
-        )[0]
+        options = dataclasses.replace(self._render_options, expand_inplace=True, inplace_sep=", ")
+        rendered = self.render_template(description_template, options)[0]
         description = " ".join(rendered) if rendered else ""
         exif["EXIF:ImageDescription"] = description
         exif["XMP:Description"] = description
@@ -1556,10 +1647,9 @@ def _exiftool_dict(
 
     if keyword_template:
         rendered_keywords = []
+        options = dataclasses.replace(self._render_options, none_str=_OSXPHOTOS_NONE_SENTINEL, path_sep="/")
         for template_str in keyword_template:
-            rendered, unmatched = self.render_template(
-                template_str, none_str=_OSXPHOTOS_NONE_SENTINEL, path_sep="/"
-            )
+            rendered, unmatched = self.render_template(template_str, options)
             if unmatched:
                 logging.warning(
                     f"Unmatched template substitution for template: {template_str} {unmatched}"
@@ -1682,7 +1772,7 @@ def _exiftool_dict(
 
 
 def _get_exif_keywords(self):
-    """ returns list of keywords found in the file's exif metadata """
+    """returns list of keywords found in the file's exif metadata"""
     keywords = []
     exif = self.exiftool
     if exif:
@@ -1700,7 +1790,7 @@ def _get_exif_keywords(self):
 
 
 def _get_exif_persons(self):
-    """ returns list of persons found in the file's exif metadata """
+    """returns list of persons found in the file's exif metadata"""
     persons = []
     exif = self.exiftool
     if exif:
@@ -1835,9 +1925,8 @@ def _xmp_sidecar(
         extension = extension.suffix[1:] if extension.suffix else None
 
     if description_template is not None:
-        rendered = self.render_template(
-            description_template, expand_inplace=True, inplace_sep=", "
-        )[0]
+        options = dataclasses.replace(self._render_options, expand_inplace=True, inplace_sep=", ")
+        rendered = self.render_template(description_template, options)[0]
         description = " ".join(rendered) if rendered else ""
     else:
         description = self.description if self.description is not None else ""
@@ -1869,10 +1958,9 @@ def _xmp_sidecar(
 
     if keyword_template:
         rendered_keywords = []
+        options = dataclasses.replace(self._render_options, none_str=_OSXPHOTOS_NONE_SENTINEL, path_sep="/")
         for template_str in keyword_template:
-            rendered, unmatched = self.render_template(
-                template_str, none_str=_OSXPHOTOS_NONE_SENTINEL, path_sep="/"
-            )
+            rendered, unmatched = self.render_template(template_str, options)
             if unmatched:
                 logging.warning(
                     f"Unmatched template substitution for template: {template_str} {unmatched}"

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,7 +34,7 @@ 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
 
@@ -46,30 +46,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 +78,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 +111,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,12 +137,12 @@ 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:
@@ -210,7 +214,7 @@ class PhotoInfo:
 
     @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 +228,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
@@ -282,7 +286,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!")
@@ -342,7 +346,7 @@ class PhotoInfo:
 
     @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
@@ -412,17 +416,17 @@ class PhotoInfo:
 
     @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 +437,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 +451,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 +463,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 +476,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,7 +488,7 @@ 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:
@@ -497,7 +501,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 +514,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 +542,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 +571,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"]
@@ -606,7 +610,7 @@ class PhotoInfo:
 
     @property
     def date_added(self):
-        """ Date photo was added to the database """
+        """Date photo was added to the database"""
         try:
             return self._date_added
         except AttributeError:
@@ -623,7 +627,7 @@ class PhotoInfo:
 
     @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
@@ -719,27 +723,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
@@ -759,7 +763,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
@@ -820,7 +824,7 @@ class PhotoInfo:
 
     @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) """
+        """Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)"""
         if self._db._db_version <= _PHOTOS_4_VERSION:
             return self._path_derivatives_4()
 
@@ -837,7 +841,7 @@ class PhotoInfo:
         return [str(filename) for filename in files if filename.suffix != ".THM"]
 
     def _path_derivatives_4(self):
-        """ Return paths to all derivative (preview) files for Photos <= 4"""
+        """Return paths to all derivative (preview) files for Photos <= 4"""
         modelid = self._info["modelID"]
         if modelid is None:
             return []
@@ -874,42 +878,42 @@ class PhotoInfo:
 
     @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
@@ -937,12 +941,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
@@ -954,17 +958,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"]
 
@@ -980,76 +984,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):
@@ -1087,7 +1078,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 = (
@@ -1150,7 +1141,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 {}
@@ -1226,7 +1217,7 @@ class PhotoInfo:
         }
 
     def json(self):
-        """ Return JSON representation """
+        """Return JSON representation"""
 
         def default(o):
             if isinstance(o, (datetime.date, datetime.datetime)):
@@ -1235,7 +1226,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__):
@@ -1247,5 +1238,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/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, List
+from typing import List, Optional
+
 import photoscript
+from more_itertools import chunked
+
 from .photoinfo import PhotoInfo
 from .utils import noop
 
@@ -26,8 +29,14 @@ class PhotosAlbum:
         )
 
     def add_list(self, photo_list: List[PhotoInfo]):
-        photos = [photoscript.Photo(p.uuid) for p in photo_list]
-        self.album.add(photos)
+        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}")

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,10 @@ 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 = {}
+
         if _debug():
             logging.debug(f"dbfile = {dbfile}")
 
@@ -322,7 +328,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 +338,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 +351,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 +368,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 +387,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 +410,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 +431,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 +452,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 +464,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 +478,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 +491,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 +507,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 +519,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 +541,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,8 +593,8 @@ 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.")
@@ -1180,6 +1186,13 @@ class PhotosDB:
             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(
@@ -1532,15 +1545,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"]
 
@@ -1563,11 +1576,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():
@@ -1615,7 +1628,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],
@@ -2141,6 +2158,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:
@@ -2426,9 +2450,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"]
@@ -2449,17 +2473,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:
@@ -2467,7 +2491,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 []
@@ -2493,10 +2517,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:
@@ -2504,7 +2528,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)
@@ -2536,15 +2560,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)
@@ -2570,14 +2594,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)
@@ -2602,19 +2626,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(
@@ -2666,14 +2690,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
         """
 
@@ -2692,7 +2716,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)
@@ -2707,10 +2731,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:
@@ -2817,7 +2841,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
@@ -2832,7 +2856,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.
@@ -3184,11 +3208,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)
@@ -3203,8 +3228,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}')"
 
@@ -3216,8 +3287,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)
 
@@ -3247,4 +3318,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/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,7 +4,10 @@ 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
 
@@ -13,7 +16,9 @@ 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, "")
@@ -137,7 +142,12 @@ TEMPLATE_SUBSTITUTIONS = {
     "{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"
+    "{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)
@@ -164,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. "
@@ -179,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
@@ -187,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 = ","
@@ -217,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
@@ -238,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.
@@ -262,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:
@@ -314,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
             ]
@@ -370,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 []
@@ -387,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
 
@@ -414,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:
@@ -435,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:
@@ -457,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:
@@ -478,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:
@@ -489,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:
@@ -497,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:
@@ -531,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:
@@ -546,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}"
@@ -607,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 ""
@@ -632,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}")
 
@@ -920,9 +929,40 @@ class PhotoTemplate:
             # 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]
@@ -968,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 [].
 
@@ -990,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
@@ -1013,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
@@ -1025,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)
@@ -1043,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(".")
@@ -1073,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]
 
@@ -1083,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 []
 
@@ -1098,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(
@@ -1117,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)):
@@ -1131,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(
@@ -1150,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]
@@ -1166,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"]
@@ -1176,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:
@@ -1210,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'
@@ -1235,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/utils.py

@@ -38,7 +38,7 @@ if not _DEBUG:
 
 def _get_logger():
     """Used only for testing
-    
+
     Returns:
         logging.Logger object -- logging.Logger object for osxphotos
     """
@@ -46,7 +46,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 +56,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 +92,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 +117,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 +136,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 +165,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 +190,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 +241,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
@@ -266,21 +266,30 @@ def list_photo_libraries():
 
 
 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 """
+    """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"""
 
     # reference: https://developer.apple.com/documentation/coreservices/1442744-uttypecopypreferredtagwithclass?language=objc
     with objc.autorelease_pool():
-        return CoreServices.UTTypeCopyPreferredTagWithClass(
+        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
+
 
 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
@@ -307,8 +316,8 @@ def findfiles(pattern, path_):
 
 
 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 +328,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 +381,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 +394,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 +419,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>

tests/conftest.py

@@ -3,9 +3,10 @@ import os
 import pathlib
 
 import pytest
-from applescript import AppleScript
 from photoscript.utils import ditto
 
+import osxphotos
+from applescript import AppleScript
 from osxphotos.exiftool import _ExifToolProc
 
 
@@ -63,7 +64,9 @@ def pytest_collection_modifyitems(config, items):
         # --addalbum given in cli: do not skip addalbum tests (these require interactive test)
         return
 
-    skip_addalbum = pytest.mark.skip(reason="need --addalbum option and MacOS Catalina to run")
+    skip_addalbum = pytest.mark.skip(
+        reason="need --addalbum option and MacOS Catalina to run"
+    )
     for item in items:
         if "addalbum" in item.keywords:
             item.add_marker(skip_addalbum)

tests/generate_search_info_test_data.py

@@ -10,9 +10,9 @@ import json
 import osxphotos
 
 UUID = [
-    "C8EAF50A-D891-4E0C-8086-C417E1284153",
-    "71DFB4C3-E868-4BE4-906E-D96BD8692D7E",
-    "2C151013-5BBA-4D00-B70F-1C9420418B86",
+    "DC09F4D8-6173-452D-AC15-725C8D7C185E",
+    "AFECD4AB-937C-46AF-A79B-9C9A38AA42B1",
+    "A1C36260-92CD-47E2-927A-35DAF16D7882",
 ]
 
 data = {

tests/hyphen-dir/README.md

@@ -0,0 +1,3 @@
+# Contents
+
+This directory used by test_template.py for testing {function} templates with hyphenated directory names

tests/hyphen-dir/template_function.py

@@ -0,0 +1,20 @@
+""" Example showing how to use a custom function for osxphotos {function} template """
+
+import pathlib
+from typing import List, Union
+
+import osxphotos
+
+
+def foo(photo: osxphotos.PhotoInfo, **kwargs) -> Union[List, str]:
+    """ example function for {function} template
+
+    Args:
+        photo: osxphotos.PhotoInfo object
+        **kwargs: not currently used, placeholder to keep functions compatible with possible changes to {function}
+
+    Returns:
+        str or list of str of values that should be substituted for the {function} template
+    """
+
+    return photo.original_filename + "-FOO"

tests/photoinfo_mock.py

@@ -8,6 +8,7 @@ class PhotoInfoMock(PhotoInfo):
         self._photo = photo
         self._db = photo._db
         self._info = photo._info
+        self._uuid = photo.uuid
 
         for kw in kwargs:
             if hasattr(photo, kw):

tests/sidecars/D79B8D77-BFFC-460B-9312-034F2877D35B_albums_as_keywords.json

@@ -1 +1 @@
-[{"EXIF:ImageDescription": "Girl holding pumpkin", "XMP:Description": "Girl holding pumpkin", "IPTC:Caption-Abstract": "Girl holding pumpkin", "XMP:Title": "I found one!", "IPTC:ObjectName": "I found one!", "IPTC:Keywords": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:Subject": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:TagsList": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:PersonInImage": ["Katie"], "EXIF:GPSLatitude": 41.256566, "EXIF:GPSLongitude": -95.940257, "EXIF:GPSLatitudeRef": "N", "EXIF:GPSLongitudeRef": "W", "EXIF:DateTimeOriginal": "2018:09:28 16:07:07", "EXIF:CreateDate": "2018:09:28 16:07:07", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2018:09:28", "IPTC:TimeCreated": "16:07:07-04:00", "EXIF:ModifyDate": "2018:09:28 16:07:07"}]
+[{"EXIF:ImageDescription": "Girl holding pumpkin", "XMP:Description": "Girl holding pumpkin", "IPTC:Caption-Abstract": "Girl holding pumpkin", "XMP:Title": "I found one!", "IPTC:ObjectName": "I found one!", "IPTC:Keywords": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:Subject": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:TagsList": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:PersonInImage": ["Katie"], "EXIF:GPSLatitude": 41.256566, "EXIF:GPSLongitude": -95.940257, "EXIF:GPSLatitudeRef": "N", "EXIF:GPSLongitudeRef": "W", "EXIF:DateTimeOriginal": "2018:09:28 16:07:07", "EXIF:CreateDate": "2018:09:28 16:07:07", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2018:09:28", "IPTC:TimeCreated": "16:07:07-04:00", "EXIF:ModifyDate": "2018:09:28 16:07:07"}]

tests/sidecars/D79B8D77-BFFC-460B-9312-034F2877D35B_albums_as_keywords.xmp

@@ -18,6 +18,7 @@
         <dc:subject>
          <rdf:Bag>
           <rdf:li>Kids</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>Pumpkin Farm</rdf:li>
           <rdf:li>Test Album</rdf:li>
          </rdf:Bag>
@@ -37,6 +38,7 @@
         <digiKam:TagsList>
         <rdf:Seq>
           <rdf:li>Kids</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>Pumpkin Farm</rdf:li>
           <rdf:li>Test Album</rdf:li>
         </rdf:Seq>

tests/sidecars/D79B8D77-BFFC-460B-9312-034F2877D35B_keyword_template.json

@@ -1 +1 @@
-[{"EXIF:ImageDescription": "Girl holding pumpkin", "XMP:Description": "Girl holding pumpkin", "IPTC:Caption-Abstract": "Girl holding pumpkin", "XMP:Title": "I found one!", "IPTC:ObjectName": "I found one!", "IPTC:Keywords": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:Subject": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:TagsList": ["Kids", "Pumpkin Farm", "Test Album"], "XMP:PersonInImage": ["Katie"], "EXIF:GPSLatitude": 41.256566, "EXIF:GPSLongitude": -95.940257, "EXIF:GPSLatitudeRef": "N", "EXIF:GPSLongitudeRef": "W", "EXIF:DateTimeOriginal": "2018:09:28 16:07:07", "EXIF:CreateDate": "2018:09:28 16:07:07", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2018:09:28", "IPTC:TimeCreated": "16:07:07-04:00", "EXIF:ModifyDate": "2018:09:28 16:07:07"}]
+[{"EXIF:ImageDescription": "Girl holding pumpkin", "XMP:Description": "Girl holding pumpkin", "IPTC:Caption-Abstract": "Girl holding pumpkin", "XMP:Title": "I found one!", "IPTC:ObjectName": "I found one!", "IPTC:Keywords": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:Subject": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:TagsList": ["Kids", "Multi Keyword", "Pumpkin Farm", "Test Album"], "XMP:PersonInImage": ["Katie"], "EXIF:GPSLatitude": 41.256566, "EXIF:GPSLongitude": -95.940257, "EXIF:GPSLatitudeRef": "N", "EXIF:GPSLongitudeRef": "W", "EXIF:DateTimeOriginal": "2018:09:28 16:07:07", "EXIF:CreateDate": "2018:09:28 16:07:07", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2018:09:28", "IPTC:TimeCreated": "16:07:07-04:00", "EXIF:ModifyDate": "2018:09:28 16:07:07"}]

tests/sidecars/D79B8D77-BFFC-460B-9312-034F2877D35B_keyword_template.xmp

@@ -19,6 +19,7 @@
          <rdf:Bag>
           <rdf:li>2018</rdf:li>
           <rdf:li>Kids</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>Pumpkin Farm</rdf:li>
           <rdf:li>Test Album</rdf:li>
          </rdf:Bag>
@@ -39,6 +40,7 @@
         <rdf:Seq>
           <rdf:li>2018</rdf:li>
           <rdf:li>Kids</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>Pumpkin Farm</rdf:li>
           <rdf:li>Test Album</rdf:li>
         </rdf:Seq>

tests/sidecars/E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51_albums_as_keywords.json

@@ -1 +1 @@
-[{"EXIF:ImageDescription": "Bride Wedding day", "XMP:Description": "Bride Wedding day", "IPTC:Caption-Abstract": "Bride Wedding day", "IPTC:Keywords": ["AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:Subject": ["AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:TagsList": ["AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:PersonInImage": ["Maria"], "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", "EXIF:CreateDate": "2019:04:15 14:40:24", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2019:04:15", "IPTC:TimeCreated": "14:40:24-04:00", "EXIF:ModifyDate": "2019:07:27 17:33:28"}]
+[{"EXIF:ImageDescription": "Bride Wedding day", "XMP:Description": "Bride Wedding day", "IPTC:Caption-Abstract": "Bride Wedding day", "IPTC:Keywords": ["AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:Subject": ["AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:TagsList": ["AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:PersonInImage": ["Maria"], "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", "EXIF:CreateDate": "2019:04:15 14:40:24", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2019:04:15", "IPTC:TimeCreated": "14:40:24-04:00", "EXIF:ModifyDate": "2019:07:27 17:33:28"}]

tests/sidecars/E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51_albums_as_keywords.xmp

@@ -20,6 +20,7 @@
           <rdf:li>AlbumInFolder</rdf:li>
           <rdf:li>I have a deleted twin</rdf:li>
           <rdf:li>Maria</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>wedding</rdf:li>
          </rdf:Bag>
         </dc:subject>
@@ -40,6 +41,7 @@
           <rdf:li>AlbumInFolder</rdf:li>
           <rdf:li>I have a deleted twin</rdf:li>
           <rdf:li>Maria</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>wedding</rdf:li>
         </rdf:Seq>
         </digiKam:TagsList>

tests/sidecars/E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51_keyword_template.json

@@ -1 +1 @@
-[{"EXIF:ImageDescription": "Bride Wedding day", "XMP:Description": "Bride Wedding day", "IPTC:Caption-Abstract": "Bride Wedding day", "IPTC:Keywords": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:Subject": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:TagsList": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "wedding"], "XMP:PersonInImage": ["Maria"], "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", "EXIF:CreateDate": "2019:04:15 14:40:24", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2019:04:15", "IPTC:TimeCreated": "14:40:24-04:00", "EXIF:ModifyDate": "2019:07:27 17:33:28"}]
+[{"EXIF:ImageDescription": "Bride Wedding day", "XMP:Description": "Bride Wedding day", "IPTC:Caption-Abstract": "Bride Wedding day", "IPTC:Keywords": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:Subject": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:TagsList": ["Folder1/SubFolder2/AlbumInFolder", "I have a deleted twin", "Maria", "Multi Keyword", "wedding"], "XMP:PersonInImage": ["Maria"], "EXIF:DateTimeOriginal": "2019:04:15 14:40:24", "EXIF:CreateDate": "2019:04:15 14:40:24", "EXIF:OffsetTimeOriginal": "-04:00", "IPTC:DateCreated": "2019:04:15", "IPTC:TimeCreated": "14:40:24-04:00", "EXIF:ModifyDate": "2019:07:27 17:33:28"}]

tests/sidecars/E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51_keyword_template.xmp

@@ -21,6 +21,7 @@
           <rdf:li>Folder1/SubFolder2/AlbumInFolder</rdf:li>
           <rdf:li>I have a deleted twin</rdf:li>
           <rdf:li>Maria</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>wedding</rdf:li>
          </rdf:Bag>
         </dc:subject>
@@ -42,6 +43,7 @@
           <rdf:li>Folder1/SubFolder2/AlbumInFolder</rdf:li>
           <rdf:li>I have a deleted twin</rdf:li>
           <rdf:li>Maria</rdf:li>
+          <rdf:li>Multi Keyword</rdf:li>
           <rdf:li>wedding</rdf:li>
         </rdf:Seq>
         </digiKam:TagsList>

tests/test_10_12_6.py

@@ -1,5 +1,9 @@
+import collections
+import datetime
+
 import pytest
 
+import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
 
 PHOTOS_DB = "./tests/Test-10.12.6.photoslibrary/database/photos.db"
@@ -18,8 +22,8 @@ PERSONS = ["Katie", "Suzy", "Maria", _UNKNOWN_PERSON]
 ALBUMS = ["Pumpkin Farm", "AlbumInFolder"]
 KEYWORDS_DICT = {
     "Kids": 4,
-    "wedding": 2,
-    "flowers": 1,
+    "wedding": 3,
+    "flowers": 2,
     "England": 1,
     "London": 1,
     "London 2018": 1,
@@ -30,83 +34,64 @@ KEYWORDS_DICT = {
 PERSONS_DICT = {"Katie": 3, "Suzy": 2, "Maria": 1, _UNKNOWN_PERSON: 1}
 ALBUM_DICT = {"Pumpkin Farm": 3, "AlbumInFolder": 1}
 
-UUID_DICT = {"derivatives": "FPm+ICxpQV+LPBKR22UepA"}
+UUID_DICT = {
+    "derivatives": "FPm+ICxpQV+LPBKR22UepA",
+    "no_duplicates": "FPm+ICxpQV+LPBKR22UepA",
+    "duplicates": "HWsxlzxlQ++1TUPg2XNUgg",
+}
+
+UUID_DUPLICATE = "VwOUaFMlSry5+51f6q8uyw"
 
 
-def test_init():
-    import osxphotos
+@pytest.fixture(scope="module")
+def photosdb():
+    return osxphotos.PhotosDB(dbfile=PHOTOS_DB)
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+
+def test_init(photosdb):
     assert isinstance(photosdb, osxphotos.PhotosDB)
 
 
-def test_db_version():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_db_version(photosdb):
     # assert photosdb.db_version in osxphotos._TESTED_DB_VERSIONS
     assert photosdb.db_version == "2622"
 
 
-def test_persons():
-    import osxphotos
-    import collections
+def test_persons(photosdb):
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
     assert "Katie" in photosdb.persons
     assert collections.Counter(PERSONS) == collections.Counter(photosdb.persons)
 
 
-def test_keywords():
-    import osxphotos
-    import collections
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_keywords(photosdb):
     assert "wedding" in photosdb.keywords
     assert collections.Counter(KEYWORDS) == collections.Counter(photosdb.keywords)
 
 
-def test_album_names():
-    import osxphotos
-    import collections
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_album_names(photosdb):
     assert "Pumpkin Farm" in photosdb.albums
     assert collections.Counter(ALBUMS) == collections.Counter(photosdb.albums)
 
 
-def test_keywords_dict():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_keywords_dict(photosdb):
     keywords = photosdb.keywords_as_dict
-    assert keywords["wedding"] == 2
+    assert keywords["wedding"] == 3
     assert keywords == KEYWORDS_DICT
 
 
-def test_persons_as_dict():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_persons_as_dict(photosdb):
     persons = photosdb.persons_as_dict
     assert persons["Maria"] == 1
     assert persons == PERSONS_DICT
 
 
-def test_albums_as_dict():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_albums_as_dict(photosdb):
     albums = photosdb.albums_as_dict
     assert albums["Pumpkin Farm"] == 3
     assert albums == ALBUM_DICT
 
 
-def test_attributes():
-    import datetime
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_attributes(photosdb):
     photos = photosdb.photos(uuid=["sE5LlfekS8ykEE7o0cuMVA"])
     assert len(photos) == 1
     p = photos[0]
@@ -126,38 +111,25 @@ def test_attributes():
     assert p.ismissing == False
 
 
-def test_missing():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_missing(photosdb):
     photos = photosdb.photos(uuid=["Pj99JmYjQkeezdY2OFuSaw"])
     assert len(photos) == 1
     p = photos[0]
-    assert p.path == None
+    assert p.path is None
     assert p.ismissing == True
 
 
-def test_count():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_count(photosdb):
     photos = photosdb.photos()
-    assert len(photos) == 9
+    assert len(photos) == 10
 
 
-def test_keyword_2():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_keyword_2(photosdb):
     photos = photosdb.photos(keywords=["wedding"])
-    assert len(photos) == 2
+    assert len(photos) == 3
 
 
-def test_keyword_not_in_album():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_keyword_not_in_album(photosdb):
     # find all photos with keyword "Kids" not in the album "Pumpkin Farm"
     photos1 = photosdb.photos(albums=["Pumpkin Farm"])
     photos2 = photosdb.photos(keywords=["Kids"])
@@ -166,12 +138,8 @@ def test_keyword_not_in_album():
     assert photos3[0].uuid == "Pj99JmYjQkeezdY2OFuSaw"
 
 
-def test_path_derivatives():
+def test_path_derivatives(photosdb):
     # test path_derivatives
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
     photos = photosdb.photos(uuid=[UUID_DICT["derivatives"]])
     p = photos[0]
     derivs = [
@@ -180,3 +148,18 @@ def test_path_derivatives():
     ]
     for i, p in enumerate(p.path_derivatives):
         assert p.endswith(derivs[i])
+
+
+def test_duplicates_1(photosdb):
+    # test photo has duplicates
+
+    photo = photosdb.get_photo(uuid=UUID_DICT["duplicates"])
+    assert len(photo.duplicates) == 1
+    assert photo.duplicates[0].uuid == UUID_DUPLICATE
+
+
+def test_duplicates_2(photosdb):
+    # test photo does not have duplicates
+
+    photo = photosdb.get_photo(uuid=UUID_DICT["no_duplicates"])
+    assert not photo.duplicates

tests/test_albums_folders_catalina_10_15_4.py

@@ -1,5 +1,7 @@
 import pytest
 
+import osxphotos
+
 from osxphotos._constants import _UNKNOWN_PERSON
 
 PHOTOS_DB = "./tests/Test-10.15.4.photoslibrary/database/photos.db"
@@ -61,11 +63,12 @@ UUID_DICT = {
 }
 
 
-def test_folders_1():
-    import osxphotos
+@pytest.fixture(scope="module")
+def photosdb():
+    return osxphotos.PhotosDB(dbfile=PHOTOS_DB)
 
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
 
+def test_folders_1(photosdb):
     # top level folders
     folders = photosdb.folder_info
     assert len(folders) == len(TOP_LEVEL_FOLDERS)
@@ -75,31 +78,19 @@ def test_folders_1():
     assert sorted(folder_names) == sorted(TOP_LEVEL_FOLDERS)
 
 
-def test_folder_names():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_folder_names(photosdb):
     # check folder names
     folder_names = photosdb.folders
     assert sorted(folder_names) == sorted(TOP_LEVEL_FOLDERS)
 
 
-def test_folders_len():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_folders_len(photosdb):
     # top level folders
     folders = photosdb.folder_info
     assert len(folders[0]) == len(TOP_LEVEL_CHILDREN)
 
 
-def test_folders_children():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_folders_children(photosdb):
     # top level folders
     folders = photosdb.folder_info
 
@@ -118,11 +109,7 @@ def test_folders_children():
     assert sorted(folder_names) == sorted(TOP_LEVEL_FOLDERS)
 
 
-def test_folders_parent():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_folders_parent(photosdb):
     # top level folders
     folders = photosdb.folder_info
 
@@ -135,11 +122,7 @@ def test_folders_parent():
             assert child.parent.uuid == folder.uuid
 
 
-def test_folders_albums():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_folders_albums(photosdb):
     # top level folders
     folders = photosdb.folder_info
 
@@ -156,11 +139,7 @@ def test_folders_albums():
 ########## Test AlbumInfo ##########
 
 
-def test_albums_1():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_1(photosdb):
     albums = photosdb.album_info
     assert len(albums) == len(ALBUM_NAMES)
 
@@ -169,11 +148,7 @@ def test_albums_1():
     assert sorted(album_names) == sorted(ALBUM_NAMES)
 
 
-def test_albums_parent():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_parent(photosdb):
     albums = photosdb.album_info
 
     for album in albums:
@@ -181,11 +156,7 @@ def test_albums_parent():
         assert parent == ALBUM_PARENT_DICT[album.title]
 
 
-def test_albums_folder_names():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_folder_names(photosdb):
     albums = photosdb.album_info
 
     for album in albums:
@@ -193,11 +164,7 @@ def test_albums_folder_names():
         assert folder_names == ALBUM_FOLDER_NAMES_DICT[album.title]
 
 
-def test_albums_folders():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_folders(photosdb):
     albums = photosdb.album_info
     for album in albums:
         folders = album.folder_list
@@ -205,22 +172,14 @@ def test_albums_folders():
         assert folder_names == ALBUM_FOLDER_NAMES_DICT[album.title]
 
 
-def test_albums_len():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_len(photosdb):
     albums = photosdb.album_info
 
     for album in albums:
         assert len(album) == ALBUM_LEN_DICT[album.title]
 
 
-def test_albums_photos():
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
-
+def test_albums_photos(photosdb):
     albums = photosdb.album_info
 
     for album in albums:
@@ -231,12 +190,9 @@ def test_albums_photos():
             assert photo.uuid in ALBUM_PHOTO_UUID_DICT[album.title]
 
 
-def test_album_dates():
-    """ Test album date methods """
+def test_album_dates(photosdb):
+    """Test album date methods"""
     import datetime
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
 
     album = [a for a in photosdb.album_info if a.uuid == UUID_DICT["album_dates"]][0]
     assert album.creation_date == datetime.datetime(
@@ -271,34 +227,24 @@ def test_album_dates():
     )
 
 
-def test_photoinfo_albums():
-    """ Test PhotoInfo.albums """
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_photoinfo_albums(photosdb):
+    """Test PhotoInfo.albums"""
     photos = photosdb.photos(uuid=ALBUM_PHOTO_UUID_DICT["Pumpkin Farm"])
 
     albums = photos[0].albums
     assert "Pumpkin Farm" in albums
 
 
-def test_photoinfo_albums_2():
-    """ Test that PhotoInfo.albums returns only number albums expected """
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_photoinfo_albums_2(photosdb):
+    """Test that PhotoInfo.albums returns only number albums expected"""
     photos = photosdb.photos(uuid=[UUID_DICT["two_albums"]])
 
     albums = photos[0].albums
     assert len(albums) == 2
 
 
-def test_photoinfo_album_info():
-    """ test PhotoInfo.album_info """
-
-    import osxphotos
-
-    photosdb = osxphotos.PhotosDB(dbfile=PHOTOS_DB)
+def test_photoinfo_album_info(photosdb):
+    """test PhotoInfo.album_info"""
     photos = photosdb.photos(uuid=[UUID_DICT["two_albums"]])
 
     album_info = photos[0].album_info