Updated search info for Ventura, #937 (#943)

API_README.md

@@ -238,7 +238,7 @@ Returns a list of the keywords found in the Photos library
 albums = photosdb.album_info
 ```
 
-Returns a list of [AlbumInfo](#AlbumInfo) objects representing albums in the database or empty list if there are no albums.  See also [albums](#albums) and [burst_album_info](#burst_album_info).
+Returns a list of [AlbumInfo](#albuminfo) objects representing albums in the database or empty list if there are no albums.  See also [albums](#albums) and [burst_album_info](#burst_album_info).
 
 #### `albums`
 
@@ -278,7 +278,7 @@ Returns the  [MomentInfo](#momentinfo) object for the photo or `None` if the pho
 folders = photosdb.folder_info
 ```
 
-Returns a list of [FolderInfo](#FolderInfo) objects representing top level folders in the database or empty list if there are no folders.  See also [folders](#folders).
+Returns a list of [FolderInfo](#folderinfo) objects representing top level folders in the database or empty list if there are no folders.  See also [folders](#folders).
 
 **Note**: Currently folder_info is only implemented for Photos 5 (Catalina); will return empty list and output warning if called on earlier database versions.
 
@@ -402,6 +402,15 @@ photosdb.db_version
 
 Returns the version number for Photos library database.  You likely won't need this but it's provided in case needed for debugging. PhotosDB will print a warning to `sys.stderr` if you open a database version that has not been tested.
 
+#### `photos_version`
+
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photosdb.photos_version
+```
+
+Returns the version number as int for version of Photos that created the library, e.g. 2, 3, 4, 5...
+
 #### `get_db_connection()`
 
 Returns tuple of (connection, cursor) for the working copy of the Photos database.  This is useful for debugging or prototyping new features.
@@ -428,7 +437,7 @@ conn.close()
 photos = photosdb.photos([keywords=['keyword',]], [uuid=['uuid',]], [persons=['person',]], [albums=['album',]],[from_date=datetime.datetime],[to_date=datetime.datetime])
 ```
 
-Returns a list of [PhotoInfo](#PhotoInfo) objects.  Each PhotoInfo object represents a photo in the Photos Libary.
+Returns a list of [PhotoInfo](#photoinfo) objects.  Each PhotoInfo object represents a photo in the Photos Libary.
 
 If called with no parameters, returns a list of every photo in the Photos library.
 
@@ -593,7 +602,7 @@ Returns a list of albums the photo is contained in. See also [album_info](#album
 
 #### `album_info`
 
-Returns a list of [AlbumInfo](#AlbumInfo) objects representing the albums the photo is contained in or empty list of the photo is not in any albums.  See also [albums](#albums).
+Returns a list of [AlbumInfo](#albuminfo) objects representing the albums the photo is contained in or empty list of the photo is not in any albums.  See also [albums](#albums).
 
 #### `import_info`
 
@@ -729,7 +738,7 @@ Returns latitude and longitude as a tuple of floats (latitude, longitude).  If l
 
 #### `place`
 
-Returns a [PlaceInfo](#PlaceInfo) object with reverse geolocation data or None if there is the photo has no reverse geolocation information.
+Returns a [PlaceInfo](#placeinfo) object with reverse geolocation data or None if there is the photo has no reverse geolocation information.
 
 #### `shared`
 
@@ -842,7 +851,7 @@ If a burst photo which has unselected burst images (e.g. the burst images are in
 
 #### `burst_album_info`
 
-If photo is non-selected burst photo, teturns a list of [AlbumInfo](#AlbumInfo) objects representing the albums any other photos in the same burst set are contained in.  Otherwise, returns `PhotoInfo.album_info`. See also [burst_albums](#burst_albums) and [album_info](#album_info).
+If photo is non-selected burst photo, teturns a list of [AlbumInfo](#albuminfo) objects representing the albums any other photos in the same burst set are contained in.  Otherwise, returns `PhotoInfo.album_info`. See also [burst_albums](#burst_albums) and [album_info](#album_info).
 
 #### `live_photo`
 
@@ -1129,7 +1138,7 @@ Returns the title or name of the album.
 
 #### <a name="albumphotos">`photos`</a>
 
-Returns a list of [PhotoInfo](#PhotoInfo) objects representing each photo contained in the album sorted in the same order as in Photos. (e.g. if photos were manually sorted in the Photos albums, photos returned by `photos` will be in same order as they appear in the Photos album)
+Returns a list of [PhotoInfo](#photoinfo) objects representing each photo contained in the album sorted in the same order as in Photos. (e.g. if photos were manually sorted in the Photos albums, photos returned by `photos` will be in same order as they appear in the Photos album)
 
 #### `creation_date`
 
@@ -1145,7 +1154,7 @@ Returns the date of latest photo in the album as a timezone aware datetime.datet
 
 #### `folder_list`
 
-Returns a hierarchical list of [FolderInfo](#FolderInfo) objects representing the folders the album is contained in.  For example, if album "AlbumInFolder" is in SubFolder2 of Folder1 as illustrated below, would return a list of `FolderInfo` objects representing ["Folder1", "SubFolder2"]
+Returns a hierarchical list of [FolderInfo](#folderinfo) objects representing the folders the album is contained in.  For example, if album "AlbumInFolder" is in SubFolder2 of Folder1 as illustrated below, would return a list of `FolderInfo` objects representing ["Folder1", "SubFolder2"]
 
 ```txt
 Photos Library
@@ -1169,7 +1178,7 @@ Photos Library
 
 #### `parent`
 
-Returns a [FolderInfo](#FolderInfo) object representing the albums parent folder or `None` if album is not a in a folder.
+Returns a [FolderInfo](#folderinfo) object representing the albums parent folder or `None` if album is not a in a folder.
 
 #### `owner`
 
@@ -1189,7 +1198,7 @@ Returns the universally unique identifier (uuid) of the import session.  This is
 
 #### <a name="importphotos">`photos`</a>
 
-Returns a list of [PhotoInfo](#PhotoInfo) objects representing each photo contained in the import session.
+Returns a list of [PhotoInfo](#photoinfo) objects representing each photo contained in the import session.
 
 #### `creation_date`
 
@@ -1219,7 +1228,7 @@ Returns the title or name of the project.
 
 #### <a name="projectphotos">`photos`</a>
 
-Returns a list of [PhotoInfo](#PhotoInfo) objects representing each photo contained in the project.
+Returns a list of [PhotoInfo](#photoinfo) objects representing each photo contained in the project.
 
 #### `creation_date`
 
@@ -1283,21 +1292,21 @@ Returns the title or name of the folder.
 
 #### `album_info`
 
-Returns a list of [AlbumInfo](#AlbumInfo) objects representing each album contained in the folder.
+Returns a list of [AlbumInfo](#albuminfo) objects representing each album contained in the folder.
 
 #### `album_info_shared`
 
-Returns a list of [AlbumInfo](#AlbumInfo) objects for each shared album in the photos database.
+Returns a list of [AlbumInfo](#albuminfo) objects for each shared album in the photos database.
 
 **Note**: Only valid for Photos 5+; on Photos <= 4, prints warning and returns empty list.
 
 #### `subfolders`
 
-Returns a list of [FolderInfo](#FolderInfo) objects representing the sub-folders of the folder.  
+Returns a list of [FolderInfo](#folderinfo) objects representing the sub-folders of the folder.  
 
 #### `parent`
 
-Returns a [FolderInfo](#FolderInfo) object representing the folder's parent folder or `None` if album is not a in a folder.
+Returns a [FolderInfo](#folderinfo) object representing the folder's parent folder or `None` if album is not a in a folder.
 
 #### `sort_order`
 
@@ -1780,10 +1789,10 @@ Template statements are white-space sensitive meaning that white space (spaces,
 
 e.g. if Photo keywords are `["foo","bar"]`:
 
-- `"{keyword}"` renders to `"foo", "bar"`
-- `"{,+keyword}"` renders to: `"foo,bar"`
-- `"{; +keyword}"` renders to: `"foo; bar"`
-- `"{+keyword}"` renders to `"foobar"`
+* `"{keyword}"` renders to `"foo", "bar"`
+* `"{,+keyword}"` renders to: `"foo,bar"`
+* `"{; +keyword}"` renders to: `"foo; bar"`
+* `"{+keyword}"` renders to `"foobar"`
 
 `template_field`: The template field to resolve.  See [Template Substitutions](#template-substitutions) for full list of template fields.
 
@@ -1795,75 +1804,75 @@ e.g. if Photo keywords are `["foo","bar"]`:
 
 Valid filters are:
 
-- `lower`: Convert value to lower case, e.g. 'Value' => 'value'.
-- `upper`: Convert value to upper case, e.g. 'Value' => 'VALUE'.
-- `strip`: Strip whitespace from beginning/end of value, e.g. ' Value ' => 'Value'.
-- `titlecase`: Convert value to title case, e.g. 'my value' => 'My Value'.
-- `capitalize`: Capitalize first word of value and convert other words to lower case, e.g. 'MY VALUE' => 'My value'.
-- `braces`: Enclose value in curly braces, e.g. 'value => '{value}'.
-- `parens`: Enclose value in parentheses, e.g. 'value' => '(value')
-- `brackets`: Enclose value in brackets, e.g. 'value' => '[value]'
-- `shell_quote`: Quotes the value for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.
-- `function`: Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py
-- `split(x)`: Split value into a list of values using x as delimiter, e.g. 'value1;value2' => ['value1', 'value2'] if used with split(;).
-- `autosplit`: Automatically split delimited string into separate values; will split strings delimited by comma, semicolon, or space, e.g. 'value1,value2' => ['value1', 'value2'].
-- `chop(x)`: Remove x characters off the end of value, e.g. chop(1): 'Value' => 'Valu'; when applied to a list, chops characters from each list value, e.g. chop(1): ['travel', 'beach']=> ['trave', 'beac'].
-- `chomp(x)`: Remove x characters from the beginning of value, e.g. chomp(1): ['Value'] => ['alue']; when applied to a list, removes characters from each list value, e.g. chomp(1): ['travel', 'beach']=> ['ravel', 'each'].
-- `sort`: Sort list of values, e.g. ['c', 'b', 'a'] => ['a', 'b', 'c'].
-- `rsort`: Sort list of values in reverse order, e.g. ['a', 'b', 'c'] => ['c', 'b', 'a'].
-- `reverse`: Reverse order of values, e.g. ['a', 'b', 'c'] => ['c', 'b', 'a'].
-- `uniq`: Remove duplicate values, e.g. ['a', 'b', 'c', 'b', 'a'] => ['a', 'b', 'c'].
-- `join(x)`: Join list of values with delimiter x, e.g. join(,): ['a', 'b', 'c'] => 'a,b,c'; the DELIM option functions similar to join(x) but with DELIM, the join happens before being passed to any filters.May optionally be used without an argument, that is 'join()' which joins values together with no delimiter. e.g. join(): ['a', 'b', 'c'] => 'abc'.
-- `append(x)`: Append x to list of values, e.g. append(d): ['a', 'b', 'c'] => ['a', 'b', 'c', 'd'].
-- `prepend(x)`: Prepend x to list of values, e.g. prepend(d): ['a', 'b', 'c'] => ['d', 'a', 'b', 'c'].
-- `remove(x)`: Remove x from list of values, e.g. remove(b): ['a', 'b', 'c'] => ['a', 'c'].
-- `slice(start:stop:step)`: Slice list using same semantics as Python's list slicing, e.g. slice(1:3): ['a', 'b', 'c', 'd'] => ['b', 'c']; slice(1:4:2): ['a', 'b', 'c', 'd'] => ['b', 'd']; slice(1:): ['a', 'b', 'c', 'd'] => ['b', 'c', 'd']; slice(:-1): ['a', 'b', 'c', 'd'] => ['a', 'b', 'c']; slice(::-1): ['a', 'b', 'c', 'd'] => ['d', 'c', 'b', 'a']. See also sslice().
-- `sslice(start:stop:step)`: [s(tring) slice] Slice values in a list using same semantics as Python's string slicing, e.g. sslice(1:3):'abcd => 'bc'; sslice(1:4:2): 'abcd' => 'bd', etc. See also slice().
-- `filter(x)`: Filter list of values using predicate x; for example, `{folder_album|filter(contains Events)}` returns only folders/albums containing the word 'Events' in their path.
-- `int`: Convert values in list to integer, e.g. 1.0 => 1. If value cannot be converted to integer, remove value from list. ['1.1', 'x'] => ['1']. See also float.
-- `float`: Convert values in list to floating point number, e.g. 1 => 1.0. If value cannot be converted to float, remove value from list. ['1', 'x'] => ['1.0']. See also int.
+* `lower`: Convert value to lower case, e.g. 'Value' => 'value'.
+* `upper`: Convert value to upper case, e.g. 'Value' => 'VALUE'.
+* `strip`: Strip whitespace from beginning/end of value, e.g. ' Value ' => 'Value'.
+* `titlecase`: Convert value to title case, e.g. 'my value' => 'My Value'.
+* `capitalize`: Capitalize first word of value and convert other words to lower case, e.g. 'MY VALUE' => 'My value'.
+* `braces`: Enclose value in curly braces, e.g. 'value => '{value}'.
+* `parens`: Enclose value in parentheses, e.g. 'value' => '(value')
+* `brackets`: Enclose value in brackets, e.g. 'value' => '[value]'
+* `shell_quote`: Quotes the value for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.
+* `function`: Run custom python function to filter value; use in format 'function:/path/to/file.py::function_name'. See example at <https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py>
+* `split(x)`: Split value into a list of values using x as delimiter, e.g. 'value1;value2' => ['value1', 'value2'] if used with split(;).
+* `autosplit`: Automatically split delimited string into separate values; will split strings delimited by comma, semicolon, or space, e.g. 'value1,value2' => ['value1', 'value2'].
+* `chop(x)`: Remove x characters off the end of value, e.g. chop(1): 'Value' => 'Valu'; when applied to a list, chops characters from each list value, e.g. chop(1): ['travel', 'beach']=> ['trave', 'beac'].
+* `chomp(x)`: Remove x characters from the beginning of value, e.g. chomp(1): ['Value'] => ['alue']; when applied to a list, removes characters from each list value, e.g. chomp(1): ['travel', 'beach']=> ['ravel', 'each'].
+* `sort`: Sort list of values, e.g. ['c', 'b', 'a'] => ['a', 'b', 'c'].
+* `rsort`: Sort list of values in reverse order, e.g. ['a', 'b', 'c'] => ['c', 'b', 'a'].
+* `reverse`: Reverse order of values, e.g. ['a', 'b', 'c'] => ['c', 'b', 'a'].
+* `uniq`: Remove duplicate values, e.g. ['a', 'b', 'c', 'b', 'a'] => ['a', 'b', 'c'].
+* `join(x)`: Join list of values with delimiter x, e.g. join(,): ['a', 'b', 'c'] => 'a,b,c'; the DELIM option functions similar to join(x) but with DELIM, the join happens before being passed to any filters.May optionally be used without an argument, that is 'join()' which joins values together with no delimiter. e.g. join(): ['a', 'b', 'c'] => 'abc'.
+* `append(x)`: Append x to list of values, e.g. append(d): ['a', 'b', 'c'] => ['a', 'b', 'c', 'd'].
+* `prepend(x)`: Prepend x to list of values, e.g. prepend(d): ['a', 'b', 'c'] => ['d', 'a', 'b', 'c'].
+* `remove(x)`: Remove x from list of values, e.g. remove(b): ['a', 'b', 'c'] => ['a', 'c'].
+* `slice(start:stop:step)`: Slice list using same semantics as Python's list slicing, e.g. slice(1:3): ['a', 'b', 'c', 'd'] => ['b', 'c']; slice(1:4:2): ['a', 'b', 'c', 'd'] => ['b', 'd']; slice(1:): ['a', 'b', 'c', 'd'] => ['b', 'c', 'd']; slice(:-1): ['a', 'b', 'c', 'd'] => ['a', 'b', 'c']; slice(::-1): ['a', 'b', 'c', 'd'] => ['d', 'c', 'b', 'a']. See also sslice().
+* `sslice(start:stop:step)`: [s(tring) slice] Slice values in a list using same semantics as Python's string slicing, e.g. sslice(1:3):'abcd => 'bc'; sslice(1:4:2): 'abcd' => 'bd', etc. See also slice().
+* `filter(x)`: Filter list of values using predicate x; for example, `{folder_album|filter(contains Events)}` returns only folders/albums containing the word 'Events' in their path.
+* `int`: Convert values in list to integer, e.g. 1.0 => 1. If value cannot be converted to integer, remove value from list. ['1.1', 'x'] => ['1']. See also float.
+* `float`: Convert values in list to floating point number, e.g. 1 => 1.0. If value cannot be converted to float, remove value from list. ['1', 'x'] => ['1.0']. See also int.
 
 e.g. if Photo keywords are `["FOO","bar"]`:
 
-- `"{keyword|lower}"` renders to `"foo", "bar"`
-- `"{keyword|upper}"` renders to: `"FOO", "BAR"`
-- `"{keyword|capitalize}"` renders to: `"Foo", "Bar"`
-- `"{keyword|lower|parens}"` renders to: `"(foo)", "(bar)"`
+* `"{keyword|lower}"` renders to `"foo", "bar"`
+* `"{keyword|upper}"` renders to: `"FOO", "BAR"`
+* `"{keyword|capitalize}"` renders to: `"Foo", "Bar"`
+* `"{keyword|lower|parens}"` renders to: `"(foo)", "(bar)"`
 
 e.g. if Photo description is "my description":
 
-- `"{descr|titlecase}"` renders to: `"My Description"`
+* `"{descr|titlecase}"` renders to: `"My Description"`
 
 e.g. If Photo is in `Album1` in `Folder1`:
 
-- `"{folder_album}"` renders to `["Folder1/Album1"]`
-- `"{folder_album(>)}"` renders to `["Folder1>Album1"]`
-- `"{folder_album()}"` renders to `["Folder1Album1"]`
+* `"{folder_album}"` renders to `["Folder1/Album1"]`
+* `"{folder_album(>)}"` renders to `["Folder1>Album1"]`
+* `"{folder_album()}"` renders to `["Folder1Album1"]`
 
 `[find,replace]`: optional text replacement to perform on rendered template value.  For example, to replace "/" in an album name, you could use the template `"{album[/,-]}"`.  Multiple replacements can be made by appending "|" and adding another find|replace pair.  e.g. to replace both "/" and ":" in album name: `"{album[/,-|:,-]}"`.  find/replace pairs are not limited to single characters.  The "|" character cannot be used in a find/replace pair.
 
 `conditional`: optional conditional expression that is evaluated as boolean (True/False) for use with the `?bool_value` modifier.  Conditional expressions take the form '`not operator value`' where `not` is an optional modifier that negates the `operator`.  Note: the space before the conditional expression is required if you use a conditional expression.  Valid comparison operators are:
 
-- `contains`: template field contains value, similar to python's `in`
-- `matches`: template field contains exactly value, unlike `contains`: does not match partial matches
-- `startswith`: template field starts with value
-- `endswith`: template field ends with value
-- `<=`: template field is less than or equal to value
-- `>=`: template field is greater than or equal to value
-- `<`: template field is less than value
-- `>`: template field is greater than value
-- `==`: template field equals value
-- `!=`: template field does not equal value
+* `contains`: template field contains value, similar to python's `in`
+* `matches`: template field contains exactly value, unlike `contains`: does not match partial matches
+* `startswith`: template field starts with value
+* `endswith`: template field ends with value
+* `<=`: template field is less than or equal to value
+* `>=`: template field is greater than or equal to value
+* `<`: template field is less than value
+* `>`: template field is greater than value
+* `==`: template field equals value
+* `!=`: template field does not equal value
 
 The `value` part of the conditional expression is treated as a bare (unquoted) word/phrase.  Multiple values may be separated by '|' (the pipe symbol).  `value` is itself a template statement so you can use one or more template fields in `value` which will be resolved before the comparison occurs.
 
 For example:
 
-- `{keyword matches Beach}` resolves to True if 'Beach' is a keyword. It would not match keyword 'BeachDay'.
-- `{keyword contains Beach}` resolves to True if any keyword contains the word 'Beach' so it would match both 'Beach' and 'BeachDay'.
-- `{photo.score.overall > 0.7}` resolves to True if the photo's overall aesthetic score is greater than 0.7.
-- `{keyword|lower contains beach}` uses the lower case filter to do case-insensitive matching to match any keyword that contains the word 'beach'.
-- `{keyword|lower not contains beach}` uses the `not` modifier to negate the comparison so this resolves to True if there is no keyword that matches 'beach'.
+* `{keyword matches Beach}` resolves to True if 'Beach' is a keyword. It would not match keyword 'BeachDay'.
+* `{keyword contains Beach}` resolves to True if any keyword contains the word 'Beach' so it would match both 'Beach' and 'BeachDay'.
+* `{photo.score.overall > 0.7}` resolves to True if the photo's overall aesthetic score is greater than 0.7.
+* `{keyword|lower contains beach}` uses the lower case filter to do case-insensitive matching to match any keyword that contains the word 'beach'.
+* `{keyword|lower not contains beach}` uses the `not` modifier to negate the comparison so this resolves to True if there is no keyword that matches 'beach'.
 
 Examples: to export photos that contain certain keywords with the `osxphotos export` command's `--directory` option:
 
@@ -1880,24 +1889,24 @@ This renames any photo that is a favorite as 'Favorite-ImageName.jpg' (where 'Im
 
 e.g. if photo is an HDR image,
 
-- `"{hdr?ISHDR,NOTHDR}"` renders to `"ISHDR"`
+* `"{hdr?ISHDR,NOTHDR}"` renders to `"ISHDR"`
 
 and if it is not an HDR image,
 
-- `"{hdr?ISHDR,NOTHDR}"` renders to `"NOTHDR"`
+* `"{hdr?ISHDR,NOTHDR}"` renders to `"NOTHDR"`
 
 `,default`: optional default value to use if the template name has no value.  This modifier is also used for the value if False for boolean-type fields (see above) as well as to hold a sub-template for values like `{created.strftime}`.  If no default value provided, "_" is used.
 
 e.g., if photo has no title set,
 
-- `"{title}"` renders to "_"
-- `"{title,I have no title}"` renders to `"I have no title"`
+* `"{title}"` renders to "_"
+* `"{title,I have no title}"` renders to `"I have no title"`
 
 Template fields such as `created.strftime` use the default value to pass the template to use for `strftime`.  
 
 e.g., if photo date is 4 February 2020, 19:07:38,
 
-- `"{created.strftime,%Y-%m-%d-%H%M%S}"` renders to `"2020-02-04-190738"`
+* `"{created.strftime,%Y-%m-%d-%H%M%S}"` renders to `"2020-02-04-190738"`
 
 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 was a time_lapse photo, `media_type` would resolve to `vidéo_accélérée` instead of `time_lapse`.
 
@@ -1949,7 +1958,7 @@ cog.out(get_template_field_table())
 |{created.hour}|2-digit hour of the photo creation time|
 |{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.|
+|{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}|Photo's modification date in ISO format, e.g. '2020-03-22'; uses creation date if photo is not modified|
 |{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|
@@ -1963,7 +1972,7 @@ cog.out(get_template_field_table())
 |{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'. If used with no template will return null value. Uses creation date if photo is not modified. See https://strftime.org/ for help on strftime templates.|
+|{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'. If used with no template will return null value. Uses creation date if photo is not modified. See <https://strftime.org/> for help on strftime templates.|
 |{today}|Current date in iso format, e.g. '2020-03-22'|
 |{today.date}|Current date in iso format, e.g. '2020-03-22'|
 |{today.year}|4-digit year of current date|
@@ -1977,7 +1986,7 @@ cog.out(get_template_field_table())
 |{today.hour}|2-digit hour of the current date|
 |{today.min}|2-digit minute of the current date|
 |{today.sec}|2-digit second of the current date|
-|{today.strftime}|Apply strftime template to current date/time. Should be used in form {today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {today.strftime,%Y-%U} would result in year-week number of year: '2020-23'. If used with no template will return null value. See https://strftime.org/ for help on strftime templates.|
+|{today.strftime}|Apply strftime template to current date/time. Should be used in form {today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {today.strftime,%Y-%U} would result in year-week number of year: '2020-23'. If used with no template will return null value. See <https://strftime.org/> for help on strftime templates.|
 |{place.name}|Place name from the photo's reverse geolocation data, as displayed in Photos|
 |{place.country_code}|The ISO country code from the photo's reverse geolocation data|
 |{place.name.country}|Country name from the photo's reverse geolocation data|
@@ -2028,17 +2037,17 @@ cog.out(get_template_field_table())
 |{label}|Image categorization label associated with a photo (Photos 5+ only). Labels are added automatically by Photos using machine learning algorithms to categorize images. These are not the same as {keyword} which refers to the user-defined keywords/tags applied in Photos.|
 |{label_normalized}|All lower case version of 'label' (Photos 5+ only)|
 |{comment}|Comment(s) on shared Photos; format is 'Person name: comment text' (Photos 5+ only)|
-|{exiftool}|Format: '{exiftool:GROUP:TAGNAME}'; use exiftool (https://exiftool.org) to extract metadata, in form GROUP:TAGNAME, from image.  E.g. '{exiftool:EXIF:Make}' to get camera make, or {exiftool:IPTC:Keywords} to extract keywords. See https://exiftool.org/TagNames/ for list of valid tag names.  You must specify group (e.g. EXIF, IPTC, etc) as used in `exiftool -G`. exiftool must be installed in the path to use this template.|
+|{exiftool}|Format: '{exiftool:GROUP:TAGNAME}'; use exiftool (<https://exiftool.org>) to extract metadata, in form GROUP:TAGNAME, from image.  E.g. '{exiftool:EXIF:Make}' to get camera make, or {exiftool:IPTC:Keywords} to extract keywords. See <https://exiftool.org/TagNames/> for list of valid tag names.  You must specify group (e.g. EXIF, IPTC, etc) as used in `exiftool -G`. exiftool must be installed in the path to use this template.|
 |{searchinfo.holiday}|Holiday names associated with a photo, e.g. 'Christmas Day'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
 |{searchinfo.activity}|Activities associated with a photo, e.g. 'Sporting Event'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
 |{searchinfo.venue}|Venues associated with a photo, e.g. name of restaurant; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
 |{searchinfo.venue_type}|Venue types associated with a photo, e.g. 'Restaurant'; (Photos 5+ only, applied automatically by Photos' image categorization algorithms).|
-|{photo}|Provides direct access to the PhotoInfo object for the photo. Must be used in format '{photo.property}' where 'property' represents a PhotoInfo property. For example: '{photo.favorite}' is the same as '{favorite}' and '{photo.place.name}' is the same as '{place.name}'. '{photo}' provides access to properties that are not available as separate template fields but it assumes some knowledge of the underlying PhotoInfo class.  See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.|
+|{photo}|Provides direct access to the PhotoInfo object for the photo. Must be used in format '{photo.property}' where 'property' represents a PhotoInfo property. For example: '{photo.favorite}' is the same as '{favorite}' and '{photo.place.name}' is the same as '{place.name}'. '{photo}' provides access to properties that are not available as separate template fields but it assumes some knowledge of the underlying PhotoInfo class.  See <https://rhettbull.github.io/osxphotos/> for additional documentation on the PhotoInfo class.|
 |{detected_text}|List of text strings found in the image after performing text detection. Using '{detected_text}' will cause osxphotos to perform text detection on your photos using the built-in macOS text detection algorithms which will slow down your export. The results for each photo will be cached in the export database so that future exports with '--update' do not need to reprocess each photo. You may pass a confidence threshold value between 0.0 and 1.0 after a colon as in '{detected_text:0.5}'; The default confidence threshold is 0.75. '{detected_text}' works only on macOS Catalina (10.15) or later. Note: this feature is not the same thing as Live Text in macOS Monterey, which osxphotos does not yet support.|
 |{shell_quote}|Use in form '{shell_quote,TEMPLATE}'; quotes the rendered TEMPLATE value(s) for safe usage in the shell, e.g. My file.jpeg => 'My file.jpeg'; only adds quotes if needed.|
 |{strip}|Use in form '{strip,TEMPLATE}'; strips whitespace from begining and end of rendered TEMPLATE value(s).|
 |{format}|Use in form, '{format:TYPE:FORMAT,TEMPLATE}'; converts TEMPLATE value to TYPE then formats the value using Python string formatting codes specified by FORMAT; TYPE is one of: 'int', 'float', or 'str'. For example, '{format:float:.1f,{exiftool:EXIF:FocalLength}}' will format focal length to 1 decimal place (e.g. '100.0'). |
-|{function}|Execute a python function from an external file and use return value as template substitution. Use in format: {function:file.py::function_name} where 'file.py' is the name of the python file and 'function_name' is the name of the function to call. The function will be passed the PhotoInfo object for the photo. See https://github.com/RhetTbull/osxphotos/blob/master/examples/template_function.py for an example of how to implement a template function.|
+|{function}|Execute a python function from an external file and use return value as template substitution. Use in format: {function:file.py::function_name} where 'file.py' is the name of the python file and 'function_name' is the name of the function to call. The function will be passed the PhotoInfo object for the photo. See <https://github.com/RhetTbull/osxphotos/blob/master/examples/template_function.py> for an example of how to implement a template function.|
 <!--[[[end]]] -->
 
 ### <a name="exiftoolExifTool">ExifTool</a>

osxphotos/_constants.py

@@ -1,6 +1,6 @@
-"""
-Constants used by osxphotos 
-"""
+""" Constants used by osxphotos """
+
+from __future__ import annotations
 
 import os.path
 from datetime import datetime
@@ -138,7 +138,9 @@ _PHOTOS_5_SHARED_PHOTO_PATH = "resources/cloudsharing/data"
 _PHOTOS_8_SHARED_PHOTO_PATH = "scopes/cloudsharing/data"
 
 # Where are shared iCloud derivatives located?
-_PHOTOS_5_SHARED_DERIVATIVE_PATH = "resources/cloudsharing/resources/derivatives/masters"
+_PHOTOS_5_SHARED_DERIVATIVE_PATH = (
+    "resources/cloudsharing/resources/derivatives/masters"
+)
 _PHOTOS_8_SHARED_DERIVATIVE_PATH = "scopes/cloudsharing/resources/derivatives/masters"
 
 # What type of file? Based on ZGENERICASSET.ZKIND in Photos 5 database
@@ -213,11 +215,11 @@ class SearchCategory:
     TITLE = 2017
     DESCRIPTION = 2018
     HOME = 2020
+    WORK = 2036
     PERSON = 2021
     ACTIVITY = 2027
     HOLIDAY = 2029
     SEASON = 2030
-    WORK = 2036
     VENUE = 2038
     VENUE_TYPE = 2039
     PHOTO_TYPE_VIDEO = 2044
@@ -230,6 +232,7 @@ class SearchCategory:
     PHOTO_TYPE_PORTRAIT = 2053
     PHOTO_TYPE_SELFIES = 2054
     PHOTO_TYPE_FAVORITES = 2055
+    PHOTO_TYPE_ANIMATED = None  # Photos 8+ only
     MEDIA_TYPES = [
         PHOTO_TYPE_VIDEO,
         PHOTO_TYPE_SLOMO,
@@ -244,7 +247,23 @@ class SearchCategory:
     ]
     PHOTO_NAME = 2056
     CAMERA = None  # Photos 8+ only
+    TEXT_FOUND = None  # Photos 8+ only
     DETECTED_TEXT = None  # Photos 8+ only
+    SOURCE = None  # Photos 8+ only
+
+    @classmethod
+    def categories(cls) -> dict[int, str]:
+        """Return categories as dict of value: name"""
+        # a bit of a hack to basically reverse the enum
+        return {
+            value: name
+            for name, value in cls.__dict__.items()
+            if name is not None
+            and not name.startswith("__")
+            and not callable(name)
+            and name.isupper()
+            and not isinstance(value, (list, dict, tuple))
+        }
 
 
 class SearchCategory_Photos8(SearchCategory):
@@ -252,6 +271,20 @@ class SearchCategory_Photos8(SearchCategory):
 
     # Many of the category values changed in Ventura / Photos 8
     # and some new categories were added
+    CITY = 5
+    LOCALITY_4 = 4
+    SUB_LOCALITY_5 = None
+    SUB_LOCALITY_6 = 6
+    LOCALITY_8 = 8
+    NAMED_AREA = 7
+    ALL_LOCALITY = [
+        LOCALITY_4,
+        SUB_LOCALITY_6,
+        LOCALITY_8,
+        NAMED_AREA,
+    ]
+    HOME = 1000
+    WORK = 1001
     LABEL = 1500
     MONTH = 1100
     YEAR = 1101
@@ -261,11 +294,55 @@ class SearchCategory_Photos8(SearchCategory):
     TITLE = 1201
     DESCRIPTION = 1202
     DETECTED_TEXT = 1203  # new in Photos 8
+    TEXT_FOUND = 1205  # new in Photos 8
     PERSON = 1300
     ACTIVITY = 1600
+    VENUE = 1700
+    VENUE_TYPE = 1701
+    PHOTO_TYPE_VIDEO = 1901
+    PHOTO_TYPE_SELFIES = 1915
+    PHOTO_TYPE_LIVE = 1906
+    PHOTO_TYPE_PORTRAIT = 1914
     PHOTO_TYPE_FAVORITES = 2000
+    PHOTO_TYPE_PANORAMA = 1908
+    PHOTO_TYPE_TIMELAPSE = 1909
+    PHOTO_TYPE_SLOMO = 1905
+    PHOTO_TYPE_BURSTS = 1913
+    PHOTO_TYPE_SCREENSHOT = 1907
+    PHOTO_TYPE_ANIMATED = 1912
+    PHOTO_TYPE_RAW = 1902
+    MEDIA_TYPES = [
+        PHOTO_TYPE_VIDEO,
+        PHOTO_TYPE_SLOMO,
+        PHOTO_TYPE_LIVE,
+        PHOTO_TYPE_SCREENSHOT,
+        PHOTO_TYPE_PANORAMA,
+        PHOTO_TYPE_TIMELAPSE,
+        PHOTO_TYPE_BURSTS,
+        PHOTO_TYPE_PORTRAIT,
+        PHOTO_TYPE_SELFIES,
+        PHOTO_TYPE_FAVORITES,
+        PHOTO_TYPE_ANIMATED,
+    ]
     PHOTO_NAME = 2100
     CAMERA = 2300  # new in Photos 8
+    SOURCE = 2200  # new in Photos 8, shows the app/software source for the photo, e.g. Messages, Safari, etc.
+
+    @classmethod
+    def categories(cls) -> dict[int, str]:
+        """Return categories as dict of value: name"""
+        # need to get the categories from the base class and update with the new values
+        classdict = SearchCategory.__dict__.copy()
+        classdict |= cls.__dict__.copy()
+        return {
+            value: name
+            for name, value in classdict.items()
+            if name is not None
+            and not name.startswith("__")
+            and not callable(name)
+            and name.isupper()
+            and not isinstance(value, (list, dict, tuple))
+        }
 
 
 def search_category_factory(version: int) -> SearchCategory:

osxphotos/cli/photo_inspect.py

@@ -21,7 +21,7 @@ from rich.live import Live
 from rich.panel import Panel
 
 from osxphotos import PhotoInfo, PhotosDB
-from osxphotos._constants import _UNKNOWN_PERSON
+from osxphotos._constants import _UNKNOWN_PERSON, search_category_factory
 from osxphotos.rich_utils import add_rich_markup_tag
 from osxphotos.text_detection import detect_text as detect_text_in_photo
 from osxphotos.utils import dd_to_dms_str
@@ -65,6 +65,22 @@ def trim(text: str, pad: str = "") -> str:
     return text if len(text) <= width else f"{text[: width- 3]}..."
 
 
+def format_search_info(photo: PhotoInfo) -> str:
+    """Format search info for photo"""
+    categories = sorted(list(photo._db._db_searchinfo_categories.keys()))
+    search_info = photo.search_info
+    if not search_info:
+        return ""
+    search_info_strs = []
+    category_dict = search_category_factory(photo._db.photos_version).categories()
+    for category in categories:
+        if text := search_info._get_text_for_category(category):
+            text = ", ".join(t for t in text if t) if isinstance(text, list) else text
+            category_name = str(category_dict.get(category, category)).lower()
+            search_info_strs.append(f"{bold(category_name)}: {text}")
+    return ", ".join(search_info_strs)
+
+
 def inspect_photo(
     photo: PhotoInfo,
     detected_text: Optional[str] = None,
@@ -138,8 +154,10 @@ def inspect_photo(
             + f"{', '.join(dd_to_dms_str(*photo.location)) if photo.location[0] else '-'}",
             bold("Place: ") + f"{photo.place.name if photo.place else '-'}",
             bold("Categories/Labels: ") + f"{', '.join(photo.labels) or '-'}",
+            bold("Search Info: ") + format_search_info(photo),
         ]
     )
+
     properties.append(format_flags(photo))
     properties.append(format_albums(photo))
 

osxphotos/photosdb/photosdb.py

@@ -324,8 +324,15 @@ class PhotosDB:
         # _db_version is set from photos.db
         self._db_version = get_db_version(self._tmp_db)
         # _photos_version is set from Photos.sqlite which only exists for Photos 5+
-        self._photos_ver = 4 if self._db_version == 4 else 5
-
+        db_ver_int = int(self._db_version)
+        if db_ver_int < 3000:
+            self._photos_ver = 2
+        elif db_ver_int < 4000:
+            self._photos_ver = 3
+        elif db_ver_int < 5000:
+            self._photos_ver = 4
+        else:
+            self._photos_ver = 5
         # If Photos >= 5, actual data isn't in photos.db but in Photos.sqlite
         if int(self._db_version) > int(_PHOTOS_4_VERSION):
             dbpath = pathlib.Path(self._dbfile).parent
@@ -585,6 +592,11 @@ class PhotosDB:
         """returns path to the Photos library PhotosDB was initialized with"""
         return self._library_path
 
+    @property
+    def photos_version(self):
+        """returns version of Photos app that created the library"""
+        return self._photos_ver
+
     def get_db_connection(self):
         """Get connection to the working copy of the Photos database
 

osxphotos/searchinfo.py

@@ -139,6 +139,13 @@ class SearchInfo:
             return []
         return self._get_text_for_category(self._categories.DETECTED_TEXT)
 
+    @property
+    def text_found(self):
+        """Returns True if photos has detected text (macOS 13+ / Photos 8+ only)"""
+        if self._photo._db._photos_ver < 8:
+            return []
+        return self._get_text_for_category(self._categories.TEXT_FOUND)
+
     @property
     def camera(self):
         """returns camera name (macOS 13+ / Photos 8+ only)"""
@@ -147,10 +154,18 @@ class SearchInfo:
         camera = self._get_text_for_category(self._categories.CAMERA)
         return camera[0] if camera else ""
 
+    @property
+    def source(self):
+        """returns source of the photo (e.g. "Messages", "Safar", etc) (macOS 13+ / Photos 8+ only)"""
+        if self._photo._db._photos_ver < 8:
+            return ""
+        source = self._get_text_for_category(self._categories.SOURCE)
+        return source[0] if source else ""
+
     @property
     def all(self):
         """return all search info properties in a single list"""
-        all = (
+        all_ = (
             self.labels
             + self.place_names
             + self.streets
@@ -165,23 +180,23 @@ class SearchInfo:
             + self.detected_text
         )
         if self.city:
-            all += [self.city]
+            all_ += [self.city]
         if self.state:
-            all += [self.state]
+            all_ += [self.state]
         if self.state_abbreviation:
-            all += [self.state_abbreviation]
+            all_ += [self.state_abbreviation]
         if self.country:
-            all += [self.country]
+            all_ += [self.country]
         if self.month:
-            all += [self.month]
+            all_ += [self.month]
         if self.year:
-            all += [self.year]
+            all_ += [self.year]
         if self.season:
-            all += [self.season]
+            all_ += [self.season]
         if self.camera:
-            all += [self.camera]
+            all_ += [self.camera]
 
-        return all
+        return all_
 
     def asdict(self):
         """return dict of search info"""
@@ -206,6 +221,7 @@ class SearchInfo:
             "media_types": self.media_types,
             "detected_text": self.detected_text,
             "camera": self.camera,
+            "source": self.source,
         }
 
     def _get_text_for_category(self, category):

tests/test_10_12_6.py

@@ -57,6 +57,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "2622"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 2
+
+
 def test_persons(photosdb):
 
     assert "Katie" in photosdb.persons

tests/test_bigsur_10_16_0_1.py

@@ -268,6 +268,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "6000"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 6
+
+
 def test_persons(photosdb):
     import collections
 

tests/test_catalina_10_15_7.py

@@ -358,6 +358,10 @@ def test_persons(photosdb):
     assert Counter(PERSONS) == Counter(photosdb.persons)
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 5
+
+
 def test_keywords(photosdb):
 
     assert "wedding" in photosdb.keywords

tests/test_highsierra.py

@@ -47,6 +47,10 @@ def test_db_version(photosdb):
     # assert photosdb.db_version in osxphotos._TESTED_DB_VERSIONS
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 3
+
+
 def test_persons(photosdb):
     import collections
 

tests/test_mojave_10_14_6.py

@@ -183,6 +183,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "4025"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 4
+
+
 def test_db_len(photosdb):
     # assert photosdb.db_version in osxphotos._TESTED_DB_VERSIONS
     assert len(photosdb) == PHOTOS_DB_LEN

tests/test_monterey_dev_beta_12_0_0.py

@@ -302,6 +302,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "6000"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 7
+
+
 def test_persons(photosdb):
 
     assert "Katie" in photosdb.persons

tests/test_ventura_13_0_0.py

@@ -215,8 +215,8 @@ UUID_SEARCH_INFO = {
         "place_names": ["River Torrens/Karrawirra Parri"],
         "streets": ["River Torrens Linear Park Trl"],
         "neighborhoods": ["Central Ward"],
-        "city": "",
-        "locality_names": ["Adelaide", "South Australia"],
+        "city": "Adelaide",
+        "locality_names": [],
         "state": "Adelaide",
         "state_abbreviation": "SA",
         "country": "Australia",
@@ -231,6 +231,7 @@ UUID_SEARCH_INFO = {
         "media_types": [],
         "detected_text": [],
         "camera": "Apple iPhone 6s",
+        "source": "",
     }
 }
 
@@ -316,6 +317,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "6000"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 8
+
+
 def test_persons(photosdb):
     import collections
 

tests/test_ventura_dev_preview_13_0_0.py

@@ -270,6 +270,10 @@ def test_db_version(photosdb):
     assert photosdb.db_version == "6000"
 
 
+def test_photos_version(photosdb):
+    assert photosdb.photos_version == 8
+
+
 def test_persons(photosdb):
     import collections