Updated CHANGELOG.md

Added Finder tags, partial implementation for issue #242

CHANGELOG.md

@@ -4,6 +4,46 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.39.5](https://github.com/RhetTbull/osxphotos/compare/v0.39.3...v0.39.5)
+
+> 3 January 2021
+
+- Implemented text replacement for templates, issue #316 [`478715a`](https://github.com/RhetTbull/osxphotos/commit/478715a363f5009e4a38148e832bf0ad3c4cc4f8)
+
+#### [v0.39.3](https://github.com/RhetTbull/osxphotos/compare/v0.39.2...v0.39.3)
+
+> 31 December 2020
+
+- Fixed modified template to use creation time if no modificationd date, issue #312 [`2f57abd`](https://github.com/RhetTbull/osxphotos/commit/2f57abd23cabe57bcf667a1713c37689b330a702)
+
+#### [v0.39.2](https://github.com/RhetTbull/osxphotos/compare/v0.39.1...v0.39.2)
+
+> 31 December 2020
+
+- Added --xattr-template, closes #242 [`#242`](https://github.com/RhetTbull/osxphotos/issues/242)
+
+#### [v0.39.1](https://github.com/RhetTbull/osxphotos/compare/v0.39.0...v0.39.1)
+
+> 31 December 2020
+
+- Fixed --exiftool-path bug, issue #311, #313 [`3394c52`](https://github.com/RhetTbull/osxphotos/commit/3394c527682d8fdd2f20f4f778d802dab86b6372)
+
+#### [v0.39.0](https://github.com/RhetTbull/osxphotos/compare/v0.38.22...v0.39.0)
+
+> 30 December 2020
+
+- Added Finder tags, partial implementation for issue #242  [`#310`](https://github.com/RhetTbull/osxphotos/pull/310)
+- Added tests for Finder tags [`29e4245`](https://github.com/RhetTbull/osxphotos/commit/29e424575a522ae03efe5a140be46bfd0a1346c5)
+- Initial implementation for Finder tags [`5885b23`](https://github.com/RhetTbull/osxphotos/commit/5885b23d3249cf91953092a6b1ce967da2667e29)
+- Updated README for finder tags [`f25a299`](https://github.com/RhetTbull/osxphotos/commit/f25a2993097ad7b2b8ab2d1c787db58c0d799a41)
+- Updated requirements.txt [`ea373c4`](https://github.com/RhetTbull/osxphotos/commit/ea373c4197ce1cce00e89157fe560d1366f7e764)
+
+#### [v0.38.22](https://github.com/RhetTbull/osxphotos/compare/v0.38.21...v0.38.22)
+
+> 30 December 2020
+
+- Fixed --exiftool-path bug, issue #308 [`5dccdf7`](https://github.com/RhetTbull/osxphotos/commit/5dccdf7750611c78de5356bb02f6023d4fc382c5)
+
 #### [v0.38.21](https://github.com/RhetTbull/osxphotos/compare/v0.38.20...v0.38.21)
 
 > 29 December 2020

README.md

@@ -412,6 +412,30 @@ Options:
                                   could specify --description-template
                                   "{descr} exported with osxphotos on
                                   {today.date}" See Templating System below.
+  --finder-tag-template TEMPLATE  Set MacOS Finder tags to TEMPLATE. These
+                                  tags can be searched in the Finder or
+                                  Spotlight with 'tag:tagname' format. For
+                                  example, '--finder-tag-template "{label}"'
+                                  to set Finder tags to photo labels. You may
+                                  specify multiple TEMPLATE values by using '
+                                  --finder-tag-template' multiple times. See
+                                  also '--finder-tag-keywords and Extended
+                                  Attributes below.'.
+  --finder-tag-keywords           Set MacOS Finder tags to keywords; any
+                                  keywords specified via '--keyword-template',
+                                  '--person-keyword', etc. will also be used
+                                  as Finder tags. See also '--finder-tag-
+                                  template and Extended Attributes below.'.
+  --xattr-template ATTRIBUTE TEMPLATE
+                                  Set extended attribute ATTRIBUTE to TEMPLATE
+                                  value. Valid attributes are: 'authors',
+                                  'comment', 'copyright', 'description',
+                                  'findercomment', 'headline', 'keywords'. For
+                                  example, to set Finder comment to the
+                                  photo's title and description: '--xattr-
+                                  template findercomment "{title}; {descr}"
+                                  See Extended Attributes below for additional
+                                  details on this option.
   --directory DIRECTORY           Optional template for specifying name of
                                   output directory in the form
                                   '{name,DEFAULT}'. See below for additional
@@ -422,6 +446,13 @@ Options:
                                   do not include an extension in the FILENAME
                                   template. See below for additional details
                                   on templating system.
+  --strip                         Optionally strip leading and trailing
+                                  whitespace from any rendered templates. For
+                                  example, if --filename template is "{title,}
+                                  {original_name}" and image has no title,
+                                  resulting file would have a leading space
+                                  but if used with --strip, this will be
+                                  removed.
   --edited-suffix SUFFIX          Optional suffix template for naming edited
                                   photos.  Default name for edited photos is
                                   in form 'photoname_edited.ext'. For example,
@@ -514,53 +545,74 @@ option to re-export the entire library thus rebuilding the
 '.osxphotos_export.db' database.
 
 
+** Extended Attributes **
+
+Some options (currently '--finder-tag-template', '--finder-tag-keywords',
+'-xattr-template') write additional metadata to extended attributes in the
+file. These options will only work if the destination filesystem supports
+extended attributes (most do). For example, --finder-tag-keyword writes all
+keywords (including any specified by '--keyword-template' or other options) to
+Finder tags that are searchable in Spotlight using the syntax: 'tag:tagname'.
+For example, if you have images with keyword "Travel" then using '--finder-
+tag-keywords' you could quickly find those images in the Finder by typing
+'tag:Travel' in the Spotlight search bar. Finder tags are written to the
+'com.apple.metadata:_kMDItemUserTags' extended attribute. Unlike EXIF
+metadata, extended attributes do not modify the actual file. Most cloud
+storage services do not synch extended attributes. Dropbox does sync them and
+any changes to a file's extended attributes will cause Dropbox to re-sync the
+files.
+
+The following attributes may be used with '--xattr-template':
+
+
+authors        The author, or authors, of the contents of the file.  A list
+               of strings. (com.apple.metadata:kMDItemAuthors)
+comment        A comment related to the file.  This differs from the Finder
+               comment, kMDItemFinderComment.  A string.
+               (com.apple.metadata:kMDItemComment)
+copyright      The copyright owner of the file contents.  A string.
+               (com.apple.metadata:kMDItemCopyright)
+description    A description of the content of the resource.  The
+               description may include an abstract, table of contents,
+               reference to a graphical representation of content or a free-
+               text account of the content.  A string.
+               (com.apple.metadata:kMDItemDescription)
+findercomment  Finder comments for this file.  A string.
+               (com.apple.metadata:kMDItemFinderComment)
+headline       A publishable entry providing a synopsis of the contents of
+               the file.  A string. (com.apple.metadata:kMDItemHeadline)
+keywords       Keywords associated with this file. For example, “Birthday”,
+               “Important”, etc. This differs from Finder tags
+               (_kMDItemUserTags) which are keywords/tags shown in the
+               Finder and searchable in Spotlight using "tag:tag_name".  A
+               list of strings. (com.apple.metadata:kMDItemKeywords)
+
+For additional information on extended attributes see: https://developer.apple
+.com/documentation/coreservices/file_metadata/mditem/common_metadata_attribute
+_keys
+
+
 ** Templating System **
 
 Several options, such as --directory, allow you to specify a template  which
-will be rendered to substitute template fields with values from the photo.
-For example, '{created.month}' would be replaced with the month name of the
-photo creation date.  e.g. 'November'.
+will be rendered to substitute template fields with values from the photo. For
+example, '{created.month}' would be replaced with the month name of the photo
+creation date.  e.g. 'November'.
 
 Some options supporting templates may be repeated e.g., --keyword-template
 '{label}'  --keyword-template '{media_type}' to add both labels and media
 types to the  keywords.
 
-The general format for a template is '{TEMPLATE_FIELD[,[DEFAULT]]}'.  Some
-templates have optional modifiers in form
-'{[[DELIM]+]TEMPLATE_FIELD[(PATH_SEP)][?VALUE_IF_TRUE][,[DEFAULT]]}'
+The general format for a template is '{TEMPLATE_FIELD,DEFAULT}'. The full
+template format is:
+'{DELIM+TEMPLATE_FIELD(PATH_SEP)[OLD,NEW]?VALUE_IF_TRUE,DEFAULT}'
 
-The ',' and DEFAULT value are optional.  If TEMPLATE_FIELD results in a null
-(empty) value, the default is '_'.   You may specify an alternate default
-value by appending ',DEFAULT' after template_field.  e.g. '{title,no_title}'
-would result in 'no_title' if the photo had no title.  You may include other
-text in the template string outside the {} and use more than  one template
-field, e.g. '{created.year} - {created.month}' (e.g. '2020 - November').
+With a few exceptions (like '{created.strftime}') everything but the
+TEMPLATE_FIELD is optional.
 
-Some template fields such as 'hdr' are boolean and resolve to True or False.
-These take the form: '{TEMPLATE_FIELD?VALUE_IF_TRUE,VALUE_IF_FALSE}', e.g.
-{hdr?is_hdr,not_hdr} which would result in 'is_hdr' if photo is an HDR  image
-and 'not_hdr' otherwise.
-
-Some template fields such as 'folder_template' are "path-like" in that they
-join  multiple elements into a single path-like string.  For example, if photo
-is in  album Album1 in folder Folder1, '{folder_album}` results in
-'Folder1/Album1'.  This is so these template fields may be used as paths in
---directory.  If you intend to use such a field as a string, e.g. in the
-filename, you may specify  a different path separator using the form:
-'{TEMPLATE_FIELD(PATH_SEP)}'.  For example, using the example above,
-'{folder_album(-)}' would result in  'Folder1-Album1' and '{folder_album()}'
-would result in  'Folder1Album1'.
-
-Some templates may resolve to more than one value.  For example, a photo can
-have  multiple keywords so '{keyword}' can result in multiple values.  If used
-in a filename  or directory, these templates may result in more than one copy
-of the photo being exported.  For example, if photo has keywords "foo" and
-"bar", --directory '{keyword}' will result in  copies of the photo being
-exported to 'foo/image_name.jpeg' and 'bar/image_name.jpeg'.
-
-Multi-value template fields such as '{keyword}' may be expanded 'in place'
-with an optional delimiter using the template form '{DELIM+TEMPLATE_FIELD}'.
-For example, a photo with  keywords 'foo' and 'bar':
+- 'DELIM+' Multi-value template fields such as '{keyword}' may be expanded 'in
+place' with an optional delimiter using the template form
+'{DELIM+TEMPLATE_FIELD}'. For example, a photo with  keywords 'foo' and 'bar':
 
 '{keyword}' renders to 'foo' and 'bar'
 
@@ -570,6 +622,62 @@ For example, a photo with  keywords 'foo' and 'bar':
 
 '{+keyword}' renders to 'foobar'
 
+- 'TEMPLATE_FIELD' The name of the template field, for example 'keyword'
+
+- '(PATH_SEP)' Some template fields such as '{folder_album}' are "path-like"
+in  that they join multiple elements into a single path-like string. For
+example,  if photo is in album Album1 in folder Folder1, '{folder_album}'
+results in 'Folder1/Album1'. This is so these template fields may be used as
+paths in --directory. If you intend to use such a field as a string, e.g. in
+the filename, you may specify a different path separator using the form:
+'{TEMPLATE_FIELD(PATH_SEP)}'. For example, using the example above,
+'{folder_album(-)}' would result in 'Folder1-Album1' and '{folder_album()}'
+would result in  'Folder1Album1'.
+
+- '[OLD,NEW]' Use the [OLD,NEW] option to replace text "OLD" in the template
+value with text "NEW". For example, if you have album names with '/' in the
+album name you could replace '/' with "-" using the template '{album[/,-]}'.
+This would replace any occurence of "/" in the album name with "-"; album
+"Vacation/2019" would thus become "Vacation-2019".  You may specify more than
+one pair of OLD,NEW values by listing them delimited by '|'. For example:
+'{album[/,-|:,-]}' to replace both '/' and ':' by '-'. You can also use the
+[OLD,NEW] syntax to delete a character by omitting the NEW value as in
+'{album[/,]}'.
+
+- '?' Some template fields such as 'hdr' are boolean and resolve to True or
+False. These take the form: '{TEMPLATE_FIELD?VALUE_IF_TRUE,VALUE_IF_FALSE}',
+e.g. {hdr?is_hdr,not_hdr} which would result in 'is_hdr' if photo is an HDR
+image and 'not_hdr' otherwise.
+
+- ',DEFAULT' The ',' and DEFAULT value are optional.  If TEMPLATE_FIELD
+results in a null (empty) value, the template will result in default value of
+'_'. You may specify an alternate default value by appending ',DEFAULT' after
+template_field. Example: '{title,no_title}' would result in 'no_title' if the
+photo had no title. Example: '{created.year}/{place.address,NO_ADDRESS}' but
+there was  no address associated with the photo, the resulting output would
+be: '2020/NO_ADDRESS/photoname.jpg'. If specified, the default value may not
+contain a brace symbol ('{' or '}').
+
+Again, if you do not specify a default value and the template substitution has
+no value, '_' (underscore) will be used as the default value. For example, in
+the above example, this would result in '2020/_/photoname.jpg' if address was
+null.
+
+You may specify a null default (e.g. "" or empty string) by omitting the value
+after the comma, e.g. {title,} which would render to "" if title had no value
+thus effectively deleting the template from the resulting string.
+
+You may include other text in the template string outside the {} and use more
+than one template field in a single string,  e.g. '{created.year} -
+{created.month}' (e.g. '2020 - November').
+
+Some templates may resolve to more than one value.  For example, a photo can
+have multiple keywords so '{keyword}' can result in multiple values.  If used
+in a filename  or directory, these templates may result in more than one copy
+of the photo being exported.  For example, if photo has keywords "foo" and
+"bar", --directory '{keyword}' will result in  copies of the photo being
+exported to 'foo/image_name.jpeg' and 'bar/image_name.jpeg'.
+
 Some template fields such as '{media_type}' use the 'DEFAULT' value to allow
 customization  of the output. For example, '{media_type}' resolves to the
 special media type of the  photo such as 'panorama' or 'selfie'.  You may use
@@ -579,6 +687,28 @@ photo is a time_lapse photo, 'media_type' would resolve to  'vidéo_accélérée
 instead of 'time_lapse' and video would resolve to 'vidéo' if photo is an
 ordinary video.
 
+With the --directory and --filename options you may specify a template for the
+export directory or filename, respectively. The directory will be appended to
+the export path specified in the export DEST argument to export. For example,
+if template is '{created.year}/{created.month}', and export destination DEST
+is '/Users/maria/Pictures/export', the actual export directory for a photo
+would be '/Users/maria/Pictures/export/2020/March' if the photo was created in
+March 2020.
+
+The templating system may also be used with the --keyword-template option to
+set keywords on export (with --exiftool or --sidecar), for example, to set a
+new keyword in format 'folder/subfolder/album' to preserve the folder/album
+structure, you can use --keyword-template "{folder_album}"
+
+In the template, valid template substitutions will be replaced by the
+corresponding value from the table below.  Invalid substitutions will result
+in an error.
+
+If you want the actual text of the template substition to appear in the
+rendered name, use double braces, e.g. '{{' or '}}', thus using
+'{created.year}/{{name}}' for --directory would result in output of
+2020/{name}/photoname.jpg
+
 With the --directory and --filename options you may specify a template for the
 export directory or filename, respectively. The directory will be appended to
 the export path specified in the export DEST argument to export.  For example,
@@ -669,27 +799,39 @@ Substitution                    Description
                                 https://strftime.org/ for help on strftime
                                 templates.
 {modified.date}                 Photo's modification date in ISO format,
-                                e.g. '2020-03-22'
-{modified.year}                 4-digit year of photo modification time
-{modified.yy}                   2-digit year of photo modification time
+                                e.g. '2020-03-22'; uses creation date if
+                                photo is not modified
+{modified.year}                 4-digit year of photo modification time;
+                                uses creation date if photo is not modified
+{modified.yy}                   2-digit year of photo modification time;
+                                uses creation date if photo is not modified
 {modified.mm}                   2-digit month of the photo modification time
-                                (zero padded)
+                                (zero padded); uses creation date if photo
+                                is not modified
 {modified.month}                Month name in user's locale of the photo
-                                modification time
+                                modification time; uses creation date if
+                                photo is not modified
 {modified.mon}                  Month abbreviation in the user's locale of
-                                the photo modification time
+                                the photo modification time; uses creation
+                                date if photo is not modified
 {modified.dd}                   2-digit day of the month (zero padded) of
-                                the photo modification time
+                                the photo modification time; uses creation
+                                date if photo is not modified
 {modified.dow}                  Day of week in user's locale of the photo
-                                modification time
+                                modification time; uses creation date if
+                                photo is not modified
 {modified.doy}                  3-digit day of year (e.g Julian day) of
                                 photo modification time, starting from 1
-                                (zero padded)
-{modified.hour}                 2-digit hour of the photo modification time
+                                (zero padded); uses creation date if photo
+                                is not modified
+{modified.hour}                 2-digit hour of the photo modification time;
+                                uses creation date if photo is not modified
 {modified.min}                  2-digit minute of the photo modification
-                                time
+                                time; uses creation date if photo is not
+                                modified
 {modified.sec}                  2-digit second of the photo modification
-                                time
+                                time; uses creation date if photo is not
+                                modified
 {today.date}                    Current date in iso format, e.g.
                                 '2020-03-22'
 {today.year}                    4-digit year of current date
@@ -750,6 +892,19 @@ Substitution                    Description
                                 e.g. 'Summer'; (Photos 5+ only, applied
                                 automatically by Photos' image
                                 categorization algorithms).
+{exif.camera_make}              Camera make from original photo's EXIF
+                                inormation as imported by Photos, e.g.
+                                'Apple'
+{exif.camera_model}             Camera model from original photo's EXIF
+                                inormation as imported by Photos, e.g.
+                                'iPhone 6s'
+{exif.lens_model}               Lens model from original photo's EXIF
+                                inormation as imported by Photos, e.g.
+                                'iPhone 6s back camera 4.15mm f/2.2'
+{uuid}                          Photo's internal universally unique
+                                identifier (UUID) for the photo, a
+                                36-character string unique to the photo,
+                                e.g. '128FB4C6-0B16-4E7D-9108-FB2E90DA1546'
 
 The following substitutions may result in multiple values. Thus if specified
 for --directory these could result in multiple copies of a photo being being
@@ -1643,7 +1798,7 @@ If overwrite=False and increment=False, export will fail if destination file alr
 
 #### <a name="rendertemplate">`render_template()`</a>
 
-`render_template(template_str, none_str = "_", path_sep = None, expand_inplace = False, inplace_sep = None, filename=False, dirname=False, replacement=":",)`
+`render_template(template_str, none_str = "_", path_sep = None, expand_inplace = False, inplace_sep = None, filename=False, dirname=False, strip=False)`
 
 Render template string for photo.  none_str is used if template substitution results in None value and no default specified.
 
@@ -1654,7 +1809,7 @@ Render template string for photo.  none_str is used if template substitution res
 - `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
-- `replacement`: str, value to replace any illegal file path characters with; default = ":"
+- `strip`: if True, leading/trailign whitespace will be stripped from rendered template strings
 
 Returns a tuple of (rendered, unmatched) where rendered is a list of rendered strings with all substitutions made and unmatched is a list of any strings that resembled a template substitution but did not match a known substitution. E.g. if template contained "{foo}", unmatched would be ["foo"].
 
@@ -1668,7 +1823,7 @@ Some substitutions, notably `album`, `keyword`, and `person` could return multip
 
 The template field format contains optional modifiers:
 
-`"{[[DELIM]+]name[(PATH_SEP)][?TRUE_VALUE][,[DEFAULT]]}"`
+`"{DELIM+name(PATH_SEP)[OLD,NEW]?TRUE_VALUE,DEFAULT}"`
 
 `DELIM`: optional delimiter string to use when expanding multi-valued template values in-place
 
@@ -1689,6 +1844,8 @@ e.g. If Photo is in `Album1` in `Folder1`:
 - `"{folder_album(:)}"` renders to `["Folder1:Album1"]`
 - `"{folder_album()}"` renders to `["Folder1Album1"]`
 
+`[OLD,NEW]`: optional text replacement to perform on rendered template value.  For example, to replace "/" in an album name, you could use the template `"{album[/,-]}"`.
+
 `?TRUE_VALUE`: optional value to use if name is boolean-type field which evaluates to true.  For example `"{hdr}"` evaluates to True if photo is an high dynamic range (HDR) image and False otherwise. In these types of fields, use `?TRUE_VALUE` to provide the value if True and `,DEFAULT` to provide the value of False.  
 
 e.g. if photo is an HDR image,
@@ -2226,18 +2383,18 @@ The following template field substitutions are availabe for use with `PhotoInfo.
 |{created.min}|2-digit minute of the photo creation time|
 |{created.sec}|2-digit second of the photo creation time|
 |{created.strftime}|Apply strftime template to file creation date/time. Should be used in form {created.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {created.strftime,%Y-%U} would result in year-week number of year: '2020-23'. If used with no template will return null value. See https://strftime.org/ for help on strftime templates.|
-|{modified.date}|Photo's modification date in ISO format, e.g. '2020-03-22'|
-|{modified.year}|4-digit year of photo modification time|
-|{modified.yy}|2-digit year of photo modification time|
-|{modified.mm}|2-digit month of the photo modification time (zero padded)|
-|{modified.month}|Month name in user's locale of the photo modification time|
-|{modified.mon}|Month abbreviation in the user's locale of the photo modification time|
-|{modified.dd}|2-digit day of the month (zero padded) of the photo modification time|
-|{modified.dow}|Day of week in user's locale of the photo modification time|
-|{modified.doy}|3-digit day of year (e.g Julian day) of photo modification time, starting from 1 (zero padded)|
-|{modified.hour}|2-digit hour of the photo modification time|
-|{modified.min}|2-digit minute of the photo modification time|
-|{modified.sec}|2-digit second of the photo modification time|
+|{modified.date}|Photo's modification date in ISO format, e.g. '2020-03-22'; uses creation date if photo is not modified|
+|{modified.year}|4-digit year of photo modification time; uses creation date if photo is not modified|
+|{modified.yy}|2-digit year of photo modification time; uses creation date if photo is not modified|
+|{modified.mm}|2-digit month of the photo modification time (zero padded); uses creation date if photo is not modified|
+|{modified.month}|Month name in user's locale of the photo modification time; uses creation date if photo is not modified|
+|{modified.mon}|Month abbreviation in the user's locale of the photo modification time; uses creation date if photo is not modified|
+|{modified.dd}|2-digit day of the month (zero padded) of the photo modification time; uses creation date if photo is not modified|
+|{modified.dow}|Day of week in user's locale of the photo modification time; uses creation date if photo is not modified|
+|{modified.doy}|3-digit day of year (e.g Julian day) of photo modification time, starting from 1 (zero padded); uses creation date if photo is not modified|
+|{modified.hour}|2-digit hour of the photo modification time; uses creation date if photo is not modified|
+|{modified.min}|2-digit minute of the photo modification time; uses creation date if photo is not modified|
+|{modified.sec}|2-digit second of the photo modification time; uses creation date if photo is not modified|
 |{today.date}|Current date in iso format, e.g. '2020-03-22'|
 |{today.year}|4-digit year of current date|
 |{today.yy}|2-digit year of current date|
@@ -2265,6 +2422,10 @@ The following template field substitutions are availabe for use with `PhotoInfo.
 |{place.address.country}|Country name of the postal address, e.g. 'United States'|
 |{place.address.country_code}|ISO country code of the postal address, e.g. 'US'|
 |{searchinfo.season}|Season of the year associated with a photo, e.g. 'Summer'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
+|{exif.camera_make}|Camera make from original photo's EXIF inormation as imported by Photos, e.g. 'Apple'|
+|{exif.camera_model}|Camera model from original photo's EXIF inormation as imported by Photos, e.g. 'iPhone 6s'|
+|{exif.lens_model}|Lens model from original photo's EXIF inormation as imported by Photos, e.g. 'iPhone 6s back camera 4.15mm f/2.2'|
+|{uuid}|Photo's internal universally unique identifier (UUID) for the photo, a 36-character string unique to the photo, e.g. '128FB4C6-0B16-4E7D-9108-FB2E90DA1546'|
 |{album}|Album(s) photo is contained in|
 |{folder_album}|Folder path + album photo is contained in. e.g. 'Folder/Subfolder/Album' or just 'Album' if no enclosing folder|
 |{keyword}|Keyword(s) assigned to photo|

osxphotos/__main__.py

@@ -11,12 +11,14 @@ import time
 import unicodedata
 
 import click
+import osxmetadata
 import yaml
 
 import osxphotos
 
 from ._constants import (
     _EXIF_TOOL_URL,
+    _OSXPHOTOS_NONE_SENTINEL,
     _PHOTOS_4_VERSION,
     _UNKNOWN_PLACE,
     CLI_COLOR_ERROR,
@@ -24,6 +26,8 @@ from ._constants import (
     DEFAULT_EDITED_SUFFIX,
     DEFAULT_JPEG_QUALITY,
     DEFAULT_ORIGINAL_SUFFIX,
+    EXTENDED_ATTRIBUTE_NAMES,
+    EXTENDED_ATTRIBUTE_NAMES_QUOTED,
     SIDECAR_EXIFTOOL,
     SIDECAR_JSON,
     SIDECAR_XMP,
@@ -179,72 +183,157 @@ class ExportCommand(click.Command):
             + "You can always run export without the --update option to re-export the entire library thus "
             + f"rebuilding the '{OSXPHOTOS_EXPORT_DB}' database."
         )
+        formatter.write("\n\n")
+        formatter.write_text("** Extended Attributes **")
+        formatter.write("\n")
+        formatter.write_text(
+            """
+Some options (currently '--finder-tag-template', '--finder-tag-keywords', '-xattr-template') write
+additional metadata to extended attributes in the file. These options will only work
+if the destination filesystem supports extended attributes (most do).
+For example, --finder-tag-keyword writes all keywords (including any specified by '--keyword-template'
+or other options) to Finder tags that are searchable in Spotlight using the syntax: 'tag:tagname'.
+For example, if you have images with keyword "Travel" then using '--finder-tag-keywords' you could quickly
+find those images in the Finder by typing 'tag:Travel' in the Spotlight search bar.
+Finder tags are written to the 'com.apple.metadata:_kMDItemUserTags' extended attribute.
+Unlike EXIF metadata, extended attributes do not modify the actual file. Most cloud storage services
+do not synch extended attributes. Dropbox does sync them and any changes to a file's extended attributes
+will cause Dropbox to re-sync the files.
 
+The following attributes may be used with '--xattr-template':
+
+            """
+        )
+        formatter.write_dl(
+            [
+                (
+                    attr,
+                    f"{osxmetadata.ATTRIBUTES[attr].help} ({osxmetadata.ATTRIBUTES[attr].constant})",
+                )
+                for attr in EXTENDED_ATTRIBUTE_NAMES
+            ]
+        )
+        formatter.write("\n")
+        formatter.write_text(
+            "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_text("** Templating System **")
         formatter.write("\n")
         formatter.write_text(
             """
-Several options, such as --directory, allow you to specify a template 
-which will be rendered to substitute template fields with values from the photo. 
-For example, '{created.month}' would be replaced with the month name of the photo creation date. 
-e.g. 'November'. 
-\n
-Some options supporting templates may be repeated e.g., --keyword-template '{label}' 
---keyword-template '{media_type}' to add both labels and media types to the 
-keywords.
-\n
-The general format for a template is '{TEMPLATE_FIELD[,[DEFAULT]]}'. 
-Some templates have optional modifiers in form 
-'{[[DELIM]+]TEMPLATE_FIELD[(PATH_SEP)][?VALUE_IF_TRUE][,[DEFAULT]]}'
-\n
-The ',' and DEFAULT value are optional. 
-If TEMPLATE_FIELD results in a null (empty) value, the default is '_'.  
-You may specify an alternate default value by appending ',DEFAULT' after template_field. 
-e.g. '{title,no_title}' would result in 'no_title' if the photo had no title. 
-You may include other text in the template string outside the {} and use more than 
-one template field, e.g. '{created.year} - {created.month}' (e.g. '2020 - November'). 
-\n
-Some template fields such as 'hdr' are boolean and resolve to True or False. 
-These take the form: '{TEMPLATE_FIELD?VALUE_IF_TRUE,VALUE_IF_FALSE}', e.g. 
-{hdr?is_hdr,not_hdr} which would result in 'is_hdr' if photo is an HDR 
-image and 'not_hdr' otherwise.
-\n
-Some template fields such as 'folder_template' are "path-like" in that they join 
-multiple elements into a single path-like string.  For example, if photo is in 
-album Album1 in folder Folder1, '{folder_album}` results in 'Folder1/Album1'. 
-This is so these template fields may be used as paths in --directory. 
-If you intend to use such a field as a string, e.g. in the filename, you may specify 
-a different path separator using the form: '{TEMPLATE_FIELD(PATH_SEP)}'. 
-For example, using the example above, '{folder_album(-)}' would result in 
-'Folder1-Album1' and '{folder_album()}' would result in 
-'Folder1Album1'.
-\n
-Some templates may resolve to more than one value.  For example, a photo can have 
-multiple keywords so '{keyword}' can result in multiple values.  If used in a filename 
-or directory, these templates may result in more than one copy of the photo being exported. 
-For example, if photo has keywords "foo" and "bar", --directory '{keyword}' will result in 
-copies of the photo being exported to 'foo/image_name.jpeg' and 'bar/image_name.jpeg'.  
-\n
-Multi-value template fields such as '{keyword}' may be expanded 'in place' with an optional
-delimiter using the template form '{DELIM+TEMPLATE_FIELD}'.  For example, a photo with 
-keywords 'foo' and 'bar':
-\n
+Several options, such as --directory, allow you to specify a template  which
+will be rendered to substitute template fields with values from the photo.
+For example, '{created.month}' would be replaced with the month name of the
+photo creation date.  e.g. 'November'.
+
+Some options supporting templates may be repeated e.g., --keyword-template
+'{label}'  --keyword-template '{media_type}' to add both labels and media
+types to the  keywords.
+
+The general format for a template is '{TEMPLATE_FIELD,DEFAULT}'. The full template format is: 
+'{DELIM+TEMPLATE_FIELD(PATH_SEP)[OLD,NEW]?VALUE_IF_TRUE,DEFAULT}'
+
+With a few exceptions (like '{created.strftime}') everything but the TEMPLATE_FIELD
+is optional.
+
+- 'DELIM+' Multi-value template fields such as '{keyword}' may be expanded 'in place'
+with an optional delimiter using the template form '{DELIM+TEMPLATE_FIELD}'.
+For example, a photo with  keywords 'foo' and 'bar':
+
 '{keyword}' renders to 'foo' and 'bar'
-\n
+
 '{,+keyword}' renders to: 'foo,bar'
-\n
+
 '{; +keyword}' renders to: 'foo; bar'
-\n
+
 '{+keyword}' renders to 'foobar'
-\n
-Some template fields such as '{media_type}' use the 'DEFAULT' value to allow customization 
-of the output. For example, '{media_type}' resolves to the special media type of the 
-photo such as 'panorama' or 'selfie'.  You may use the 'DEFAULT' value to override 
-these in form: '{media_type,video=vidéo;time_lapse=vidéo_accélérée}'. 
-In this example, if photo is a time_lapse photo, 'media_type' would resolve to 
-'vidéo_accélérée' instead of 'time_lapse' and video would resolve to 'vidéo' if photo
-is an ordinary video. 
+
+- 'TEMPLATE_FIELD' The name of the template field, for example 'keyword'
+
+- '(PATH_SEP)' Some template fields such as '{folder_album}' are "path-like" in 
+that they join multiple elements into a single path-like string. For example, 
+if photo is in album Album1 in folder Folder1, '{folder_album}' results in
+'Folder1/Album1'. This is so these template fields may be used as paths in
+--directory. If you intend to use such a field as a string, e.g. in the
+filename, you may specify a different path separator using the form:
+'{TEMPLATE_FIELD(PATH_SEP)}'. For example, using the example above,
+'{folder_album(-)}' would result in 'Folder1-Album1' and '{folder_album()}'
+would result in  'Folder1Album1'.
+
+- '[OLD,NEW]' Use the [OLD,NEW] option to replace text "OLD" in the template value
+with text "NEW". For example, if you have album names with '/' in the album name you
+could replace '/' with "-" using the template '{album[/,-]}'. This would replace
+any occurence of "/" in the album name with "-"; album "Vacation/2019" would thus
+become "Vacation-2019".  You may specify more than one pair of OLD,NEW values by
+listing them delimited by '|'. For example: '{album[/,-|:,-]}' to replace both
+'/' and ':' by '-'. You can also use the [OLD,NEW] syntax to delete a character by
+omitting the NEW value as in '{album[/,]}'.
+
+- '?' Some template fields such as 'hdr' are boolean and resolve to True or False.
+These take the form: '{TEMPLATE_FIELD?VALUE_IF_TRUE,VALUE_IF_FALSE}', e.g.
+{hdr?is_hdr,not_hdr} which would result in 'is_hdr' if photo is an HDR  image
+and 'not_hdr' otherwise.
+
+- ',DEFAULT' The ',' and DEFAULT value are optional.  If TEMPLATE_FIELD results
+in a null (empty) value, the template will result in default value of '_'.
+You may specify an alternate default value by appending ',DEFAULT' after
+template_field. Example: '{title,no_title}' would result in 'no_title' if the photo
+had no title. Example: '{created.year}/{place.address,NO_ADDRESS}' but there was 
+no address associated with the photo, the resulting output would be:
+'2020/NO_ADDRESS/photoname.jpg'. If specified, the default value may not
+contain a brace symbol ('{' or '}').
+
+Again, if you do not specify a default value and the template substitution has no
+value, '_' (underscore) will be used as the default value. For example, in the
+above example, this would result in '2020/_/photoname.jpg' if address was
+null.
+
+You may specify a null default (e.g. "" or empty string) by omitting the value
+after the comma, e.g. {title,} which would render to "" if title had no value thus
+effectively deleting the template from the resulting string.
+
+You may include other text in the template string outside the {}
+and use more than one template field in a single string, 
+e.g. '{created.year} - {created.month}' (e.g. '2020 - November').
+
+Some templates may resolve to more than one value.  For example, a photo can
+have multiple keywords so '{keyword}' can result in multiple values.  If used
+in a filename  or directory, these templates may result in more than one copy
+of the photo being exported.  For example, if photo has keywords "foo" and
+"bar", --directory '{keyword}' will result in  copies of the photo being
+exported to 'foo/image_name.jpeg' and 'bar/image_name.jpeg'.
+
+Some template fields such as '{media_type}' use the 'DEFAULT' value to allow
+customization  of the output. For example, '{media_type}' resolves to the
+special media type of the  photo such as 'panorama' or 'selfie'.  You may use
+the 'DEFAULT' value to override  these in form:
+'{media_type,video=vidéo;time_lapse=vidéo_accélérée}'.  In this example, if
+photo is a time_lapse photo, 'media_type' would resolve to  'vidéo_accélérée'
+instead of 'time_lapse' and video would resolve to 'vidéo' if photo is an
+ordinary video.
+
+With the --directory and --filename options you may specify a template for the
+export directory or filename, respectively. The directory will be appended to
+the export path specified in the export DEST argument to export. For example,
+if template is '{created.year}/{created.month}', and export destination DEST
+is '/Users/maria/Pictures/export', the actual export directory for a photo
+would be '/Users/maria/Pictures/export/2020/March' if the photo was created in
+March 2020.
+
+The templating system may also be used with the --keyword-template option to
+set keywords on export (with --exiftool or --sidecar), for example, to set a
+new keyword in format 'folder/subfolder/album' to preserve the folder/album
+structure, you can use --keyword-template "{folder_album}"
+
+In the template, valid template substitutions will be replaced by the
+corresponding value from the table below.  Invalid substitutions will result
+in an error.
+
+If you want the actual text of the template substition to appear in the
+rendered name, use double braces, e.g. '{{' or '}}', thus using
+'{created.year}/{{name}}' for --directory would result in output of
+2020/{name}/photoname.jpg
 """
         )
         formatter.write("\n")
@@ -1454,6 +1543,33 @@ def query(
     '--description-template "{descr} exported with osxphotos on {today.date}" '
     "See Templating System below.",
 )
+@click.option(
+    "--finder-tag-template",
+    metavar="TEMPLATE",
+    multiple=True,
+    default=None,
+    help="Set MacOS Finder tags to TEMPLATE. These tags can be searched in the Finder or Spotlight with "
+    "'tag:tagname' format. For example, '--finder-tag-template \"{label}\"' to set Finder tags to photo labels. "
+    "You may specify multiple TEMPLATE values by using '--finder-tag-template' multiple times. "
+    "See also '--finder-tag-keywords and Extended Attributes below.'.",
+)
+@click.option(
+    "--finder-tag-keywords",
+    is_flag=True,
+    help="Set MacOS Finder tags to keywords; any keywords specified via '--keyword-template', '--person-keyword', etc. "
+    "will also be used as Finder tags. See also '--finder-tag-template and Extended Attributes below.'.",
+)
+@click.option(
+    "--xattr-template",
+    nargs=2,
+    metavar="ATTRIBUTE TEMPLATE",
+    multiple=True,
+    help="Set extended attribute ATTRIBUTE to TEMPLATE value. Valid attributes are: "
+    f"{', '.join(EXTENDED_ATTRIBUTE_NAMES_QUOTED)}. "
+    "For example, to set Finder comment to the photo's title and description: "
+    '\'--xattr-template findercomment "{title}; {descr}" '
+    "See Extended Attributes below for additional details on this option.",
+)
 @click.option(
     "--directory",
     metavar="DIRECTORY",
@@ -1470,6 +1586,14 @@ def query(
     "File extension will be added automatically--do not include an extension in the FILENAME template. "
     "See below for additional details on templating system.",
 )
+@click.option(
+    "--strip",
+    is_flag=True,
+    help="Optionally strip leading and trailing whitespace from any rendered templates. "
+    'For example, if --filename template is "{title,} {original_name}" and image has no '
+    "title, resulting file would have a leading space but if used with --strip, this will "
+    "be removed.",
+)
 @click.option(
     "--edited-suffix",
     metavar="SUFFIX",
@@ -1594,6 +1718,9 @@ def export(
     album_keyword,
     keyword_template,
     description_template,
+    finder_tag_template,
+    finder_tag_keywords,
+    xattr_template,
     current_name,
     convert_to_jpeg,
     jpeg_quality,
@@ -1630,6 +1757,7 @@ def export(
     has_raw,
     directory,
     filename_template,
+    strip,
     edited_suffix,
     original_suffix,
     place,
@@ -1686,7 +1814,7 @@ def export(
             )
             raise click.Abort()
 
-        # re-set the local function vars to the corresponding config value
+        # re-set the local vars to the corresponding config value
         # this isn't elegant but avoids having to rewrite this function to use cfg.varname for every parameter
         db = cfg.db
         photos_library = cfg.photos_library
@@ -1730,6 +1858,9 @@ def export(
         album_keyword = cfg.album_keyword
         keyword_template = cfg.keyword_template
         description_template = cfg.description_template
+        finder_tag_template = cfg.finder_tag_template
+        finder_tag_keywords = cfg.finder_tag_keywords
+        xattr_template = cfg.xattr_template
         current_name = cfg.current_name
         convert_to_jpeg = cfg.convert_to_jpeg
         jpeg_quality = cfg.jpeg_quality
@@ -1765,6 +1896,7 @@ def export(
         has_raw = cfg.has_raw
         directory = cfg.directory
         filename_template = cfg.filename_template
+        strip = cfg.strip
         edited_suffix = cfg.edited_suffix
         original_suffix = cfg.original_suffix
         place = cfg.place
@@ -1844,6 +1976,19 @@ def export(
         )
         raise click.Abort()
 
+    if xattr_template:
+        for attr, _ in xattr_template:
+            if attr not in EXTENDED_ATTRIBUTE_NAMES:
+                click.echo(
+                    click.style(
+                        f"Invalid attribute '{attr}' for --xattr-template; "
+                        f"valid values are {', '.join(EXTENDED_ATTRIBUTE_NAMES_QUOTED)}",
+                        fg=CLI_COLOR_ERROR,
+                    ),
+                    err=True,
+                )
+                raise click.Abort()
+
     if save_config:
         verbose_(f"Saving options to file {save_config}")
         cfg.write_to_file(save_config)
@@ -1890,8 +2035,13 @@ def export(
         not x for x in [skip_edited, skip_bursts, skip_live, skip_raw]
     ]
 
-    # verify exiftool installed and in path if path not provided
-    if (exiftool or exiftool_merge_keywords or exiftool_merge_persons) and not exiftool_path:
+    # verify exiftool installed and in path if path not provided and exiftool will be used
+    # NOTE: this won't catch use of {exiftool:} in a template
+    # but those will raise error during template eval if exiftool path not set
+    if (
+        any([exiftool, exiftool_merge_keywords, exiftool_merge_persons])
+        and not exiftool_path
+    ):
         try:
             exiftool_path = get_exiftool_path()
         except FileNotFoundError:
@@ -1905,7 +2055,7 @@ def export(
             )
             ctx.exit(2)
 
-    if any([exiftool, exiftool_path, exiftool_merge_keywords, exiftool_merge_persons]):
+    if any([exiftool, exiftool_merge_keywords, exiftool_merge_persons]):
         verbose_(f"exiftool path: {exiftool_path}")
 
     isphoto = ismovie = True  # default searches for everything
@@ -2070,8 +2220,10 @@ def export(
         original_name = not current_name
 
         results = ExportResults()
-        if verbose:
-            for p in photos:
+        # send progress bar output to /dev/null if verbose to hide the progress bar
+        fp = open(os.devnull, "w") if verbose else None
+        with click.progressbar(photos, file=fp) as bar:
+            for p in bar:
                 export_results = export_photo(
                     photo=p,
                     dest=dest,
@@ -2110,59 +2262,45 @@ def export(
                     ignore_date_modified=ignore_date_modified,
                     use_photokit=use_photokit,
                     exiftool_option=exiftool_option,
+                    strip=strip,
                 )
                 results += export_results
 
-                # if convert_to_jpeg and p.isphoto and p.uti != "public.jpeg":
-                #     for photo_file in set(
-                #         results.exported + results.updated + results.exif_updated
-                #     ):
-                #         verbose_(f"Converting {photo_file} to jpeg")
+                # all photo files (not including sidecars) that are part of this export set
+                # used below for applying Finder tags, etc.
+                photo_files = set(
+                    export_results.exported
+                    + export_results.new
+                    + export_results.updated
+                    + export_results.exif_updated
+                    + export_results.converted_to_jpeg
+                    + export_results.skipped
+                )
 
-        else:
-            # show progress bar
-            with click.progressbar(photos) as bar:
-                for p in bar:
-                    export_results = export_photo(
-                        photo=p,
-                        dest=dest,
-                        verbose=verbose,
-                        export_by_date=export_by_date,
-                        sidecar=sidecar,
-                        sidecar_drop_ext=sidecar_drop_ext,
-                        update=update,
-                        ignore_signature=ignore_signature,
-                        export_as_hardlink=export_as_hardlink,
-                        overwrite=overwrite,
-                        export_edited=export_edited,
-                        skip_original_if_edited=skip_original_if_edited,
-                        original_name=original_name,
-                        export_live=export_live,
-                        download_missing=download_missing,
-                        exiftool=exiftool,
-                        exiftool_merge_keywords=exiftool_merge_keywords,
-                        exiftool_merge_persons=exiftool_merge_persons,
-                        directory=directory,
-                        filename_template=filename_template,
-                        export_raw=export_raw,
+                if finder_tag_keywords or finder_tag_template:
+                    tags_written, tags_skipped = write_finder_tags(
+                        p,
+                        photo_files,
+                        keywords=finder_tag_keywords,
+                        keyword_template=keyword_template,
                         album_keyword=album_keyword,
                         person_keyword=person_keyword,
-                        keyword_template=keyword_template,
-                        description_template=description_template,
-                        export_db=export_db,
-                        fileutil=fileutil,
-                        dry_run=dry_run,
-                        touch_file=touch_file,
-                        edited_suffix=edited_suffix,
-                        original_suffix=original_suffix,
-                        use_photos_export=use_photos_export,
-                        convert_to_jpeg=convert_to_jpeg,
-                        jpeg_quality=jpeg_quality,
-                        ignore_date_modified=ignore_date_modified,
-                        use_photokit=use_photokit,
-                        exiftool_option=exiftool_option,
+                        exiftool_merge_keywords=exiftool_merge_keywords,
+                        finder_tag_template=finder_tag_template,
+                        strip=strip,
                     )
-                    results += export_results
+                    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
+                    )
+                    results.xattr_written.extend(xattr_written)
+                    results.xattr_skipped.extend(xattr_skipped)
+
+        if fp is not None:
+            fp.close()
 
         if cleanup:
             all_files = (
@@ -2399,9 +2537,9 @@ def _query(
     has_likes=False,
     no_likes=False,
 ):
-    """ Run a query against PhotosDB to extract the photos based on user supply criteria used by query and export commands
+    """Run a query against PhotosDB to extract the photos based on user supply criteria used by query and export commands
 
-    Args:   
+    Args:
         photosdb: PhotosDB object
     """
 
@@ -2696,6 +2834,7 @@ def export_photo(
     ignore_date_modified=False,
     use_photokit=False,
     exiftool_option=None,
+    strip=False,
 ):
     """Helper function for export that does the actual export
 
@@ -2786,12 +2925,20 @@ def export_photo(
         if photo.hasadjustments and photo.path_edited is None:
             missing_edited = True
 
-    filenames = get_filenames_from_template(photo, filename_template, original_name)
+    filenames = get_filenames_from_template(
+        photo, filename_template, original_name, strip=strip
+    )
     for filename in filenames:
         if original_suffix:
-            rendered_suffix, unmatched = photo.render_template(
-                original_suffix, filename=True
-            )
+            try:
+                rendered_suffix, unmatched = photo.render_template(
+                    original_suffix, filename=True, strip=strip
+                )
+            except ValueError:
+                raise click.BadOptionUsage(
+                    "original_suffix",
+                    f"Invalid template for --original-suffix '{original_suffix}'",
+                )
             if not rendered_suffix or unmatched:
                 raise click.BadOptionUsage(
                     "original_suffix",
@@ -2818,7 +2965,7 @@ def export_photo(
         )
 
         dest_paths = get_dirnames_from_template(
-            photo, directory, export_by_date, dest, dry_run
+            photo, directory, export_by_date, dest, dry_run, strip=strip
         )
 
         sidecar = [s.lower() for s in sidecar]
@@ -2928,10 +3075,15 @@ def export_photo(
                     edited_ext = pathlib.Path(photo.filename).suffix
 
                 if edited_suffix:
-                    rendered_suffix, unmatched = photo.render_template(
-                        edited_suffix, filename=True
-                    )
-
+                    try:
+                        rendered_suffix, unmatched = photo.render_template(
+                            edited_suffix, filename=True, strip=strip
+                        )
+                    except ValueError:
+                        raise click.BadOptionUsage(
+                            "edited_suffix",
+                            f"Invalid template for --edited-suffix '{edited_suffix}'",
+                        )
                     if not rendered_suffix or unmatched:
                         raise click.BadOptionUsage(
                             "edited_suffix",
@@ -3030,7 +3182,7 @@ def export_photo(
     return results
 
 
-def get_filenames_from_template(photo, filename_template, original_name):
+def get_filenames_from_template(photo, filename_template, original_name, strip=False):
     """get list of export filenames for a photo
 
     Args:
@@ -3046,9 +3198,14 @@ def get_filenames_from_template(photo, filename_template, original_name):
     """
     if filename_template:
         photo_ext = pathlib.Path(photo.original_filename).suffix
-        filenames, unmatched = photo.render_template(
-            filename_template, path_sep="_", filename=True
-        )
+        try:
+            filenames, unmatched = photo.render_template(
+                filename_template, path_sep="_", filename=True, strip=strip
+            )
+        except ValueError:
+            raise click.BadOptionUsage(
+                "filename_template", f"Invalid template '{filename_template}'"
+            )
         if not filenames or unmatched:
             raise click.BadOptionUsage(
                 "filename_template",
@@ -3066,7 +3223,9 @@ def get_filenames_from_template(photo, filename_template, original_name):
     return filenames
 
 
-def get_dirnames_from_template(photo, directory, export_by_date, dest, dry_run):
+def get_dirnames_from_template(
+    photo, directory, export_by_date, dest, dry_run, strip=False
+):
     """get list of directories to export a photo into, creates directories if they don't exist
 
     Args:
@@ -3093,7 +3252,12 @@ def get_dirnames_from_template(photo, directory, export_by_date, dest, dry_run):
         dest_paths = [dest_path]
     elif directory:
         # got a directory template, render it and check results are valid
-        dirnames, unmatched = photo.render_template(directory, dirname=True)
+        try:
+            dirnames, unmatched = photo.render_template(
+                directory, dirname=True, strip=strip
+            )
+        except ValueError:
+            raise click.BadOptionUsage("directory", f"Invalid template '{directory}'")
         if not dirnames or unmatched:
             raise click.BadOptionUsage(
                 "directory",
@@ -3180,8 +3344,8 @@ def load_uuid_from_file(filename):
 
 def write_export_report(report_file, results):
 
-    """ write CSV report with results from export
-    
+    """write CSV report with results from export
+
     Args:
         report_file: path to report file
         results: ExportResults object
@@ -3206,6 +3370,8 @@ def write_export_report(report_file, results):
             "error": 0,
             "exiftool_warning": "",
             "exiftool_error": "",
+            "extended_attributes_written": 0,
+            "extended_attributes_skipped": 0,
         }
         for result in results.all_files()
     }
@@ -3267,6 +3433,12 @@ def write_export_report(report_file, results):
     for result in results.exiftool_error:
         all_results[result[0]]["exiftool_error"] = result[1]
 
+    for result in results.xattr_written:
+        all_results[result]["extended_attributes_written"] = 1
+
+    for result in results.xattr_skipped:
+        all_results[result]["extended_attributes_skipped"] = 1
+
     report_columns = [
         "filename",
         "exported",
@@ -3283,6 +3455,8 @@ def write_export_report(report_file, results):
         "error",
         "exiftool_warning",
         "exiftool_error",
+        "extended_attributes_written",
+        "extended_attributes_skipped",
     ]
 
     try:
@@ -3300,7 +3474,7 @@ def write_export_report(report_file, results):
 
 
 def cleanup_files(dest_path, files_to_keep, fileutil):
-    """ cleanup dest_path by deleting and files and empty directories 
+    """cleanup dest_path by deleting and files and empty directories
         not in files_to_keep
 
     Args:
@@ -3334,5 +3508,163 @@ def cleanup_files(dest_path, files_to_keep, fileutil):
     return (deleted_files, deleted_dirs)
 
 
+def write_finder_tags(
+    photo,
+    files,
+    keywords=False,
+    keyword_template=None,
+    album_keyword=None,
+    person_keyword=None,
+    exiftool_merge_keywords=None,
+    finder_tag_template=None,
+    strip=False,
+):
+    """Write Finder tags (extended attributes) to files; only writes attributes if attributes on file differ from what would be written
+
+    Args:
+        photo: a PhotoInfo object
+        files: list of file paths to write Finder tags to
+        keywords: if True, sets Finder tags to all keywords including any evaluated from keyword_template, album_keyword, person_keyword, exiftool_merge_keywords
+        keyword_template: list of keyword templates to evaluate for determining keywords
+        album_keyword: if True, use album names as keywords
+        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
+
+    Returns:
+        (list of file paths that were updated with new Finder tags, list of file paths skipped because Finder tags didn't need updating)
+    """
+
+    tags = []
+    written = []
+    skipped = []
+    if keywords:
+        # match whatever keywords would've been used in --exiftool or --sidecar
+        exif = photo._exiftool_dict(
+            use_albums_as_keywords=album_keyword,
+            use_persons_as_keywords=person_keyword,
+            keyword_template=keyword_template,
+            merge_exif_keywords=exiftool_merge_keywords,
+        )
+        try:
+            if exif["IPTC:Keywords"]:
+                tags.extend(exif["IPTC:Keywords"])
+        except KeyError:
+            pass
+
+    if finder_tag_template:
+        rendered_tags = []
+        for template_str in finder_tag_template:
+            try:
+                rendered, unmatched = photo.render_template(
+                    template_str,
+                    none_str=_OSXPHOTOS_NONE_SENTINEL,
+                    path_sep="/",
+                    strip=strip,
+                )
+            except ValueError:
+                raise click.BadOptionUsage(
+                    "finder_tag_template",
+                    f"Invalid template for --finder-tag-template': {template_str}",
+                )
+
+            if unmatched:
+                click.echo(
+                    click.style(
+                        f"Warning: unmatched template substitution for template: {template_str} {unmatched}",
+                        fg=CLI_COLOR_WARNING,
+                    ),
+                    err=True,
+                )
+            rendered_tags.extend(rendered)
+
+        # filter out any template values that didn't match by looking for sentinel
+        rendered_tags = [
+            tag for tag in rendered_tags if _OSXPHOTOS_NONE_SENTINEL not in tag
+        ]
+        tags.extend(rendered_tags)
+
+    tags = [osxmetadata.Tag(tag) for tag in set(tags)]
+    for f in files:
+        md = osxmetadata.OSXMetaData(f)
+        if sorted(md.tags) != sorted(tags):
+            verbose_(f"Writing Finder tags to {f}")
+            md.tags = tags
+            written.append(f)
+        else:
+            verbose_(f"Skipping Finder tags for {f}: nothing to do")
+            skipped.append(f)
+
+    return (written, skipped)
+
+
+def write_extended_attributes(photo, files, xattr_template, strip=False):
+    """ Writes extended attributes to exported files
+
+    Args:
+        photo: a PhotoInfo object
+        xattr_template: list of tuples: (attribute name, attribute template)
+    
+    Returns:
+        tuple(list of file paths that were updated with new attributes, list of file paths skipped because attributes didn't need updating)
+    """
+
+    attributes = {}
+    for xattr, template_str in xattr_template:
+        try:
+            rendered, unmatched = photo.render_template(
+                template_str,
+                none_str=_OSXPHOTOS_NONE_SENTINEL,
+                path_sep="/",
+                strip=strip,
+            )
+        except ValueError:
+            raise click.BadOptionUsage(
+                "xattr_template",
+                f"Invalid template for --xattr-template': {template_str}",
+            )
+        if unmatched:
+            click.echo(
+                click.style(
+                    f"Warning: unmatched template substitution for template: {template_str} {unmatched}",
+                    fg=CLI_COLOR_WARNING,
+                ),
+                err=True,
+            )
+        # filter out any template values that didn't match by looking for sentinel
+        rendered = [
+            value for value in rendered if _OSXPHOTOS_NONE_SENTINEL not in value
+        ]
+        try:
+            attributes[xattr].extend(rendered)
+        except KeyError:
+            attributes[xattr] = rendered
+
+    written = set()
+    skipped = set()
+    for f in files:
+        md = osxmetadata.OSXMetaData(f)
+        for attr, value in attributes.items():
+            islist = osxmetadata.ATTRIBUTES[attr].list
+            if value:
+                value = ", ".join(value) if not islist else sorted(value)
+            file_value = md.get_attribute(attr)
+
+            if file_value and islist:
+                file_value = sorted(file_value)
+
+            if (not file_value and not value) or file_value == value:
+                # if both not set or both equal, nothing to do
+                # get_attribute returns None if not set and value will be [] if not set so can't directly compare
+                verbose_(f"Skipping extended attribute {attr} for {f}: nothing to do")
+                skipped.add(f)
+            else:
+                verbose_(f"Writing extended attribute {attr} to {f}")
+                md.set_attribute(attr, value)
+                written.add(f)
+
+    return list(written), [f for f in skipped if f not in written]
+
+
 if __name__ == "__main__":
     cli()  # pylint: disable=no-value-for-parameter

osxphotos/_constants.py

@@ -108,7 +108,7 @@ SEARCH_CATEGORY_NEIGHBORHOOD = 3
 SEARCH_CATEGORY_LOCALITY_4 = 4
 SEARCH_CATEGORY_SUB_LOCALITY_5 = 5
 SEARCH_CATEGORY_SUB_LOCALITY_6 = 6
-SEARCH_CATEGORY_CITY = 7 
+SEARCH_CATEGORY_CITY = 7
 SEARCH_CATEGORY_LOCALITY_8 = 8
 SEARCH_CATEGORY_NAMED_AREA = 9
 SEARCH_CATEGORY_ALL_LOCALITY = [
@@ -182,4 +182,16 @@ CLI_COLOR_WARNING = "yellow"
 # Bit masks for --sidecar
 SIDECAR_JSON = 0x1
 SIDECAR_EXIFTOOL = 0x2
-SIDECAR_XMP = 0x4
+SIDECAR_XMP = 0x4
+
+# supported attributes for --xattr-template
+EXTENDED_ATTRIBUTE_NAMES = [
+    "authors",
+    "comment",
+    "copyright",
+    "description",
+    "findercomment",
+    "headline",
+    "keywords",
+]
+EXTENDED_ATTRIBUTE_NAMES_QUOTED = [f"'{x}'" for x in EXTENDED_ATTRIBUTE_NAMES]

osxphotos/_version.py

@@ -1,5 +1,5 @@
 """ version info """
 
-__version__ = "0.38.22"
+__version__ = "0.39.5"
 
 

osxphotos/exiftool.py

@@ -33,8 +33,8 @@ def get_exiftool_path():
 
 
 class _ExifToolProc:
-    """ Runs exiftool in a subprocess via Popen
-        Creates a singleton object """
+    """Runs exiftool in a subprocess via Popen
+    Creates a singleton object"""
 
     def __new__(cls, *args, **kwargs):
         """ create new object or return instance of already created singleton """
@@ -44,8 +44,8 @@ class _ExifToolProc:
         return cls.instance
 
     def __init__(self, exiftool=None):
-        """ construct _ExifToolProc singleton object or return instance of already created object
-            exiftool: optional path to exiftool binary (if not provided, will search path to find it) """
+        """construct _ExifToolProc singleton object or return instance of already created object
+        exiftool: optional path to exiftool binary (if not provided, will search path to find it)"""
 
         if hasattr(self, "_process_running") and self._process_running:
             # already running
@@ -56,8 +56,8 @@ class _ExifToolProc:
                 )
             return
 
-        self._exiftool = exiftool or get_exiftool_path()
         self._process_running = False
+        self._exiftool = exiftool or get_exiftool_path()
         self._start_proc()
 
     @property
@@ -106,8 +106,8 @@ class _ExifToolProc:
 
     def _stop_proc(self):
         """ stop the exiftool process if it's running, otherwise, do nothing """
+
         if not self._process_running:
-            logging.warning("exiftool process is not running")
             return
 
         self._process.stdin.write(b"-stay_open\n")
@@ -133,7 +133,7 @@ class ExifTool:
     """ Basic exiftool interface for reading and writing EXIF tags """
 
     def __init__(self, filepath, exiftool=None, overwrite=True, flags=None):
-        """ Create ExifTool object
+        """Create ExifTool object
 
         Args:
             file: path to image file
@@ -157,15 +157,15 @@ class ExifTool:
         self._read_exif()
 
     def setvalue(self, tag, value):
-        """ Set tag to value(s); if value is None, will delete tag
+        """Set tag to value(s); if value is None, will delete tag
 
         Args:
             tag: str; name of tag to set
             value: str; value to set tag to
-        
+
         Returns:
             True if success otherwise False
-            
+
             If error generated by exiftool, returns False and sets self.error to error string
             If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
             If called in context manager, returns True (execution is delayed until exiting context manager)
@@ -184,26 +184,26 @@ class ExifTool:
             return error is None
 
     def addvalues(self, tag, *values):
-        """ Add one or more value(s) to tag
+        """Add one or more value(s) to tag
             If more than one value is passed, each value will be added to the tag
 
         Args:
             tag: str; tag to set
             *values: str; one or more values to set
-        
+
         Returns:
             True if success otherwise False
-            
+
             If error generated by exiftool, returns False and sets self.error to error string
             If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
             If called in context manager, returns True (execution is delayed until exiting context manager)
-            
+
         Notes: exiftool may add duplicate values for some tags so the caller must ensure
                the values being added are not already in the EXIF data
-               For some tags, such as IPTC:Keywords, this will add a new value to the list of keywords, 
+               For some tags, such as IPTC:Keywords, this will add a new value to the list of keywords,
                but for others, such as EXIF:ISO, this will literally add a value to the existing value.
                It's up to the caller to know what exiftool will do for each tag
-               If setvalue called before addvalues, exiftool does not appear to add duplicates, 
+               If setvalue called before addvalues, exiftool does not appear to add duplicates,
                but if addvalues called without first calling setvalue, exiftool will add duplicate values
         """
         if not values:
@@ -226,7 +226,7 @@ class ExifTool:
             return error is None
 
     def run_commands(self, *commands, no_file=False):
-        """ Run commands in the exiftool process and return result.
+        """Run commands in the exiftool process and return result.
 
         Args:
                 *commands: exiftool commands to run
@@ -301,8 +301,8 @@ class ExifTool:
         return ver.decode("utf-8")
 
     def asdict(self):
-        """ return dictionary of all EXIF tags and values from exiftool 
-            returns empty dict if no tags
+        """return dictionary of all EXIF tags and values from exiftool
+        returns empty dict if no tags
         """
         json_str, _, _ = self.run_commands("-json")
         if json_str:

osxphotos/photoinfo/_photoinfo_export.py

@@ -74,6 +74,8 @@ class ExportResults:
         error=None,
         exiftool_warning=None,
         exiftool_error=None,
+        xattr_written=None,
+        xattr_skipped=None,
     ):
         self.exported = exported or []
         self.new = new or []
@@ -92,6 +94,8 @@ class ExportResults:
         self.error = error or []
         self.exiftool_warning = exiftool_warning or []
         self.exiftool_error = exiftool_error or []
+        self.xattr_written = xattr_written or []
+        self.xattr_skipped = xattr_skipped or []
 
     def all_files(self):
         """ return all filenames contained in results """

osxphotos/photoinfo/photoinfo.py

@@ -86,8 +86,8 @@ class PhotoInfo:
 
     @property
     def original_filename(self):
-        """ original filename of the picture 
-            Photos 5 mangles filenames upon import """
+        """original filename of the picture
+        Photos 5 mangles filenames upon import"""
         if (
             self._db._db_version <= _PHOTOS_4_VERSION
             and self.has_raw
@@ -106,8 +106,8 @@ class PhotoInfo:
 
     @property
     def date_modified(self):
-        """ image modification date as timezone aware datetime object
-            or None if no modification date set """
+        """image modification date as timezone aware datetime object
+        or None if no modification date set"""
 
         # Photos <= 4 provides no way to get date of adjustment and will update
         # lastmodifieddate anytime photo database record is updated (e.g. adding tags)
@@ -492,9 +492,9 @@ class PhotoInfo:
 
     @property
     def ismissing(self):
-        """ returns true if photo is missing from disk (which means it's not been downloaded from iCloud) 
+        """returns true if photo is missing from disk (which means it's not been downloaded from iCloud)
         NOTE:   the photos.db database uses an asynchrounous write-ahead log so changes in Photos
-                do not immediately get written to disk. In particular, I've noticed that downloading 
+                do not immediately get written to disk. In particular, I've noticed that downloading
                 an image from the cloud does not force the database to be updated until something else
                 e.g. an edit, keyword, etc. occurs forcing a database synch
                 The exact process / timing is a mystery to be but be aware that if some photos were recently
@@ -539,8 +539,8 @@ class PhotoInfo:
 
     @property
     def shared(self):
-        """ returns True if photos is in a shared iCloud album otherwise false
-            Only valid on Photos 5; returns None on older versions """
+        """returns True if photos is in a shared iCloud album otherwise false
+        Only valid on Photos 5; returns None on older versions"""
         if self._db._db_version > _PHOTOS_4_VERSION:
             return self._info["shared"]
         else:
@@ -548,8 +548,8 @@ class PhotoInfo:
 
     @property
     def uti(self):
-        """ Returns Uniform Type Identifier (UTI) for the image
-            for example: public.jpeg or com.apple.quicktime-movie
+        """Returns Uniform Type Identifier (UTI) for the image
+        for example: public.jpeg or com.apple.quicktime-movie
         """
         if self._db._db_version <= _PHOTOS_4_VERSION:
             if self.hasadjustments:
@@ -564,8 +564,8 @@ class PhotoInfo:
 
     @property
     def uti_original(self):
-        """ Returns Uniform Type Identifier (UTI) for the original image
-            for example: public.jpeg or com.apple.quicktime-movie
+        """Returns Uniform Type Identifier (UTI) for the original image
+        for example: public.jpeg or com.apple.quicktime-movie
         """
         if self._db._db_version <= _PHOTOS_4_VERSION and self._info["has_raw"]:
             return self._info["raw_pair_info"]["UTI"]
@@ -577,9 +577,9 @@ class PhotoInfo:
 
     @property
     def uti_edited(self):
-        """ Returns Uniform Type Identifier (UTI) for the edited image 
-            if the photo has been edited, otherwise None; 
-            for example: public.jpeg 
+        """Returns Uniform Type Identifier (UTI) for the edited image
+        if the photo has been edited, otherwise None;
+        for example: public.jpeg
         """
         if self._db._db_version >= _PHOTOS_5_VERSION:
             return self.uti if self.hasadjustments else None
@@ -588,36 +588,34 @@ class PhotoInfo:
 
     @property
     def uti_raw(self):
-        """ Returns Uniform Type Identifier (UTI) for the RAW image if there is one
-            for example: com.canon.cr2-raw-image
-            Returns None if no associated RAW image
+        """Returns Uniform Type Identifier (UTI) for the RAW image if there is one
+        for example: com.canon.cr2-raw-image
+        Returns None if no associated RAW image
         """
         return self._info["UTI_raw"]
 
     @property
     def ismovie(self):
-        """ Returns True if file is a movie, otherwise False
-        """
+        """Returns True if file is a movie, otherwise False"""
         return True if self._info["type"] == _MOVIE_TYPE else False
 
     @property
     def isphoto(self):
-        """ Returns True if file is an image, otherwise False
-        """
+        """Returns True if file is an image, otherwise False"""
         return True if self._info["type"] == _PHOTO_TYPE else False
 
     @property
     def incloud(self):
-        """ Returns True if photo is cloud asset and is synched to cloud
-                    False if photo is cloud asset and not yet synched to cloud
-                    None if photo is not cloud asset
+        """Returns True if photo is cloud asset and is synched to cloud
+        False if photo is cloud asset and not yet synched to cloud
+        None if photo is not cloud asset
         """
         return self._info["incloud"]
 
     @property
     def iscloudasset(self):
-        """ Returns True if photo is a cloud asset (in an iCloud library),
-            otherwise False 
+        """Returns True if photo is a cloud asset (in an iCloud library),
+        otherwise False
         """
         if self._db._db_version <= _PHOTOS_4_VERSION:
             return (
@@ -636,9 +634,9 @@ class PhotoInfo:
 
     @property
     def burst_photos(self):
-        """ If photo is a burst photo, returns list of PhotoInfo objects 
-            that are part of the same burst photo set; otherwise returns empty list.
-            self is not included in the returned list """
+        """If photo is a burst photo, returns list of PhotoInfo objects
+        that are part of the same burst photo set; otherwise returns empty list.
+        self is not included in the returned list"""
         if self._info["burst"]:
             burst_uuid = self._info["burstUUID"]
             return [
@@ -656,9 +654,9 @@ class PhotoInfo:
 
     @property
     def path_live_photo(self):
-        """ Returns path to the associated video file for a live photo
-            If photo is not a live photo, returns None
-            If photo is missing, returns None """
+        """Returns path to the associated video file for a live photo
+        If photo is not a live photo, returns None
+        If photo is missing, returns None"""
 
         photopath = None
         if self._db._db_version <= _PHOTOS_4_VERSION:
@@ -785,9 +783,9 @@ class PhotoInfo:
 
     @property
     def raw_original(self):
-        """ returns True if associated raw image and the raw image is selected in Photos
-            via "Use RAW as Original "
-            otherwise returns False """
+        """returns True if associated raw image and the raw image is selected in Photos
+        via "Use RAW as Original "
+        otherwise returns False"""
         return self._info["raw_is_original"]
 
     @property
@@ -834,27 +832,27 @@ class PhotoInfo:
         inplace_sep=None,
         filename=False,
         dirname=False,
-        replacement=":",
+        strip=False,
     ):
         """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 
+            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 
+            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 
-            replacement: str, value to replace any illegal file path characters with; default = ":"
-        
+            dirname: if True, template output will be sanitized to produce valid directory name
+            strip: if True, strips leading/trailing white space from resulting template
+
         Returns:
             ([rendered_strings], [unmatched]): tuple of list of rendered strings and list of unmatched template values
         """
-        template = PhotoTemplate(self)
+        template = PhotoTemplate(self, exiftool_path=self._db._exiftool_path)
         return template.render(
             template_str,
             none_str=none_str,
@@ -863,7 +861,7 @@ class PhotoInfo:
             inplace_sep=inplace_sep,
             filename=filename,
             dirname=dirname,
-            replacement=replacement,
+            strip=strip,
         )
 
     @property
@@ -877,11 +875,11 @@ class PhotoInfo:
         return self._info["latitude"]
 
     def _get_album_uuids(self):
-        """ Return list of album UUIDs this photo is found in
-        
+        """Return list of album UUIDs this photo is found in
+
             Filters out albums in the trash and any special album types
 
-        Returns: list of album UUIDs 
+        Returns: list of album UUIDs
         """
         if self._db._db_version <= _PHOTOS_4_VERSION:
             version4 = True

osxphotos/phototemplate.py

@@ -6,9 +6,9 @@
 # 2. Needed to handle default values if template not found
 # 3. Didn't want user to need to know python (e.g. by using Mako which is
 #    already used elsewhere in this project)
-# 4. Couldn't figure out how to do #1 and #2 with str.format()
 #
-# This code isn't elegant but it seems to work well.  PRs gladly accepted.
+# This code isn't elegant and is prime for refactoring but it seems to work well.  PRs gladly accepted.
+
 import datetime
 import locale
 import os
@@ -70,18 +70,18 @@ TEMPLATE_SUBSTITUTIONS = {
     + "{created.strftime,%Y-%U} would result in year-week number of year: '2020-23'. "
     + "If used with no template will return null value. "
     + "See https://strftime.org/ for help on strftime templates.",
-    "{modified.date}": "Photo's modification date in ISO format, e.g. '2020-03-22'",
-    "{modified.year}": "4-digit year of photo modification time",
-    "{modified.yy}": "2-digit year of photo modification time",
-    "{modified.mm}": "2-digit month of the photo modification time (zero padded)",
-    "{modified.month}": "Month name in user's locale of the photo modification time",
-    "{modified.mon}": "Month abbreviation in the user's locale of the photo modification time",
-    "{modified.dd}": "2-digit day of the month (zero padded) of the photo modification time",
-    "{modified.dow}": "Day of week in user's locale of the photo modification time",
-    "{modified.doy}": "3-digit day of year (e.g Julian day) of photo modification time, starting from 1 (zero padded)",
-    "{modified.hour}": "2-digit hour of the photo modification time",
-    "{modified.min}": "2-digit minute of the photo modification time",
-    "{modified.sec}": "2-digit second of the photo modification time",
+    "{modified.date}": "Photo's modification date in ISO format, e.g. '2020-03-22'; uses creation date if photo is not modified",
+    "{modified.year}": "4-digit year of photo modification time; uses creation date if photo is not modified",
+    "{modified.yy}": "2-digit year of photo modification time; uses creation date if photo is not modified",
+    "{modified.mm}": "2-digit month of the photo modification time (zero padded); uses creation date if photo is not modified",
+    "{modified.month}": "Month name in user's locale of the photo modification time; uses creation date if photo is not modified",
+    "{modified.mon}": "Month abbreviation in the user's locale of the photo modification time; uses creation date if photo is not modified",
+    "{modified.dd}": "2-digit day of the month (zero padded) of the photo modification time; uses creation date if photo is not modified",
+    "{modified.dow}": "Day of week in user's locale of the photo modification time; uses creation date if photo is not modified",
+    "{modified.doy}": "3-digit day of year (e.g Julian day) of photo modification time, starting from 1 (zero padded); uses creation date if photo is not modified",
+    "{modified.hour}": "2-digit hour of the photo modification time; uses creation date if photo is not modified",
+    "{modified.min}": "2-digit minute of the photo modification time; uses creation date if photo is not modified",
+    "{modified.sec}": "2-digit second of the photo modification time; uses creation date if photo is not modified",
     # "{modified.strftime}": "Apply strftime template to file modification date/time. Should be used in form "
     # + "{modified.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. "
     # + "{modified.strftime,%Y-%U} would result in year-week number of year: '2020-23'. "
@@ -118,6 +118,10 @@ TEMPLATE_SUBSTITUTIONS = {
     "{place.address.country}": "Country name of the postal address, e.g. 'United States'",
     "{place.address.country_code}": "ISO country code of the postal address, e.g. 'US'",
     "{searchinfo.season}": "Season of the year associated with a photo, e.g. 'Summer'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).",
+    "{exif.camera_make}": "Camera make from original photo's EXIF inormation as imported by Photos, e.g. 'Apple'",
+    "{exif.camera_model}": "Camera model from original photo's EXIF inormation as imported by Photos, e.g. 'iPhone 6s'",
+    "{exif.lens_model}": "Lens model from original photo's EXIF inormation as imported by Photos, e.g. 'iPhone 6s back camera 4.15mm f/2.2'",
+    "{uuid}": "Photo's internal universally unique identifier (UUID) for the photo, a 36-character string unique to the photo, e.g. '128FB4C6-0B16-4E7D-9108-FB2E90DA1546'",
 }
 
 # Permitted multi-value substitutions (each of these returns None or 1 or more values)
@@ -145,25 +149,48 @@ MULTI_VALUE_SUBSTITUTIONS = [
     for field in TEMPLATE_SUBSTITUTIONS_MULTI_VALUED
 ]
 
+# regular expressions for matching template syntax
+RE_OPENING_BRACE = r"(?<!\{)\{"  # match { but not {{
+RE_DELIM = r"([^}]*\+)?"  # group 1: optional DELIM+
+RE_FIELD_NAME = r"([^\\,}+\?]+)"  # group 2: field name
+RE_PATH_SEP = r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
+# + r"(\[[^{}\)]*\])?"  # group 4: optional [REPLACE]
+RE_REPLACE = r"(\[[^{}]*\])?"  # group 4: optional [REPLACE]
+RE_BOOL_VAL = r"(\?[^\\,}]*)?"  # group 5: optional ?TRUE_VALUE for boolean fields
+RE_DEFAULT_VAL = r"(,[\w\=\;\-\%. ]*)?"  # group 6: optional ,DEFAULT
+RE_CLOSING_BRACE = r"(?=\}(?!\}))\}"  # match } but not }}
+
+MATCH_GROUPS_TOTAL = 6
+MATCH_GROUPS_DELIM = 1
+MATCH_GROUPS_FIELD = 2
+MATCH_GROUPS_PATH_SEP = 3
+MATCH_GROUPS_REPLACE = 4
+MATCH_GROUPS_BOOL_VAL = 5
+MATCH_GROUPS_DEFAULT = 6
+
+# default values for string manipulation template options
+INPLACE_DEFAULT = ","
+PATH_SEP_DEFAULT = os.path.sep
+
 
 class PhotoTemplate:
     """ PhotoTemplate class to render a template string from a PhotoInfo object """
 
-    def __init__(self, photo):
-        """ Inits PhotoTemplate class with photo, non_str, and path_sep
+    def __init__(self, photo, exiftool_path=None):
+        """ Inits PhotoTemplate class with photo
 
         Args:
             photo: a PhotoInfo instance.
+            exiftool_path: optional path to exiftool for use with {exiftool:} template; if not provided, will look for exiftool in $PATH
         """
         self.photo = photo
+        self.exiftool_path = exiftool_path
 
         # holds value of current date/time for {today.x} fields
         # gets initialized in get_template_value
         self.today = None
 
-    def make_subst_function(
-        self, none_str, filename, dirname, replacement, get_func=None
-    ):
+    def make_subst_function(self, none_str, filename, dirname, get_func=None):
         """ returns: substitution function for use in re.sub 
             none_str: value to use if substitution lookup is None and no default provided
             get_func: function that gets the substitution value for a given template field
@@ -172,37 +199,39 @@ class PhotoTemplate:
         if get_func is None:
             # used by make_subst_function to get the value for a template substitution
             get_func = partial(
-                self.get_template_value,
-                filename=filename,
-                dirname=dirname,
-                replacement=replacement,
+                self.get_template_value, filename=filename, dirname=dirname
             )
 
         # closure to capture photo, none_str, filename, dirname in subst
         def subst(matchobj):
             groups = len(matchobj.groups())
-            if groups != 5:
+            if groups != MATCH_GROUPS_TOTAL:
                 raise ValueError(
-                    f"Unexpected number of groups: expected 4, got {groups}"
+                    f"Unexpected number of groups: expected {MATCH_GROUPS_TOTAL}, got {groups}"
                 )
 
-            delim = matchobj.group(1)
-            field = matchobj.group(2)
-            path_sep = matchobj.group(3)
-            bool_val = matchobj.group(4)
-            default = matchobj.group(5)
+            delim = matchobj.group(MATCH_GROUPS_DELIM)
+            field = matchobj.group(MATCH_GROUPS_FIELD)
+            path_sep = matchobj.group(MATCH_GROUPS_PATH_SEP)
+            replace = matchobj.group(MATCH_GROUPS_REPLACE)
+            bool_val = matchobj.group(MATCH_GROUPS_BOOL_VAL)
+            default = matchobj.group(MATCH_GROUPS_DEFAULT)
 
             # drop the '+' on delim
             delim = delim[:-1] if delim is not None else None
             # drop () from path_sep
             path_sep = path_sep.strip("()") if path_sep is not None else None
+            # drop [] from replace
+            replace = replace[1:-1] if replace is not None else None
             # drop the ? on bool_val
             bool_val = bool_val[1:] if bool_val is not None else None
             # drop the comma on default
             default_val = default[1:] if default is not None else None
 
             try:
-                val = get_func(field, default_val, bool_val, delim, path_sep)
+                val = get_func(
+                    field, default_val, bool_val, delim, path_sep, replacement=replace
+                )
             except ValueError:
                 return matchobj.group(0)
 
@@ -226,7 +255,7 @@ class PhotoTemplate:
         inplace_sep=None,
         filename=False,
         dirname=False,
-        replacement=":",
+        strip=False,
     ):
         """ Render a filename or directory template 
 
@@ -240,17 +269,17 @@ class PhotoTemplate:
             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 
-            replacement: str, value to replace any illegal file path characters with; default = ":"
+            strip: if True, strips leading/trailing whitespace from rendered templates
 
         Returns:
             ([rendered_strings], [unmatched]): tuple of list of rendered strings and list of unmatched template values
         """
 
         if path_sep is None:
-            path_sep = os.path.sep
+            path_sep = PATH_SEP_DEFAULT
 
         if inplace_sep is None:
-            inplace_sep = ","
+            inplace_sep = INPLACE_DEFAULT
 
         # the rendering happens in two phases:
         # phase 1: handle all the single-value template substitutions
@@ -263,19 +292,20 @@ class PhotoTemplate:
         # regex to find {template_field,optional_default} in strings
         # pylint: disable=anomalous-backslash-in-string
         regex = (
-            r"(?<!\{)\{"  # match { but not {{
-            + r"([^}]*\+)?"  # group 1: optional DELIM+
-            + r"([^\\,}+\?]+)"  # group 2: field name
-            + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
-            + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
-            + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
-            + r"(?=\}(?!\}))\}"  # match } but not }}
+            RE_OPENING_BRACE
+            + RE_DELIM
+            + RE_FIELD_NAME
+            + RE_PATH_SEP
+            + RE_REPLACE
+            + RE_BOOL_VAL
+            + RE_DEFAULT_VAL
+            + RE_CLOSING_BRACE
         )
 
         if type(template) is not str:
             raise TypeError(f"template must be type str, not {type(template)}")
 
-        subst_func = self.make_subst_function(none_str, filename, dirname, replacement)
+        subst_func = self.make_subst_function(none_str, filename, dirname)
 
         # do the replacements
         rendered = re.sub(regex, subst_func, template)
@@ -304,14 +334,7 @@ class PhotoTemplate:
         #    '2011/Album2/keyword2/person1',]
 
         rendered_strings = self._render_multi_valued_templates(
-            rendered,
-            none_str,
-            path_sep,
-            expand_inplace,
-            inplace_sep,
-            filename,
-            dirname,
-            replacement,
+            rendered, none_str, path_sep, expand_inplace, inplace_sep, filename, dirname
         )
 
         # process exiftool: templates
@@ -323,7 +346,6 @@ class PhotoTemplate:
             inplace_sep,
             filename,
             dirname,
-            replacement,
         )
 
         # find any {fields} that weren't replaced
@@ -348,6 +370,11 @@ class PhotoTemplate:
                 sanitize_filename(rendered_str) for rendered_str in rendered_strings
             ]
 
+        if strip:
+            rendered_strings = [
+                rendered_str.strip() for rendered_str in rendered_strings
+            ]
+
         return rendered_strings, unmatched
 
     def _render_multi_valued_templates(
@@ -359,7 +386,6 @@ class PhotoTemplate:
         inplace_sep,
         filename,
         dirname,
-        replacement,
     ):
         rendered_strings = [rendered]
         new_rendered_strings = []
@@ -368,15 +394,16 @@ class PhotoTemplate:
             for field in MULTI_VALUE_SUBSTITUTIONS:
                 # Build a regex that matches only the field being processed
                 re_str = (
-                    r"(?<!\{)\{"  # match { but not {{
-                    + r"([^}]*\+)?"  # group 1: optional DELIM+
+                    RE_OPENING_BRACE
+                    + RE_DELIM
                     + r"("
                     + field  # group 2: field name
                     + r")"
-                    + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
-                    + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
-                    + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
-                    + r"(?=\}(?!\}))\}"  # match } but not }}
+                    + RE_PATH_SEP
+                    + RE_REPLACE
+                    + RE_BOOL_VAL
+                    + RE_DEFAULT_VAL
+                    + RE_CLOSING_BRACE
                 )
                 regex_multi = re.compile(re_str)
 
@@ -387,21 +414,29 @@ class PhotoTemplate:
                     matches = regex_multi.search(str_template)
                     if matches:
                         path_sep = (
-                            matches.group(3).strip("()")
-                            if matches.group(3) is not None
+                            matches.group(MATCH_GROUPS_PATH_SEP).strip("()")
+                            if matches.group(MATCH_GROUPS_PATH_SEP) is not None
                             else path_sep
                         )
+                        replace = (
+                            matches.group(MATCH_GROUPS_REPLACE)[1:-1]
+                            if matches.group(MATCH_GROUPS_REPLACE) is not None
+                            else None
+                        )
                         values = self.get_template_value_multi(
                             field,
                             path_sep,
                             filename=filename,
                             dirname=dirname,
-                            replacement=replacement,
+                            replacement=replace,
                         )
-                        if expand_inplace or matches.group(1) is not None:
+                        if (
+                            expand_inplace
+                            or matches.group(MATCH_GROUPS_DELIM) is not None
+                        ):
                             delim = (
-                                matches.group(1)[:-1]
-                                if matches.group(1) is not None
+                                matches.group(MATCH_GROUPS_DELIM)[:-1]
+                                if matches.group(MATCH_GROUPS_DELIM) is not None
                                 else inplace_sep
                             )
                             # instead of returning multiple strings, join values into a single string
@@ -411,7 +446,9 @@ class PhotoTemplate:
                                 else None
                             )
 
-                            def lookup_template_value_multi(lookup_value, *_):
+                            def lookup_template_value_multi(
+                                lookup_value, *args, **kwargs
+                            ):
                                 """ Closure passed to make_subst_function get_func 
                                         Capture val and field in the closure 
                                         Allows make_subst_function to be re-used w/o modification
@@ -427,7 +464,6 @@ class PhotoTemplate:
                                 none_str,
                                 filename,
                                 dirname,
-                                replacement,
                                 get_func=lookup_template_value_multi,
                             )
                             new_string = regex_multi.sub(subst, str_template)
@@ -438,7 +474,9 @@ class PhotoTemplate:
                             # create a new template string for each value
                             for val in values:
 
-                                def lookup_template_value_multi(lookup_value, *_):
+                                def lookup_template_value_multi(
+                                    lookup_value, *args, **kwargs
+                                ):
                                     """ Closure passed to make_subst_function get_func 
                                         Capture val and field in the closure 
                                         Allows make_subst_function to be re-used w/o modification
@@ -454,7 +492,6 @@ class PhotoTemplate:
                                     none_str,
                                     filename,
                                     dirname,
-                                    replacement,
                                     get_func=lookup_template_value_multi,
                                 )
                                 new_string = regex_multi.sub(subst, str_template)
@@ -473,7 +510,6 @@ class PhotoTemplate:
         inplace_sep,
         filename,
         dirname,
-        replacement,
     ):
         # TODO: lots of code commonality with render_multi_valued_templates -- combine or pull out
         # TODO: put these in globals
@@ -484,15 +520,15 @@ class PhotoTemplate:
             inplace_sep = ","
 
         # Build a regex that matches only the field being processed
-        # todo: pull out regexes into globals?
         re_str = (
-            r"(?<!\{)\{"  # match { but not {{
-            + r"([^}]*\+)?"  # group 1: optional DELIM+
-            + r"(exiftool:[^\\,}+\?]+)"  # group 3 field name
-            + r"(\([^{}\)]*\))?"  # group 3: optional (PATH_SEP)
-            + r"(\?[^\\,}]*)?"  # group 4: optional ?TRUE_VALUE for boolean fields
-            + r"(,[\w\=\;\-\%. ]*)?"  # group 5: optional ,DEFAULT
-            + r"(?=\}(?!\}))\}"  # match } but not }}
+            RE_OPENING_BRACE
+            + RE_DELIM
+            + r"(exiftool:[^\\,}+\?\[\]]+)"  # group 3 field name
+            + RE_PATH_SEP
+            + RE_REPLACE
+            + RE_BOOL_VAL
+            + RE_DEFAULT_VAL
+            + RE_CLOSING_BRACE
         )
         regex_multi = re.compile(re_str)
 
@@ -507,17 +543,21 @@ class PhotoTemplate:
                     # allmatches = regex_multi.finditer(str_template)
                     # for matches in allmatches:
                     path_sep = (
-                        matches.group(3).strip("()")
-                        if matches.group(3) is not None
+                        matches.group(MATCH_GROUPS_PATH_SEP).strip("()")
+                        if matches.group(MATCH_GROUPS_PATH_SEP) is not None
                         else path_sep
                     )
-                    field = matches.group(2)
+                    replace = (
+                        matches.group(MATCH_GROUPS_REPLACE)[1:-1]
+                        if matches.group(MATCH_GROUPS_REPLACE) is not None
+                        else None
+                    )
+                    field = matches.group(MATCH_GROUPS_FIELD)
                     subfield = field[9:]
-
                     if not self.photo.path:
                         values = [None]
                     else:
-                        exif = ExifTool(self.photo.path)
+                        exif = ExifTool(self.photo.path, exiftool=self.exiftool_path)
                         exifdict = exif.asdict()
                         exifdict = {k.lower(): v for (k, v) in exifdict.items()}
                         subfield = subfield.lower()
@@ -526,12 +566,24 @@ class PhotoTemplate:
                             values = (
                                 [values] if not isinstance(values, list) else values
                             )
+                            if replace and values:
+                                new_values = []
+                                for value in values:
+                                    new_values.append(self.replace(value, replace))
+                                values = new_values
+
+                            # sanitize directory names if needed
+                            if filename:
+                                values = [sanitize_pathpart(value) for value in values]
+                            elif dirname:
+                                values = [sanitize_dirname(value) for value in values]
+
                         else:
                             values = [None]
-                    if expand_inplace or matches.group(1) is not None:
+                    if expand_inplace or matches.group(MATCH_GROUPS_DELIM) is not None:
                         delim = (
-                            matches.group(1)[:-1]
-                            if matches.group(1) is not None
+                            matches.group(MATCH_GROUPS_DELIM)[:-1]
+                            if matches.group(MATCH_GROUPS_DELIM) is not None
                             else inplace_sep
                         )
                         # instead of returning multiple strings, join values into a single string
@@ -539,7 +591,7 @@ class PhotoTemplate:
                             delim.join(sorted(values)) if values and values[0] else None
                         )
 
-                        def lookup_template_value_exif(lookup_value, *_):
+                        def lookup_template_value_exif(lookup_value, *args, **kwargs):
                             """ Closure passed to make_subst_function get_func 
                                     Capture val and field in the closure 
                                     Allows make_subst_function to be re-used w/o modification
@@ -553,7 +605,6 @@ class PhotoTemplate:
                             none_str,
                             filename,
                             dirname,
-                            replacement,
                             get_func=lookup_template_value_exif,
                         )
                         new_string = regex_multi.sub(subst, str_template)
@@ -563,7 +614,9 @@ class PhotoTemplate:
                         # create a new template string for each value
                         for val in values:
 
-                            def lookup_template_value_exif(lookup_value, *_):
+                            def lookup_template_value_exif(
+                                lookup_value, *args, **kwargs
+                            ):
                                 """ Closure passed to make_subst_function get_func 
                                     Capture val and field in the closure 
                                     Allows make_subst_function to be re-used w/o modification
@@ -579,7 +632,6 @@ class PhotoTemplate:
                                 none_str,
                                 filename,
                                 dirname,
-                                replacement,
                                 get_func=lookup_template_value_exif,
                             )
                             new_string = regex_multi.sub(subst, str_template)
@@ -597,7 +649,7 @@ class PhotoTemplate:
         path_sep=None,
         filename=False,
         dirname=False,
-        replacement=":",
+        replacement=None,
     ):
         """lookup value for template field (single-value template substitutions)
 
@@ -677,73 +729,73 @@ class PhotoTemplate:
             value = (
                 DateTimeFormatter(self.photo.date_modified).date
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).date
             )
         elif field == "modified.year":
             value = (
                 DateTimeFormatter(self.photo.date_modified).year
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).year
             )
         elif field == "modified.yy":
             value = (
                 DateTimeFormatter(self.photo.date_modified).yy
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).yy
             )
         elif field == "modified.mm":
             value = (
                 DateTimeFormatter(self.photo.date_modified).mm
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).mm
             )
         elif field == "modified.month":
             value = (
                 DateTimeFormatter(self.photo.date_modified).month
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).month
             )
         elif field == "modified.mon":
             value = (
                 DateTimeFormatter(self.photo.date_modified).mon
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).mon
             )
         elif field == "modified.dd":
             value = (
                 DateTimeFormatter(self.photo.date_modified).dd
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).dd
             )
         elif field == "modified.dow":
             value = (
                 DateTimeFormatter(self.photo.date_modified).dow
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).dow
             )
         elif field == "modified.doy":
             value = (
                 DateTimeFormatter(self.photo.date_modified).doy
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).doy
             )
         elif field == "modified.hour":
             value = (
                 DateTimeFormatter(self.photo.date_modified).hour
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).hour
             )
         elif field == "modified.min":
             value = (
                 DateTimeFormatter(self.photo.date_modified).min
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).min
             )
         elif field == "modified.sec":
             value = (
                 DateTimeFormatter(self.photo.date_modified).sec
                 if self.photo.date_modified
-                else None
+                else DateTimeFormatter(self.photo.date).sec
             )
         elif field == "today.date":
             value = DateTimeFormatter(self.today).date
