Updated docs [skip ci]

* add __all__ to files "adjustmentsinfo.py" and "albuminfo.py"

* add __all__ to file "cli.py"

* add __all__ to all files that misses except files with prefix "_"

.all-contributorsrc

@@ -293,7 +293,8 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/6291?v=4",
       "profile": "https://hyfen.net",
       "contributions": [
-        "doc", "code"
+        "doc",
+        "code"
       ]
     },
     {
@@ -304,6 +305,25 @@
       "contributions": [
         "bug"
       ]
+    },
+    {
+      "login": "ahti123",
+      "name": "Ahti Liin",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22232632?v=4",
+      "profile": "https://github.com/ahti123",
+      "contributions": [
+        "code",
+        "bug"
+      ]
+    },
+    {
+      "login": "xwu64",
+      "name": "Xiaoliang Wu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/10580396?v=4",
+      "profile": "https://github.com/xwu64",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

CHANGELOG.md

@@ -4,6 +4,82 @@ 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.44.12](https://github.com/RhetTbull/osxphotos/compare/v0.44.11...v0.44.12)
+
+> 23 January 2022
+
+- Added query options to repl, #597 [`7855801`](https://github.com/RhetTbull/osxphotos/commit/785580115b29f5ccb895de22be1243f56dbb43dc)
+- Added run command, #598 [`b4bd04c`](https://github.com/RhetTbull/osxphotos/commit/b4bd04c1461d0b427937f541403305bc979bcf4f)
+- Bug fix for get_photos_library_version [`e88c6b8`](https://github.com/RhetTbull/osxphotos/commit/e88c6b8a59dfd947f6cf3c7eac9c92519ab781a3)
+
+#### [v0.44.11](https://github.com/RhetTbull/osxphotos/compare/v0.44.10...v0.44.11)
+
+> 23 January 2022
+
+- creat unit test for __all__ [`#599`](https://github.com/RhetTbull/osxphotos/pull/599)
+- Performance improvements, added --profile [`7486823`](https://github.com/RhetTbull/osxphotos/commit/74868238f3b1ee18feb744f137f5c14ef8e36ffc)
+
+#### [v0.44.10](https://github.com/RhetTbull/osxphotos/compare/v0.44.9...v0.44.10)
+
+> 22 January 2022
+
+- Create __all__ for all python files [`#589`](https://github.com/RhetTbull/osxphotos/pull/589)
+- Create __all__ for the file cli.py [`#587`](https://github.com/RhetTbull/osxphotos/pull/587)
+- docs: add xwu64 as a contributor for code [`#585`](https://github.com/RhetTbull/osxphotos/pull/585)
+- add __all__ to files "adjustmentsinfo.py" and "albuminfo.py" [`#584`](https://github.com/RhetTbull/osxphotos/pull/584)
+- More refactoring of export code, #462 [`6261a7b`](https://github.com/RhetTbull/osxphotos/commit/6261a7b5c96ac43aece66b72b9e27a90854accfa)
+- Added ExportOptions to photoexporter.py, #462 [`9517876`](https://github.com/RhetTbull/osxphotos/commit/9517876bd06572238648a6362a309063b86007e7)
+- Blackified files [`3bafdf7`](https://github.com/RhetTbull/osxphotos/commit/3bafdf7bfd5f7992b2e0c12496c55e7be1f57455)
+- More refactoring of export code, #462 [`c2d726b`](https://github.com/RhetTbull/osxphotos/commit/c2d726beafabe76cf4d5fb3213447c900129b8c0)
+- Refactored photoexporter sidecar writing, #462 [`458da0e`](https://github.com/RhetTbull/osxphotos/commit/458da0e9b2b82a78cec30191c5bf1ee2ed993acf)
+
+#### [v0.44.9](https://github.com/RhetTbull/osxphotos/compare/v0.44.8...v0.44.9)
+
+> 9 January 2022
+
+- Added diff command [`3927f05`](https://github.com/RhetTbull/osxphotos/commit/3927f052670b2a1c31cced1f8278a0ffe519a3eb)
+- Added uuid command [`a010ab5`](https://github.com/RhetTbull/osxphotos/commit/a010ab5a299470782b938e689a7ddc336513065e)
+
+#### [v0.44.8](https://github.com/RhetTbull/osxphotos/compare/v0.44.7...v0.44.8)
+
+> 9 January 2022
+
+- docs: add ahti123 as a contributor for code, bug [`#578`](https://github.com/RhetTbull/osxphotos/pull/578)
+- changing photos_5 version constant to satisfy version 5001 [`#577`](https://github.com/RhetTbull/osxphotos/pull/577)
+- Added grep command to CLI [`4dd838b`](https://github.com/RhetTbull/osxphotos/commit/4dd838b8bcb639eba3df9cb60a7cd28f45b22833)
+- Added test for #576 [`92fced7`](https://github.com/RhetTbull/osxphotos/commit/92fced75da38f1c47be8d3d9d4ee22463ad029b9)
+- Added sqlgrep [`53c701c`](https://github.com/RhetTbull/osxphotos/commit/53c701cc0ebd38db255c1ce694391b38dbb5fe01)
+- Fix for #575, database version 5001 [`5a8105f`](https://github.com/RhetTbull/osxphotos/commit/5a8105f5a02080368ad22717c064afcb0748f646)
+- Updated docs [skip ci] [`64a0760`](https://github.com/RhetTbull/osxphotos/commit/64a0760a47205a452e015a860f39f45bba67164a)
+
+#### [v0.44.7](https://github.com/RhetTbull/osxphotos/compare/v0.44.6...v0.44.7)
+
+> 8 January 2022
+
+- Fix for #576, error exporting edited live photos [`2e7db47`](https://github.com/RhetTbull/osxphotos/commit/2e7db47806683fdd0db4d1d75e42471d2f127d4d)
+
+#### [v0.44.6](https://github.com/RhetTbull/osxphotos/compare/v0.44.5...v0.44.6)
+
+> 6 January 2022
+
+- Fix for burst images with pick type = 0, partial fix for #571 [`d2d56a7`](https://github.com/RhetTbull/osxphotos/commit/d2d56a7f7118aeffa7ac81cc474fdd4fb4843065)
+
+#### [v0.44.5](https://github.com/RhetTbull/osxphotos/compare/v0.44.4...v0.44.5)
+
+> 6 January 2022
+
+- More refactoring of export code, #462 [`0c9bd87`](https://github.com/RhetTbull/osxphotos/commit/0c9bd8760261770e11b0fa59153f49f2d65e2c2f)
+- Fix for #570 [`661a573`](https://github.com/RhetTbull/osxphotos/commit/661a573bf50353fb2393c604080ffe0790ade59c)
+- version bump [skip ci] [`b4897ff`](https://github.com/RhetTbull/osxphotos/commit/b4897ff1b5d2bc00f34158345b2b5fe85f1490ac)
+
+#### [v0.44.4](https://github.com/RhetTbull/osxphotos/compare/v0.44.3...v0.44.4)
+
+> 4 January 2022
+
+- Refactored photoinfo, photoexporter; #462 [`a73dc72`](https://github.com/RhetTbull/osxphotos/commit/a73dc72558b77152f4c90f143b6a60924b8905c8)
+- More refactoring of export code, #462 [`147b30f`](https://github.com/RhetTbull/osxphotos/commit/147b30f97308db65868dc7a8d177d77ad0d0ad40)
+- Export DB can now reside outside export directory, #568 [`76aee7f`](https://github.com/RhetTbull/osxphotos/commit/76aee7f189b4b32e2e263a4e798711713ed17a14)
+
 #### [v0.44.3](https://github.com/RhetTbull/osxphotos/compare/v0.44.2...v0.44.3)
 
 > 31 December 2021

MANIFEST.in

@@ -3,4 +3,5 @@ include README.rst
 include osxphotos/templates/*
 include osxphotos/phototemplate.tx
 include osxphotos/phototemplate.md
+include osxphotos/tutorial.md
 include osxphotos/queries/*

README.md

@@ -5,7 +5,7 @@
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/osxphotos)
 [![Downloads](https://static.pepy.tech/personalized-badge/osxphotos?period=month&units=international_system&left_color=black&right_color=brightgreen&left_text=downloads/month)](https://pepy.tech/project/osxphotos)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-32-orange.svg?style=flat)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-34-orange.svg?style=flat)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 OSXPhotos provides the ability to interact with and query Apple's Photos.app library on macOS. You can query the Photos library database — for example, file name, file path, and metadata such as keywords/tags, persons/faces, albums, etc. You can also easily export both the original and edited photos.
@@ -142,6 +142,7 @@ Options:
 Commands:
   about      Print information about osxphotos including license.
   albums     Print out albums found in the Photos library.
+  diff       Compare two Photos databases and print out differences
   dump       Print list of all photos & associated info from the Photos...
   export     Export photos from the Photos database.
   help       Print help; for help on commands: help <command>.
@@ -154,8 +155,10 @@ Commands:
   places     Print out places found in the Photos library.
   query      Query the Photos database using 1 or more search options; if...
   repl       Run interactive osxphotos REPL shell (useful for debugging,...
+  snap       Create snapshot of Photos database to use with diff command
   tutorial   Display osxphotos tutorial.
   uninstall  Uninstall Python packages from the osxphotos environment
+  uuid       Print out unique IDs (UUID) of photos selected in Photos
 ```
 
 To get help on a specific command, use `osxphotos help <command_name>`
@@ -1720,7 +1723,7 @@ Substitution                    Description
 {lf}                            A line feed: '\n', alias for {newline}
 {cr}                            A carriage return: '\r'
 {crlf}                          a carriage return + line feed: '\r\n'
-{osxphotos_version}             The osxphotos version, e.g. '0.44.4'
+{osxphotos_version}             The osxphotos version, e.g. '0.45.0'
 {osxphotos_cmd_line}            The full command line used to run osxphotos
 
 The following substitutions may result in multiple values. Thus if specified for
@@ -2763,25 +2766,27 @@ Returns a JSON representation of all photo info.
 Returns a dictionary representation of all photo info.
 
 #### `export()`
-`export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)`
+`export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, download_missing=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)`
 
 Export photo from the Photos library to another destination on disk.  
 - dest: must be valid destination path as str (or exception raised).
 - filename (optional): name of picture as str; if not provided, will use current filename.  **NOTE**: if provided, user must ensure file extension (suffix) is correct. For example, if photo is .CR2 file, edited image may be .jpeg.  If you provide an extension different than what the actual file is, export will print a warning but will happily export the photo using the incorrect file extension.  e.g. to get the extension of the edited photo, look at [PhotoInfo.path_edited](#path_edited).
-- edited: boolean; if True (default=False), will export the edited version of the photo (or raise exception if no edited version)
-- export_as_hardlink: boolean; if True (default=False), will hardlink files instead of copying them
-- overwrite: boolean; if True (default=False), will overwrite files if they alreay exist
-- live_photo: boolean; if True (default=False), will also export the associted .mov for live photos; exported live photo will be named filename.mov
-- increment: boolean; if True (default=True), will increment file name until a non-existent name is found
-- sidecar_json: (boolean, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name
-- sidecar_json: (boolean, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will include tag group names (e.g. `exiftool -G -j`)
-- sidecar_exiftool: (boolean, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. `exiftool -j`)
-- sidecar_xmp: (boolean, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name
-- use_photos_export: boolean; (default=False), if True will attempt to export photo via applescript interaction with Photos; useful for forcing download of missing photos.  This only works if the Photos library being used is the default library (last opened by Photos) as applescript will directly interact with whichever library Photos is currently using.
+- edited: bool; if True (default=False), will export the edited version of the photo (or raise exception if no edited version)
+- export_as_hardlink: bool; if True (default=False), will hardlink files instead of copying them
+- overwrite: bool; if True (default=False), will overwrite files if they alreay exist
+- live_photo: bool; if True (default=False), will also export the associted .mov for live photos; exported live photo will be named filename.mov
+- increment: bool; if True (default=True), will increment file name until a non-existent name is found
+- sidecar_json: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name
+- sidecar_json: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will include tag group names (e.g. `exiftool -G -j`)
+- sidecar_exiftool: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. `exiftool -j`)
+- sidecar_xmp: (bool, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name
+- use_photos_export: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos
+- download_missing: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos if missing
+- use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export or download_missing
 - timeout: (int, default=120) timeout in seconds used with use_photos_export
-- exiftool: (boolean, default = False) if True, will use [exiftool](https://exiftool.org/) to write metadata directly to the exported photo; exiftool must be installed and in the system path
-- use_albums_as_keywords: (boolean, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar
-- use_persons_as_keywords: (boolean, default = False); if True, will use person names as keywords when exporting metadata with exiftool or sidecar
+- exiftool: (bool, default = False) if True, will use [exiftool](https://exiftool.org/) to write metadata directly to the exported photo; exiftool must be installed and in the system path
+- use_albums_as_keywords: (bool, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar
+- use_persons_as_keywords: (bool, default = False); if True, will use person names as keywords when exporting metadata with exiftool or sidecar
 
 Returns: list of paths to exported files. More than one file could be exported, for example if live_photo=True, both the original image and the associated .mov file will be exported
 
@@ -3622,7 +3627,7 @@ The following template field substitutions are availabe for use the templating s
 |{lf}|A line feed: '\n', alias for {newline}|
 |{cr}|A carriage return: '\r'|
 |{crlf}|a carriage return + line feed: '\r\n'|
-|{osxphotos_version}|The osxphotos version, e.g. '0.44.4'|
+|{osxphotos_version}|The osxphotos version, e.g. '0.45.0'|
 |{osxphotos_cmd_line}|The full command line used to run osxphotos|
 |{album}|Album(s) photo is contained in|
 |{folder_album}|Folder path + album photo is contained in. e.g. 'Folder/Subfolder/Album' or just 'Album' if no enclosing folder|
@@ -3850,6 +3855,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://alandefreitas.github.io/alandefreitas/"><img src="https://avatars.githubusercontent.com/u/5369819?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Alan de Freitas</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/issues?q=author%3Aalandefreitas" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://hyfen.net"><img src="https://avatars.githubusercontent.com/u/6291?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Andrew Louis</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/commits?author=hyfen" title="Documentation">📖</a> <a href="https://github.com/RhetTbull/osxphotos/commits?author=hyfen" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/neebah"><img src="https://avatars.githubusercontent.com/u/71442026?v=4?s=75" width="75px;" alt=""/><br /><sub><b>neebah</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/issues?q=author%3Aneebah" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/ahti123"><img src="https://avatars.githubusercontent.com/u/22232632?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Ahti Liin</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/commits?author=ahti123" title="Code">💻</a> <a href="https://github.com/RhetTbull/osxphotos/issues?q=author%3Aahti123" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/xwu64"><img src="https://avatars.githubusercontent.com/u/10580396?v=4?s=75" width="75px;" alt=""/><br /><sub><b>Xiaoliang Wu</b></sub></a><br /><a href="https://github.com/RhetTbull/osxphotos/commits?author=xwu64" title="Code">💻</a></td>
   </tr>
 </table>
 

docs/.buildinfo

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

docs/_static/documentation_options.js

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

docs/cli.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>osxphotos command line interface (CLI) &#8212; osxphotos 0.44.4 documentation</title>
+    <title>osxphotos command line interface (CLI) &#8212; osxphotos 0.45.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

docs/genindex.html

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

docs/index.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>Welcome to osxphotos’s documentation! &#8212; osxphotos 0.44.4 documentation</title>
+    <title>Welcome to osxphotos’s documentation! &#8212; osxphotos 0.45.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

docs/modules.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>osxphotos &#8212; osxphotos 0.44.4 documentation</title>
+    <title>osxphotos &#8212; osxphotos 0.45.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

docs/reference.html

@@ -6,7 +6,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
 
-    <title>osxphotos package &#8212; osxphotos 0.44.4 documentation</title>
+    <title>osxphotos package &#8212; osxphotos 0.45.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>

docs/search.html

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

osxphotos/__init__.py

@@ -1,13 +1,45 @@
 from ._constants import AlbumSortOrder
 from ._version import __version__
 from .exiftool import ExifTool
-from .photoexporter import ExportResults, PhotoExporter
+from .export_db import ExportDB, ExportDBInMemory, ExportDBNoOp
+from .fileutil import FileUtil, FileUtilNoOp
+from .momentinfo import MomentInfo
+from .personinfo import PersonInfo
+from .photoexporter import ExportOptions, ExportResults, PhotoExporter
 from .photoinfo import PhotoInfo
 from .photosdb import PhotosDB
 from .photosdb._photosdb_process_comments import CommentInfo, LikeInfo
 from .phototemplate import PhotoTemplate
+from .placeinfo import PlaceInfo
 from .queryoptions import QueryOptions
+from .scoreinfo import ScoreInfo
+from .searchinfo import SearchInfo
 from .utils import _debug, _get_logger, _set_debug
 
-# TODO: Add test for imageTimeZoneOffsetSeconds = None
-# TODO: Add special albums and magic albums
+__all__ = [
+    "__version__",
+    "_debug",
+    "_get_logger",
+    "_set_debug",
+    "AlbumSortOrder",
+    "CommentInfo",
+    "ExifTool",
+    "ExportDB",
+    "ExportDBInMemory",
+    "ExportDBNoOp",
+    "ExportOptions",
+    "ExportResults",
+    "FileUtil",
+    "FileUtilNoOp",
+    "LikeInfo",
+    "MomentInfo",
+    "PersonInfo",
+    "PhotoExporter",
+    "PhotoInfo",
+    "PhotosDB",
+    "PhotoTemplate",
+    "PlaceInfo",
+    "QueryOptions",
+    "ScoreInfo",
+    "SearchInfo",
+]

osxphotos/_constants.py

@@ -20,8 +20,8 @@ UNICODE_FORMAT = "NFC"
 # Photos 3.0 (10.13.6) == 3301
 # Photos 4.0 (10.14.5) == 4016
 # Photos 4.0 (10.14.6) == 4025
-# Photos 5.0 (10.15.0) == 6000
-_TESTED_DB_VERSIONS = ["6000", "4025", "4016", "3301", "2622"]
+# Photos 5.0 (10.15.0) == 6000 or 5001
+_TESTED_DB_VERSIONS = ["6000", "5001", "4025", "4016", "3301", "2622"]
 
 # database model versions (applies to Photos 5, Photos 6)
 # these come from PLModelVersion key in binary plist in Z_METADATA.Z_PLIST
@@ -37,12 +37,15 @@ _PHOTOS_3_VERSION = "3301"
 
 # versions 5.0 and later have a different database structure
 _PHOTOS_4_VERSION = "4025"  # latest Mojove version on 10.14.6
-_PHOTOS_5_VERSION = "6000"  # seems to be current on 10.15.1 through 10.15.7 (also Big Sur and Monterey which switch to model version)
+_PHOTOS_5_VERSION = "5000"  # I've seen both 5001 and 6000.  6000 is most common on Catalina and up but there are some version 5001 database in the wild
 
 # Ranges for model version by Photos version
 _PHOTOS_5_MODEL_VERSION = [13000, 13999]
 _PHOTOS_6_MODEL_VERSION = [14000, 14999]
-_PHOTOS_7_MODEL_VERSION = [15000, 15999]  # Monterey developer preview is 15134
+_PHOTOS_7_MODEL_VERSION = [
+    15000,
+    15999,
+]  # Monterey developer preview is 15134, 12.1 is 15331
 
 # some table names differ between Photos 5 and Photos 6
 _DB_TABLE_NAMES = {
@@ -98,6 +101,8 @@ _TESTED_OS_VERSIONS = [
     ("11", "4"),
     ("11", "5"),
     ("11", "6"),
+    ("12", "0"),
+    ("12", "1"),
 ]
 
 # Photos 5 has persons who are empty string if unidentified face
@@ -258,6 +263,7 @@ EXTENDED_ATTRIBUTE_NAMES_QUOTED = [f"'{x}'" for x in EXTENDED_ATTRIBUTE_NAMES]
 OSXPHOTOS_EXPORT_DB = ".osxphotos_export.db"
 
 # bit flags for burst images ("burstPickType")
+BURST_PICK_TYPE_NONE = 0b0  # 0: sometimes used for single images with a burst UUID
 BURST_NOT_SELECTED = 0b10  # 2: burst image is not selected
 BURST_DEFAULT_PICK = 0b100  # 4: burst image is the one Photos picked to be key image before any selections made
 BURST_SELECTED = 0b1000  # 8: burst image is selected
@@ -299,3 +305,21 @@ class AlbumSortOrder(Enum):
 
 
 TEXT_DETECTION_CONFIDENCE_THRESHOLD = 0.75
+
+# stat sort order for cProfile: https://docs.python.org/3/library/profile.html#pstats.Stats.sort_stats
+PROFILE_SORT_KEYS = [
+    "calls",
+    "cumulative",
+    "cumtime",
+    "file",
+    "filename",
+    "module",
+    "ncalls",
+    "pcalls",
+    "line",
+    "name",
+    "nfl",
+    "stdname",
+    "time",
+    "tottime",
+]

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.44.4"
+__version__ = "0.45.0"

osxphotos/adjustmentsinfo.py

@@ -16,6 +16,8 @@ import zlib
 
 from .datetime_utils import datetime_naive_to_utc
 
+__all__ = ["AdjustmentsDecodeError", "AdjustmentsInfo"]
+
 
 class AdjustmentsDecodeError(Exception):
     """Could not decode adjustments plist file"""
@@ -73,37 +75,37 @@ class AdjustmentsInfo:
 
     @property
     def plist(self):
-        """The actual adjustments plist content as a dict """
+        """The actual adjustments plist content as a dict"""
         return self._plist
 
     @property
     def data(self):
-        """The raw adjustments data as a binary blob """
+        """The raw adjustments data as a binary blob"""
         return self._data
 
     @property
     def editor(self):
-        """The editor bundle ID for app/plug-in which made the adjustments """
+        """The editor bundle ID for app/plug-in which made the adjustments"""
         return self._editor_bundle_id
 
     @property
     def format_id(self):
-        """The value of the adjustmentFormatIdentifier field in the plist """
+        """The value of the adjustmentFormatIdentifier field in the plist"""
         return self._format_identifier
 
     @property
     def base_version(self):
-        """Value of adjustmentBaseVersion field """
+        """Value of adjustmentBaseVersion field"""
         return self._base_version
 
     @property
     def format_version(self):
-        """The value of the adjustmentFormatVersion in the plist """
+        """The value of the adjustmentFormatVersion in the plist"""
         return self._format_version
 
     @property
     def timestamp(self):
-        """The time stamp of the adjustment as timezone aware datetime.datetime object or None if no timestamp """
+        """The time stamp of the adjustment as timezone aware datetime.datetime object or None if no timestamp"""
         return self._timestamp
 
     @property

osxphotos/albuminfo.py

@@ -24,6 +24,15 @@ from ._constants import (
 from .datetime_utils import get_local_tz
 from .query_builder import get_query
 
+__all__ = [
+    "sort_list_by_keys",
+    "AlbumInfoBaseClass",
+    "AlbumInfo",
+    "ImportInfo",
+    "ProjectInfo",
+    "FolderInfo",
+]
+
 
 def sort_list_by_keys(values, sort_keys):
     """Sorts list values by a second list sort_keys

osxphotos/cli_help.py

@@ -22,6 +22,17 @@ from .phototemplate import (
     get_template_help,
 )
 
+__all__ = [
+    "ExportCommand",
+    "template_help",
+    "tutorial_help",
+    "rich_text",
+    "strip_md_header_and_links",
+    "strip_md_links",
+    "strip_html_comments",
+    "get_tutorial_text",
+]
+
 
 # TODO: The following help text could probably be done as mako template
 class ExportCommand(click.Command):

osxphotos/configoptions.py

@@ -1,9 +1,16 @@
 """ ConfigOptions class to load/save config settings for osxphotos CLI """
 import toml
 
+__all__ = [
+    "ConfigOptionsException",
+    "ConfigOptionsInvalidError",
+    "ConfigOptionsLoadError",
+    "ConfigOptions",
+]
+
 
 class ConfigOptionsException(Exception):
-    """ Invalid combination of options. """
+    """Invalid combination of options."""
 
     def __init__(self, message):
         self.message = message
@@ -19,10 +26,10 @@ class ConfigOptionsLoadError(ConfigOptionsException):
 
 
 class ConfigOptions:
-    """ data class to store and load options for osxphotos commands """
+    """data class to store and load options for osxphotos commands"""
 
     def __init__(self, name, attrs, ignore=None):
-        """ init ConfigOptions class
+        """init ConfigOptions class
 
         Args:
             name: name for these options, will be used for section heading in TOML file when saving/loading from file
@@ -53,21 +60,21 @@ class ConfigOptions:
                 raise KeyError(f"Missing argument: {attr}")
 
     def validate(self, exclusive=None, inclusive=None, dependent=None, cli=False):
-        """ validate combinations of otions
-        
+        """validate combinations of otions
+
         Args:
-            exclusive: list of tuples in form [("option_1", "option_2")...] which are exclusive; 
-                       ie. either option_1 can be set or option_2 but not both; 
-            inclusive: list of tuples in form [("option_1", "option_2")...] which are inclusive; 
+            exclusive: list of tuples in form [("option_1", "option_2")...] which are exclusive;
+                       ie. either option_1 can be set or option_2 but not both;
+            inclusive: list of tuples in form [("option_1", "option_2")...] which are inclusive;
                        ie. if either option_1 or option_2 is set, the other must be set
-            dependent: list of tuples in form [("option_1", ("option_2", "option_3"))...] 
+            dependent: list of tuples in form [("option_1", ("option_2", "option_3"))...]
                        where if option_1 is set, then at least one of the options in the second tuple must also be set
-            cli: bool, set to True if called to validate CLI options; 
+            cli: bool, set to True if called to validate CLI options;
                        will prepend '--' to option names in InvalidOptions.message and change _ to - in option names
-        
+
         Returns:
             True if all options valid
-            
+
         Raises:
             InvalidOption if any combination of options is invalid
             InvalidOption.message will be descriptive message of invalid options
@@ -121,7 +128,7 @@ class ConfigOptions:
         return True
 
     def write_to_file(self, filename):
-        """ Write self to TOML file
+        """Write self to TOML file
 
         Args:
             filename: full path to TOML file to write; filename will be overwritten if it exists
@@ -141,7 +148,7 @@ class ConfigOptions:
             toml.dump({self._name: data}, fd)
 
     def load_from_file(self, filename, override=False):
-        """ Load options from a TOML file.
+        """Load options from a TOML file.
 
         Args:
             filename: full path to TOML file

osxphotos/datetime_formatter.py

@@ -2,69 +2,71 @@
 
 import datetime
 
+__all__ = ["DateTimeFormatter"]
+
 
 class DateTimeFormatter:
-    """ provides property access to formatted datetime.datetime strftime values """
+    """provides property access to formatted datetime.datetime strftime values"""
 
     def __init__(self, dt: datetime.datetime):
         self.dt = dt
 
     @property
     def date(self):
-        """ ISO date in form 2020-03-22 """
+        """ISO date in form 2020-03-22"""
         return self.dt.date().isoformat()
 
     @property
     def year(self):
-        """ 4 digit year """
+        """4 digit year"""
         return f"{self.dt.year}"
 
     @property
     def yy(self):
-        """ 2 digit year """
+        """2 digit year"""
         return f"{self.dt.strftime('%y')}"
 
     @property
     def mm(self):
-        """ 2 digit month """
+        """2 digit month"""
         return f"{self.dt.strftime('%m')}"
 
     @property
     def month(self):
-        """ Month as locale's full name """
+        """Month as locale's full name"""
         return f"{self.dt.strftime('%B')}"
 
     @property
     def mon(self):
-        """ Month as locale's abbreviated name """
+        """Month as locale's abbreviated name"""
         return f"{self.dt.strftime('%b')}"
 
     @property
     def dd(self):
-        """ 2-digit day of the month """
+        """2-digit day of the month"""
         return f"{self.dt.strftime('%d')}"
 
     @property
     def dow(self):
-        """ Day of week as locale's name """
+        """Day of week as locale's name"""
         return f"{self.dt.strftime('%A')}"
 
     @property
     def doy(self):
-        """ Julian day of year starting from 001 """
+        """Julian day of year starting from 001"""
         return f"{self.dt.strftime('%j')}"
 
     @property
     def hour(self):
-        """ 2-digit hour """
+        """2-digit hour"""
         return f"{self.dt.strftime('%H')}"
 
     @property
     def min(self):
-        """ 2-digit minute """
+        """2-digit minute"""
         return f"{self.dt.strftime('%M')}"
 
     @property
     def sec(self):
-        """ 2-digit second """
+        """2-digit second"""
         return f"{self.dt.strftime('%S')}"

osxphotos/datetime_utils.py

@@ -2,13 +2,23 @@
 
 import datetime
 
+__all__ = [
+    "get_local_tz",
+    "datetime_has_tz",
+    "datetime_tz_to_utc",
+    "datetime_remove_tz",
+    "datetime_naive_to_utc",
+    "datetime_naive_to_local",
+    "datetime_utc_to_local",
+]
+
 
 def get_local_tz(dt):
-    """ Return local timezone as datetime.timezone tzinfo for dt
-    
+    """Return local timezone as datetime.timezone tzinfo for dt
+
     Args:
         dt: datetime.datetime
-    
+
     Returns:
         local timezone for dt as datetime.timezone
 
@@ -22,14 +32,14 @@ def get_local_tz(dt):
 
 
 def datetime_has_tz(dt):
-    """ Return True if datetime dt has tzinfo else False
+    """Return True if datetime dt has tzinfo else False
 
     Args:
         dt: datetime.datetime
-    
+
     Returns:
         True if dt is timezone aware, else False
-        
+
     Raises:
         TypeError if dt is not a datetime.datetime object
     """
@@ -41,15 +51,15 @@ def datetime_has_tz(dt):
 
 
 def datetime_tz_to_utc(dt):
-    """ Convert datetime.datetime object with timezone to UTC timezone 
+    """Convert datetime.datetime object with timezone to UTC timezone
 
     Args:
         dt: datetime.datetime object
 
     Returns:
         datetime.datetime in UTC timezone
-        
-    Raises: 
+
+    Raises:
         TypeError if dt is not datetime.datetime object
         ValueError if dt does not have timeone information
     """
@@ -64,14 +74,14 @@ def datetime_tz_to_utc(dt):
 
 
 def datetime_remove_tz(dt):
-    """ Remove timezone from a datetime.datetime object
+    """Remove timezone from a datetime.datetime object
 
     Args:
         dt: datetime.datetime object with tzinfo
-    
+
     Returns:
-        dt without any timezone info (naive datetime object) 
-        
+        dt without any timezone info (naive datetime object)
+
     Raises:
         TypeError if dt is not a datetime.datetime object
     """
@@ -83,15 +93,15 @@ def datetime_remove_tz(dt):
 
 
 def datetime_naive_to_utc(dt):
-    """ Convert naive (timezone unaware) datetime.datetime
+    """Convert naive (timezone unaware) datetime.datetime
         to aware timezone in UTC timezone
 
     Args:
         dt: datetime.datetime without timezone
-    
+
     Returns:
         datetime.datetime with UTC timezone
-        
+
     Raises:
         TypeError if dt is not a datetime.datetime object
         ValueError if dt is not a naive/timezone unaware object
@@ -111,15 +121,15 @@ def datetime_naive_to_utc(dt):
 
 
 def datetime_naive_to_local(dt):
-    """ Convert naive (timezone unaware) datetime.datetime
+    """Convert naive (timezone unaware) datetime.datetime
         to aware timezone in local timezone
 
     Args:
         dt: datetime.datetime without timezone
-    
+
     Returns:
         datetime.datetime with local timezone
-        
+
     Raises:
         TypeError if dt is not a datetime.datetime object
         ValueError if dt is not a naive/timezone unaware object
@@ -139,7 +149,7 @@ def datetime_naive_to_local(dt):
 
 
 def datetime_utc_to_local(dt):
-    """ Convert datetime.datetime object in UTC timezone to local timezone 
+    """Convert datetime.datetime object in UTC timezone to local timezone
 
     Args:
         dt: datetime.datetime object

osxphotos/exifinfo.py

@@ -2,6 +2,8 @@
 
 from dataclasses import dataclass
 
+__all__ = ["ExifInfo"]
+
 
 @dataclass(frozen=True)
 class ExifInfo:

osxphotos/exiftool.py

@@ -17,6 +17,15 @@ import subprocess
 from abc import ABC, abstractmethod
 from functools import lru_cache  # pylint: disable=syntax-error
 
+__all__ = [
+    "escape_str",
+    "unescape_str",
+    "terminate_exiftool",
+    "get_exiftool_path",
+    "ExifTool",
+    "ExifToolCaching",
+]
+
 # exiftool -stay_open commands outputs this EOF marker after command is run
 EXIFTOOL_STAYOPEN_EOF = "{ready}"
 EXIFTOOL_STAYOPEN_EOF_LEN = len(EXIFTOOL_STAYOPEN_EOF)

osxphotos/export_db.py

@@ -14,7 +14,9 @@ from sqlite3 import Error
 from ._constants import OSXPHOTOS_EXPORT_DB
 from ._version import __version__
 
-OSXPHOTOS_EXPORTDB_VERSION = "4.0"
+__all__ = ["ExportDB_ABC", "ExportDBNoOp", "ExportDB", "ExportDBInMemory"]
+
+OSXPHOTOS_EXPORTDB_VERSION = "4.2"
 OSXPHOTOS_ABOUT_STRING = f"Created by osxphotos version {__version__} (https://github.com/RhetTbull/osxphotos) on {datetime.datetime.now()}"
 
 
@@ -102,12 +104,12 @@ class ExportDB_ABC(ABC):
         self,
         filename,
         uuid,
-        orig_stat,
-        exif_stat,
-        converted_stat,
-        edited_stat,
-        info_json,
-        exif_json,
+        orig_stat=None,
+        exif_stat=None,
+        converted_stat=None,
+        edited_stat=None,
+        info_json=None,
+        exif_json=None,
     ):
         pass
 
@@ -181,12 +183,12 @@ class ExportDBNoOp(ExportDB_ABC):
         self,
         filename,
         uuid,
-        orig_stat,
-        exif_stat,
-        converted_stat,
-        edited_stat,
-        info_json,
-        exif_json,
+        orig_stat=None,
+        exif_stat=None,
+        converted_stat=None,
+        edited_stat=None,
+        info_json=None,
+        exif_json=None,
     ):
         pass
 
@@ -504,52 +506,65 @@ class ExportDB(ExportDB_ABC):
         self,
         filename,
         uuid,
-        orig_stat,
-        exif_stat,
-        converted_stat,
-        edited_stat,
-        info_json,
-        exif_json,
+        orig_stat=None,
+        exif_stat=None,
+        converted_stat=None,
+        edited_stat=None,
+        info_json=None,
+        exif_json=None,
     ):
-        """sets all the data for file and uuid at once"""
+        """sets all the data for file and uuid at once; if any value is None, does not set it"""
         filename = str(pathlib.Path(filename).relative_to(self._path))
         filename_normalized = filename.lower()
         conn = self._conn
         try:
             c = conn.cursor()
+            # update files table (if needed);
+            # this statement works around fact that there was no unique constraint on files.filepath_normalized
             c.execute(
-                "INSERT OR REPLACE INTO files(filepath, filepath_normalized, uuid) VALUES (?, ?, ?);",
+                """INSERT OR IGNORE INTO files(filepath, filepath_normalized, uuid) VALUES (?, ?, ?);""",
                 (filename, filename_normalized, uuid),
             )
 
-            c.execute(
-                "UPDATE files "
-                + "SET orig_mode = ?, orig_size = ?, orig_mtime = ? "
-                + "WHERE filepath_normalized = ?;",
-                (*orig_stat, filename_normalized),
-            )
-            c.execute(
-                "UPDATE files "
-                + "SET exif_mode = ?, exif_size = ?, exif_mtime = ? "
-                + "WHERE filepath_normalized = ?;",
-                (*exif_stat, filename_normalized),
-            )
-            c.execute(
-                "INSERT OR REPLACE INTO converted(filepath_normalized, mode, size, mtime) VALUES (?, ?, ?, ?);",
-                (filename_normalized, *converted_stat),
-            )
-            c.execute(
-                "INSERT OR REPLACE INTO edited(filepath_normalized, mode, size, mtime) VALUES (?, ?, ?, ?);",
-                (filename_normalized, *edited_stat),
-            )
-            c.execute(
-                "INSERT OR REPLACE INTO info(uuid, json_info) VALUES (?, ?);",
-                (uuid, info_json),
-            )
-            c.execute(
-                "INSERT OR REPLACE INTO exifdata(filepath_normalized, json_exifdata) VALUES (?, ?);",
-                (filename_normalized, exif_json),
-            )
+            if orig_stat is not None:
+                c.execute(
+                    "UPDATE files "
+                    + "SET orig_mode = ?, orig_size = ?, orig_mtime = ? "
+                    + "WHERE filepath_normalized = ?;",
+                    (*orig_stat, filename_normalized),
+                )
+
+            if exif_stat is not None:
+                c.execute(
+                    "UPDATE files "
+                    + "SET exif_mode = ?, exif_size = ?, exif_mtime = ? "
+                    + "WHERE filepath_normalized = ?;",
+                    (*exif_stat, filename_normalized),
+                )
+
+            if converted_stat is not None:
+                c.execute(
+                    "INSERT OR REPLACE INTO converted(filepath_normalized, mode, size, mtime) VALUES (?, ?, ?, ?);",
+                    (filename_normalized, *converted_stat),
+                )
+
+            if edited_stat is not None:
+                c.execute(
+                    "INSERT OR REPLACE INTO edited(filepath_normalized, mode, size, mtime) VALUES (?, ?, ?, ?);",
+                    (filename_normalized, *edited_stat),
+                )
+
+            if info_json is not None:
+                c.execute(
+                    "INSERT OR REPLACE INTO info(uuid, json_info) VALUES (?, ?);",
+                    (uuid, info_json),
+                )
+
+            if exif_json is not None:
+                c.execute(
+                    "INSERT OR REPLACE INTO exifdata(filepath_normalized, json_exifdata) VALUES (?, ?);",
+                    (filename_normalized, exif_json),
+                )
             conn.commit()
         except Error as e:
             logging.warning(e)
@@ -660,6 +675,22 @@ class ExportDB(ExportDB_ABC):
                               exif_size INTEGER,
                               exif_mtime REAL
                               ); """,
+            "sql_files_table_migrate": """ CREATE TABLE IF NOT EXISTS files_migrate (
+                              id INTEGER PRIMARY KEY,
+                              filepath TEXT NOT NULL,
+                              filepath_normalized TEXT NOT NULL,
+                              uuid TEXT,
+                              orig_mode INTEGER,
+                              orig_size INTEGER,
+                              orig_mtime REAL,
+                              exif_mode INTEGER,
+                              exif_size INTEGER,
+                              exif_mtime REAL,
+                              UNIQUE(filepath_normalized)
+                              ); """,
+            "sql_files_migrate": """ INSERT INTO files_migrate SELECT * FROM files;""",
+            "sql_files_drop_tables": """ DROP TABLE files;""",
+            "sql_files_alter": """ ALTER TABLE files_migrate RENAME TO files;""",
             "sql_runs_table": """ CREATE TABLE IF NOT EXISTS runs (
                              id INTEGER PRIMARY KEY,
                              datetime TEXT,

osxphotos/fileutil.py

@@ -11,9 +11,11 @@ import Foundation
 
 from .imageconverter import ImageConverter
 
+__all__ = ["FileUtilABC", "FileUtilMacOS", "FileUtil", "FileUtilNoOp"]
+
 
 class FileUtilABC(ABC):
-    """ Abstract base class for FileUtil """
+    """Abstract base class for FileUtil"""
 
     @classmethod
     @abstractmethod
@@ -67,14 +69,14 @@ class FileUtilABC(ABC):
 
 
 class FileUtilMacOS(FileUtilABC):
-    """ Various file utilities """
+    """Various file utilities"""
 
     @classmethod
     def hardlink(cls, src, dest):
-        """ Hardlinks a file from src path to dest path 
-            src: source path as string 
-            dest: destination path as string
-            Raises exception if linking fails or either path is None """
+        """Hardlinks a file from src path to dest path
+        src: source path as string
+        dest: destination path as string
+        Raises exception if linking fails or either path is None"""
 
         if src is None or dest is None:
             raise ValueError("src and dest must not be None", src, dest)
@@ -90,17 +92,17 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def copy(cls, src, dest):
-        """ Copies a file from src path to dest path 
-        
+        """Copies a file from src path to dest path
+
         Args:
             src: source path as string; must be a valid file path
             dest: destination path as string
                   dest may be either directory or file; in either case, src file must not exist in dest
             Note: src and dest may be either a string or a pathlib.Path object
-        
+
         Returns:
             True if copy succeeded
-        
+
         Raises:
             OSError if copy fails
             TypeError if either path is None
@@ -124,7 +126,7 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def unlink(cls, filepath):
-        """ unlink filepath; if it's pathlib.Path, use Path.unlink, otherwise use os.unlink """
+        """unlink filepath; if it's pathlib.Path, use Path.unlink, otherwise use os.unlink"""
         if isinstance(filepath, pathlib.Path):
             filepath.unlink()
         else:
@@ -132,7 +134,7 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def rmdir(cls, dirpath):
-        """ remove directory filepath; dirpath must be empty """
+        """remove directory filepath; dirpath must be empty"""
         if isinstance(dirpath, pathlib.Path):
             dirpath.rmdir()
         else:
@@ -140,7 +142,7 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def utime(cls, path, times):
-        """ Set the access and modified time of path. """
+        """Set the access and modified time of path."""
         os.utime(path, times)
 
     @classmethod
@@ -152,7 +154,7 @@ class FileUtilMacOS(FileUtilABC):
         mtime1 -- optional, pass alternate file modification timestamp for f1; will be converted to int
 
         Return value:
-        True if the file signatures as returned by stat are the same, False otherwise. 
+        True if the file signatures as returned by stat are the same, False otherwise.
         Does not do a byte-by-byte comparison.
         """
 
@@ -179,27 +181,26 @@ class FileUtilMacOS(FileUtilABC):
             return False
 
         s1 = cls._sig(os.stat(f1))
-
         if s1[0] != stat.S_IFREG or s2[0] != stat.S_IFREG:
             return False
         return s1 == s2
 
     @classmethod
     def file_sig(cls, f1):
-        """ return os.stat signature for file f1 """
+        """return os.stat signature for file f1"""
         return cls._sig(os.stat(f1))
 
     @classmethod
     def convert_to_jpeg(cls, src_file, dest_file, compression_quality=1.0):
-        """ converts image file src_file to jpeg format as dest_file
+        """converts image file src_file to jpeg format as dest_file
 
-            Args:
-                src_file: image file to convert
-                dest_file: destination path to write converted file to
-                compression quality: JPEG compression quality in range 0.0 <= compression_quality <= 1.0; default 1.0 (best quality)
-                
-            Returns:
-                True if success, otherwise False 
+        Args:
+            src_file: image file to convert
+            dest_file: destination path to write converted file to
+            compression quality: JPEG compression quality in range 0.0 <= compression_quality <= 1.0; default 1.0 (best quality)
+
+        Returns:
+            True if success, otherwise False
         """
         converter = ImageConverter()
         return converter.write_jpeg(
@@ -208,40 +209,40 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def rename(cls, src, dest):
-        """ Copy src to dest 
+        """Copy src to dest
 
         Args:
             src: path to source file
             dest: path to destination file
-        
+
         Returns:
             Name of renamed file (dest)
-        
+
         """
         os.rename(str(src), str(dest))
         return dest
 
     @staticmethod
     def _sig(st):
-        """ return tuple of (mode, size, mtime) of file based on os.stat
-            Args:
-                st: os.stat signature
+        """return tuple of (mode, size, mtime) of file based on os.stat
+        Args:
+            st: os.stat signature
         """
         # use int(st.st_mtime) because ditto does not copy fractional portion of mtime
         return (stat.S_IFMT(st.st_mode), st.st_size, int(st.st_mtime))
 
 
 class FileUtil(FileUtilMacOS):
-    """ Various file utilities """
+    """Various file utilities"""
 
     pass
 
 
 class FileUtilNoOp(FileUtil):
-    """ No-Op implementation of FileUtil for testing / dry-run mode
-        all methods with exception of cmp, cmp_file_sig and file_cmp are no-op
-        cmp and cmp_file_sig functions as FileUtil methods do
-        file_cmp returns mock data
+    """No-Op implementation of FileUtil for testing / dry-run mode
+    all methods with exception of cmp, cmp_file_sig and file_cmp are no-op
+    cmp and cmp_file_sig functions as FileUtil methods do
+    file_cmp returns mock data
     """
 
     @staticmethod

osxphotos/imageconverter.py

@@ -15,6 +15,8 @@ from Foundation import NSDictionary
 # needed to capture system-level stderr
 from wurlitzer import pipes
 
+__all__ = ["ImageConversionError", "ImageConverter"]
+
 
 class ImageConversionError(Exception):
     """Base class for exceptions in this module."""

osxphotos/momentinfo.py

@@ -1,3 +1,4 @@
+__all__ = ["MomentInfo"]
 """MomentInfo class with details about photo moments."""
 
 

osxphotos/path_utils.py

@@ -4,6 +4,14 @@ import pathvalidate
 
 from ._constants import MAX_DIRNAME_LEN, MAX_FILENAME_LEN
 
+__all__ = [
+    "sanitize_filepath",
+    "is_valid_filepath",
+    "sanitize_filename",
+    "sanitize_dirname",
+    "sanitize_pathpart",
+]
+
 
 def sanitize_filepath(filepath):
     """sanitize a filepath"""

osxphotos/personinfo.py

@@ -6,6 +6,8 @@ import math
 
 from collections import namedtuple
 
+__all__ = ["PersonInfo", "FaceInfo", "rotate_image_point"]
+
 MWG_RS_Area = namedtuple("MWG_RS_Area", ["x", "y", "h", "w"])
 MPRI_Reg_Rect = namedtuple("MPRI_Reg_Rect", ["x", "y", "h", "w"])
 
@@ -51,7 +53,7 @@ class PersonInfo:
 
     @property
     def photos(self):
-        """ Returns list of PhotoInfo objects associated with this person """
+        """Returns list of PhotoInfo objects associated with this person"""
         return self._db.photos_by_uuid(self._db._dbfaces_pk[self._pk])
 
     @property
@@ -71,7 +73,7 @@ class PersonInfo:
             return []
 
     def asdict(self):
-        """ Returns dictionary representation of class instance """
+        """Returns dictionary representation of class instance"""
         keyphoto = self.keyphoto.uuid if self.keyphoto is not None else None
         return {
             "uuid": self.uuid,
@@ -83,7 +85,7 @@ class PersonInfo:
         }
 
     def json(self):
-        """ Returns JSON representation of class instance """
+        """Returns JSON representation of class instance"""
         return json.dumps(self.asdict())
 
     def __str__(self):
@@ -201,7 +203,7 @@ class FaceInfo:
 
     @property
     def person_info(self):
-        """ PersonInfo instance for person associated with this face """
+        """PersonInfo instance for person associated with this face"""
         try:
             return self._person
         except AttributeError:
@@ -210,7 +212,7 @@ class FaceInfo:
 
     @property
     def photo(self):
-        """ PhotoInfo instance associated with this face """
+        """PhotoInfo instance associated with this face"""
         try:
             return self._photo
         except AttributeError:
@@ -292,7 +294,7 @@ class FaceInfo:
         return [(x0, y0), (x1, y1)]
 
     def roll_pitch_yaw(self):
-        """ Roll, pitch, yaw of face in radians as tuple """
+        """Roll, pitch, yaw of face in radians as tuple"""
         info = self._info
         roll = 0 if info["roll"] is None else info["roll"]
         pitch = 0 if info["pitch"] is None else info["pitch"]
@@ -302,19 +304,19 @@ class FaceInfo:
 
     @property
     def roll(self):
-        """ Return roll angle in radians of the face region """
+        """Return roll angle in radians of the face region"""
         roll, _, _ = self.roll_pitch_yaw()
         return roll
 
     @property
     def pitch(self):
-        """ Return pitch angle in radians of the face region """
+        """Return pitch angle in radians of the face region"""
         _, pitch, _ = self.roll_pitch_yaw()
         return pitch
 
     @property
     def yaw(self):
-        """ Return yaw angle in radians of the face region """
+        """Return yaw angle in radians of the face region"""
         _, _, yaw = self.roll_pitch_yaw()
         return yaw
 
@@ -402,7 +404,7 @@ class FaceInfo:
         return (int(xr), int(yr))
 
     def asdict(self):
-        """ Returns dict representation of class instance """
+        """Returns dict representation of class instance"""
         roll, pitch, yaw = self.roll_pitch_yaw()
         return {
             "_pk": self._pk,
@@ -451,7 +453,7 @@ class FaceInfo:
         }
 
     def json(self):
-        """ Return JSON representation of FaceInfo instance """
+        """Return JSON representation of FaceInfo instance"""
         return json.dumps(self.asdict())
 
     def __str__(self):

osxphotos/photoinfo.py

@@ -53,6 +53,8 @@ from .text_detection import detect_text
 from .uti import get_preferred_uti_extension, get_uti_for_extension
 from .utils import _debug, _get_resource_loc, findfiles
 
+__all__ = ["PhotoInfo", "PhotoInfoNone"]
+
 
 class PhotoInfo:
     """
@@ -725,8 +727,10 @@ class PhotoInfo:
                 self._uti_original = self.uti
             elif self._db._photos_ver >= 7:
                 # Monterey+
-                self._uti_original = get_uti_for_extension(
-                    pathlib.Path(self.original_filename).suffix
+                # there are some cases with UTI_original is None (photo imported with no extension) so fallback to UTI and hope it's right
+                self._uti_original = (
+                    get_uti_for_extension(pathlib.Path(self.original_filename).suffix)
+                    or self.uti
                 )
             else:
                 self._uti_original = self._info["UTI_original"]
@@ -1025,7 +1029,7 @@ class PhotoInfo:
     @property
     def israw(self):
         """returns True if photo is a raw image. For images with an associated RAW+JPEG pair, see has_raw"""
-        return "raw-image" in self.uti_original
+        return "raw-image" in self.uti_original if self.uti_original else False
 
     @property
     def raw_original(self):

osxphotos/photokit.py

@@ -36,6 +36,28 @@ from .fileutil import FileUtil
 from .uti import get_preferred_uti_extension
 from .utils import _get_os_version, increment_filename
 
+__all__ = [
+    "NSURL_to_path",
+    "path_to_NSURL",
+    "check_photokit_authorization",
+    "request_photokit_authorization",
+    "PhotoKitError",
+    "PhotoKitFetchFailed",
+    "PhotoKitAuthError",
+    "PhotoKitExportError",
+    "PhotoKitMediaTypeError",
+    "ImageData",
+    "AVAssetData",
+    "PHAssetResourceData",
+    "PhotoKitNotificationDelegate",
+    "PhotoAsset",
+    "SlowMoVideoExporter",
+    "VideoAsset",
+    "LivePhotoRequest",
+    "LivePhotoAsset",
+    "PhotoLibrary",
+]
+
 # NOTE: This requires user have granted access to the terminal (e.g. Terminal.app or iTerm)
 # to access Photos.  This should happen automatically the first time it's called. I've
 # not figured out how to get the call to requestAuthorization_ to actually work in the case
@@ -520,7 +542,8 @@ class PhotoAsset:
                                 == Photos.PHAssetResourceTypeAlternatePhoto
                             ):
                                 data = self._request_resource_data(resource)
-                                ext = pathlib.Path(self.raw_filename).suffix[1:]
+                                suffix = pathlib.Path(self.raw_filename).suffix
+                                ext = suffix[1:] if suffix else ""
                                 break
                         else:
                             raise PhotoKitExportError(

osxphotos/photosalbum.py

@@ -8,6 +8,8 @@ from more_itertools import chunked
 from .photoinfo import PhotoInfo
 from .utils import noop
 
+__all__ = ["PhotosAlbum"]
+
 
 class PhotosAlbum:
     def __init__(self, name: str, verbose: Optional[callable] = None):

osxphotos/photosdb/_photosdb_process_comments.py

@@ -10,9 +10,9 @@ from ..utils import _open_sql_file, normalize_unicode
 
 
 def _process_comments(self):
-    """ load the comments and likes data from the database 
-        this is a PhotosDB method that should be imported in 
-        the PhotosDB class definition in photosdb.py
+    """load the comments and likes data from the database
+    this is a PhotosDB method that should be imported in
+    the PhotosDB class definition in photosdb.py
     """
     self._db_hashed_person_id = {}
     self._db_comments_uuid = {}
@@ -24,7 +24,7 @@ def _process_comments(self):
 
 @dataclass
 class CommentInfo:
-    """ Class for shared photo comments """
+    """Class for shared photo comments"""
 
     datetime: datetime.datetime
     user: str
@@ -37,7 +37,7 @@ class CommentInfo:
 
 @dataclass
 class LikeInfo:
-    """ Class for shared photo likes """
+    """Class for shared photo likes"""
 
     datetime: datetime.datetime
     user: str
@@ -50,16 +50,16 @@ class LikeInfo:
 # The following methods do not get imported into PhotosDB
 # but will get called by _process_comments
 def _process_comments_4(photosdb):
-    """ process comments and likes info for Photos <= 4 
-        photosdb: PhotosDB instance """
+    """process comments and likes info for Photos <= 4
+    photosdb: PhotosDB instance"""
     raise NotImplementedError(
         f"Not implemented for database version {photosdb._db_version}."
     )
 
 
 def _process_comments_5(photosdb):
-    """ process comments and likes info for Photos >= 5 
-        photosdb: PhotosDB instance """
+    """process comments and likes info for Photos >= 5
+    photosdb: PhotosDB instance"""
 
     db = photosdb._tmp_db
 

osxphotos/photosdb/_photosdb_process_exif.py

@@ -7,10 +7,11 @@ from .._constants import _DB_TABLE_NAMES, _PHOTOS_4_VERSION
 from ..utils import _db_is_locked, _debug, _open_sql_file
 from .photosdb_utils import get_db_version
 
+
 def _process_exifinfo(self):
-    """ load the exif data from the database 
-        this is a PhotosDB method that should be imported in 
-        the PhotosDB class definition in photosdb.py
+    """load the exif data from the database
+    this is a PhotosDB method that should be imported in
+    the PhotosDB class definition in photosdb.py
     """
     if self._db_version <= _PHOTOS_4_VERSION:
         _process_exifinfo_4(self)
@@ -23,20 +24,20 @@ def _process_exifinfo(self):
 
 
 def _process_exifinfo_4(photosdb):
-    """ process exif info for Photos <= 4 
-        photosdb: PhotosDB instance """
+    """process exif info for Photos <= 4
+    photosdb: PhotosDB instance"""
     photosdb._db_exifinfo_uuid = {}
     raise NotImplementedError(f"search info not implemented for this database version")
 
 
 def _process_exifinfo_5(photosdb):
-    """ process exif info for Photos >= 5 
-        photosdb: PhotosDB instance """
+    """process exif info for Photos >= 5
+    photosdb: PhotosDB instance"""
 
     db = photosdb._tmp_db
 
     asset_table = _DB_TABLE_NAMES[photosdb._photos_ver]["ASSET"]
-        
+
     (conn, cursor) = _open_sql_file(db)
 
     result = conn.execute(

osxphotos/photosdb/_photosdb_process_faceinfo.py

@@ -22,8 +22,7 @@ from .photosdb_utils import get_db_version
 
 
 def _process_faceinfo(self):
-    """ Process face information
-    """
+    """Process face information"""
 
     self._db_faceinfo_pk = {}
     self._db_faceinfo_uuid = {}
@@ -36,7 +35,7 @@ def _process_faceinfo(self):
 
 
 def _process_faceinfo_4(photosdb):
-    """ Process face information for Photos 4 databases
+    """Process face information for Photos 4 databases
 
     Args:
         photosdb: an OSXPhotosDB instance
@@ -172,7 +171,7 @@ def _process_faceinfo_4(photosdb):
 
 
 def _process_faceinfo_5(photosdb):
-    """ Process face information for Photos 5 databases
+    """Process face information for Photos 5 databases
 
     Args:
         photosdb: an OSXPhotosDB instance

osxphotos/photosdb/_photosdb_process_scoreinfo.py

@@ -22,8 +22,8 @@ from .photosdb_utils import get_db_version
 
 
 def _process_scoreinfo(self):
-    """ Process computed photo scores
-        Note: Only works on Photos version == 5.0
+    """Process computed photo scores
+    Note: Only works on Photos version == 5.0
     """
 
     # _db_scoreinfo_uuid is dict in form {uuid: {score values}}
@@ -38,7 +38,7 @@ def _process_scoreinfo(self):
 
 
 def _process_scoreinfo_5(photosdb):
-    """ Process computed photo scores for Photos 5 databases
+    """Process computed photo scores for Photos 5 databases
 
     Args:
         photosdb: an OSXPhotosDB instance
@@ -147,4 +147,4 @@ def _process_scoreinfo_5(photosdb):
         scores["well_timed_shot"] = row[27]
         photosdb._db_scoreinfo_uuid[uuid] = scores
 
-    conn.close()
+    conn.close()

osxphotos/photosdb/_photosdb_process_searchinfo.py

@@ -35,10 +35,10 @@ from ..utils import _db_is_locked, _debug, _open_sql_file, normalize_unicode
 
 
 def _process_searchinfo(self):
-    """ load machine learning/search term label info from a Photos library
-        db_connection: a connection to the SQLite database file containing the 
-        search terms.  In Photos 5, this is called psi.sqlite
-        Note: Only works on Photos version == 5.0 """
+    """load machine learning/search term label info from a Photos library
+    db_connection: a connection to the SQLite database file containing the
+    search terms.  In Photos 5, this is called psi.sqlite
+    Note: Only works on Photos version == 5.0"""
 
     # _db_searchinfo_uuid is dict in form {uuid : [list of associated search info records]
     self._db_searchinfo_uuid = _db_searchinfo_uuid = {}
@@ -155,7 +155,7 @@ def _process_searchinfo(self):
 
 @property
 def labels(self):
-    """ return list of all search info labels found in the library """
+    """return list of all search info labels found in the library"""
     if self._db_version <= _PHOTOS_4_VERSION:
         logging.warning(f"SearchInfo not implemented for this library version")
         return []
@@ -165,7 +165,7 @@ def labels(self):
 
 @property
 def labels_normalized(self):
-    """ return list of all normalized search info labels found in the library """
+    """return list of all normalized search info labels found in the library"""
     if self._db_version <= _PHOTOS_4_VERSION:
         logging.warning(f"SearchInfo not implemented for this library version")
         return []
@@ -175,7 +175,7 @@ def labels_normalized(self):
 
 @property
 def labels_as_dict(self):
-    """ return labels as dict of label: count in reverse sorted order (descending) """
+    """return labels as dict of label: count in reverse sorted order (descending)"""
     if self._db_version <= _PHOTOS_4_VERSION:
         logging.warning(f"SearchInfo not implemented for this library version")
         return dict()
@@ -187,7 +187,7 @@ def labels_as_dict(self):
 
 @property
 def labels_normalized_as_dict(self):
-    """ return normalized labels as dict of label: count in reverse sorted order (descending) """
+    """return normalized labels as dict of label: count in reverse sorted order (descending)"""
     if self._db_version <= _PHOTOS_4_VERSION:
         logging.warning(f"SearchInfo not implemented for this library version")
         return dict()
@@ -201,8 +201,8 @@ def labels_normalized_as_dict(self):
 
 @lru_cache(maxsize=128)
 def ints_to_uuid(uuid_0, uuid_1):
-    """ convert two signed ints into a UUID strings
-        uuid_0, uuid_1: the two int components of an RFC 4122 UUID """
+    """convert two signed ints into a UUID strings
+    uuid_0, uuid_1: the two int components of an RFC 4122 UUID"""
 
     # assumes uuid imported as uuidlib (to avoid namespace conflict with other uses of uuid)
 

osxphotos/photosdb/photosdb.py

@@ -27,11 +27,11 @@ from .._constants import (
     _PHOTO_TYPE,
     _PHOTOS_3_VERSION,
     _PHOTOS_4_ALBUM_KIND,
-    _PHOTOS_4_ROOT_FOLDER,
-    _PHOTOS_4_TOP_LEVEL_ALBUMS,
     _PHOTOS_4_ALBUM_TYPE_ALBUM,
     _PHOTOS_4_ALBUM_TYPE_PROJECT,
     _PHOTOS_4_ALBUM_TYPE_SLIDESHOW,
+    _PHOTOS_4_ROOT_FOLDER,
+    _PHOTOS_4_TOP_LEVEL_ALBUMS,
     _PHOTOS_4_VERSION,
     _PHOTOS_5_ALBUM_KIND,
     _PHOTOS_5_FOLDER_KIND,
@@ -42,6 +42,7 @@ from .._constants import (
     _TESTED_OS_VERSIONS,
     _UNKNOWN_PERSON,
     BURST_KEY,
+    BURST_PICK_TYPE_NONE,
     BURST_SELECTED,
     TIME_DELTA,
 )
@@ -65,6 +66,8 @@ from ..utils import (
 )
 from .photosdb_utils import get_db_model_version, get_db_version
 
+__all__ = ["PhotosDB"]
+
 # TODO: Add test for imageTimeZoneOffsetSeconds = None
 # TODO: Add test for __str__
 # TODO: Add special albums and magic albums
@@ -3062,6 +3065,7 @@ class PhotosDB:
                 if self._dbphotos[p]["burst"] and not (
                     self._dbphotos[p]["burstPickType"] & BURST_SELECTED
                     or self._dbphotos[p]["burstPickType"] & BURST_KEY
+                    or self._dbphotos[p]["burstPickType"] == BURST_PICK_TYPE_NONE
                 ):
                     # not a key/selected burst photo, don't include in returned results
                     continue

osxphotos/photosdb/photosdb_utils.py

@@ -1,6 +1,7 @@
 """ utility functions used by PhotosDB """
 
 import logging
+import pathlib
 import plistlib
 
 from .._constants import (
@@ -15,9 +16,17 @@ from .._constants import (
 )
 from ..utils import _open_sql_file
 
+__all__ = [
+    "get_db_version",
+    "get_model_version",
+    "get_db_model_version",
+    "UnknownLibraryVersion",
+    "get_photos_library_version",
+]
+
 
 def get_db_version(db_file):
-    """ Gets the Photos DB version from LiGlobals table
+    """Gets the Photos DB version from LiGlobals table
 
     Args:
         db_file: path to photos.db database file containing LiGlobals table
@@ -44,11 +53,11 @@ def get_db_version(db_file):
 
 
 def get_model_version(db_file):
-    """ Returns the database model version from Z_METADATA
-    
+    """Returns the database model version from Z_METADATA
+
     Args:
         db_file: path to Photos.sqlite database file containing Z_METADATA table
-        
+
     Returns: model version as str
     """
 
@@ -67,11 +76,11 @@ def get_model_version(db_file):
 
 
 def get_db_model_version(db_file):
-    """ Returns Photos version based on model version found in db_file
-    
+    """Returns Photos version based on model version found in db_file
+
     Args:
         db_file: path to Photos.sqlite file
-    
+
     Returns: int of major Photos version number (e.g. 5 or 6).
     If unknown model version found, logs warning and returns most current Photos version.
     """
@@ -94,7 +103,7 @@ class UnknownLibraryVersion(Exception):
 
 
 def get_photos_library_version(library_path):
-    """Return int indicating which Photos version a library was created with """
+    """Return int indicating which Photos version a library was created with"""
     library_path = pathlib.Path(library_path)
     db_ver = get_db_version(str(library_path / "database" / "photos.db"))
     db_ver = int(db_ver)
@@ -104,9 +113,8 @@ def get_photos_library_version(library_path):
         return 3
     if db_ver == int(_PHOTOS_4_VERSION):
         return 4
-    if db_ver != int(_PHOTOS_5_VERSION):
-        raise UnknownLibraryVersion(f"db_ver = {db_ver}")
 
+    # assume it's a Photos 5+ library, get the model version to determine which version
     model_ver = get_model_version(str(library_path / "database" / "Photos.sqlite"))
     model_ver = int(model_ver)
     if _PHOTOS_5_MODEL_VERSION[0] <= model_ver <= _PHOTOS_5_MODEL_VERSION[1]:

osxphotos/phototemplate.py

@@ -17,11 +17,19 @@ from ._constants import _UNKNOWN_PERSON, TEXT_DETECTION_CONFIDENCE_THRESHOLD
 from ._version import __version__
 from .datetime_formatter import DateTimeFormatter
 from .exiftool import ExifToolCaching
-from .export_db import ExportDB_ABC, ExportDBInMemory
 from .path_utils import sanitize_dirname, sanitize_filename, sanitize_pathpart
 from .text_detection import detect_text
 from .utils import expand_and_validate_filepath, load_function
 
+__all__ = [
+    "RenderOptions",
+    "PhotoTemplateParser",
+    "PhotoTemplate",
+    "parse_default_kv",
+    "get_template_help",
+    "format_str_value",
+]
+
 # TODO: a lot of values are passed from function to function like path_sep--make these all class properties
 
 # ensure locale set to user's locale
@@ -291,7 +299,6 @@ class RenderOptions:
     dest_path: set to the destination path of the photo (for use by {function} template), only valid with --filename
     filepath: set to value for filepath of the exported photo if you want to evaluate {filepath} template
     quote: quote path templates for execution in the shell
-    exportdb: ExportDB object
     """
 
     none_str: str = "_"
@@ -306,7 +313,6 @@ class RenderOptions:
     dest_path: Optional[str] = None
     filepath: Optional[str] = None
     quote: bool = False
-    exportdb: Optional[ExportDB_ABC] = None
 
 
 class PhotoTemplateParser:
@@ -375,9 +381,6 @@ class PhotoTemplate:
         self.filepath = options.filepath
         self.quote = options.quote
         self.dest_path = options.dest_path
-        self.exportdb = options.exportdb or ExportDBInMemory(
-            None, self.export_dir or "."
-        )
 
     def render(
         self,
@@ -411,7 +414,6 @@ class PhotoTemplate:
         self.filepath = options.filepath
         self.quote = options.quote
         self.dest_path = options.dest_path
-        self.exportdb = options.exportdb or self.exportdb
 
         try:
             model = self.parser.parse(template)
@@ -1207,7 +1209,7 @@ class PhotoTemplate:
             else:
                 values = list(obj)
         elif field == "detected_text":
-            values = _get_detected_text(self.photo, self.exportdb, confidence=subfield)
+            values = _get_detected_text(self.photo, confidence=subfield)
         else:
             raise ValueError(f"Unhandled template value: {field}")
 
@@ -1450,7 +1452,7 @@ def _get_album_by_path(photo, folder_album_path):
     return None
 
 
-def _get_detected_text(photo, exportdb, confidence=TEXT_DETECTION_CONFIDENCE_THRESHOLD):
+def _get_detected_text(photo, confidence=TEXT_DETECTION_CONFIDENCE_THRESHOLD):
     """Returns the detected text for a photo
     {detected_text} uses this instead of PhotoInfo.detected_text() to cache the text for all confidence values
     """
@@ -1466,5 +1468,4 @@ def _get_detected_text(photo, exportdb, confidence=TEXT_DETECTION_CONFIDENCE_THR
     # _detected_text caches the text detection results in an extended attribute
     # so the first time this gets called is slow but repeated accesses are fast
     detected_text = photo._detected_text()
-    exportdb.set_detected_text_for_uuid(photo.uuid, json.dumps(detected_text))
     return [text for text, conf in detected_text if conf >= confidence]

osxphotos/placeinfo.py

@@ -14,6 +14,16 @@ from bpylist import archiver
 from ._constants import UNICODE_FORMAT
 from .utils import normalize_unicode
 
+__all__ = [
+    "PLRevGeoLocationInfo",
+    "PLRevGeoMapItem",
+    "PLRevGeoMapItemAdditionalPlaceInfo",
+    "CNPostalAddress",
+    "PlaceInfo",
+    "PlaceInfo4",
+    "PlaceInfo5",
+]
+
 # postal address information, returned by PlaceInfo.address
 PostalAddress = namedtuple(
     "PostalAddress",
@@ -65,7 +75,7 @@ PlaceNames = namedtuple(
 # in ZADDITIONALASSETATTRIBUTES.ZREVERSELOCATIONDATA
 # These classes are used by bpylist.archiver to unarchive the serialized objects
 class PLRevGeoLocationInfo:
-    """ The top level reverse geolocation object """
+    """The top level reverse geolocation object"""
 
     def __init__(
         self,
@@ -147,7 +157,7 @@ class PLRevGeoLocationInfo:
 
 
 class PLRevGeoMapItem:
-    """ Stores the list of place names, organized by area """
+    """Stores the list of place names, organized by area"""
 
     def __init__(self, sortedPlaceInfos, finalPlaceInfos):
         self.sortedPlaceInfos = sortedPlaceInfos
@@ -182,7 +192,7 @@ class PLRevGeoMapItem:
 
 
 class PLRevGeoMapItemAdditionalPlaceInfo:
-    """ Additional info about individual places """
+    """Additional info about individual places"""
 
     def __init__(self, area, name, placeType, dominantOrderType):
         self.area = area
@@ -221,7 +231,7 @@ class PLRevGeoMapItemAdditionalPlaceInfo:
 
 
 class CNPostalAddress:
-    """ postal address for the reverse geolocation info """
+    """postal address for the reverse geolocation info"""
 
     def __init__(
         self,
@@ -354,17 +364,17 @@ class PlaceInfo(ABC):
 
 
 class PlaceInfo4(PlaceInfo):
-    """ Reverse geolocation place info for a photo (Photos <= 4) """
+    """Reverse geolocation place info for a photo (Photos <= 4)"""
 
     def __init__(self, place_names, country_code):
-        """ place_names: list of place name tuples in ascending order by area 
-            tuple fields are: modelID, place name, place type, area, e.g.
-            [(5, "St James's Park", 45, 0), 
-            (4, 'Westminster', 16, 22097376), 
-            (3, 'London', 4, 1596146816), 
-            (2, 'England', 2, 180406091776), 
-            (1, 'United Kingdom', 1, 414681432064)] 
-            country_code: two letter country code for the country
+        """place_names: list of place name tuples in ascending order by area
+        tuple fields are: modelID, place name, place type, area, e.g.
+        [(5, "St James's Park", 45, 0),
+        (4, 'Westminster', 16, 22097376),
+        (3, 'London', 4, 1596146816),
+        (2, 'England', 2, 180406091776),
+        (1, 'United Kingdom', 1, 414681432064)]
+        country_code: two letter country code for the country
         """
         self._place_names = place_names
         self._country_code = country_code
@@ -404,7 +414,7 @@ class PlaceInfo4(PlaceInfo):
             )
 
     def _process_place_info(self):
-        """ Process place_names to set self._name and self._names """
+        """Process place_names to set self._name and self._names"""
         places = self._place_names
 
         # build a dictionary where key is placetype
@@ -500,38 +510,38 @@ class PlaceInfo4(PlaceInfo):
 
 
 class PlaceInfo5(PlaceInfo):
-    """ Reverse geolocation place info for a photo (Photos >= 5) """
+    """Reverse geolocation place info for a photo (Photos >= 5)"""
 
     def __init__(self, revgeoloc_bplist):
-        """ revgeoloc_bplist: a binary plist blob containing 
-                a serialized PLRevGeoLocationInfo object """
+        """revgeoloc_bplist: a binary plist blob containing
+        a serialized PLRevGeoLocationInfo object"""
         self._bplist = revgeoloc_bplist
         self._plrevgeoloc = archiver.unarchive(revgeoloc_bplist)
         self._process_place_info()
 
     @property
     def address_str(self):
-        """ returns the postal address as a string """
+        """returns the postal address as a string"""
         return self._plrevgeoloc.addressString
 
     @property
     def country_code(self):
-        """ returns the country code """
+        """returns the country code"""
         return self._plrevgeoloc.countryCode
 
     @property
     def ishome(self):
-        """ returns True if place is user's home address """
+        """returns True if place is user's home address"""
         return self._plrevgeoloc.isHome
 
     @property
     def name(self):
-        """ returns local place name """
+        """returns local place name"""
         return self._name
 
     @property
     def names(self):
-        """ returns PlaceNames tuple with detailed reverse geolocation place names """
+        """returns PlaceNames tuple with detailed reverse geolocation place names"""
         return self._names
 
     @property
@@ -556,7 +566,7 @@ class PlaceInfo5(PlaceInfo):
         return postal_address
 
     def _process_place_info(self):
-        """ Process sortedPlaceInfos to set self._name and self._names """
+        """Process sortedPlaceInfos to set self._name and self._names"""
         places = self._plrevgeoloc.mapItem.sortedPlaceInfos
 
         # build a dictionary where key is placetype

osxphotos/pyrepl.py

@@ -1,3 +1,4 @@
+__all__ = ["PyReplQuitter", "embed_repl"]
 """ Custom Python REPL based on ptpython that allows quitting with custom keywords instead of `quit()` """
 
 """ This file is distributed under the same license as the ptpython package:

osxphotos/query_builder.py

@@ -8,6 +8,8 @@ from mako.template import Template
 
 from ._constants import _DB_TABLE_NAMES
 
+__all__ = ["get_query"]
+
 QUERY_DIR = os.path.join(os.path.dirname(__file__), "queries")
 
 

osxphotos/queryoptions.py

@@ -6,6 +6,8 @@ from typing import Iterable, List, Optional, Tuple
 
 import bitmath
 
+__all__ = ["QueryOptions"]
+
 
 @dataclass
 class QueryOptions:

osxphotos/scoreinfo.py

@@ -4,10 +4,12 @@ from dataclasses import dataclass
 
 from ._constants import _PHOTOS_4_VERSION
 
+__all__ = ["ScoreInfo"]
+
 
 @dataclass(frozen=True)
 class ScoreInfo:
-    """ Computed photo score info associated with a photo from the Photos library """
+    """Computed photo score info associated with a photo from the Photos library"""
 
     overall: float
     curation: float
@@ -36,4 +38,3 @@ class ScoreInfo:
     well_chosen_subject: float
     well_framed_subject: float
     well_timed_shot: float
-

osxphotos/searchinfo.py

@@ -23,6 +23,8 @@ from ._constants import (
     SEARCH_CATEGORY_YEAR,
 )
 
+__all__ = ["SearchInfo"]
+
 
 class SearchInfo:
     """Info about search terms such as machine learning labels that Photos knows about a photo"""

osxphotos/sqlgrep.py

@@ -0,0 +1,57 @@
+"""Search through a sqlite database file for a given string"""
+
+import re
+import sqlite3
+from typing import Generator, List
+
+__all__ = ["sqlgrep"]
+
+
+def sqlgrep(
+    filename: str,
+    pattern: str,
+    ignore_case: bool = False,
+    print_filename: bool = True,
+    rich_markup: bool = False,
+) -> Generator[List[str], None, None]:
+    """grep through a sqlite database file for a given string
+
+    Args:
+        filename (str): The filename of the sqlite database file
+        pattern (str): The pattern to search for
+        ignore_case (bool, optional): Ignore case when searching. Defaults to False.
+        print_filename (bool, optional): include the filename of the file with table name. Defaults to True.
+        rich_markup (bool, optional): Add rich markup to mark found text in bold. Defaults to False.
+
+    Returns:
+        Generator which yields list of [table, column, row_id, value]
+    """
+    flags = re.IGNORECASE if ignore_case else 0
+    try:
+        with sqlite3.connect(f"file:{filename}?mode=ro", uri=True) as conn:
+            regex = re.compile(r"(" + pattern + r")", flags=flags)
+            filename_header = f"{filename}: " if print_filename else ""
+            conn.row_factory = sqlite3.Row
+            cursor = conn.cursor()
+            cursor.execute("SELECT name FROM sqlite_master WHERE type='table'")
+            for tablerow in cursor.fetchall():
+                table = tablerow[0]
+                cursor.execute("SELECT * FROM {t}".format(t=table))
+                for row_num, row in enumerate(cursor):
+                    for field in row.keys():
+                        field_value = row[field]
+                        if not field_value or type(field_value) == bytes:
+                            # don't search binary blobs
+                            next
+                        field_value = str(field_value)
+                        if re.search(pattern, field_value, flags=flags):
+                            if rich_markup:
+                                field_value = regex.sub(r"[bold]\1[/bold]", field_value)
+                            yield [
+                                f"{filename_header}{table}",
+                                field,
+                                str(row_num),
+                                field_value,
+                            ]
+    except sqlite3.DatabaseError as e:
+        raise sqlite3.DatabaseError(f"{filename}: {e}")

osxphotos/text_detection.py

@@ -13,6 +13,8 @@ from wurlitzer import pipes
 
 from .utils import _get_os_version
 
+__all__ = ["detect_text", "make_request_handler"]
+
 ver, major, minor = _get_os_version()
 if ver == "10" and int(major) < 15:
     vision = False

osxphotos/uti.py

@@ -1,3 +1,4 @@
+__all__ = ["get_preferred_uti_extension", "get_uti_for_extension"]
 """ get UTI for a given file extension and the preferred extension for a given UTI """
 
 """ Implementation note: runs only on macOS
@@ -591,6 +592,9 @@ def get_preferred_uti_extension(uti):
 def get_uti_for_extension(extension):
     """get UTI for a given file extension"""
 
+    if not extension:
+        return None
+
     # accepts extension with or without leading 0
     if extension[0] == ".":
         extension = extension[1:]

osxphotos/utils.py

@@ -16,14 +16,31 @@ import sys
 import unicodedata
 import urllib.parse
 from plistlib import load as plistload
-from typing import Callable, Union
+from typing import Callable, List, Union
 
 import CoreFoundation
 import objc
-from Foundation import NSString
+from Foundation import NSFileManager, NSPredicate, NSString
 
 from ._constants import UNICODE_FORMAT
 
+__all__ = [
+    "dd_to_dms_str",
+    "expand_and_validate_filepath",
+    "findfiles",
+    "get_last_library_path",
+    "get_system_library_path",
+    "increment_filename_with_count",
+    "increment_filename",
+    "lineno",
+    "list_directory",
+    "list_photo_libraries",
+    "load_function",
+    "noop",
+    "normalize_fs_path",
+    "normalize_unicode",
+]
+
 _DEBUG = False
 
 
@@ -248,7 +265,7 @@ def list_photo_libraries():
     # On older MacOS versions, mdfind appears to ignore some libraries
     # glob to find libraries in ~/Pictures then mdfind to find all the others
     # TODO: make this more robust
-    lib_list = glob.glob(f"{str(pathlib.Path.home())}/Pictures/*.photoslibrary")
+    lib_list = glob.glob(f"{pathlib.Path.home()}/Pictures/*.photoslibrary")
 
     # On older OS, may not get all libraries so make sure we get the last one
     last_lib = get_last_library_path()
@@ -267,26 +284,34 @@ def list_photo_libraries():
 
 def normalize_fs_path(path: str) -> str:
     """Normalize filesystem paths with unicode in them"""
-    with objc.autorelease_pool():
-        normalized_path = NSString.fileSystemRepresentation(path)
-        return normalized_path.decode("utf8")
+    # macOS HFS+ uses NFD, APFS doesn't normalize but stick with NFD
+    # ref: https://eclecticlight.co/2021/05/08/explainer-unicode-normalization-and-apfs/
+    return unicodedata.normalize("NFD", path)
 
 
-def findfiles(pattern, path_):
-    """Returns list of filenames from path_ matched by pattern
+def findfiles(pattern, path):
+    """Returns list of filenames from path matched by pattern
     shell pattern. Matching is case-insensitive.
     If 'path_' is invalid/doesn't exist, returns []."""
-    if not os.path.isdir(path_):
+    if not os.path.isdir(path):
         return []
-    # See: https://gist.github.com/techtonik/5694830
 
     # paths need to be normalized for unicode as filesystem returns unicode in NFD form
     pattern = normalize_fs_path(pattern)
     rule = re.compile(fnmatch.translate(pattern), re.IGNORECASE)
-    files = [normalize_fs_path(p) for p in os.listdir(path_)]
+    files = os.listdir(path)
     return [name for name in files if rule.match(name)]
 
 
+def list_directory_startswith(directory_path: str, startswith: str) -> List[str]:
+    """List directory contents and return list of files starting with startswith; returns [] if directory doesn't exist"""
+    if not os.path.isdir(directory_path):
+        return []
+    startswith = normalize_fs_path(startswith)
+    files = [normalize_fs_path(f) for f in os.listdir(directory_path)]
+    return [f for f in files if f.startswith(startswith)]
+
+
 def _open_sql_file(dbname):
     """opens sqlite file dbname in read-only mode
     returns tuple of (connection, cursor)"""
@@ -325,47 +350,21 @@ def _db_is_locked(dbname):
     return locked
 
 
-# OSXPHOTOS_XATTR_UUID = "com.osxphotos.uuid"
-
-# def get_uuid_for_file(filepath):
-#     """ returns UUID associated with an exported file
-#         filepath: path to exported photo
-#     """
-#     attr = xattr.xattr(filepath)
-#     try:
-#         uuid_bytes = attr[OSXPHOTOS_XATTR_UUID]
-#         uuid_str = uuid_bytes.decode('utf-8')
-#     except KeyError:
-#         uuid_str = None
-#     return uuid_str
-
-# def set_uuid_for_file(filepath, uuid):
-#     """ sets the UUID associated with an exported file
-#         filepath: path to exported photo
-#         uuid: uuid string for photo
-#     """
-#     if not os.path.exists(filepath):
-#         raise FileNotFoundError(f"Missing file: {filepath}")
-
-#     attr = xattr.xattr(filepath)
-#     uuid_bytes = bytes(uuid, 'utf-8')
-#     attr.set(OSXPHOTOS_XATTR_UUID, uuid_bytes)
-
-
 def normalize_unicode(value):
     """normalize unicode data"""
-    if value is not None:
-        if isinstance(value, (tuple, list)):
-            return tuple(unicodedata.normalize(UNICODE_FORMAT, v) for v in value)
-        elif isinstance(value, str):
-            return unicodedata.normalize(UNICODE_FORMAT, value)
-        else:
-            return value
-    else:
+    if value is None:
         return None
+    if isinstance(value, (tuple, list)):
+        return tuple(unicodedata.normalize(UNICODE_FORMAT, v) for v in value)
+    elif isinstance(value, str):
+        return unicodedata.normalize(UNICODE_FORMAT, value)
+    else:
+        return value
 
 
-def increment_filename_with_count(filepath: Union[str,pathlib.Path], count: int = 0) -> str:
+def increment_filename_with_count(
+    filepath: Union[str, pathlib.Path], count: int = 0
+) -> str:
     """Return filename (1).ext, etc if filename.ext exists
 
         If file exists in filename's parent folder with same stem as filename,
@@ -381,16 +380,16 @@ def increment_filename_with_count(filepath: Union[str,pathlib.Path], count: int
     Note: This obviously is subject to race condition so using with caution.
     """
     dest = filepath if isinstance(filepath, pathlib.Path) else pathlib.Path(filepath)
-    dest_files = findfiles(f"{dest.stem}*", str(dest.parent))
-    dest_files = [normalize_fs_path(pathlib.Path(f).stem.lower()) for f in dest_files]
-    dest_new = dest.stem
-    if count:
-        dest_new = f"{dest.stem} ({count})"
-    while normalize_fs_path(dest_new.lower()) in dest_files:
+    dest_files = list_directory_startswith(str(dest.parent), dest.stem)
+    dest_files = [pathlib.Path(f).stem.lower() for f in dest_files]
+    dest_new = f"{dest.stem} ({count})" if count else dest.stem
+    dest_new = normalize_fs_path(dest_new)
+
+    while dest_new.lower() in dest_files:
         count += 1
-        dest_new = f"{dest.stem} ({count})"
+        dest_new = normalize_fs_path(f"{dest.stem} ({count})")
     dest = dest.parent / f"{dest_new}{dest.suffix}"
-    return str(dest), count
+    return normalize_fs_path(str(dest)), count
 
 
 def increment_filename(filepath: Union[str, pathlib.Path]) -> str:

tests/test___all__.py

@@ -0,0 +1,25 @@
+import re
+import sys
+
+from os import walk
+from collections import Counter
+
+
+FILE_PATTERN = "^(?!_).*\.py$"
+SOUCE_CODE_ROOT = "osxphotos"
+
+def create_module_name(dirpath: str, filename: str) -> str:
+    prefix = dirpath[dirpath.rfind(SOUCE_CODE_ROOT):].replace('/', '.')
+    return f"{prefix}.{filename}".replace(".py", "")
+
+
+def test_check_duplicate():
+    for dirpath, dirnames, filenames in walk(SOUCE_CODE_ROOT):
+        print("\n", sys.modules)
+        for filename in filenames:
+            if re.search(FILE_PATTERN, filename):
+                module = create_module_name(dirpath, filename)
+                if module in sys.modules:
+                    all_list = sys.modules[module].__all__
+                    all_set = set(all_list)
+                    assert Counter(all_list) == Counter(all_set)

tests/test_cli.py

@@ -768,7 +768,10 @@ CLI_EXPORT_UUID_FROM_FILE_FILENAMES = [
     "wedding_edited.jpeg",
 ]
 
-CLI_EXPORT_SKIP_UUID = ["E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51", "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4"]
+CLI_EXPORT_SKIP_UUID = [
+    "E9BC5C36-7CD1-40A1-A72B-8B8FAC227D51",
+    "6191423D-8DB8-4D4C-92BE-9BBBA308AAC4",
+]
 CLI_EXPORT_SKIP_UUID_FILENAMES = [
     "Tulips.jpg",
     "Tulips_edited.jpeg",
@@ -903,6 +906,14 @@ QUERY_EXIF_DATA_CASE_INSENSITIVE = [
 ]
 EXPORT_EXIF_DATA = [("EXIF:Make", "FUJIFILM", ["Tulips.jpg", "Tulips_edited.jpeg"])]
 
+UUID_LIVE_EDITED = "136A78FA-1B90-46CC-88A7-CCA3331F0353"  # IMG_4813.HEIC
+CLI_EXPORT_LIVE_EDITED = [
+    "IMG_4813.HEIC",
+    "IMG_4813.mov",
+    "IMG_4813_edited.jpeg",
+    "IMG_4813_edited.mov",
+]
+
 
 def modify_file(filename):
     """appends data to a file to modify it"""
@@ -1268,7 +1279,8 @@ def test_query_duplicate():
     runner = CliRunner()
     cwd = os.getcwd()
     result = runner.invoke(
-        query, ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--duplicate"],
+        query,
+        ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--duplicate"],
     )
     assert result.exit_code == 0
 
@@ -1289,7 +1301,8 @@ def test_query_location():
     runner = CliRunner()
     cwd = os.getcwd()
     result = runner.invoke(
-        query, ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--location"],
+        query,
+        ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--location"],
     )
     assert result.exit_code == 0
 
@@ -1311,7 +1324,8 @@ def test_query_no_location():
     runner = CliRunner()
     cwd = os.getcwd()
     result = runner.invoke(
-        query, ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--no-location"],
+        query,
+        ["--json", "--db", os.path.join(cwd, CLI_PHOTOS_DB), "--no-location"],
     )
     assert result.exit_code == 0
 
@@ -1432,6 +1446,7 @@ def test_export_uuid_from_file():
         files = glob.glob("*")
         assert sorted(files) == sorted(CLI_EXPORT_UUID_FROM_FILE_FILENAMES)
 
+
 def test_export_skip_uuid_from_file():
     """Test export with --skip-uuid-from-file"""
     import glob
@@ -1458,7 +1473,8 @@ def test_export_skip_uuid_from_file():
         assert result.exit_code == 0
         files = glob.glob("*")
         for skipped_file in CLI_EXPORT_SKIP_UUID_FILENAMES:
-            assert skipped_file not in files 
+            assert skipped_file not in files
+
 
 def test_export_skip_uuid():
     """Test export with --skip-uuid"""
@@ -4304,7 +4320,7 @@ def test_export_error(monkeypatch):
 @pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
 @pytest.mark.parametrize("exiftag,exifvalue,files_expected", EXPORT_EXIF_DATA)
 def test_export_exif(exiftag, exifvalue, files_expected):
-    """Test export --exif query """
+    """Test export --exif query"""
     import glob
     import os
     import os.path
@@ -4665,6 +4681,32 @@ def test_export_update_basic():
         )
 
 
+@pytest.mark.skipif(
+    "OSXPHOTOS_TEST_EXPORT" not in os.environ,
+    reason="Skip if not running on author's personal library.",
+)
+def test_export_live_edited():
+    """test export of edited live image #576"""
+    import glob
+    import os
+    import os.path
+
+    from osxphotos.cli import OSXPHOTOS_EXPORT_DB, export
+
+    runner = CliRunner()
+    cwd = os.getcwd()
+    # pylint: disable=not-context-manager
+    with runner.isolated_filesystem():
+        # basic export
+        result = runner.invoke(
+            export,
+            [os.path.join(cwd, PHOTOS_DB_RHET), ".", "-V", "--uuid", UUID_LIVE_EDITED],
+        )
+        assert result.exit_code == 0
+        files = glob.glob("*")
+        assert sorted(files) == sorted(CLI_EXPORT_LIVE_EDITED)
+
+
 def test_export_update_child_folder():
     """test export then update into a child folder of previous export"""
     import glob
@@ -6826,7 +6868,7 @@ def test_export_download_missing_file_exists():
             ],
         )
         assert result.exit_code == 0
-        assert "exported: 1" in result.output
+        assert "skipped: 1" in result.output
 
 
 @pytest.mark.skipif(
@@ -7642,6 +7684,7 @@ def test_export_query_function():
 def test_export_album_seq():
     """Test {album_seq} template"""
     import glob
+
     from osxphotos.cli import cli
 
     runner = CliRunner()
@@ -7719,7 +7762,6 @@ def test_export_description_template_conditional():
     import osxphotos
     from osxphotos.cli import cli
     from osxphotos.exiftool import ExifTool
-    import json
 
     runner = CliRunner()
     cwd = os.getcwd()

tests/test_export_catalina_10_15_7.py

@@ -8,7 +8,7 @@ import pytest
 import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
 from osxphotos.exiftool import get_exiftool_path
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 from osxphotos.utils import dd_to_dms_str
 
 # determine if exiftool installed so exiftool tests can be skipped
@@ -321,7 +321,9 @@ def test_export_12(photosdb):
 
     edited_name = pathlib.Path(photos[0].path_edited).name
     edited_suffix = pathlib.Path(edited_name).suffix
-    filename = pathlib.Path(photos[0].original_filename).stem + "_edited" + edited_suffix
+    filename = (
+        pathlib.Path(photos[0].original_filename).stem + "_edited" + edited_suffix
+    )
     expected_dest = os.path.join(dest, filename)
 
     got_dest = photos[0].export(dest, edited=True)[0]
@@ -418,7 +420,9 @@ def test_exiftool_json_sidecar_ignore_date_modified(photosdb):
     ) as fp:
         json_expected = json.load(fp)[0]
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(ignore_date_modified=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(ignore_date_modified=True)
+    )
     json_got = json.loads(json_got)[0]
 
     assert json_got == json_expected
@@ -449,7 +453,9 @@ def test_exiftool_json_sidecar_keyword_template_long(capsys, photosdb):
 
     long_str = "x" * (_MAX_IPTC_KEYWORD_LEN + 1)
     photos[0]._verbose = print
-    json_got = PhotoExporter(photos[0])._exiftool_json_sidecar(keyword_template=[long_str])
+    json_got = PhotoExporter(photos[0])._exiftool_json_sidecar(
+        ExportOptions(keyword_template=[long_str])
+    )
     json_got = json.loads(json_got)[0]
 
     captured = capsys.readouterr()
@@ -484,7 +490,9 @@ def test_exiftool_json_sidecar_keyword_template(photosdb):
         str(pathlib.Path(SIDECAR_DIR) / f"{uuid}_keyword_template.json"), "r"
     ) as fp:
         json_expected = json.load(fp)
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(keyword_template=["{folder_album}"])
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(keyword_template=["{folder_album}"])
+    )
     json_got = json.loads(json_got)
 
     assert json_got == json_expected
@@ -500,7 +508,9 @@ def test_exiftool_json_sidecar_use_persons_keyword(photosdb):
     ) as fp:
         json_expected = json.load(fp)[0]
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(use_persons_as_keywords=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(use_persons_as_keywords=True)
+    )
     json_got = json.loads(json_got)[0]
 
     assert json_got == json_expected
@@ -516,7 +526,9 @@ def test_exiftool_json_sidecar_use_albums_keywords(photosdb):
     ) as fp:
         json_expected = json.load(fp)
 
-    json_got = PhotoExporter(photo)._exiftool_json_sidecar(use_albums_as_keywords=True)
+    json_got = PhotoExporter(photo)._exiftool_json_sidecar(
+        ExportOptions(use_albums_as_keywords=True)
+    )
     json_got = json.loads(json_got)
 
     assert json_got == json_expected
@@ -536,7 +548,7 @@ def test_exiftool_sidecar(photosdb):
 
 @pytest.mark.skipif(exiftool is None, reason="exiftool not installed")
 def test_xmp_sidecar_is_valid(tmp_path, photosdb):
-    """ validate XMP sidecar file with exiftool """
+    """validate XMP sidecar file with exiftool"""
     from osxphotos.exiftool import ExifTool
 
     photos = photosdb.photos(uuid=[UUID_DICT["xmp"]])
@@ -560,7 +572,7 @@ def test_xmp_sidecar(photosdb):
 
 
 def test_xmp_sidecar_extension(photosdb):
-    """ test XMP sidecar when no extension is passed """
+    """test XMP sidecar when no extension is passed"""
 
     uuid = UUID_DICT["xmp"]
     photos = photosdb.photos(uuid=[uuid])
@@ -581,7 +593,9 @@ def test_xmp_sidecar_use_persons_keyword(photosdb):
     with open(pathlib.Path(SIDECAR_DIR) / f"{uuid}_persons_as_keywords.xmp") as fp:
         xmp_expected = fp.read()
 
-    xmp_got = PhotoExporter(photo)._xmp_sidecar(use_persons_as_keywords=True, extension="jpg")
+    xmp_got = PhotoExporter(photo)._xmp_sidecar(
+        ExportOptions(use_persons_as_keywords=True), extension="jpg"
+    )
     assert xmp_got == xmp_expected
 
 
@@ -593,12 +607,14 @@ def test_xmp_sidecar_use_albums_keyword(photosdb):
     with open(pathlib.Path(SIDECAR_DIR) / f"{uuid}_albums_as_keywords.xmp") as fp:
         xmp_expected = fp.read()
 
-    xmp_got = PhotoExporter(photo)._xmp_sidecar(use_albums_as_keywords=True, extension="jpg")
+    xmp_got = PhotoExporter(photo)._xmp_sidecar(
+        ExportOptions(use_albums_as_keywords=True), extension="jpg"
+    )
     assert xmp_got == xmp_expected
 
 
 def test_xmp_sidecar_gps(photosdb):
-    """ Test export XMP sidecar with GPS info """
+    """Test export XMP sidecar with GPS info"""
 
     uuid = UUID_DICT["location"]
     photo = photosdb.get_photo(uuid)
@@ -619,7 +635,7 @@ def test_xmp_sidecar_keyword_template(photosdb):
         xmp_expected = fp.read()
 
     xmp_got = PhotoExporter(photo)._xmp_sidecar(
-        keyword_template=["{created.year}", "{folder_album}"], extension="jpg"
+        ExportOptions(keyword_template=["{created.year}", "{folder_album}"]),
+        extension="jpg",
     )
     assert xmp_got == xmp_expected
-

tests/test_export_catalina_10_15_7_use_photos_export.py

@@ -73,7 +73,6 @@ def test_export_default_name(photosdb):
 
     filename = photos[0].original_filename
     expected_dest = pathlib.Path(dest) / filename
-    expected_dest = expected_dest.parent / f"{expected_dest.stem}.jpeg"
     got_dest = photos[0].export(dest, use_photos_export=True)[0]
 
     assert got_dest == str(expected_dest)

tests/test_export_convert_to_jpeg.py

@@ -1,8 +1,9 @@
 import os
+
 import pytest
 
 from osxphotos._constants import _UNKNOWN_PERSON
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 skip_test = "OSXPHOTOS_TEST_CONVERT" not in os.environ
 pytestmark = pytest.mark.skipif(
@@ -16,16 +17,10 @@ UUID_DICT = {
     "heic": "7783E8E6-9CAC-40F3-BE22-81FB7051C266",
 }
 
-NAMES_DICT = {
-    "raw": "DSC03584.jpeg",
-    "heic": "IMG_3092.jpeg"
-}
+NAMES_DICT = {"raw": "DSC03584.jpeg", "heic": "IMG_3092.jpeg"}
 
 UUID_LIVE_HEIC = "8EC216A2-0032-4934-BD3F-04C6259B3304"
-NAMES_LIVE_HEIC = [
-    "IMG_3259.jpeg",
-    "IMG_3259.mov"
-]
+NAMES_LIVE_HEIC = ["IMG_3259.jpeg", "IMG_3259.mov"]
 
 
 @pytest.fixture(scope="module")
@@ -44,7 +39,8 @@ def test_export_convert_raw_to_jpeg(photosdb):
     dest = tempdir.name
     photos = photosdb.photos(uuid=[UUID_DICT["raw"]])
 
-    results = PhotoExporter(photos[0]).export2(dest, convert_to_jpeg=True)
+    export_options = ExportOptions(convert_to_jpeg=True)
+    results = PhotoExporter(photos[0]).export2(dest, options=export_options)
     got_dest = pathlib.Path(results.exported[0])
 
     assert got_dest.is_file()
@@ -61,7 +57,8 @@ def test_export_convert_heic_to_jpeg(photosdb):
     dest = tempdir.name
     photos = photosdb.photos(uuid=[UUID_DICT["heic"]])
 
-    results = PhotoExporter(photos[0]).export2(dest, convert_to_jpeg=True)
+    export_options = ExportOptions(convert_to_jpeg=True)
+    results = PhotoExporter(photos[0]).export2(dest, options=export_options)
     got_dest = pathlib.Path(results.exported[0])
 
     assert got_dest.is_file()
@@ -88,7 +85,8 @@ def test_export_convert_live_heic_to_jpeg():
     dest = tempdir.name
     photo = photosdb.get_photo(UUID_LIVE_HEIC)
 
-    results = PhotoExporter(photo).export2(dest, convert_to_jpeg=True, live_photo=True)
+    export_options = ExportOptions(convert_to_jpeg=True, live_photo=True)
+    results = PhotoExporter(photo).export2(dest, options=export_options)
 
     for name in NAMES_LIVE_HEIC:
         assert f"{tempdir.name}/{name}" in results.exported
@@ -96,4 +94,3 @@ def test_export_convert_live_heic_to_jpeg():
     for file_ in results.exported:
         dest = pathlib.Path(file_)
         assert dest.is_file()
-

tests/test_export_db.py

@@ -74,6 +74,26 @@ def test_export_db():
     assert db.get_stat_edited_for_file(filepath2) == (10, 11, 12)
     assert sorted(db.get_previous_uuids()) == (["BAR-FOO", "FOO-BAR"])
 
+    # test set_data value=None doesn't overwrite existing data
+    db.set_data(
+        filepath2,
+        "BAR-FOO",
+        None,
+        None,
+        None,
+        None,
+        None,
+        None,
+    )
+    assert db.get_uuid_for_file(filepath2) == "BAR-FOO"
+    assert db.get_info_for_uuid("BAR-FOO") == INFO_DATA
+    assert db.get_exifdata_for_file(filepath2) == EXIF_DATA
+    assert db.get_stat_orig_for_file(filepath2) == (1, 2, 3)
+    assert db.get_stat_exif_for_file(filepath2) == (4, 5, 6)
+    assert db.get_stat_converted_for_file(filepath2) == (7, 8, 9)
+    assert db.get_stat_edited_for_file(filepath2) == (10, 11, 12)
+    assert sorted(db.get_previous_uuids()) == (["BAR-FOO", "FOO-BAR"])
+
     # close and re-open
     db.close()
     db = ExportDB(dbname, tempdir.name)

tests/test_export_mojave_10_14_6.py

@@ -5,7 +5,7 @@ import pytest
 
 import osxphotos
 from osxphotos._constants import _UNKNOWN_PERSON
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 PHOTOS_DB = "./tests/Test-10.14.6.photoslibrary/database/photos.db"
 PHOTOS_DB_PATH = "/Test-10.14.6.photoslibrary/database/photos.db"
@@ -365,7 +365,8 @@ def test_xmp_sidecar_keyword_template(photosdb):
         xmp_expected = fp.read()
 
     xmp_got = PhotoExporter(photo)._xmp_sidecar(
-        keyword_template=["{created.year}", "{folder_album}"], extension="jpg"
+        ExportOptions(keyword_template=["{created.year}", "{folder_album}"]),
+        extension="jpg",
     )
 
     assert xmp_got == xmp_expected

tests/test_exportresults.py

@@ -93,7 +93,7 @@ def test_exportresults_iadd():
 
 
 def test_all_files():
-    """ test ExportResults.all_files() """
+    """test ExportResults.all_files()"""
     results = ExportResults()
     for x in EXPORT_RESULT_ATTRIBUTES:
         setattr(results, x, [f"{x}1"])
@@ -106,13 +106,3 @@ def test_all_files():
     assert sorted(
         results.all_files() + results.deleted_files + results.deleted_directories
     ) == sorted([f"{x}1" for x in EXPORT_RESULT_ATTRIBUTES])
-
-
-def test_str():
-    """ test ExportResults.__str__ """
-    results = ExportResults()
-    assert (
-        str(results)
-        == "ExportResults(exported=[],new=[],updated=[],skipped=[],exif_updated=[],touched=[],converted_to_jpeg=[],sidecar_json_written=[],sidecar_json_skipped=[],sidecar_exiftool_written=[],sidecar_exiftool_skipped=[],sidecar_xmp_written=[],sidecar_xmp_skipped=[],missing=[],error=[],exiftool_warning=[],exiftool_error=[],deleted_files=[],deleted_directories=[],exported_album=[],skipped_album=[],missing_album=[])"
-    )
-

tests/test_search_info_10_15_5.py

@@ -348,7 +348,6 @@ def test_labels_normalized(photosdb):
 
     for uuid in LABELS_NORMALIZED_DICT:
         photo = photosdb.photos(uuid=[uuid])[0]
-        logging.warning(f"uuid = {uuid}")
         assert sorted(photo.search_info_normalized.labels) == sorted(
             LABELS_NORMALIZED_DICT[uuid]
         )
@@ -359,7 +358,6 @@ def test_labels(photosdb):
     import logging
 
     for uuid in LABELS_DICT:
-        logging.warning(f"uuid = {uuid}")
         photo = photosdb.photos(uuid=[uuid])[0]
         assert sorted(photo.search_info.labels) == sorted(LABELS_DICT[uuid])
         assert sorted(photo.labels) == sorted(LABELS_DICT[uuid])

tests/test_sidecar_xmp.py

@@ -9,7 +9,7 @@ import osxphotos
 from osxphotos._constants import SIDECAR_XMP
 from osxphotos.exiftool import ExifTool, get_exiftool_path
 from osxphotos.fileutil import FileUtil
-from osxphotos.photoexporter import PhotoExporter
+from osxphotos.photoexporter import ExportOptions, PhotoExporter
 
 PHOTOS_DB_15_7 = "tests/Test-10.15.7.photoslibrary"
 
@@ -40,7 +40,10 @@ def test_sidecar_xmp(photosdb):
         tempdir = tempfile.TemporaryDirectory(prefix="osxphotos")
         dest = tempdir.name
         photo = photosdb.get_photo(uuid)
-        PhotoExporter(photo).export2(dest, photo.original_filename, sidecar=SIDECAR_XMP)
+        export_options = ExportOptions(sidecar=SIDECAR_XMP)
+        PhotoExporter(photo).export2(
+            dest, photo.original_filename, options=export_options
+        )
         filepath = str(pathlib.Path(dest) / photo.original_filename)
         xmppath = filepath + ".xmp"