@@ -849,18 +901,56 @@ class PhotoTemplate:
             )
         elif field == "searchinfo.season":
             value = self.photo.search_info.season if self.photo.search_info else None
+        elif field == "exif.camera_make":
+            value = self.photo.exif_info.camera_make if self.photo.exif_info else None
+        elif field == "exif.camera_model":
+            value = self.photo.exif_info.camera_model if self.photo.exif_info else None
+        elif field == "exif.lens_model":
+            value = self.photo.exif_info.lens_model if self.photo.exif_info else None
+        elif field == "uuid":
+            value = self.photo.uuid
         else:
             # if here, didn't get a match
             raise ValueError(f"Unhandled template value: {field}")
 
+        if value and replacement:
+            value = self.replace(value, replacement)
+            # process character replacements
+
         if filename:
-            value = sanitize_pathpart(value, replacement=replacement)
+            value = sanitize_pathpart(value)
         elif dirname:
-            value = sanitize_dirname(value, replacement=replacement)
+            value = sanitize_dirname(value)
+
+        return value
+
+    def replace(self, value, replacement):
+        """ process REPLACE template option
+
+        Args:
+            value: str value to process
+            replacement: str in form OLD,NEW|OLD,NEW... with old and new values for replacement
+        
+        Returns:
+            value with all replacements done
+        
+        Raises:
+            ValueError if replacement string is in wrong format
+        """
+        if not value:
+            return value
+
+        replacements = replacement.split("|")
+        for r in replacements:
+            try:
+                old, new = r.split(",")
+            except ValueError:
+                raise ValueError(f"Invalid template REPLACE value: {replacement}")
+            value = value.replace(old, new)
         return value
 
     def get_template_value_multi(
-        self, field, path_sep, filename=False, dirname=False, replacement=":"
+        self, field, path_sep, filename=False, dirname=False, replacement=None
     ):
         """lookup value for template field (multi-value template substitutions)
 
@@ -899,12 +989,9 @@ class PhotoTemplate:
                     if dirname:
                         # being used as a filepath so sanitize each part
                         folder = path_sep.join(
-                            sanitize_dirname(f, replacement=replacement)
-                            for f in album.folder_names
-                        )
-                        folder += path_sep + sanitize_dirname(
-                            album.title, replacement=replacement
+                            sanitize_dirname(f) for f in album.folder_names
                         )
+                        folder += path_sep + sanitize_dirname(album.title)
                     else:
                         folder = path_sep.join(album.folder_names)
                         folder += path_sep + album.title
@@ -912,9 +999,7 @@ class PhotoTemplate:
                 else:
                     # album not in folder
                     if dirname:
-                        values.append(
-                            sanitize_dirname(album.title, replacement=replacement)
-                        )
+                        values.append(sanitize_dirname(album.title))
                     else:
                         values.append(album.title)
         elif field == "comment":
@@ -932,18 +1017,23 @@ class PhotoTemplate:
                 self.photo.search_info.venue_types if self.photo.search_info else []
             )
         elif not field.startswith("exiftool:"):
+            # exiftool: templates handled by _render_exiftool_template
             raise ValueError(f"Unhandled template value: {field}")
 
+        # do any replacements needs
+        if replacement:
+            new_values = []
+            for value in values:
+                # process replacements
+                new_values.append(self.replace(value, replacement))
+            values = new_values
+
         # sanitize directory names if needed, folder_album handled differently above
         if filename:
-            values = [
-                sanitize_pathpart(value, replacement=replacement) for value in values
-            ]
+            values = [sanitize_pathpart(value) for value in values]
         elif dirname and field != "folder_album":
             # skip folder_album because it would have been handled above
-            values = [
-                sanitize_dirname(value, replacement=replacement) for value in values
-            ]
+            values = [sanitize_dirname(value) for value in values]
 
         # If no values, insert None so code below will substite none_str for None
         values = values or [None]

requirements.txt

@@ -42,6 +42,7 @@ 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

setup.py

@@ -81,6 +81,7 @@ setup(
         "wurlitzer>=2.0.1",
         "photoscript>=0.1.0",
         "toml>=0.10.0",
+        "osxmetadata>=0.99.13",
     ],
     entry_points={"console_scripts": ["osxphotos=osxphotos.__main__:cli"]},
     include_package_data=True,

tests/test_cli.py

@@ -357,6 +357,7 @@ CLI_EXIFTOOL = {
         "XMP:TagsList": "Kids",
         "XMP:Title": "I found one!",
         "EXIF:ImageDescription": "Girl holding pumpkin",
+        "EXIF:Make": "Canon",
         "XMP:Description": "Girl holding pumpkin",
         "XMP:PersonInImage": "Katie",
         "XMP:Subject": "Kids",
@@ -439,6 +440,19 @@ CLI_EXIFTOOL_DUPLICATE_KEYWORDS = {
     "E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51": "wedding.jpg"
 }
 
+CLI_FINDER_TAGS = {
+    "D79B8D77-BFFC-460B-9312-034F2877D35B": {
+        "File:FileName": "Pumkins2.jpg",
+        "IPTC:Keywords": "Kids",
+        "XMP:TagsList": "Kids",
+        "XMP:Title": "I found one!",
+        "EXIF:ImageDescription": "Girl holding pumpkin",
+        "XMP:Description": "Girl holding pumpkin",
+        "XMP:PersonInImage": "Katie",
+        "XMP:Subject": "Kids",
+    }
+}
+
 LABELS_JSON = {
     "labels": {
         "Plant": 7,
@@ -1101,6 +1115,54 @@ def test_export_exiftool_path():
                     assert exif[key] == CLI_EXIFTOOL[uuid][key]
 
 
+@pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
+def test_export_exiftool_path_render_template():
+    """ test --exiftool-path with {exiftool:} template rendering """
+    import glob
+    import os
+    import os.path
+    import re
+    import shutil
+    import sys
+    import tempfile
+    from osxphotos.__main__ import export
+    from osxphotos.exiftool import ExifTool
+    from osxphotos.utils import noop
+
+    exiftool_source = osxphotos.exiftool.get_exiftool_path()
+
+    # monkey patch get_exiftool_path so it returns None
+    get_exiftool_path = osxphotos.exiftool.get_exiftool_path
+    osxphotos.exiftool.get_exiftool_path = noop
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        tempdir = tempfile.TemporaryDirectory()
+        exiftool_path = os.path.join(tempdir.name, "myexiftool")
+        shutil.copy2(exiftool_source, exiftool_path)
+        for uuid in CLI_EXIFTOOL:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_6),
+                    ".",
+                    "-V",
+                    "--filename",
+                    "{original_name}_{exiftool:EXIF:Make}",
+                    "--uuid",
+                    f"{uuid}",
+                    "--exiftool-path",
+                    exiftool_path,
+                ],
+            )
+            assert result.exit_code == 0
+            assert re.search(r"Exporting.*Canon", result.output)
+
+    osxphotos.exiftool.get_exiftool_path = get_exiftool_path
+
+
 @pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
 def test_export_exiftool_ignore_date_modified():
     import glob
@@ -2818,7 +2880,6 @@ def test_export_filename_template_1():
             ],
         )
         assert result.exit_code == 0
-        workdir = os.getcwd()
         files = glob.glob("*.*")
         assert sorted(files) == sorted(CLI_EXPORTED_FILENAME_TEMPLATE_FILENAMES1)
 
@@ -2853,6 +2914,37 @@ def test_export_filename_template_2():
         assert sorted(files) == sorted(CLI_EXPORTED_FILENAME_TEMPLATE_FILENAMES2)
 
 
+def test_export_filename_template_strip():
+    """ export photos using filename template with --strip """
+    import glob
+    import locale
+    import os
+    import os.path
+    import osxphotos
+    from osxphotos.__main__ import export
+
+    locale.setlocale(locale.LC_ALL, "en_US")
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            export,
+            [
+                os.path.join(cwd, CLI_PHOTOS_DB),
+                ".",
+                "-V",
+                "--filename",
+                "{searchinfo.venue,} {created.year}-{original_name}",
+                "--strip",
+            ],
+        )
+        assert result.exit_code == 0
+        files = glob.glob("*.*")
+        assert sorted(files) == sorted(CLI_EXPORTED_FILENAME_TEMPLATE_FILENAMES1)
+
+
 def test_export_filename_template_pathsep_in_name_1():
     """ export photos using filename template with folder_album and "/" in album name """
     import locale
@@ -4814,3 +4906,335 @@ def test_export_exportdb():
             "Error: --exportdb must be specified as filename not path" in result.output
         )
 
+
+def test_export_finder_tag_keywords():
+    """ test --finder-tag-keywords """
+    import glob
+    import os
+    import os.path
+
+    from osxmetadata import OSXMetaData, Tag
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        for uuid in CLI_FINDER_TAGS:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-keywords",
+                    "--uuid",
+                    f"{uuid}",
+                ],
+            )
+            assert result.exit_code == 0
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["IPTC:Keywords"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+            # run again with --update, should skip writing extended attributes
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-keywords",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Skipping Finder tags" in result.output
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["IPTC:Keywords"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+            # clear tags and run again, should update extended attributes
+            md.tags = None
+
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-keywords",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Writing Finder tags" in result.output
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["IPTC:Keywords"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+
+def test_export_finder_tag_template():
+    """ test --finder-tag-template """
+    import glob
+    import os
+    import os.path
+
+    from osxmetadata import OSXMetaData, Tag
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        for uuid in CLI_FINDER_TAGS:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-template",
+                    "{person}",
+                    "--uuid",
+                    f"{uuid}",
+                ],
+            )
+            assert result.exit_code == 0
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+            # run again with --update, should skip writing extended attributes
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-template",
+                    "{person}",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Skipping Finder tags" in result.output
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+            # clear tags and run again, should update extended attributes
+            md.tags = None
+
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-template",
+                    "{person}",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Writing Finder tags" in result.output
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            expected = [Tag(x) for x in keywords]
+            assert sorted(md.tags) == sorted(expected)
+
+
+def test_export_finder_tag_template_multiple():
+    """ test --finder-tag-template used more than once """
+    import glob
+    import os
+    import os.path
+
+    from osxmetadata import OSXMetaData, Tag
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        for uuid in CLI_FINDER_TAGS:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-template",
+                    "{keyword}",
+                    "--finder-tag-template",
+                    "{person}",
+                    "--uuid",
+                    f"{uuid}",
+                ],
+            )
+            assert result.exit_code == 0
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["IPTC:Keywords"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            persons = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            persons = [persons] if type(persons) != list else persons
+            expected = [Tag(x) for x in keywords + persons]
+            assert sorted(md.tags) == sorted(expected)
+
+
+def test_export_finder_tag_template_keywords():
+    """ test --finder-tag-template with --finder-tag-keywords """
+    import glob
+    import os
+    import os.path
+
+    from osxmetadata import OSXMetaData, Tag
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        for uuid in CLI_FINDER_TAGS:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--finder-tag-keywords",
+                    "--finder-tag-template",
+                    "{person}",
+                    "--uuid",
+                    f"{uuid}",
+                ],
+            )
+            assert result.exit_code == 0
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            keywords = CLI_FINDER_TAGS[uuid]["IPTC:Keywords"]
+            keywords = [keywords] if type(keywords) != list else keywords
+            persons = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            persons = [persons] if type(persons) != list else persons
+            expected = [Tag(x) for x in keywords + persons]
+            assert sorted(md.tags) == sorted(expected)
+
+
+def test_export_xattr_template():
+    """ test --xattr template """
+    import glob
+    import os
+    import os.path
+
+    from osxmetadata import OSXMetaData
+    from osxphotos.__main__ import export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        for uuid in CLI_FINDER_TAGS:
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--xattr-template",
+                    "keywords",
+                    "{person}",
+                    "--xattr-template",
+                    "comment",
+                    "{title}",
+                    "--uuid",
+                    f"{uuid}",
+                ],
+            )
+            assert result.exit_code == 0
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            expected = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            expected = [expected] if type(expected) != list else expected
+            assert sorted(md.keywords) == sorted(expected)
+            assert md.comment == CLI_FINDER_TAGS[uuid]["XMP:Title"]
+
+            # run again with --update, should skip writing extended attributes
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--xattr-template",
+                    "keywords",
+                    "{person}",
+                    "--xattr-template",
+                    "comment",
+                    "{title}",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Skipping extended attribute keywords" in result.output
+            assert "Skipping extended attribute comment" in result.output
+
+            # clear tags and run again, should update extended attributes
+            md.keywords = None
+            md.comment = None
+
+            result = runner.invoke(
+                export,
+                [
+                    os.path.join(cwd, PHOTOS_DB_15_7),
+                    ".",
+                    "-V",
+                    "--xattr-template",
+                    "keywords",
+                    "{person}",
+                    "--xattr-template",
+                    "comment",
+                    "{title}",
+                    "--uuid",
+                    f"{uuid}",
+                    "--update",
+                ],
+            )
+            assert result.exit_code == 0
+            assert "Writing extended attribute keyword" in result.output
+            assert "Writing extended attribute comment" in result.output
+
+            md = OSXMetaData(CLI_FINDER_TAGS[uuid]["File:FileName"])
+            expected = CLI_FINDER_TAGS[uuid]["XMP:PersonInImage"]
+            expected = [expected] if type(expected) != list else expected
+            assert sorted(md.keywords) == sorted(expected)
+            assert md.comment == CLI_FINDER_TAGS[uuid]["XMP:Title"]
+

tests/test_template.py

@@ -53,6 +53,7 @@ TEMPLATE_VALUES_MULTI_KEYWORDS = {
 UUID_TITLE = "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4"
 TEMPLATE_VALUES_TITLE = {
     "{title}": ["Tulips tied together at a flower shop"],
+    "{title[ ,_]}": ["Tulips_tied_together_at_a_flower_shop"],
     "{+title}": ["Tulips tied together at a flower shop"],
     "{,+title}": ["Tulips tied together at a flower shop"],
     "{, +title}": ["Tulips tied together at a flower shop"],
@@ -74,7 +75,9 @@ UUID_BOOL_VALUES_NOT = {
 UUID_EXIFTOOL = {
     "A92D9C26-3A50-4197-9388-CB5F7DB9FA91": {
         "{exiftool:EXIF:Make}": ["Canon"],
+        "{exiftool:EXIF:Make[Canon,CANON]}": ["CANON"],
         "{exiftool:EXIF:Model}": ["Canon PowerShot G10"],
+        "{exiftool:EXIF:Model[ G10,]}": ["Canon PowerShot"],
         "{exiftool:EXIF:Make}/{exiftool:EXIF:Model}": ["Canon/Canon PowerShot G10"],
         "{exiftool:IPTC:Keywords,foo}": ["foo"],
     },
@@ -87,6 +90,14 @@ UUID_EXIFTOOL = {
             "UK",
             "United Kingdom",
         ],
+        "{exiftool:IPTC:Keywords[ ,_|.,]}": [
+            "England",
+            "London",
+            "London_2018",
+            "St_James's_Park",
+            "UK",
+            "United_Kingdom",
+        ],
         "{,+exiftool:IPTC:Keywords}": [
             "England,London,London 2018,St. James's Park,UK,United Kingdom"
         ],
@@ -96,7 +107,9 @@ UUID_EXIFTOOL = {
 TEMPLATE_VALUES = {
     "{name}": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
     "{original_name}": "IMG_1064",
+    "{original_name[_,-]}": "IMG-1064",
     "{title}": "Glen Ord",
+    "{title[ ,]}": "GlenOrd",
     "{descr}": "Jack Rose Dining Saloon",
     "{created.date}": "2020-02-04",
     "{created.year}": "2020",
@@ -123,6 +136,10 @@ TEMPLATE_VALUES = {
     "{place.address.postal_code}": "20009",
     "{place.address.country}": "United States",
     "{place.address.country_code}": "US",
+    "{uuid}": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
+    "{exif.camera_make}": "Apple",
+    "{exif.camera_model}": "iPhone 6s",
+    "{exif.lens_model}": "iPhone 6s back camera 4.15mm f/2.2",
 }
 
 
@@ -170,17 +187,21 @@ TEMPLATE_VALUES_DATE_MODIFIED = {
 }
 
 TEMPLATE_VALUES_DATE_NOT_MODIFIED = {
+    # uses creation date instead of modified date
     "{name}": "128FB4C6-0B16-4E7D-9108-FB2E90DA1546",
     "{original_name}": "IMG_1064",
-    "{modified.date}": "_",
-    "{modified.year}": "_",
-    "{modified.yy}": "_",
-    "{modified.mm}": "_",
-    "{modified.month}": "_",
-    "{modified.mon}": "_",
-    "{modified.dd}": "_",
-    "{modified.doy}": "_",
-    "{modified.dow}": "_",
+    "{modified.date}": "2020-02-04",
+    "{modified.year}": "2020",
+    "{modified.yy}": "20",
+    "{modified.mm}": "02",
+    "{modified.month}": "February",
+    "{modified.mon}": "Feb",
+    "{modified.dd}": "04",
+    "{modified.dow}": "Tuesday",
+    "{modified.doy}": "035",
+    "{modified.hour}": "19",
+    "{modified.min}": "07",
+    "{modified.sec}": "38",
 }
 
 
@@ -785,3 +806,4 @@ def test_exiftool_template():
         for template in UUID_EXIFTOOL[uuid]:
             rendered, _ = photo.render_template(template)
             assert sorted(rendered) == sorted(UUID_EXIFTOOL[uuid][template])
+