Fix for --load-config, #643

* Initial refactoring of cli.py

* Renamed cli_help

* Refactored all cli commands

* Dropped support for 3.7

* Added test for export with --min-size

* Version bump

* Fixed python version

.all-contributorsrc

@@ -229,7 +229,8 @@
       "avatar_url": "https://avatars.githubusercontent.com/u/36466711?v=4",
       "profile": "https://github.com/mkirkland4874",
       "contributions": [
-        "bug"
+        "bug",
+        "example"
       ]
     },
     {
@@ -240,6 +241,91 @@
       "contributions": [
         "data"
       ]
+    },
+    {
+      "login": "dssinger",
+      "name": "David Singer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1817903?v=4",
+      "profile": "https://github.com/dssinger",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "oPromessa",
+      "name": "oPromessa",
+      "avatar_url": "https://avatars.githubusercontent.com/u/21261491?v=4",
+      "profile": "https://github.com/oPromessa",
+      "contributions": [
+        "bug",
+        "ideas",
+        "test"
+      ]
+    },
+    {
+      "login": "spencerc99",
+      "name": "Spencer Chang",
+      "avatar_url": "https://avatars.githubusercontent.com/u/14796580?v=4",
+      "profile": "http://spencerchang.me",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "dgleich",
+      "name": "David Gleich",
+      "avatar_url": "https://avatars.githubusercontent.com/u/33995?v=4",
+      "profile": "https://www.cs.purdue.edu/homes/dgleich",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "alandefreitas",
+      "name": "Alan de Freitas",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5369819?v=4",
+      "profile": "https://alandefreitas.github.io/alandefreitas/",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "hyfen",
+      "name": "Andrew Louis",
+      "avatar_url": "https://avatars.githubusercontent.com/u/6291?v=4",
+      "profile": "https://hyfen.net",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "neebah",
+      "name": "neebah",
+      "avatar_url": "https://avatars.githubusercontent.com/u/71442026?v=4",
+      "profile": "https://github.com/neebah",
+      "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,

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+** Before submitting a bug report, please ensure you are running the most recent version of osxphotos and that the bug is reproducible on the latest version **
+
+- If you installed with pipx: `pipx upgrade osxphotos`
+- If you installed with pip: `pip install --upgrade osxphotos`
+- If you installed the pre-built binary, download and install the latest [release](https://github.com/RhetTbull/osxphotos/releases)
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. What' the full command line you used with osxphotos?
+2. What was the error output?
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. which version of macOS]
+ - osxphotos version (`osxphotos --version`)
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
       max-parallel: 4
       matrix:
         os: [macos-10.15]
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ['3.8', '3.9', '3.10']
 
     steps:
     - uses: actions/checkout@v1

.gitignore

@@ -16,3 +16,4 @@ cli.spec
 *.pyc
 docsrc/_build/
 venv/
+.python-version

CHANGELOG.md

@@ -4,6 +4,596 @@ 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.47.1](https://github.com/RhetTbull/osxphotos/compare/v0.47.0...v0.47.1)
+
+> 26 February 2022
+
+- Fixed entry point [`d275367`](https://github.com/RhetTbull/osxphotos/commit/d2753672f36a0c84b7be143a47cc85cd6c99cb6d)
+
+#### [v0.47.0](https://github.com/RhetTbull/osxphotos/compare/v0.46.6...v0.47.0)
+
+> 26 February 2022
+
+- CLI refactor [`#642`](https://github.com/RhetTbull/osxphotos/pull/642)
+- Updated docs [skip ci] [`6fae979`](https://github.com/RhetTbull/osxphotos/commit/6fae97906124c9284e382170e20c8ab9999105b0)
+- Fixed 3.10 in yaml [`3704fc4`](https://github.com/RhetTbull/osxphotos/commit/3704fc4a23e83ff2d16d6d221fb6c752dabcedca)
+- Dropped 3.7 [`7883fc1`](https://github.com/RhetTbull/osxphotos/commit/7883fc1911057df9a4c596375b498e85a73c1bec)
+
+#### [v0.46.6](https://github.com/RhetTbull/osxphotos/compare/v0.46.5...v0.46.6)
+
+> 26 February 2022
+
+- Updated tests [`43e1cb1`](https://github.com/RhetTbull/osxphotos/commit/43e1cb18cc65b1abe1f49b464563e816b2ed1cff)
+- Updated docs [skip ci] [`3a990e3`](https://github.com/RhetTbull/osxphotos/commit/3a990e39971d838e52d5f19bf28b8253c4c7b811)
+- Bug fix for bitmath types in saved config [`26f916e`](https://github.com/RhetTbull/osxphotos/commit/26f916e4cbf4f28154c47aa2de1fdbc0aebc65b3)
+
+#### [v0.46.5](https://github.com/RhetTbull/osxphotos/compare/v0.46.4...v0.46.5)
+
+> 24 February 2022
+
+- Updated tested versions [`4d1b1db`](https://github.com/RhetTbull/osxphotos/commit/4d1b1db2a7cf34afaa2dc5dbebc69021ff77964f)
+
+#### [v0.46.4](https://github.com/RhetTbull/osxphotos/compare/v0.46.1...v0.46.4)
+
+> 24 February 2022
+
+- Removed debug code from exiftool, fixed #641 [`#641`](https://github.com/RhetTbull/osxphotos/issues/641)
+- Added debug output to exiftool [`39ba17d`](https://github.com/RhetTbull/osxphotos/commit/39ba17dd1cb4d8a61ab4dc8d5cff12ff9871eee0)
+- Fixed export of bursts with --uuid and --selected, #640 [`5b66962`](https://github.com/RhetTbull/osxphotos/commit/5b66962ac1bc1f48106fb8eeb600e6010088dc3b)
+- Added --sql command to exportdb [`c8ee679`](https://github.com/RhetTbull/osxphotos/commit/c8ee6797999af954c32e96ac3799a19002f4f0fe)
+- Updated docs [skip ci] [`2966c9a`](https://github.com/RhetTbull/osxphotos/commit/2966c9a60fc828afdf34263b759159a3ade31897)
+- Updated debug info [`6cb7ded`](https://github.com/RhetTbull/osxphotos/commit/6cb7dedd9be53d2c62489125fc44b9f4dccfb7ae)
+
+#### [v0.46.1](https://github.com/RhetTbull/osxphotos/compare/v0.46.0...v0.46.1)
+
+> 21 February 2022
+
+- Added --ramdb option [`#639`](https://github.com/RhetTbull/osxphotos/pull/639)
+
+#### [v0.46.0](https://github.com/RhetTbull/osxphotos/compare/v0.45.12...v0.46.0)
+
+> 21 February 2022
+
+- Exportdb refactor [`#638`](https://github.com/RhetTbull/osxphotos/pull/638)
+- Updated docs [skip ci] [`5290fae`](https://github.com/RhetTbull/osxphotos/commit/5290fae2e0ad062750348aedfee4feaf7b2e769f)
+
+#### [v0.45.12](https://github.com/RhetTbull/osxphotos/compare/v0.45.11...v0.45.12)
+
+> 14 February 2022
+
+- Allow multiple characters as path_sep, #634 [`d8204e6`](https://github.com/RhetTbull/osxphotos/commit/d8204e65eb740cece468ef021cbdf45d896d954e)
+- Added --debug and crash reporter to export, #628 [`060729c`](https://github.com/RhetTbull/osxphotos/commit/060729c4c4255651c6ee8149989d9de541d0a6aa)
+- Added crash_reporter.py [`9c26e55`](https://github.com/RhetTbull/osxphotos/commit/9c26e5519b2d48f3a0ae80d1cc4a765c12b62d40)
+
+#### [v0.45.11](https://github.com/RhetTbull/osxphotos/compare/v0.45.10...v0.45.11)
+
+> 13 February 2022
+
+- beta fix for #633, fix face regions in exiftool [`afbda03`](https://github.com/RhetTbull/osxphotos/commit/afbda030bce87f914445ebbced3f0e110e2e203b)
+- Updated docs [skip ci] [`65d51ab`](https://github.com/RhetTbull/osxphotos/commit/65d51ab1290e7c7804021e24829b93f5dce81245)
+
+#### [v0.45.10](https://github.com/RhetTbull/osxphotos/compare/v0.45.9...v0.45.10)
+
+> 12 February 2022
+
+- Added --force-update, #621 [`30abddd`](https://github.com/RhetTbull/osxphotos/commit/30abdddaf3765f1d604984d4781b78b7806871e1)
+
+#### [v0.45.9](https://github.com/RhetTbull/osxphotos/compare/v0.45.8...v0.45.9)
+
+> 12 February 2022
+
+- Added --force-update, #621 [`bfa888a`](https://github.com/RhetTbull/osxphotos/commit/bfa888adc5658a2845dcaa9b7ea360926ed4f000)
+- Refactored fix for #627 [`5fb686a`](https://github.com/RhetTbull/osxphotos/commit/5fb686ac0c231932c2695fc550a0824307bd3c5f)
+- Fix for #630 [`ac4083b`](https://github.com/RhetTbull/osxphotos/commit/ac4083bfbbabc8550718f0f7f8aadc635c05eb25)
+
+#### [v0.45.8](https://github.com/RhetTbull/osxphotos/compare/v0.45.6...v0.45.8)
+
+> 5 February 2022
+
+- Fixed exiftool to ignore unsupported file types, #615 [`1ae6270`](https://github.com/RhetTbull/osxphotos/commit/1ae627056113fc4655f1b24cfbbdf0efc04489e7)
+- Updated tests [`55a601c`](https://github.com/RhetTbull/osxphotos/commit/55a601c07ea1384623c55d5c1d26b568df5d7823)
+- Additional fix for #615 [`1d6bc4e`](https://github.com/RhetTbull/osxphotos/commit/1d6bc4e09e3c2359a21f842fadd781920606812e)
+
+#### [v0.45.6](https://github.com/RhetTbull/osxphotos/compare/v0.45.5...v0.45.6)
+
+> 5 February 2022
+
+- Fix for unicode in query strings, #618 [`9b247ac`](https://github.com/RhetTbull/osxphotos/commit/9b247acd1cc4b2def59fdd18a6fb3c8eb9914f11)
+- Fix for --name searching only original_filename on Photos 5+, #594 [`cd02144`](https://github.com/RhetTbull/osxphotos/commit/cd02144ac33cc1c13a20358133971c84d35b8a57)
+
+#### [v0.45.5](https://github.com/RhetTbull/osxphotos/compare/v0.45.4...v0.45.5)
+
+> 5 February 2022
+
+- Fix for #561, no really, I mean it this time [`b3d3e14`](https://github.com/RhetTbull/osxphotos/commit/b3d3e14ffe41fbb22edb614b24f3985f379766a2)
+- Updated docs [skip ci] [`2b9ea11`](https://github.com/RhetTbull/osxphotos/commit/2b9ea11701799af9a661a8e2af70fca97235f487)
+- Updated tests for #561 [skip ci] [`77a49a0`](https://github.com/RhetTbull/osxphotos/commit/77a49a09a1bee74113a7114c543fbc25fa410ffc)
+
+#### [v0.45.4](https://github.com/RhetTbull/osxphotos/compare/v0.45.3...v0.45.4)
+
+> 3 February 2022
+
+- docs: add oPromessa as a contributor for ideas, test [`#611`](https://github.com/RhetTbull/osxphotos/pull/611)
+- Fix for filenames with special characters, #561, #618 [`f3063d3`](https://github.com/RhetTbull/osxphotos/commit/f3063d35be3c96342d83dbd87ddd614a2001bff4)
+- Updated docs [skip ci] [`06c5bbf`](https://github.com/RhetTbull/osxphotos/commit/06c5bbfcfdf591a4a5d43f1456adaa27385fe01a)
+- Added progress counter, #601 [`7ab5007`](https://github.com/RhetTbull/osxphotos/commit/7ab500740b28594dcd778140e10991f839220e9d)
+- Updated known issues [skip ci] [`e32090b`](https://github.com/RhetTbull/osxphotos/commit/e32090bf39cb786171b49443f878ffdbab774420)
+
+#### [v0.45.3](https://github.com/RhetTbull/osxphotos/compare/v0.45.2...v0.45.3)
+
+> 29 January 2022
+
+- Added --timestamp option for --verbose, #600 [`d8c2f99`](https://github.com/RhetTbull/osxphotos/commit/d8c2f99c06bc6f72bf2cb1a13c5765824fe3cbba)
+- Updated docs [skip ci] [`5fc2813`](https://github.com/RhetTbull/osxphotos/commit/5fc28139ea0374bc3e228c0432b8a41ada430389)
+- Updated formatting for elapsed time, #604 [`16d3f74`](https://github.com/RhetTbull/osxphotos/commit/16d3f743664396d43b3b3028a5e7a919ec56d9e1)
+
+#### [v0.45.2](https://github.com/RhetTbull/osxphotos/compare/v0.45.0...v0.45.2)
+
+> 29 January 2022
+
+- Implemented #605, refactor out export2 [`235dea3`](https://github.com/RhetTbull/osxphotos/commit/235dea329c98ab8fa61565c09a1b4a83e5d99043)
+- Fix for #564, --preview with --download-missing [`5afdf6f`](https://github.com/RhetTbull/osxphotos/commit/5afdf6fc20a3cb6eb2b0217d8b3be20295eb7ba4)
+
+#### [v0.45.0](https://github.com/RhetTbull/osxphotos/compare/v0.44.13...v0.45.0)
+
+> 28 January 2022
+
+- Performance improvements and refactoring, #462, partial for #591 [`22964af`](https://github.com/RhetTbull/osxphotos/commit/22964afc6988166218413125d7a62348bb858a83)
+- Refactored photoexporter for performance, #591 [`6843b86`](https://github.com/RhetTbull/osxphotos/commit/6843b8661d41d42368794c77304fc07194e7af18)
+- Performance improvements, partial for #591 [`3bc53fd`](https://github.com/RhetTbull/osxphotos/commit/3bc53fd92b3222c6959e7aa12310811db41b83fe)
+
+#### [v0.44.13](https://github.com/RhetTbull/osxphotos/compare/v0.44.12...v0.44.13)
+
+> 24 January 2022
+
+- Removed exportdb requirement from PhotoTemplate [`6af124e`](https://github.com/RhetTbull/osxphotos/commit/6af124e4d3a0e26c48f435452920020cd42afa1c)
+- Version bump [`bd31120`](https://github.com/RhetTbull/osxphotos/commit/bd3112056920806f565be2c0c12caf4f2aff5231)
+
+#### [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
+
+- ImageConverter now uses generic context; #562 [`a3b2784`](https://github.com/RhetTbull/osxphotos/commit/a3b2784f3177a753b78965b8ca205ca9bbb08168)
+- Updated tests and docs [`1391675`](https://github.com/RhetTbull/osxphotos/commit/1391675a3a45be0d6800a68c8bcc6d0d55d1ab7a)
+- Updated docs [skip ci] [`cbe79ee`](https://github.com/RhetTbull/osxphotos/commit/cbe79ee98cae68e0789df275220f5a5870a8bd91)
+
+#### [v0.44.2](https://github.com/RhetTbull/osxphotos/compare/v0.44.1...v0.44.2)
+
+> 31 December 2021
+
+- Bug fix for #559 [`42426b9`](https://github.com/RhetTbull/osxphotos/commit/42426b95ee786b2d53482d3d931a0b962a4db20d)
+
+#### [v0.44.1](https://github.com/RhetTbull/osxphotos/compare/v0.44.0...v0.44.1)
+
+> 31 December 2021
+
+- Added --skip-uuid, --skip-uuid-from-file, #563 [`04930c3`](https://github.com/RhetTbull/osxphotos/commit/04930c3644da99c1923c4e3aaa9213902aeadfd1)
+
+#### [v0.44.0](https://github.com/RhetTbull/osxphotos/compare/v0.43.9...v0.44.0)
+
+> 31 December 2021
+
+- Added support for projects, implements #559 [`44594a8`](https://github.com/RhetTbull/osxphotos/commit/44594a8e437c20bae6fd8eecb74075d49da4b91f)
+- Updated docs [skip ci] [`c4e3c5a`](https://github.com/RhetTbull/osxphotos/commit/c4e3c5a8beac1db00533f7820ab8249cf351aef0)
+- Fixed test for #561 [`690d981`](https://github.com/RhetTbull/osxphotos/commit/690d981f310b083f5f58407cc879bca494730765)
+
+#### [v0.43.9](https://github.com/RhetTbull/osxphotos/compare/v0.43.8...v0.43.9)
+
+> 28 December 2021
+
+- Fix for accented characters in album names, #561 [`03f4e7c`](https://github.com/RhetTbull/osxphotos/commit/03f4e7cc3473c276dfd7c7e6ad64e4dfe5b32011)
+
+#### [v0.43.8](https://github.com/RhetTbull/osxphotos/compare/v0.43.7...v0.43.8)
+
+> 26 December 2021
+
+- Fixed #463 [`#463`](https://github.com/RhetTbull/osxphotos/issues/463)
+- Updated docs [skip ci] [`181f678`](https://github.com/RhetTbull/osxphotos/commit/181f678d9eda8bc8acca11b4ebd470900f30bdcb)
+- Added install/uninstall commands, #531 [`085f482`](https://github.com/RhetTbull/osxphotos/commit/085f482820af2d51f0d411c7e8a7a27329bf0722)
+- Implement #323 [`debb17c`](https://github.com/RhetTbull/osxphotos/commit/debb17c9520bec25d725426feaa512745e9d4ec0)
+- Updated docs [skip ci] [`0e54a08`](https://github.com/RhetTbull/osxphotos/commit/0e54a08ae07853c4cdb2c548bdba27335cfc32ba)
+- Added get_photos_library_version [`b71c752`](https://github.com/RhetTbull/osxphotos/commit/b71c752e9d2c59412baf812bfc50e6358ea3f02e)
+
+#### [v0.43.7](https://github.com/RhetTbull/osxphotos/compare/v0.43.6...v0.43.7)
+
+> 21 December 2021
+
+- Adds missing f-string to retry message [`#553`](https://github.com/RhetTbull/osxphotos/pull/553)
+- Update issue templates [`e7bd80e`](https://github.com/RhetTbull/osxphotos/commit/e7bd80e05f94238fd41e478e32c1709b442eb361)
+- Partial fix for #556 [`a08a653`](https://github.com/RhetTbull/osxphotos/commit/a08a653f202a49853780ab4a686bf3dfbc32a491)
+- Updated all-contributors [`e1f1772`](https://github.com/RhetTbull/osxphotos/commit/e1f1772080d24373ceb5791683615451cd390874)
+- Version bump [`6ce1b83`](https://github.com/RhetTbull/osxphotos/commit/6ce1b83ca2c7f0c6f9c86757602b81df1d9bf453)
+
+#### [v0.43.6](https://github.com/RhetTbull/osxphotos/compare/v0.43.5...v0.43.6)
+
+> 10 December 2021
+
+- Fixes typo in README [`#548`](https://github.com/RhetTbull/osxphotos/pull/548)
+- docs: add alandefreitas as a contributor for bug [`#551`](https://github.com/RhetTbull/osxphotos/pull/551)
+- docs: add dgleich as a contributor for code [`#541`](https://github.com/RhetTbull/osxphotos/pull/541)
+- Updated docs [`197e566`](https://github.com/RhetTbull/osxphotos/commit/197e5663df058a013ce2d6f8c5fd7ff71a5cc46e)
+- Added test library for Monterey on M1 [`3e038bf`](https://github.com/RhetTbull/osxphotos/commit/3e038bf124b98d6b74f19dd4db0f8f1e3c48e787)
+- Updated docs [skip ci] [`f6dedaa`](https://github.com/RhetTbull/osxphotos/commit/f6dedaa6197dc244616c5b4e9e8ce42ce6b7a252)
+- Added MomentInfo for Photos 5+, #71 [`a52b4d2`](https://github.com/RhetTbull/osxphotos/commit/a52b4d2f43970086bf25659bd58dc8479b841704)
+- Fixed error for missing photo path, #547 [`0906dbe`](https://github.com/RhetTbull/osxphotos/commit/0906dbe6370922b4c9649350014ed8a21d29c4fd)
+
+#### [v0.43.5](https://github.com/RhetTbull/osxphotos/compare/v0.43.4...v0.43.5)
+
+> 25 November 2021
+
+- Updated dependencies for pyobjc 8.0 [`7d92359`](https://github.com/RhetTbull/osxphotos/commit/7d923590ae4df941b1b9d35c21937c03eb7b4284)
+
+#### [v0.43.4](https://github.com/RhetTbull/osxphotos/compare/v0.43.3...v0.43.4)
+
+> 11 November 2021
+
+- Fix for --use-photokit with --skip-live, #537 [`0e6c92d`](https://github.com/RhetTbull/osxphotos/commit/0e6c92dbd951dd0e63cfb8b6d64e6ab96ece5955)
+
+#### [v0.43.3](https://github.com/RhetTbull/osxphotos/compare/v0.43.1...v0.43.3)
+
+> 7 November 2021
+
+- Updated docs [skip ci] [`fb583e2`](https://github.com/RhetTbull/osxphotos/commit/fb583e28e0fc2c23bf24052db8a5ee669d8c92f5)
+- Updated OTL to MTL [`2ffcf1e`](https://github.com/RhetTbull/osxphotos/commit/2ffcf1e82bfc013a4a9e0e7a709a7c1395c074ce)
+- Test fixes for Monterey/M1 [`51ba549`](https://github.com/RhetTbull/osxphotos/commit/51ba54971a874cfce00368aa5be5380b3439c254)
+
+#### [v0.43.1](https://github.com/RhetTbull/osxphotos/compare/v0.43.0...v0.43.1)
+
+> 30 October 2021
+
+- Dependency update for Monterey [`818f4f4`](https://github.com/RhetTbull/osxphotos/commit/818f4f45a4ce520b0ba1c688eabd2f4311be9540)
+- Updated docs [skip ci] [`2cf19f6`](https://github.com/RhetTbull/osxphotos/commit/2cf19f6af1a03767e4d53eee556c4d3ed9af1776)
+
+#### [v0.43.0](https://github.com/RhetTbull/osxphotos/compare/v0.42.94...v0.43.0)
+
+> 28 October 2021
+
+- Updated for Monterey 12.0.1 release [`ef82c6e`](https://github.com/RhetTbull/osxphotos/commit/ef82c6e32b536b0677530133892f95b852c6dce0)
+
+#### [v0.42.94](https://github.com/RhetTbull/osxphotos/compare/v0.42.93...v0.42.94)
+
+> 15 October 2021
+
+- docs: add spencerc99 as a contributor for bug [`#527`](https://github.com/RhetTbull/osxphotos/pull/527)
+- Fix for #526 with --update [`419b34e`](https://github.com/RhetTbull/osxphotos/commit/419b34ea73f15ccbe29f51896e11e9735ea5786b)
+- Updated docs [skip ci] [`0e9b9d6`](https://github.com/RhetTbull/osxphotos/commit/0e9b9d625190b94c1dd68276e3b0e5367002d87c)
+- Fixed FileUtil to use correct import [`f64c4ed`](https://github.com/RhetTbull/osxphotos/commit/f64c4ed374c120a95fe8adea26bd44852ca67e31)
+
+#### [v0.42.93](https://github.com/RhetTbull/osxphotos/compare/v0.42.92...v0.42.93)
+
+> 11 October 2021
+
+- Fix for #526 [`202bc11`](https://github.com/RhetTbull/osxphotos/commit/202bc1144bc842ddec825eef0745830d56170aba)
+- Updated README.md [skip ci] [`a0c654e`](https://github.com/RhetTbull/osxphotos/commit/a0c654e43f4aa5389a96c3c84fd7037c33d23404)
+
+#### [v0.42.92](https://github.com/RhetTbull/osxphotos/compare/v0.42.91...v0.42.92)
+
+> 11 October 2021
+
+- docs: add oPromessa as a contributor for bug [`#525`](https://github.com/RhetTbull/osxphotos/pull/525)
+- Fix for #524 [`04ac0a1`](https://github.com/RhetTbull/osxphotos/commit/04ac0a11215b275178013e60c6a61b9f1b3603c9)
+- Fix for #525 [`d2b0bd4`](https://github.com/RhetTbull/osxphotos/commit/d2b0bd4e28cfdf3c930aa6ae3317549327b0e29c)
+- Updated docs [skip ci] [`2bb677d`](https://github.com/RhetTbull/osxphotos/commit/2bb677dc19abaf254bc66e2cd788676e0613e548)
+
+#### [v0.42.91](https://github.com/RhetTbull/osxphotos/compare/v0.42.90...v0.42.91)
+
+> 11 October 2021
+
+- Updated docs [skip ci] [`b23e74f`](https://github.com/RhetTbull/osxphotos/commit/b23e74f8f5a8387564108c330c3f8ac11189860d)
+- Added python 3.10 to supported versions [`3f81a3c`](https://github.com/RhetTbull/osxphotos/commit/3f81a3c179dde37e9811ef19c847920bb3bd514c)
+- Updated dependencies [`a895833`](https://github.com/RhetTbull/osxphotos/commit/a895833c7f0a264488e671f1735f9e10d2618e2d)
+
+#### [v0.42.90](https://github.com/RhetTbull/osxphotos/compare/v0.42.89...v0.42.90)
+
+> 30 September 2021
+
+- Updated REPL, now with more cowbell [`c472698`](https://github.com/RhetTbull/osxphotos/commit/c472698b1d0d8ff9f4d1bde715859bf766f99290)
+- Updated docs [skip ci] [`1ddb1de`](https://github.com/RhetTbull/osxphotos/commit/1ddb1de99841e65b690ffc1cbcc5e42e6e25f727)
+
+#### [v0.42.89](https://github.com/RhetTbull/osxphotos/compare/v0.42.88...v0.42.89)
+
+> 26 September 2021
+
+- Updated docs [skip ci] [`bfbc156`](https://github.com/RhetTbull/osxphotos/commit/bfbc156821d2d262b7bd9c4437e23e310da10769)
+- Updated docs [skip ci] [`3abaa5a`](https://github.com/RhetTbull/osxphotos/commit/3abaa5ae84ca44cd900f1e3af4532ab405d41a09)
+- Fixed AlbumInfo.owner, #239 [`bfd6274`](https://github.com/RhetTbull/osxphotos/commit/bfd627460255c65f870bca6d036401e8792d29d5)
+
+#### [v0.42.88](https://github.com/RhetTbull/osxphotos/compare/v0.42.87...v0.42.88)
+
+> 26 September 2021
+
+- Performance fix for #239, owner [`14710e3`](https://github.com/RhetTbull/osxphotos/commit/14710e31789d71b2c948a37722fb6054aca4d85e)
+- version bump [`06138e1`](https://github.com/RhetTbull/osxphotos/commit/06138e15d0b87e4865a9ef0cc542303edb44c861)
+
+#### [v0.42.87](https://github.com/RhetTbull/osxphotos/compare/v0.42.86...v0.42.87)
+
+> 26 September 2021
+
+#### [v0.42.86](https://github.com/RhetTbull/osxphotos/compare/v0.42.85...v0.42.86)
+
+> 26 September 2021
+
+- Fix for #517, #239 [`ac47df8`](https://github.com/RhetTbull/osxphotos/commit/ac47df8475762fe8c8f63ad5ffa83b1e20d116b8)
+- Fixed formatting [`6adafb8`](https://github.com/RhetTbull/osxphotos/commit/6adafb8ce70e95a9f0bec1a3db6362742fcd1b0d)
+- Updated docs [skip ci] [`725f7c8`](https://github.com/RhetTbull/osxphotos/commit/725f7c87351353efeee8c43c3c7f8a95acb14490)
+
+#### [v0.42.85](https://github.com/RhetTbull/osxphotos/compare/v0.42.84...v0.42.85)
+
+> 25 September 2021
+
+- Implemented PhotoInfo.owner, AlbumInfo.owner, #216, #239 [`c4b7c26`](https://github.com/RhetTbull/osxphotos/commit/c4b7c2623f077d9964d5d578ce6c01bb83fab088)
+- Updated docs [skip ci] [`59ba325`](https://github.com/RhetTbull/osxphotos/commit/59ba325273b2f16935be944fd46c1237ce637bb8)
+
+#### [v0.42.84](https://github.com/RhetTbull/osxphotos/compare/v0.42.83...v0.42.84)
+
+> 25 September 2021
+
+- Fix for #516 [`e3e1da2`](https://github.com/RhetTbull/osxphotos/commit/e3e1da2fd898896595fc851288f905bd4e2150f8)
+- Updated docs [skip ci] [`64c226b`](https://github.com/RhetTbull/osxphotos/commit/64c226b85529581e393a2d0604b41c37a8dc2eaf)
+- Update docs [`c429a86`](https://github.com/RhetTbull/osxphotos/commit/c429a860b1ebeb77f3c3e36e9660fc9153d85d11)
+
+#### [v0.42.83](https://github.com/RhetTbull/osxphotos/compare/v0.42.82...v0.42.83)
+
+> 15 September 2021
+
+- Fixed detected_text to use image orientation if available [`dd08c7f`](https://github.com/RhetTbull/osxphotos/commit/dd08c7f701335a7e1e30fda251e6ad20ff781652)
+- Added twine [`16335a6`](https://github.com/RhetTbull/osxphotos/commit/16335a6bd66eaa53fd1c390901e2fb028059d8e1)
+- Added wheel [`e0f6d8e`](https://github.com/RhetTbull/osxphotos/commit/e0f6d8ecf27fe772b748c7b2f3108558fbc23e8a)
+
+#### [v0.42.82](https://github.com/RhetTbull/osxphotos/compare/v0.42.80...v0.42.82)
+
+> 14 September 2021
+
+- Fix for #515 [`93bf0c2`](https://github.com/RhetTbull/osxphotos/commit/93bf0c210cf01f351611427662025c86955ac373)
+- Fix for #515, updated tests [`59c31ff`](https://github.com/RhetTbull/osxphotos/commit/59c31ff88d099b251cf1b571279d7a28a0aac138)
+- Updated docs [`773dca8`](https://github.com/RhetTbull/osxphotos/commit/773dca849424c61a7447cb1bb87140708ab0a07c)
+
+#### [v0.42.80](https://github.com/RhetTbull/osxphotos/compare/v0.42.79...v0.42.80)
+
+> 29 August 2021
+
+- Bug fix for null title, #512 [`6bcc676`](https://github.com/RhetTbull/osxphotos/commit/6bcc67634ca50e84494539b8a25eb7925dcede62)
+- Updated dependencies [`2eb6e70`](https://github.com/RhetTbull/osxphotos/commit/2eb6e70e57ff1dc79907a29618757953f5871145)
+- Updated README [skip ci] [`81dd1a7`](https://github.com/RhetTbull/osxphotos/commit/81dd1a753062dacc83aaf4ce8a7667de2cda599b)
+
+#### [v0.42.79](https://github.com/RhetTbull/osxphotos/compare/v0.42.78...v0.42.79)
+
+> 29 August 2021
+
+#### [v0.42.78](https://github.com/RhetTbull/osxphotos/compare/v0.42.77...v0.42.78)
+
+> 29 August 2021
+
+- docs: add dssinger as a contributor for bug [`#514`](https://github.com/RhetTbull/osxphotos/pull/514)
+- Fix for newlines in exif tags, #513 [`f0d7496`](https://github.com/RhetTbull/osxphotos/commit/f0d7496bc66aae291337efc570a2e2c4b9b5529c)
+
+#### [v0.42.77](https://github.com/RhetTbull/osxphotos/compare/v0.42.74...v0.42.77)
+
+> 28 August 2021
+
+- Fixed --strip behavior, #511 [`dbb4dbc`](https://github.com/RhetTbull/osxphotos/commit/dbb4dbc0a7f7cb590ab3b2ce532c5c618c7fc249)
+- Update test for #506 [`f1cea14`](https://github.com/RhetTbull/osxphotos/commit/f1cea1498b3b973aa500d874126b9668a8743f1f)
+- Added {strip} template [`159d110`](https://github.com/RhetTbull/osxphotos/commit/159d1102aabd56def2caf6754747f7a4caa7d374)
+
+#### [v0.42.74](https://github.com/RhetTbull/osxphotos/compare/v0.42.73...v0.42.74)
+
+> 23 August 2021
+
+- Fix for #506 [`db5b34d`](https://github.com/RhetTbull/osxphotos/commit/db5b34d58950c65f95d22a0e81390b9d4fb7ccd7)
+- Updated README [skip ci] [`fb4138c`](https://github.com/RhetTbull/osxphotos/commit/fb4138cfe6cfad02fead821b70b4b84d11b027e9)
+
+#### [v0.42.73](https://github.com/RhetTbull/osxphotos/compare/v0.42.72...v0.42.73)
+
+> 15 August 2021
+
+- Added inspect() to repl, closes #501 [`#501`](https://github.com/RhetTbull/osxphotos/issues/501)
+- Updated docs for Text Detection [skip ci] [`c2b2476`](https://github.com/RhetTbull/osxphotos/commit/c2b2476e385fcd3773bd8abb942e788be2af8169)
+- Updated README.md [skip ci] [`2041789`](https://github.com/RhetTbull/osxphotos/commit/2041789ff4a3979a73712b27a51a77e8a880efb8)
+
+#### [v0.42.72](https://github.com/RhetTbull/osxphotos/compare/v0.42.71...v0.42.72)
+
+> 2 August 2021
+
+- Improved caching of detected_text results [`fa2027d`](https://github.com/RhetTbull/osxphotos/commit/fa2027d45308738d2335d4b5a72c3ef5c478491a)
+
+#### [v0.42.71](https://github.com/RhetTbull/osxphotos/compare/v0.42.70...v0.42.71)
+
+> 29 July 2021
+
+- Updated text_detection to detect macOS version [`7376223`](https://github.com/RhetTbull/osxphotos/commit/7376223eb87a4919fd54cc685a3f263e83626879)
+- Updated detected_text docs to make it clear this only works on Catalina+ [`ecd0b8e`](https://github.com/RhetTbull/osxphotos/commit/ecd0b8e22f8bf1f8d1e98d64834bebf0394dd903)
+- Fix for #500, check for macOS version before loading Vision [`673243c`](https://github.com/RhetTbull/osxphotos/commit/673243c6cd1c267b6b741b5429cdb63c062648d1)
+
+#### [v0.42.70](https://github.com/RhetTbull/osxphotos/compare/v0.42.69...v0.42.70)
+
+> 29 July 2021
+
+- Added error logging to {detected_text} processing, #499 [`b1c0fb3`](https://github.com/RhetTbull/osxphotos/commit/b1c0fb3e8284600394ddbfdd7dfa94916a843c81)
+- Updated README.md [skip ci] [`1ee3e03`](https://github.com/RhetTbull/osxphotos/commit/1ee3e035c42d687158f7cf73382f0f263516dc37)
+- Removed unneeded test file [skip ci] [`607cf80`](https://github.com/RhetTbull/osxphotos/commit/607cf80dda37ad529edd91fe92af3885b04b9a37)
+
+#### [v0.42.69](https://github.com/RhetTbull/osxphotos/compare/v0.42.67...v0.42.69)
+
+> 28 July 2021
+
+- Added {detected_text} template [`c233523`](https://github.com/RhetTbull/osxphotos/commit/c2335236be7a1eecf4f25a9dcb844df4d6372b5c)
+- Added PhotoInfo.detected_text() [`123340e`](https://github.com/RhetTbull/osxphotos/commit/123340eadabb0fb07209c4207ccad13a53de3619)
+- Updated dependencies [`0c8fbd6`](https://github.com/RhetTbull/osxphotos/commit/0c8fbd69af7a0d696de5224bf3c302e0c240905f)
+
+#### [v0.42.67](https://github.com/RhetTbull/osxphotos/compare/v0.42.66...v0.42.67)
+
+> 24 July 2021
+
+- Added {album_seq} and {folder_album_seq}, #496 [`12f39db`](https://github.com/RhetTbull/osxphotos/commit/12f39dbaf520ad767e3da667257ce00af60fdd7e)
+- Fixed {album_seq} and {folder_album_seq} help text [`077d577`](https://github.com/RhetTbull/osxphotos/commit/077d577c9890c4840a60c3e450dcd4167aa669ea)
+
+#### [v0.42.66](https://github.com/RhetTbull/osxphotos/compare/v0.42.65...v0.42.66)
+
+> 23 July 2021
+
+- Updated docs [`666b6ca`](https://github.com/RhetTbull/osxphotos/commit/666b6cac33fb8a2d0fc602609f11e190e11c538f)
+- Added {id} sequence number template, #154 [`e95c096`](https://github.com/RhetTbull/osxphotos/commit/e95c0967846106f6da2adaa0b85520df8b351bb0)
+- Updated example [skip ci] [`8216c33`](https://github.com/RhetTbull/osxphotos/commit/8216c33b596dba35007168cda4e8de34d9f4b2ea)
+
+#### [v0.42.65](https://github.com/RhetTbull/osxphotos/compare/v0.42.64...v0.42.65)
+
+> 20 July 2021
+
+- Fixed album sort order for custom sort, #497 [`e27c40c`](https://github.com/RhetTbull/osxphotos/commit/e27c40c7724dc47a7c95d1a417808c2b1f13adb0)
+- Updated test data [`a05e7be`](https://github.com/RhetTbull/osxphotos/commit/a05e7be14e080af0cef80831c3ff7fa0a897a1b2)
+- Updated example [skip ci] [`6f4cab6`](https://github.com/RhetTbull/osxphotos/commit/6f4cab6721ca3091031d8010e29d959e3afdecb2)
+
+#### [v0.42.64](https://github.com/RhetTbull/osxphotos/compare/v0.42.63...v0.42.64)
+
+> 18 July 2021
+
+- Pass dest_path to template function via RenderOptions, enable implementation of #496 [`2d899ef`](https://github.com/RhetTbull/osxphotos/commit/2d899ef0453c0800ff9b9d374b2b7db0948688fe)
+
+#### [v0.42.63](https://github.com/RhetTbull/osxphotos/compare/v0.42.62...v0.42.63)
+
+> 18 July 2021
+
+- Added album_sort_order example [`b04ea81`](https://github.com/RhetTbull/osxphotos/commit/b04ea8174d049d9f3783aac6bbc397ed71584965)
+- Updated README.md [skip ci] [`88099de`](https://github.com/RhetTbull/osxphotos/commit/88099de688bcb6a1ddcad6c340833f1627aff268)
+- Added RenderOptions to {function} template, #496 [`173a0fc`](https://github.com/RhetTbull/osxphotos/commit/173a0fce28e91177dec114d0dba001adfb76834a)
+
+#### [v0.42.62](https://github.com/RhetTbull/osxphotos/compare/v0.42.61...v0.42.62)
+
+> 16 July 2021
+
+- Upgraded osxmetadata to add new extended attributes [`7d81b94`](https://github.com/RhetTbull/osxphotos/commit/7d81b94c16623d11312aaf1b0c47fb580d01bc66)
+- Updated tutorial with --regex example [skip ci] [`bf208bb`](https://github.com/RhetTbull/osxphotos/commit/bf208bbe4b965a2d39fc1836335b7b65f402af30)
+- Update README.md [`d627cfc`](https://github.com/RhetTbull/osxphotos/commit/d627cfc4fa22497769babc3d686393c6043d1f37)
+
+#### [v0.42.61](https://github.com/RhetTbull/osxphotos/compare/v0.42.60...v0.42.61)
+
+> 7 July 2021
+
+- Added --selected, closes #489 [`#489`](https://github.com/RhetTbull/osxphotos/issues/489)
+
+#### [v0.42.60](https://github.com/RhetTbull/osxphotos/compare/v0.42.59...v0.42.60)
+
+> 6 July 2021
+
+- docs: add mkirkland4874 as a contributor for example [`#492`](https://github.com/RhetTbull/osxphotos/pull/492)
+- Updated README.md [skip ci], closes #488 [`#488`](https://github.com/RhetTbull/osxphotos/issues/488)
+- Added example for {function} template [`016297d`](https://github.com/RhetTbull/osxphotos/commit/016297d2ffcf2e8db0d659ccfe7411ecff3dd41b)
+- Fixed cleanup to delete empty folders, #491 [`1bf11b0`](https://github.com/RhetTbull/osxphotos/commit/1bf11b0414a7fcf785c792b98f6231821bdad4d4)
+
+#### [v0.42.59](https://github.com/RhetTbull/osxphotos/compare/v0.42.58...v0.42.59)
+
+> 4 July 2021
+
+- Re-enabled try/except in cli export [`d497b94`](https://github.com/RhetTbull/osxphotos/commit/d497b94ad506bf6cf044bbabe7fcbf4ab9d5b9e7)
+- Added test for try/except block in cli export [`2e32d62`](https://github.com/RhetTbull/osxphotos/commit/2e32d62237f59b16a9be422104347d6a1332865c)
+
+#### [v0.42.58](https://github.com/RhetTbull/osxphotos/compare/v0.42.57...v0.42.58)
+
+> 4 July 2021
+
+- Added --preview-if-missing, #446 [`632169f`](https://github.com/RhetTbull/osxphotos/commit/632169f2774558ef8487eb7fb9323aecbadedd88)
+
+#### [v0.42.57](https://github.com/RhetTbull/osxphotos/compare/v0.42.54...v0.42.57)
+
+> 4 July 2021
+
+- Refactored export2, #485, #486 [`28c681a`](https://github.com/RhetTbull/osxphotos/commit/28c681aa96874588bc59335b2a0db3b8be6eabaa)
+- Added --preview, #470 [`7e2d09b`](https://github.com/RhetTbull/osxphotos/commit/7e2d09bf123428c09a669d8d581e1a35e374273d)
+- Fixed path_derivatives to always return jpeg if photo is a photo [`b4dbad5`](https://github.com/RhetTbull/osxphotos/commit/b4dbad5e7451447480699105fb62b157dce8195d)
+
+#### [v0.42.54](https://github.com/RhetTbull/osxphotos/compare/v0.42.52...v0.42.54)
+
+> 2 July 2021
+
+- Removed _applescript, #461 [`1d26ac9`](https://github.com/RhetTbull/osxphotos/commit/1d26ac9630dd0a414c01cc4f89a080e4efd7fd97)
+- Removed _applescript, #461 [`03b4f59`](https://github.com/RhetTbull/osxphotos/commit/03b4f59549de54da91c36feba613d69f9e86e47b)
+- Added get_selected() to REPL [`2e1c91c`](https://github.com/RhetTbull/osxphotos/commit/2e1c91cd672eefe84063933437e5d691f5ad1db1)
+
+#### [v0.42.52](https://github.com/RhetTbull/osxphotos/compare/v0.42.51...v0.42.52)
+
+> 2 July 2021
+
+- docs: add jcommisso07 as a contributor for data [`#483`](https://github.com/RhetTbull/osxphotos/pull/483)
+- docs: add mkirkland4874 as a contributor for bug [`#482`](https://github.com/RhetTbull/osxphotos/pull/482)
+- Fix for path_raw when file is reference, #480 [`4cc3220`](https://github.com/RhetTbull/osxphotos/commit/4cc322028790b3beefce42af5e35c23976b1a35a)
+- Updated README.md [skip ci] [`6339e3c`](https://github.com/RhetTbull/osxphotos/commit/6339e3c70ee174394af356710de4bf9442bad9fc)
+
 #### [v0.42.51](https://github.com/RhetTbull/osxphotos/compare/v0.42.46...v0.42.51)
 
 > 30 June 2021

MANIFEST.in

@@ -1,5 +1,7 @@
-include README.md
-include README.rst
-include osxphotos/templates/*
+include osxphotos/*.json
+include osxphotos/*.md
 include osxphotos/phototemplate.tx
-include osxphotos/phototemplate.md
+include osxphotos/queries/*
+include osxphotos/templates/*
+include README.md
+include README.rst

README.rst

@@ -23,7 +23,7 @@ If you have access to macOS 12 / Monterey beta and would like to help ensure osx
 This package will read Photos databases for any supported version on any supported macOS version.  
 E.g. you can read a database created with Photos 5.0 on MacOS 10.15 on a machine running macOS 10.12 and vice versa.
 
-Requires python >= ``3.7``. 
+Requires python >= ``3.8``. 
 
 Installation
 ------------

build.sh

@@ -3,9 +3,10 @@
 # script to help build osxphotos release
 # this is unique to my own dev setup
 
-activate osxphotos
+# source venv/bin/activate
 rm -rf dist; rm -rf build
 python3 utils/update_readme.py
 (cd docsrc && make github && make pdf)
-python3 setup.py sdist bdist_wheel
-./make_cli_exe.sh
+# python3 setup.py sdist bdist_wheel
+python3 -m build
+./make_cli_exe.sh

cli.py

@@ -12,7 +12,7 @@
     
 """
 
-from osxphotos.cli import cli
+from osxphotos.cli.cli import cli_main
 
 if __name__ == "__main__":
-    cli()
+    cli_main()

dev_requirements.txt

@@ -1,7 +1,12 @@
-pytest==6.2.4
-pytest-mock==3.6.1
-Sphinx==4.0.2
-sphinx-rtd-theme==0.5.2
-wheel==0.36.2
-twine==3.4.1
-pyinstaller==4.3
+build
+m2r2
+pdbpp
+pyinstaller==4.4
+pytest-mock
+pytest==7.0.1
+Sphinx
+sphinx_click
+sphinx_rtd_theme
+sphinxcontrib-programoutput
+twine
+wheel

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: 210ecd9d654dea5d4c21627449ca1d63
+config: bc3dce8a14bcd1b0c8a34e4d16f0011f
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -5,10 +5,10 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; osxphotos 0.42.20 documentation</title>
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
-    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <title>Overview: module code &#8212; osxphotos 0.47.1 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>
     <script src="../_static/jquery.js"></script>
     <script src="../_static/underscore.js"></script>
     <script src="../_static/doctools.js"></script>
@@ -31,7 +31,7 @@
           <div class="body" role="main">
             
   <h1>All modules for which code is available</h1>
-<ul><li><a href="osxphotos/photoinfo/photoinfo.html">osxphotos.photoinfo.photoinfo</a></li>
+<ul><li><a href="osxphotos/photoinfo.html">osxphotos.photoinfo</a></li>
 <li><a href="osxphotos/photosdb/photosdb.html">osxphotos.photosdb.photosdb</a></li>
 </ul>
 
@@ -67,7 +67,7 @@
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
@@ -89,7 +89,7 @@
       &copy;2021, Rhet Turnbull.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
       
     </div>

docs/_sources/cli.rst.txt

@@ -3,4 +3,6 @@ osxphotos command line interface (CLI)
 
 .. click:: osxphotos.cli:cli
    :prog: osxphotos
-   :nested: full
+   :nested: full
+
+.. program-output:: python3 -m osxphotos --help

docs/_static/basic.css

@@ -130,7 +130,7 @@ ul.search li a {
     font-weight: bold;
 }
 
-ul.search li div.context {
+ul.search li p.context {
     color: #888;
     margin: 2px 0 0 30px;
     text-align: left;
@@ -277,25 +277,25 @@ p.rubric {
     font-weight: bold;
 }
 
-img.align-left, .figure.align-left, object.align-left {
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
     clear: left;
     float: left;
     margin-right: 1em;
 }
 
-img.align-right, .figure.align-right, object.align-right {
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
     clear: right;
     float: right;
     margin-left: 1em;
 }
 
-img.align-center, .figure.align-center, object.align-center {
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
   display: block;
   margin-left: auto;
   margin-right: auto;
 }
 
-img.align-default, .figure.align-default {
+img.align-default, figure.align-default, .figure.align-default {
   display: block;
   margin-left: auto;
   margin-right: auto;
@@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
 
 /* -- sidebars -------------------------------------------------------------- */
 
-div.sidebar {
+div.sidebar,
+aside.sidebar {
     margin: 0 0 0.5em 1em;
     border: 1px solid #ddb;
     padding: 7px;
@@ -377,12 +378,14 @@ div.body p.centered {
 /* -- content of sidebars/topics/admonitions -------------------------------- */
 
 div.sidebar > :last-child,
+aside.sidebar > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
+aside.sidebar::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -455,20 +458,22 @@ td > :last-child {
 
 /* -- figures --------------------------------------------------------------- */
 
-div.figure {
+div.figure, figure {
     margin: 0.5em;
     padding: 0.5em;
 }
 
-div.figure p.caption {
+div.figure p.caption, figcaption {
     padding: 0.3em;
 }
 
-div.figure p.caption span.caption-number {
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
     font-style: italic;
 }
 
-div.figure p.caption span.caption-text {
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
 }
 
 /* -- field list styles ----------------------------------------------------- */
@@ -503,6 +508,63 @@ table.hlist td {
     vertical-align: top;
 }
 
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
 
 /* -- other body styles ----------------------------------------------------- */
 
@@ -629,14 +691,6 @@ dl.glossary dt {
     font-size: 1.1em;
 }
 
-.optional {
-    font-size: 1.3em;
-}
-
-.sig-paren {
-    font-size: larger;
-}
-
 .versionmodified {
     font-style: italic;
 }
@@ -677,8 +731,9 @@ dl.glossary dt {
 
 .classifier:before {
     font-style: normal;
-    margin: 0.5em;
+    margin: 0 0.5em;
     content: ":";
+    display: inline-block;
 }
 
 abbr, acronym {
@@ -765,8 +820,12 @@ div.code-block-caption code {
 
 table.highlighttable td.linenos,
 span.linenos,
-div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
-    user-select: none;
+div.highlight span.gp {  /* gp: Generic.Prompt */
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
 }
 
 div.code-block-caption span.caption-number {
@@ -781,16 +840,6 @@ div.literal-block-wrapper {
     margin: 1em 0;
 }
 
-code.descname {
-    background-color: transparent;
-    font-weight: bold;
-    font-size: 1.2em;
-}
-
-code.descclassname {
-    background-color: transparent;
-}
-
 code.xref, a code {
     background-color: transparent;
     font-weight: bold;

docs/_static/doctools.js

@@ -301,12 +301,14 @@ var Documentation = {
               window.location.href = prevHref;
               return false;
             }
+            break;
           case 39: // right
             var nextHref = $('link[rel="next"]').prop('href');
             if (nextHref) {
               window.location.href = nextHref;
               return false;
             }
+            break;
         }
       }
     });

docs/_static/documentation_options.js

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

docs/_static/searchtools.js

@@ -282,7 +282,10 @@ var Search = {
                   complete: function(jqxhr, textstatus) {
                     var data = jqxhr.responseText;
                     if (data !== '' && data !== undefined) {
-                      listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
+                      var summary = Search.makeSearchSummary(data, searchterms, hlterms);
+                      if (summary) {
+                        listItem.append(summary);
+                      }
                     }
                     Search.output.append(listItem);
                     setTimeout(function() {
@@ -325,7 +328,9 @@ var Search = {
     var results = [];
 
     for (var prefix in objects) {
-      for (var name in objects[prefix]) {
+      for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
+        var match = objects[prefix][iMatch];
+        var name = match[4];
         var fullname = (prefix ? prefix + '.' : '') + name;
         var fullnameLower = fullname.toLowerCase()
         if (fullnameLower.indexOf(object) > -1) {
@@ -339,7 +344,6 @@ var Search = {
           } else if (parts[parts.length - 1].indexOf(object) > -1) {
             score += Scorer.objPartialMatch;
           }
-          var match = objects[prefix][name];
           var objname = objnames[match[1]][2];
           var title = titles[match[0]];
           // If more than one term searched for, we require other words to be
@@ -498,6 +502,9 @@ var Search = {
    */
   makeSearchSummary : function(htmlText, keywords, hlwords) {
     var text = Search.htmlToText(htmlText);
+    if (text == "") {
+      return null;
+    }
     var textLower = text.toLowerCase();
     var start = 0;
     $.each(keywords, function() {
@@ -509,7 +516,7 @@ var Search = {
     var excerpt = ((start > 0) ? '...' : '') +
       $.trim(text.substr(start, 240)) +
       ((start + 240 - text.length) ? '...' : '');
-    var rv = $('<div class="context"></div>').text(excerpt);
+    var rv = $('<p class="context"></p>').text(excerpt);
     $.each(hlwords, function() {
       rv = rv.highlightText(this, 'highlighted');
     });

docs/index.html

@@ -4,11 +4,12 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Welcome to osxphotos’s documentation! &#8212; osxphotos 0.42.20 documentation</title>
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+    <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.47.1 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>
     <script src="_static/jquery.js"></script>
     <script src="_static/underscore.js"></script>
     <script src="_static/doctools.js"></script>
@@ -31,30 +32,30 @@
 
           <div class="body" role="main">
             
-  <div class="section" id="welcome-to-osxphotos-s-documentation">
+  <section id="welcome-to-osxphotos-s-documentation">
 <h1>Welcome to osxphotos’s documentation!<a class="headerlink" href="#welcome-to-osxphotos-s-documentation" title="Permalink to this headline">¶</a></h1>
-</div>
-<div class="section" id="osxphotos">
+</section>
+<section id="osxphotos">
 <h1>OSXPhotos<a class="headerlink" href="#osxphotos" title="Permalink to this headline">¶</a></h1>
-<div class="section" id="what-is-osxphotos">
+<section id="what-is-osxphotos">
 <h2>What is osxphotos?<a class="headerlink" href="#what-is-osxphotos" title="Permalink to this headline">¶</a></h2>
 <p>OSXPhotos provides both the ability to interact with and query Apple’s Photos.app library on macOS directly from your python code
 as well as a very flexible command line interface (CLI) app for exporting photos.
 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.</p>
-</div>
-<div class="section" id="supported-operating-systems">
+</section>
+<section id="supported-operating-systems">
 <h2>Supported operating systems<a class="headerlink" href="#supported-operating-systems" title="Permalink to this headline">¶</a></h2>
-<p>Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) until macOS Catalina (10.15.7).
-Beta support for macOS Big Sur (10.16.01/11.01).</p>
+<p>Only works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) through macOS Big Sur (11.3).</p>
+<p>If you have access to macOS 12 / Monterey beta and would like to help ensure osxphotos is compatible, please contact me via GitHub.</p>
 <p>This package will read Photos databases for any supported version on any supported macOS version.
 E.g. you can read a database created with Photos 5.0 on MacOS 10.15 on a machine running macOS 10.12 and vice versa.</p>
-<p>Requires python &gt;= <code class="docutils literal notranslate"><span class="pre">3.7</span></code>.</p>
-</div>
-<div class="section" id="installation">
+<p>Requires python &gt;= <code class="docutils literal notranslate"><span class="pre">3.8</span></code>.</p>
+</section>
+<section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
 <p>If you are new to python and just want to use the command line application, I recommend you to install using pipx. See other advanced options below.</p>
-<div class="section" id="installation-using-pipx">
+<section id="installation-using-pipx">
 <h3>Installation using pipx<a class="headerlink" href="#installation-using-pipx" title="Permalink to this headline">¶</a></h3>
 <p>If you aren’t familiar with installing python applications, I recommend you install <code class="docutils literal notranslate"><span class="pre">osxphotos</span></code> with <a class="reference external" href="https://github.com/pipxproject/pipx">pipx</a>. If you use <code class="docutils literal notranslate"><span class="pre">pipx</span></code>, you will not need to create a virtual environment as <code class="docutils literal notranslate"><span class="pre">pipx</span></code> takes care of this. The easiest way to do this on a Mac is to use <a class="reference external" href="https://brew.sh/">homebrew</a>:</p>
 <ul class="simple">
@@ -64,15 +65,15 @@ E.g. you can read a database created with Photos 5.0 on MacOS 10.15 on a machine
 <li><p>Then type this: <code class="docutils literal notranslate"><span class="pre">pipx</span> <span class="pre">install</span> <span class="pre">osxphotos</span></code></p></li>
 <li><p>Now you should be able to run <code class="docutils literal notranslate"><span class="pre">osxphotos</span></code> by typing: <code class="docutils literal notranslate"><span class="pre">osxphotos</span></code></p></li>
 </ul>
-</div>
-<div class="section" id="installation-using-pip">
+</section>
+<section id="installation-using-pip">
 <h3>Installation using pip<a class="headerlink" href="#installation-using-pip" title="Permalink to this headline">¶</a></h3>
 <p>You can also install directly from <a class="reference external" href="https://pypi.org/project/osxphotos/">pypi</a>:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">osxphotos</span>
 </pre></div>
 </div>
-</div>
-<div class="section" id="installation-from-git-repository">
+</section>
+<section id="installation-from-git-repository">
 <h3>Installation from git repository<a class="headerlink" href="#installation-from-git-repository" title="Permalink to this headline">¶</a></h3>
 <p>OSXPhotos uses setuptools, thus simply run:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">RhetTbull</span><span class="o">/</span><span class="n">osxphotos</span><span class="o">.</span><span class="n">git</span>
@@ -87,9 +88,9 @@ I recommend you install the latest version from <a class="reference external" hr
 libraries. If you just want to use the command line utility, you can download a pre-built executable of the latest
 <a class="reference external" href="https://github.com/RhetTbull/osxphotos/releases">release</a> or you can install via <code class="docutils literal notranslate"><span class="pre">pip</span></code> which also installs the command line app.
 If you aren’t comfortable with running python on your Mac, start with the pre-built executable or <code class="docutils literal notranslate"><span class="pre">pipx</span></code> as described above.</p>
-</div>
-</div>
-<div class="section" id="command-line-usage">
+</section>
+</section>
+<section id="command-line-usage">
 <h2>Command Line Usage<a class="headerlink" href="#command-line-usage" title="Permalink to this headline">¶</a></h2>
 <p>This package will install a command line utility called <code class="docutils literal notranslate"><span class="pre">osxphotos</span></code> that allows you to query the Photos database and export photos.
 Alternatively, you can also run the command line utility like this: <code class="docutils literal notranslate"><span class="pre">python3</span> <span class="pre">-m</span> <span class="pre">osxphotos</span></code></p>
@@ -122,41 +123,43 @@ Alternatively, you can also run the command line utility like this: <code class=
   <span class="n">persons</span>   <span class="n">Print</span> <span class="n">out</span> <span class="n">persons</span> <span class="p">(</span><span class="n">faces</span><span class="p">)</span> <span class="n">found</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">Photos</span> <span class="n">library</span><span class="o">.</span>
   <span class="n">places</span>    <span class="n">Print</span> <span class="n">out</span> <span class="n">places</span> <span class="n">found</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">Photos</span> <span class="n">library</span><span class="o">.</span>
   <span class="n">query</span>     <span class="n">Query</span> <span class="n">the</span> <span class="n">Photos</span> <span class="n">database</span> <span class="n">using</span> <span class="mi">1</span> <span class="ow">or</span> <span class="n">more</span> <span class="n">search</span> <span class="n">options</span><span class="p">;</span> <span class="k">if</span><span class="o">...</span>
+  <span class="n">repl</span>      <span class="n">Run</span> <span class="n">interactive</span> <span class="n">osxphotos</span> <span class="n">shell</span>
+  <span class="n">tutorial</span>  <span class="n">Display</span> <span class="n">osxphotos</span> <span class="n">tutorial</span><span class="o">.</span>
 </pre></div>
 </div>
 <p>To get help on a specific command, use <code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">help</span> <span class="pre">&lt;command_name&gt;</span></code></p>
-<div class="section" id="command-line-examples">
+<section id="command-line-examples">
 <h3>Command line examples<a class="headerlink" href="#command-line-examples" title="Permalink to this headline">¶</a></h3>
-<div class="section" id="export-all-photos-to-desktop-export-group-in-folders-by-date-created">
+<section id="export-all-photos-to-desktop-export-group-in-folders-by-date-created">
 <h4>export all photos to ~/Desktop/export group in folders by date created<a class="headerlink" href="#export-all-photos-to-desktop-export-group-in-folders-by-date-created" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">--export-by-date</span> <span class="pre">~/Pictures/Photos\</span> <span class="pre">Library.photoslibrary</span> <span class="pre">~/Desktop/export</span></code></p>
 <p><strong>Note</strong>: Photos library/database path can also be specified using <code class="docutils literal notranslate"><span class="pre">--db</span></code> option:</p>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">--export-by-date</span> <span class="pre">--db</span> <span class="pre">~/Pictures/Photos\</span> <span class="pre">Library.photoslibrary</span> <span class="pre">~/Desktop/export</span></code></p>
-</div>
-<div class="section" id="find-all-photos-with-keyword-kids-and-output-results-to-json-file-named-results-json">
+</section>
+<section id="find-all-photos-with-keyword-kids-and-output-results-to-json-file-named-results-json">
 <h4>find all photos with keyword “Kids” and output results to json file named results.json:<a class="headerlink" href="#find-all-photos-with-keyword-kids-and-output-results-to-json-file-named-results-json" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">query</span> <span class="pre">--keyword</span> <span class="pre">Kids</span> <span class="pre">--json</span> <span class="pre">~/Pictures/Photos\</span> <span class="pre">Library.photoslibrary</span> <span class="pre">&gt;results.json</span></code></p>
-</div>
-<div class="section" id="export-photos-to-file-structure-based-on-4-digit-year-and-full-name-of-month-of-photo-s-creation-date">
+</section>
+<section id="export-photos-to-file-structure-based-on-4-digit-year-and-full-name-of-month-of-photo-s-creation-date">
 <h4>export photos to file structure based on 4-digit year and full name of month of photo’s creation date:<a class="headerlink" href="#export-photos-to-file-structure-based-on-4-digit-year-and-full-name-of-month-of-photo-s-creation-date" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">~/Desktop/export</span> <span class="pre">--directory</span> <span class="pre">&quot;{created.year}/{created.month}&quot;</span></code></p>
 <p>(by default, it will attempt to use the system library)</p>
-</div>
-<div class="section" id="export-photos-to-file-structure-based-on-4-digit-year-of-photo-s-creation-date-and-add-keywords-for-media-type-and-labels-labels-are-only-awailable-on-photos-5-and-higher">
+</section>
+<section id="export-photos-to-file-structure-based-on-4-digit-year-of-photo-s-creation-date-and-add-keywords-for-media-type-and-labels-labels-are-only-awailable-on-photos-5-and-higher">
 <h4>export photos to file structure based on 4-digit year of photo’s creation date and add keywords for media type and labels (labels are only awailable on Photos 5 and higher):<a class="headerlink" href="#export-photos-to-file-structure-based-on-4-digit-year-of-photo-s-creation-date-and-add-keywords-for-media-type-and-labels-labels-are-only-awailable-on-photos-5-and-higher" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">~/Desktop/export</span> <span class="pre">--directory</span> <span class="pre">&quot;{created.year}&quot;</span> <span class="pre">--keyword-template</span> <span class="pre">&quot;{label}&quot;</span> <span class="pre">--keyword-template</span> <span class="pre">&quot;{media_type}&quot;</span></code></p>
-</div>
-<div class="section" id="export-default-library-using-country-name-year-as-output-directory-but-use-nocountry-year-if-country-not-specified-add-persons-album-names-and-year-as-keywords-write-exif-metadata-to-files-when-exporting-update-only-changed-files-print-verbose-ouput">
+</section>
+<section id="export-default-library-using-country-name-year-as-output-directory-but-use-nocountry-year-if-country-not-specified-add-persons-album-names-and-year-as-keywords-write-exif-metadata-to-files-when-exporting-update-only-changed-files-print-verbose-ouput">
 <h4>export default library using ‘country name/year’ as output directory (but use “NoCountry/year” if country not specified), add persons, album names, and year as keywords, write exif metadata to files when exporting, update only changed files, print verbose ouput<a class="headerlink" href="#export-default-library-using-country-name-year-as-output-directory-but-use-nocountry-year-if-country-not-specified-add-persons-album-names-and-year-as-keywords-write-exif-metadata-to-files-when-exporting-update-only-changed-files-print-verbose-ouput" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">export</span> <span class="pre">~/Desktop/export</span> <span class="pre">--directory</span> <span class="pre">&quot;{place.name.country,NoCountry}/{created.year}&quot;</span>&#160; <span class="pre">--person-keyword</span> <span class="pre">--album-keyword</span> <span class="pre">--keyword-template</span> <span class="pre">&quot;{created.year}&quot;</span> <span class="pre">--exiftool</span> <span class="pre">--update</span> <span class="pre">--verbose</span></code></p>
-</div>
-<div class="section" id="find-all-videos-larger-than-200mb-and-add-them-to-photos-album-big-videos-creating-the-album-if-necessary">
+</section>
+<section id="find-all-videos-larger-than-200mb-and-add-them-to-photos-album-big-videos-creating-the-album-if-necessary">
 <h4>find all videos larger than 200MB and add them to Photos album “Big Videos” creating the album if necessary<a class="headerlink" href="#find-all-videos-larger-than-200mb-and-add-them-to-photos-album-big-videos-creating-the-album-if-necessary" title="Permalink to this headline">¶</a></h4>
 <p><code class="docutils literal notranslate"><span class="pre">osxphotos</span> <span class="pre">query</span> <span class="pre">--only-movies</span> <span class="pre">--min-size</span> <span class="pre">200MB</span> <span class="pre">--add-to-album</span> <span class="pre">&quot;Big</span> <span class="pre">Videos&quot;</span></code></p>
-</div>
-</div>
-</div>
-<div class="section" id="example-uses-of-the-package">
+</section>
+</section>
+</section>
+<section id="example-uses-of-the-package">
 <h2>Example uses of the package<a class="headerlink" href="#example-uses-of-the-package" title="Permalink to this headline">¶</a></h2>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="sd">&quot;&quot;&quot; Simple usage of the package &quot;&quot;&quot;</span>
 <span class="kn">import</span> <span class="nn">osxphotos</span>
@@ -272,46 +275,29 @@ Alternatively, you can also run the command line utility like this: <code class=
     <span class="n">export</span><span class="p">()</span>  <span class="c1"># pylint: disable=no-value-for-parameter</span>
 </pre></div>
 </div>
-</div>
-<div class="section" id="package-interface">
+</section>
+<section id="package-interface">
 <h2>Package Interface<a class="headerlink" href="#package-interface" title="Permalink to this headline">¶</a></h2>
 <p>Reference full documentation on <a class="reference external" href="https://github.com/RhetTbull/osxphotos/blob/master/README.md">GitHub</a></p>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="cli.html">osxphotos command line interface (CLI)</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="cli.html#osxphotos">osxphotos</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-about">about</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-albums">albums</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-dump">dump</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-export">export</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-help">help</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-info">info</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-keywords">keywords</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-labels">labels</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-list">list</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-persons">persons</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-places">places</a></li>
-<li class="toctree-l3"><a class="reference internal" href="cli.html#osxphotos-query">query</a></li>
-</ul>
-</li>
-</ul>
-</li>
+<li class="toctree-l1"><a class="reference internal" href="cli.html">osxphotos command line interface (CLI)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">osxphotos package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="reference.html#osxphotos-module">osxphotos module</a></li>
 </ul>
 </li>
 </ul>
 </div>
-</div>
-</div>
-<div class="section" id="indices-and-tables">
+</section>
+</section>
+<section id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
 <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
 <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
 <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
 </ul>
-</div>
+</section>
 
 
           </div>
@@ -347,7 +333,7 @@ Alternatively, you can also run the command line utility like this: <code class=
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
@@ -369,7 +355,7 @@ Alternatively, you can also run the command line utility like this: <code class=
       &copy;2021, Rhet Turnbull.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
       
       |

docs/modules.html

@@ -4,11 +4,12 @@
 <html>
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>osxphotos &#8212; osxphotos 0.42.20 documentation</title>
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+    <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.47.1 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>
     <script src="_static/jquery.js"></script>
     <script src="_static/underscore.js"></script>
     <script src="_static/doctools.js"></script>
@@ -30,11 +31,11 @@
 
           <div class="body" role="main">
             
-  <div class="section" id="osxphotos">
+  <section id="osxphotos">
 <h1>osxphotos<a class="headerlink" href="#osxphotos" title="Permalink to this headline">¶</a></h1>
 <div class="toctree-wrapper compound">
 </div>
-</div>
+</section>
 
 
           </div>
@@ -69,7 +70,7 @@
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
@@ -91,7 +92,7 @@
       &copy;2021, Rhet Turnbull.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
       
       |

docs/search.html

@@ -5,11 +5,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; osxphotos 0.42.20 documentation</title>
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
+    <title>Search &#8212; osxphotos 0.47.1 documentation</title>
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
     
-    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+    <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
     <script src="_static/jquery.js"></script>
     <script src="_static/underscore.js"></script>
     <script src="_static/doctools.js"></script>
@@ -37,26 +37,35 @@
           <div class="body" role="main">
             
   <h1 id="search-documentation">Search</h1>
-  <div id="fallback" class="admonition warning">
-  <script>$('#fallback').hide();</script>
+  
+  <noscript>
+  <div class="admonition warning">
   <p>
     Please activate JavaScript to enable the search
     functionality.
   </p>
   </div>
+  </noscript>
+  
+  
   <p>
     Searching for multiple words only shows matches that contain
     all words.
   </p>
+  
+  
   <form action="" method="get">
-    <input type="text" name="q" aria-labelledby="search-documentation" value="" />
+    <input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
     <input type="submit" value="search" />
     <span id="search-progress" style="padding-left: 10px"></span>
   </form>
   
+  
+  
   <div id="search-results">
   
   </div>
+  
 
           </div>
           
@@ -102,7 +111,7 @@
       &copy;2021, Rhet Turnbull.
       
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.2</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
       
     </div>

docsrc/source/cli.rst

@@ -3,4 +3,6 @@ osxphotos command line interface (CLI)
 
 .. click:: osxphotos.cli:cli
    :prog: osxphotos
-   :nested: full
+   :nested: full
+
+.. program-output:: python3 -m osxphotos --help

docsrc/source/conf.py

@@ -16,7 +16,7 @@ import sys
 
 import sphinx_rtd_theme
 
-sys.path.insert(0, os.path.abspath(".."))
+sys.path.insert(0, os.path.abspath("../.."))
 
 
 # -- Project information -----------------------------------------------------

examples/album_sort_order.py

@@ -0,0 +1,112 @@
+""" Example function for use with osxphotos export --post-function option showing how to record album sort order """
+
+import os
+import pathlib
+from typing import Optional
+
+from osxphotos import ExportResults, PhotoInfo
+from osxphotos.albuminfo import AlbumInfo
+from osxphotos.path_utils import sanitize_dirname
+from osxphotos.phototemplate import RenderOptions
+
+
+def album_sequence(photo: PhotoInfo, options: RenderOptions, **kwargs) -> str:
+    """Call this with {function} template to get album sequence (sort order) when exporting with {folder_album} template
+
+    For example, calling this template function like the following prepends sequence#_ to each exported file if the file is in an album:
+
+    osxphotos export /path/to/export -V --directory "{folder_album}" --filename "{album?{function:examples/album_sort_order.py::album_sequence}_,}{original_name}"
+
+    The sequence will start at 0.  To change the sequence to start at a different offset (e.g. 1), set the environment variable OSXPHOTOS_ALBUM_SEQUENCE_START=1 (or whatever offset you want)
+    """
+    dest_path = options.dest_path
+    if not dest_path:
+        return ""
+
+    album_info = None
+    for album in photo.album_info:
+        # following code is how {folder_album} builds the folder path
+        folder = "/".join(sanitize_dirname(f) for f in album.folder_names)
+        folder += "/" + sanitize_dirname(album.title)
+        if dest_path.endswith(folder):
+            album_info = album
+            break
+    else:
+        # didn't find the album, so skip this file
+        return ""
+    start_index = int(os.getenv("OSXPHOTOS_ALBUM_SEQUENCE_START", 0))
+    return str(album_info.photo_index(photo) + start_index)
+
+
+def album_sort_order(
+    photo: PhotoInfo, results: ExportResults, verbose: callable, **kwargs
+):
+    """Call this with osxphotos export /path/to/export --post-function album_sort_order.py::album_sort_order
+        This will get called immediately after the photo has been exported
+
+    Args:
+        photo: PhotoInfo instance for the photo that's just been exported
+        results: ExportResults instance with information about the files associated with the exported photo
+        verbose: A function to print verbose output if --verbose is set; if --verbose is not set, acts as a no-op (nothing gets printed)
+        **kwargs: reserved for future use; recommend you include **kwargs so your function still works if additional arguments are added in future versions
+
+    Notes:
+        Use verbose(str) instead of print if you want your function to conditionally output text depending on --verbose flag
+        Any string printed with verbose that contains "warning" or "error" (case-insensitive) will be printed with the appropriate warning or error color
+        Will not be called if --dry-run flag is enabled
+        Will be called immediately after export and before any --post-command commands are executed
+    """
+
+    # ExportResults has the following properties
+    # fields with filenames contain the full path to the file
+    # exported: list of all files exported
+    # new: list of all new files exported (--update)
+    # updated: list of all files updated (--update)
+    # skipped: list of all files skipped (--update)
+    # exif_updated: list of all files that were updated with --exiftool
+    # touched: list of all files that had date updated with --touch-file
+    # converted_to_jpeg: list of files converted to jpeg with --convert-to-jpeg
+    # sidecar_json_written: list of all JSON sidecar files written
+    # sidecar_json_skipped: list of all JSON sidecar files skipped (--update)
+    # sidecar_exiftool_written: list of all exiftool sidecar files written
+    # sidecar_exiftool_skipped: list of all exiftool sidecar files skipped (--update)
+    # sidecar_xmp_written: list of all XMP sidecar files written
+    # sidecar_xmp_skipped: list of all XMP sidecar files skipped (--update)
+    # missing: list of all missing files
+    # error: list tuples of (filename, error) for any errors generated during export
+    # exiftool_warning: list of tuples of (filename, warning) for any warnings generated by exiftool with --exiftool
+    # exiftool_error: list of tuples of (filename, error) for any errors generated by exiftool with --exiftool
+    # xattr_written: list of files that had extended attributes written
+    # xattr_skipped: list of files that where extended attributes were skipped (--update)
+    # deleted_files: list of deleted files
+    # deleted_directories: list of deleted directories
+    # exported_album: list of tuples of (filename, album_name) for exported files added to album with --add-exported-to-album
+    # skipped_album: list of tuples of (filename, album_name) for skipped files added to album with --add-skipped-to-album
+    # missing_album: list of tuples of (filename, album_name) for missing files added to album with --add-missing-to-album
+
+    for filepath in results.exported:
+        # do your processing here
+        filepath = pathlib.Path(filepath)
+        album_dir = filepath.parent.name
+        if album_dir not in photo.albums:
+            return
+
+        # get the first album that matches this name of which the photo is a member
+        album_info = None
+        for album in photo.album_info:
+            if album.title == album_dir:
+                album_info = album
+                break
+        else:
+            # didn't find the album, so skip this file
+            return
+
+        try:
+            sort_order = album_info.photo_index(photo)
+        except ValueError:
+            # photo not in album, so skip this file
+            return
+
+        verbose(f"Sort order for {filepath} in album {album_dir} is {sort_order}")
+        with open(str(filepath) + "_sort_order.txt", "w") as f:
+            f.write(str(sort_order))

examples/export_template.py

@@ -0,0 +1,173 @@
+""" Example showing how to use a custom function for osxphotos {function} template 
+    to export photos in a folder structure similar to Photos' own structure
+
+    Use:  osxphotos export /path/to/export --directory "{function:/path/to/export_template.py::photos_folders}"
+
+    This will likely export multiple copies of each photo.  If using APFS file system, this should be
+    a non-issue as osxphotos will use copy-on-write so each exported photo doesn't take up additional space
+    unless you edit the photo.
+
+    Thank-you @mkirkland4874 for the inspiration for this example!
+
+    This will produce output similar to this:
+
+Library
+- Photos
+-- {created.year}
+---- {created.mm}
+------ {created.dd}
+- Favorites
+- Hidden
+- Recently Deleted
+- People
+- Places
+- Imports
+Media Types
+- Videos
+- Selfies
+- Portrait
+- Panoramas
+- Time-lapse
+- Slow-mo
+- Bursts
+- Screenshots
+My Albums
+-- Album 1
+-- Album 2
+-- Folder 1
+---- Album 3
+Shared Albums
+-- Shared Album 1
+-- Shared Album 2
+"""
+
+from typing import List, Union
+
+import osxphotos
+from osxphotos._constants import _UNKNOWN_PERSON
+from osxphotos.datetime_formatter import DateTimeFormatter
+from osxphotos.path_utils import sanitize_dirname
+from osxphotos.phototemplate import RenderOptions
+
+
+def place_folder(photo: osxphotos.PhotoInfo) -> str:
+    """Return places as folder in format Country/State/City/etc."""
+    if not photo.place:
+        return ""
+
+    places = []
+    if photo.place.names.country:
+        places.append(photo.place.names.country[0])
+
+    if photo.place.names.state_province:
+        places.append(photo.place.names.state_province[0])
+
+    if photo.place.names.sub_administrative_area:
+        places.append(photo.place.names.sub_administrative_area[0])
+
+    if photo.place.names.additional_city_info:
+        places.append(photo.place.names.additional_city_info[0])
+
+    if photo.place.names.area_of_interest:
+        places.append(photo.place.names.area_of_interest[0])
+
+    if places:
+        return "Library/Places/" + "/".join(sanitize_dirname(place) for place in places)
+    else:
+        return ""
+
+
+def photos_folders(photo: osxphotos.PhotoInfo, options: osxphotos.phototemplate.RenderOptions, **kwargs) -> Union[List, str]:
+    """template function for use with --directory to export photos in a folder structure similar to Photos
+
+    Args:
+        photo: osxphotos.PhotoInfo object
+        options: RenderOptions instance
+        **kwargs: not currently used, placeholder to keep functions compatible with possible changes to {function}
+
+    Returns: list of directories for each photo
+
+    """
+
+    rendered_date, _ = photo.render_template("{created.year}/{created.mm}/{created.dd}")
+    date_path = rendered_date[0]
+
+    def add_date_path(path):
+        """add date path (year/mm/dd)"""
+        return f"{path}/{date_path}"
+
+    # Library
+
+    directories = []
+    if not photo.hidden and not photo.intrash and not photo.shared:
+        # set directories to [Library/Photos/year/mm/dd]
+        # render_template returns a tuple of [rendered value(s)], [unmatched]
+        # here, we can ignore the unmatched value, assigned to _, as we know template will match
+        directories, _ = photo.render_template(
+            "Library/Photos/{created.year}/{created.mm}/{created.dd}"
+        )
+
+    if photo.favorite:
+        directories.append(add_date_path("Library/Favorites"))
+    if photo.hidden:
+        directories.append(add_date_path("Library/Hidden"))
+    if photo.intrash:
+        directories.append(add_date_path("Library/Recently Deleted"))
+
+    directories.extend(
+        [
+            add_date_path(f"Library/People/{person}")
+            for person in photo.persons
+            if person != _UNKNOWN_PERSON
+        ]
+    )
+
+    if photo.place:
+        directories.append(add_date_path(place_folder(photo)))
+
+    if photo.import_info:
+        dt = DateTimeFormatter(photo.import_info.creation_date)
+        directories.append(f"Library/Imports/{dt.year}/{dt.mm}/{dt.dd}")
+
+    # Media Types
+
+    if photo.ismovie:
+        directories.append(add_date_path("Media Types/Videos"))
+    if photo.selfie:
+        directories.append(add_date_path("Media Types/Selfies"))
+    if photo.live_photo:
+        directories.append(add_date_path("Media Types/Live Photos"))
+    if photo.portrait:
+        directories.append(add_date_path("Media Types/Portrait"))
+    if photo.panorama:
+        directories.append(add_date_path("Media Types/Panoramas"))
+    if photo.time_lapse:
+        directories.append(add_date_path("Media Types/Time-lapse"))
+    if photo.slow_mo:
+        directories.append(add_date_path("Media Types/Slo-mo"))
+    if photo.burst:
+        directories.append(add_date_path("Media Types/Bursts"))
+    if photo.screenshot:
+        directories.append(add_date_path("Media Types/Screenshots"))
+
+    # Albums
+
+    # render the folders and albums in folder/subfolder/album format
+    # the __NO_ALBUM__ is used as a sentinel to strip out photos not in an album
+    # use RenderOptions.dirname to force the rendered folder_album value to be sanitized as a valid path
+    # use RenderOptions.none_str to specify custom value for any photo that doesn't belong to an album so
+    # those can be filtered out; if not specified, none_str is "_"
+    folder_albums, _ = photo.render_template(
+        "{folder_album}", RenderOptions(dirname=True, none_str="__NO_ALBUM__")
+    )
+
+    root_directory = "Shared Albums/" if photo.shared else "My Albums/"
+    directories.extend(
+        [
+            root_directory + folder_album
+            for folder_album in folder_albums
+            if folder_album != "__NO_ALBUM__"
+        ]
+    )
+
+    return directories

osxphotos.spec

@@ -14,6 +14,7 @@ datas = [
     ("osxphotos/phototemplate.tx", "osxphotos"),
     ("osxphotos/phototemplate.md", "osxphotos"),
     ("osxphotos/tutorial.md", "osxphotos"),
+    ("osxphotos/exiftool_filetypes.json", "osxphotos"),
 ]
 package_imports = [["photoscript", ["photoscript.applescript"]]]
 for package, files in package_imports:

osxphotos/__init__.py

@@ -1,11 +1,44 @@
+from ._constants import AlbumSortOrder
 from ._version import __version__
 from .exiftool import ExifTool
-from .photoinfo import ExportResults, PhotoInfo
+from .export_db import ExportDB
+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",
+    "ExportDBTemp",
+    "ExportOptions",
+    "ExportResults",
+    "FileUtil",
+    "FileUtilNoOp",
+    "LikeInfo",
+    "MomentInfo",
+    "PersonInfo",
+    "PhotoExporter",
+    "PhotoInfo",
+    "PhotosDB",
+    "PhotoTemplate",
+    "PlaceInfo",
+    "QueryOptions",
+    "ScoreInfo",
+    "SearchInfo",
+]

osxphotos/__main__.py

@@ -1,6 +1,6 @@
 """Command line interface for osxphotos """
 
-from .cli import cli
+from .cli.cli import cli_main
 
 if __name__ == "__main__":
-    cli()  # pylint: disable=no-value-for-parameter
+    cli_main()

osxphotos/_applescript/__init__.py

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

osxphotos/_applescript/aecodecs.py

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

osxphotos/_constants.py

@@ -4,6 +4,7 @@ Constants used by osxphotos
 
 import os.path
 from datetime import datetime
+from enum import Enum
 
 OSXPHOTOS_URL = "https://github.com/RhetTbull/osxphotos"
 
@@ -19,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
@@ -29,17 +30,22 @@ _TESTED_DB_VERSIONS = ["6000", "4025", "4016", "3301", "2622"]
 # Photos 6 (10.16.0 Beta) == 14104
 _TEST_MODEL_VERSIONS = ["13537", "13703", "14104"]
 
+_PHOTOS_2_VERSION = "2622"
+
 # only version 3 - 4 have RKVersion.selfPortrait
 _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 = {
@@ -93,6 +99,12 @@ _TESTED_OS_VERSIONS = [
     ("11", "2"),
     ("11", "3"),
     ("11", "4"),
+    ("11", "5"),
+    ("11", "6"),
+    ("12", "0"),
+    ("12", "1"),
+    ("12", "2"),
+    ("12", "3"),
 ]
 
 # Photos 5 has persons who are empty string if unidentified face
@@ -118,12 +130,20 @@ _XMP_TEMPLATE_NAME_BETA = "xmp_sidecar_beta.mako"
 # Constants used for processing folders and albums
 _PHOTOS_5_ALBUM_KIND = 2  # normal user album
 _PHOTOS_5_SHARED_ALBUM_KIND = 1505  # shared album
+_PHOTOS_5_PROJECT_ALBUM_KIND = 1508  # My Projects (e.g. Calendar, Card, Slideshow)
 _PHOTOS_5_FOLDER_KIND = 4000  # user folder
 _PHOTOS_5_ROOT_FOLDER_KIND = 3999  # root folder
 _PHOTOS_5_IMPORT_SESSION_ALBUM_KIND = 1506  # import session
 
 _PHOTOS_4_ALBUM_KIND = 3  # RKAlbum.albumSubclass
-_PHOTOS_4_TOP_LEVEL_ALBUM = "TopLevelAlbums"
+_PHOTOS_4_ALBUM_TYPE_ALBUM = 1  # RKAlbum.albumType
+_PHOTOS_4_ALBUM_TYPE_PROJECT = 9  # RKAlbum.albumType
+_PHOTOS_4_ALBUM_TYPE_SLIDESHOW = 8  # RKAlbum.albumType
+_PHOTOS_4_TOP_LEVEL_ALBUMS = [
+    "TopLevelAlbums",
+    "TopLevelKeepsakes",
+    "TopLevelSlideshows",
+]
 _PHOTOS_4_ROOT_FOLDER = "LibraryFolder"
 
 # EXIF related constants
@@ -210,9 +230,8 @@ DEFAULT_EDITED_SUFFIX = "_edited"
 # Default suffix to add to original images
 DEFAULT_ORIGINAL_SUFFIX = ""
 
-# Colors for print CLI messages
-CLI_COLOR_ERROR = "red"
-CLI_COLOR_WARNING = "yellow"
+# Default suffix to add to preview images
+DEFAULT_PREVIEW_SUFFIX = "_preview"
 
 # Bit masks for --sidecar
 SIDECAR_JSON = 0x1
@@ -224,17 +243,26 @@ EXTENDED_ATTRIBUTE_NAMES = [
     "authors",
     "comment",
     "copyright",
+    "creator",
     "description",
     "findercomment",
     "headline",
     "keywords",
+    "participants",
+    "projects",
+    "rating",
+    "subject",
+    "title",
+    "version",
 ]
 EXTENDED_ATTRIBUTE_NAMES_QUOTED = [f"'{x}'" for x in EXTENDED_ATTRIBUTE_NAMES]
 
+
 # name of export DB
 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
@@ -263,3 +291,34 @@ POST_COMMAND_CATEGORIES = {
     # "deleted_files": "When used with '--cleanup', all files deleted during the export",
     # "deleted_directories": "When used with '--cleanup', all directories deleted during the export",
 }
+
+
+class AlbumSortOrder(Enum):
+    """Album Sort Order"""
+
+    UNKNOWN = 0
+    MANUAL = 1
+    NEWEST_FIRST = 2
+    OLDEST_FIRST = 3
+    TITLE = 5
+
+
+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.42.52"
+__version__ = "0.47.2"

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

@@ -14,26 +14,37 @@ from datetime import datetime, timedelta, timezone
 
 from ._constants import (
     _PHOTOS_4_ALBUM_KIND,
-    _PHOTOS_4_TOP_LEVEL_ALBUM,
+    _PHOTOS_4_TOP_LEVEL_ALBUMS,
     _PHOTOS_4_VERSION,
     _PHOTOS_5_ALBUM_KIND,
     _PHOTOS_5_FOLDER_KIND,
     TIME_DELTA,
+    AlbumSortOrder,
 )
 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
+    """Sorts list values by a second list sort_keys
         e.g. given ["a","c","b"], [1, 3, 2], returns ["a", "b", "c"]
 
     Args:
         values: a list of values to be sorted
         sort_keys: a list of keys to sort values by
-    
+
     Returns:
         list of values, sorted by sort_keys
-    
+
     Raises:
         ValueError: raised if len(values) != len(sort_keys)
     """
@@ -63,12 +74,12 @@ class AlbumInfoBaseClass:
 
     @property
     def uuid(self):
-        """ return uuid of album """
+        """return uuid of album"""
         return self._uuid
 
     @property
     def creation_date(self):
-        """ return creation date of album """
+        """return creation date of album"""
         try:
             return self._creation_date
         except AttributeError:
@@ -90,8 +101,8 @@ class AlbumInfoBaseClass:
 
     @property
     def start_date(self):
-        """ For Albums, return start date (earliest image) of album or None for albums with no images
-            For Import Sessions, return start date of import session (when import began) """
+        """For Albums, return start date (earliest image) of album or None for albums with no images
+        For Import Sessions, return start date of import session (when import began)"""
         try:
             return self._start_date
         except AttributeError:
@@ -109,8 +120,8 @@ class AlbumInfoBaseClass:
 
     @property
     def end_date(self):
-        """ For Albums, return end date (most recent image) of album or None for albums with no images
-            For Import Sessions, return end date of import sessions (when import was completed) """
+        """For Albums, return end date (most recent image) of album or None for albums with no images
+        For Import Sessions, return end date of import sessions (when import was completed)"""
         try:
             return self._end_date
         except AttributeError:
@@ -130,43 +141,74 @@ class AlbumInfoBaseClass:
     def photos(self):
         return []
 
+    @property
+    def owner(self):
+        """Return name of photo owner for shared album (Photos 5+ only), or None if not shared"""
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return None
+
+        try:
+            return self._owner
+        except AttributeError:
+            try:
+                personid = self._db._dbalbum_details[self.uuid][
+                    "cloudownerhashedpersonid"
+                ]
+                self._owner = (
+                    self._db._db_hashed_person_id[personid]["full_name"]
+                    if personid
+                    else None
+                )
+            except KeyError:
+                self._owner = None
+            return self._owner
+
     def __len__(self):
-        """ return number of photos contained in album """
+        """return number of photos contained in album"""
         return len(self.photos)
 
 
 class AlbumInfo(AlbumInfoBaseClass):
     """
-    Base class for AlbumInfo, ImportInfo
     Info about a specific Album, contains all the details about the album
     including folders, photos, etc.
     """
 
     @property
     def title(self):
-        """ return title / name of album """
+        """return title / name of album"""
         return self._title
 
     @property
     def photos(self):
-        """ return list of photos contained in album sorted in same sort order as Photos """
+        """return list of photos contained in album sorted in same sort order as Photos"""
         try:
             return self._photos
         except AttributeError:
             if self.uuid in self._db._dbalbums_album:
                 uuid, sort_order = zip(*self._db._dbalbums_album[self.uuid])
                 sorted_uuid = sort_list_by_keys(uuid, sort_order)
-                self._photos = self._db.photos_by_uuid(sorted_uuid)
+                photos = self._db.photos_by_uuid(sorted_uuid)
+                sort_order = self.sort_order
+                if sort_order == AlbumSortOrder.NEWEST_FIRST:
+                    self._photos = sorted(photos, key=lambda p: p.date, reverse=True)
+                elif sort_order == AlbumSortOrder.OLDEST_FIRST:
+                    self._photos = sorted(photos, key=lambda p: p.date)
+                elif sort_order == AlbumSortOrder.TITLE:
+                    self._photos = sorted(photos, key=lambda p: p.title or "")
+                else:
+                    # assume AlbumSortOrder.MANUAL
+                    self._photos = photos
             else:
                 self._photos = []
             return self._photos
 
     @property
     def folder_names(self):
-        """ return hierarchical list of folders the album is contained in
-            the folder list is in form:
-            ["Top level folder", "sub folder 1", "sub folder 2", ...]
-            returns empty list if album is not in any folders """
+        """return hierarchical list of folders the album is contained in
+        the folder list is in form:
+        ["Top level folder", "sub folder 1", "sub folder 2", ...]
+        returns empty list if album is not in any folders"""
 
         try:
             return self._folder_names
@@ -176,10 +218,10 @@ class AlbumInfo(AlbumInfoBaseClass):
 
     @property
     def folder_list(self):
-        """ return hierarchical list of folders the album is contained in
-            as list of FolderInfo objects in form 
-            ["Top level folder", "sub folder 1", "sub folder 2", ...]
-            returns empty list if album is not in any folders """
+        """return hierarchical list of folders the album is contained in
+        as list of FolderInfo objects in form
+        ["Top level folder", "sub folder 1", "sub folder 2", ...]
+        returns empty list if album is not in any folders"""
 
         try:
             return self._folders
@@ -189,7 +231,7 @@ class AlbumInfo(AlbumInfoBaseClass):
 
     @property
     def parent(self):
-        """ returns FolderInfo object for parent folder or None if no parent (e.g. top-level album) """
+        """returns FolderInfo object for parent folder or None if no parent (e.g. top-level album)"""
         try:
             return self._parent
         except AttributeError:
@@ -197,7 +239,7 @@ class AlbumInfo(AlbumInfoBaseClass):
                 parent_uuid = self._db._dbalbum_details[self._uuid]["folderUuid"]
                 self._parent = (
                     FolderInfo(db=self._db, uuid=parent_uuid)
-                    if parent_uuid != _PHOTOS_4_TOP_LEVEL_ALBUM
+                    if parent_uuid not in _PHOTOS_4_TOP_LEVEL_ALBUMS
                     else None
                 )
             else:
@@ -209,11 +251,43 @@ class AlbumInfo(AlbumInfoBaseClass):
                 )
             return self._parent
 
+    @property
+    def sort_order(self):
+        """return sort order of album"""
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return AlbumSortOrder.MANUAL
+
+        details = self._db._dbalbum_details[self._uuid]
+        if details["customsortkey"] == 1:
+            if details["customsortascending"] == 0:
+                return AlbumSortOrder.NEWEST_FIRST
+            elif details["customsortascending"] == 1:
+                return AlbumSortOrder.OLDEST_FIRST
+            else:
+                return AlbumSortOrder.UNKNOWN
+        elif details["customsortkey"] == 5:
+            return AlbumSortOrder.TITLE
+        elif details["customsortkey"] == 0:
+            return AlbumSortOrder.MANUAL
+        else:
+            return AlbumSortOrder.UNKNOWN
+
+    def photo_index(self, photo):
+        """return index of photo in album (based on album sort order)"""
+        for index, p in enumerate(self.photos):
+            if p.uuid == photo.uuid:
+                return index
+        raise ValueError(
+            f"Photo with uuid {photo.uuid} does not appear to be in this album"
+        )
+
 
 class ImportInfo(AlbumInfoBaseClass):
+    """Information about import sessions"""
+
     @property
     def photos(self):
-        """ return list of photos contained in import session """
+        """return list of photos contained in import session"""
         try:
             return self._photos
         except AttributeError:
@@ -229,9 +303,18 @@ class ImportInfo(AlbumInfoBaseClass):
             return self._photos
 
 
+class ProjectInfo(AlbumInfo):
+    """
+    ProjectInfo with info about projects
+    Projects are cards, calendars, slideshows, etc.
+    """
+
+    ...
+
+
 class FolderInfo:
     """
-    Info about a specific folder, contains all the details about the folder 
+    Info about a specific folder, contains all the details about the folder
     including folders, albums, etc
     """
 
@@ -247,17 +330,17 @@ class FolderInfo:
 
     @property
     def title(self):
-        """ return title / name of folder"""
+        """return title / name of folder"""
         return self._title
 
     @property
     def uuid(self):
-        """ return uuid of folder """
+        """return uuid of folder"""
         return self._uuid
 
     @property
     def album_info(self):
-        """ return list of albums (as AlbumInfo objects) contained in the folder """
+        """return list of albums (as AlbumInfo objects) contained in the folder"""
         try:
             return self._albums
         except AttributeError:
@@ -282,7 +365,7 @@ class FolderInfo:
 
     @property
     def parent(self):
-        """ returns FolderInfo object for parent or None if no parent (e.g. top-level folder) """
+        """returns FolderInfo object for parent or None if no parent (e.g. top-level folder)"""
         try:
             return self._parent
         except AttributeError:
@@ -290,7 +373,7 @@ class FolderInfo:
                 parent_uuid = self._db._dbfolder_details[self._uuid]["parentFolderUuid"]
                 self._parent = (
                     FolderInfo(db=self._db, uuid=parent_uuid)
-                    if parent_uuid != _PHOTOS_4_TOP_LEVEL_ALBUM
+                    if parent_uuid not in _PHOTOS_4_TOP_LEVEL_ALBUMS
                     else None
                 )
             else:
@@ -304,7 +387,7 @@ class FolderInfo:
 
     @property
     def subfolders(self):
-        """ return list of folders (as FolderInfo objects) contained in the folder """
+        """return list of folders (as FolderInfo objects) contained in the folder"""
         try:
             return self._folders
         except AttributeError:
@@ -328,5 +411,5 @@ class FolderInfo:
             return self._folders
 
     def __len__(self):
-        """ returns count of folders + albums contained in the folder """
+        """returns count of folders + albums contained in the folder"""
         return len(self.subfolders) + len(self.album_info)

osxphotos/cli/__init__.py

@@ -0,0 +1,56 @@
+"""cli package for osxphotos"""
+
+from rich.traceback import install as install_traceback
+
+from .about import about
+from .albums import albums
+from .cli import cli_main
+from .common import get_photos_db, load_uuid_from_file, set_debug
+from .debug_dump import debug_dump
+from .dump import dump
+from .export import export
+from .exportdb import exportdb
+from .grep import grep
+from .help import help
+from .info import info
+from .install_uninstall_run import install, run, uninstall
+from .keywords import keywords
+from .labels import labels
+from .list import _list_libraries, list_libraries
+from .persons import persons
+from .places import places
+from .query import query
+from .repl import repl
+from .snap_diff import diff, snap
+from .tutorial import tutorial
+from .uuid import uuid
+
+install_traceback()
+
+__all__ = [
+    "about",
+    "albums",
+    "cli_main",
+    "debug_dump",
+    "diff",
+    "dump",
+    "export",
+    "exportdb",
+    "grep",
+    "help",
+    "info",
+    "install",
+    "keywords",
+    "labels",
+    "list_libraries",
+    "list_libraries",
+    "load_uuid_from_file",
+    "persons",
+    "places",
+    "query",
+    "repl",
+    "run",
+    "snap",
+    "tutorial",
+    "uuid",
+]

osxphotos/cli/about.py

@@ -0,0 +1,66 @@
+"""about command for osxphotos CLI"""
+
+import click
+
+from osxphotos._constants import OSXPHOTOS_URL
+from osxphotos._version import __version__
+
+
+@click.command(name="about")
+@click.pass_obj
+@click.pass_context
+def about(ctx, cli_obj):
+    """Print information about osxphotos including license."""
+    license = """
+MIT License
+
+Copyright (c) 2019-2021 Rhet Turnbull
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+osxphotos uses the following 3rd party software licensed under the BSD-3-Clause License:
+Click (Copyright 2014 Pallets), ptpython (Copyright (c) 2015, Jonathan Slenders)
+
+Redistribution and use in source and binary forms, with or without modification, are 
+permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list 
+of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list 
+of conditions and the following disclaimer in the documentation and/or other materials 
+provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be 
+used to endorse or promote products derived from this software without specific prior 
+written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR 
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+    click.echo(f"osxphotos, version {__version__}")
+    click.echo("")
+    click.echo(f"Source code available at: {OSXPHOTOS_URL}")
+    click.echo(license)

osxphotos/cli/albums.py

@@ -0,0 +1,42 @@
+"""albums command for osxphotos CLI"""
+
+import json
+
+import click
+import yaml
+
+import osxphotos
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+from osxphotos._constants import _PHOTOS_4_VERSION
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def albums(ctx, cli_obj, db, json_, photos_library):
+    """Print out albums found in the Photos library."""
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["albums"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    albums = {"albums": photosdb.albums_as_dict}
+    if photosdb.db_version > _PHOTOS_4_VERSION:
+        albums["shared albums"] = photosdb.albums_shared_as_dict
+
+    if json_ or cli_obj.json:
+        click.echo(json.dumps(albums, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(albums, sort_keys=False, allow_unicode=True))

osxphotos/cli/cli.py

@@ -0,0 +1,85 @@
+"""Command line interface for osxphotos """
+
+import click
+
+import osxphotos
+from osxphotos._version import __version__
+
+from .about import about
+from .albums import albums
+from .common import DB_OPTION, JSON_OPTION, OSXPHOTOS_HIDDEN
+from .debug_dump import debug_dump
+from .dump import dump
+from .export import export
+from .exportdb import exportdb
+from .grep import grep
+from .help import help
+from .info import info
+from .install_uninstall_run import install, run, uninstall
+from .keywords import keywords
+from .labels import labels
+from .list import _list_libraries, list_libraries
+from .persons import persons
+from .places import places
+from .query import query
+from .repl import repl
+from .snap_diff import diff, snap
+from .tutorial import tutorial
+from .uuid import uuid
+
+
+# Click CLI object & context settings
+class CLI_Obj:
+    def __init__(self, db=None, json=False, debug=False, group=None):
+        if debug:
+            osxphotos._set_debug(True)
+        self.db = db
+        self.json = json
+        self.group = group
+
+
+CTX_SETTINGS = dict(help_option_names=["-h", "--help"])
+
+
+@click.group(context_settings=CTX_SETTINGS)
+@DB_OPTION
+@JSON_OPTION
+@click.option(
+    "--debug",
+    required=False,
+    is_flag=True,
+    help="Enable debug output",
+    hidden=OSXPHOTOS_HIDDEN,
+)
+@click.version_option(__version__, "--version", "-v")
+@click.pass_context
+def cli_main(ctx, db, json_, debug):
+    ctx.obj = CLI_Obj(db=db, json=json_, group=cli_main)
+
+
+# install CLI commands
+for command in [
+    about,
+    albums,
+    debug_dump,
+    diff,
+    dump,
+    export,
+    exportdb,
+    grep,
+    help,
+    info,
+    install,
+    keywords,
+    labels,
+    list_libraries,
+    persons,
+    places,
+    query,
+    repl,
+    snap,
+    tutorial,
+    uninstall,
+    uuid,
+]:
+    cli_main.add_command(command)

osxphotos/cli/common.py

@@ -0,0 +1,538 @@
+"""Globals and constants use by the CLI commands"""
+
+import datetime
+import os
+import pathlib
+from typing import Callable
+
+import click
+
+import osxphotos
+from osxphotos._version import __version__
+
+from .param_types import *
+
+from rich import print as rprint
+
+# global variable to control debug output
+# set via --debug
+DEBUG = False
+
+# used to show/hide hidden commands
+OSXPHOTOS_HIDDEN = not bool(os.getenv("OSXPHOTOS_SHOW_HIDDEN", default=False))
+
+# used by snap and diff commands
+OSXPHOTOS_SNAPSHOT_DIR = "/private/tmp/osxphotos_snapshots"
+
+# where to write the crash report if osxphotos crashes
+OSXPHOTOS_CRASH_LOG = os.getcwd() + "/osxphotos_crash.log"
+
+CLI_COLOR_ERROR = "red"
+CLI_COLOR_WARNING = "yellow"
+
+
+def set_debug(debug: bool):
+    """set debug flag"""
+    global DEBUG
+    DEBUG = debug
+
+
+def is_debug():
+    """return debug flag"""
+    return DEBUG
+
+
+def noop(*args, **kwargs):
+    """no-op function"""
+    pass
+
+
+def verbose_print(
+    verbose: bool = True, timestamp: bool = False, rich=False
+) -> Callable:
+    """Create verbose function to print output
+
+    Args:
+        verbose: if True, returns verbose print function otherwise returns no-op function
+        timestamp: if True, includes timestamp in verbose output
+        rich: use rich.print instead of click.echo
+
+    Returns:
+        function to print output
+    """
+    if not verbose:
+        return noop
+
+    # closure to capture timestamp
+    def verbose_(*args, **kwargs):
+        """print output if verbose flag set"""
+        styled_args = []
+        timestamp_str = str(datetime.datetime.now()) + " -- " if timestamp else ""
+        for arg in args:
+            if type(arg) == str:
+                arg = timestamp_str + arg
+                if "error" in arg.lower():
+                    arg = click.style(arg, fg=CLI_COLOR_ERROR)
+                elif "warning" in arg.lower():
+                    arg = click.style(arg, fg=CLI_COLOR_WARNING)
+            styled_args.append(arg)
+        click.echo(*styled_args, **kwargs)
+
+    def rich_verbose_(*args, **kwargs):
+        """print output if verbose flag set using rich.print"""
+        timestamp_str = str(datetime.datetime.now()) + " -- " if timestamp else ""
+        for arg in args:
+            if type(arg) == str:
+                arg = timestamp_str + arg
+                if "error" in arg.lower():
+                    arg = f"[{CLI_COLOR_ERROR}]{arg}[/{CLI_COLOR_ERROR}]"
+                elif "warning" in arg.lower():
+                    arg = f"[{CLI_COLOR_WARNING}]{arg}[/{CLI_COLOR_WARNING}]"
+            rprint(arg, **kwargs)
+
+    return rich_verbose_ if rich else verbose_
+
+
+def get_photos_db(*db_options):
+    """Return path to photos db, select first non-None db_options
+    If no db_options are non-None, try to find library to use in
+    the following order:
+    - last library opened
+    - system library
+    - ~/Pictures/Photos Library.photoslibrary
+    - failing above, returns None
+    """
+    if db_options:
+        for db in db_options:
+            if db is not None:
+                return db
+
+    # if get here, no valid database paths passed, so try to figure out which to use
+    db = osxphotos.utils.get_last_library_path()
+    if db is not None:
+        click.echo(f"Using last opened Photos library: {db}", err=True)
+        return db
+
+    db = osxphotos.utils.get_system_library_path()
+    if db is not None:
+        click.echo(f"Using system Photos library: {db}", err=True)
+        return db
+
+    db = os.path.expanduser("~/Pictures/Photos Library.photoslibrary")
+    if os.path.isdir(db):
+        click.echo(f"Using Photos library: {db}", err=True)
+        return db
+    else:
+        return None
+
+
+DB_OPTION = click.option(
+    "--db",
+    required=False,
+    metavar="<Photos database path>",
+    default=None,
+    help=(
+        "Specify Photos database path. "
+        "Path to Photos library/database can be specified using either --db "
+        "or directly as PHOTOS_LIBRARY positional argument. "
+        "If neither --db or PHOTOS_LIBRARY provided, will attempt to find the library "
+        "to use in the following order: 1. last opened library, 2. system library, 3. ~/Pictures/Photos Library.photoslibrary"
+    ),
+    type=click.Path(exists=True),
+)
+
+DB_ARGUMENT = click.argument("photos_library", nargs=-1, type=click.Path(exists=True))
+
+JSON_OPTION = click.option(
+    "--json",
+    "json_",
+    required=False,
+    is_flag=True,
+    default=False,
+    help="Print output in JSON format.",
+)
+
+
+def DELETED_OPTIONS(f):
+    o = click.option
+    options = [
+        o(
+            "--deleted",
+            is_flag=True,
+            help="Include photos from the 'Recently Deleted' folder.",
+        ),
+        o(
+            "--deleted-only",
+            is_flag=True,
+            help="Include only photos from the 'Recently Deleted' folder.",
+        ),
+    ]
+    for o in options[::-1]:
+        f = o(f)
+    return f
+
+
+def QUERY_OPTIONS(f):
+    o = click.option
+    options = [
+        o(
+            "--keyword",
+            metavar="KEYWORD",
+            default=None,
+            multiple=True,
+            help="Search for photos with keyword KEYWORD. "
+            'If more than one keyword, treated as "OR", e.g. find photos matching any keyword',
+        ),
+        o(
+            "--person",
+            metavar="PERSON",
+            default=None,
+            multiple=True,
+            help="Search for photos with person PERSON. "
+            'If more than one person, treated as "OR", e.g. find photos matching any person',
+        ),
+        o(
+            "--album",
+            metavar="ALBUM",
+            default=None,
+            multiple=True,
+            help="Search for photos in album ALBUM. "
+            'If more than one album, treated as "OR", e.g. find photos matching any album',
+        ),
+        o(
+            "--folder",
+            metavar="FOLDER",
+            default=None,
+            multiple=True,
+            help="Search for photos in an album in folder FOLDER. "
+            'If more than one folder, treated as "OR", e.g. find photos in any FOLDER.  '
+            "Only searches top level folders (e.g. does not look at subfolders)",
+        ),
+        o(
+            "--name",
+            metavar="FILENAME",
+            default=None,
+            multiple=True,
+            help="Search for photos with filename matching FILENAME. "
+            'If more than one --name options is specified, they are treated as "OR", '
+            "e.g. find photos matching any FILENAME. ",
+        ),
+        o(
+            "--uuid",
+            metavar="UUID",
+            default=None,
+            multiple=True,
+            help="Search for photos with UUID(s). "
+            "May be repeated to include multiple UUIDs.",
+        ),
+        o(
+            "--uuid-from-file",
+            metavar="FILE",
+            default=None,
+            multiple=False,
+            help="Search for photos with UUID(s) loaded from FILE. "
+            "Format is a single UUID per line.  Lines preceded with # are ignored.",
+            type=click.Path(exists=True),
+        ),
+        o(
+            "--title",
+            metavar="TITLE",
+            default=None,
+            multiple=True,
+            help="Search for TITLE in title of photo.",
+        ),
+        o("--no-title", is_flag=True, help="Search for photos with no title."),
+        o(
+            "--description",
+            metavar="DESC",
+            default=None,
+            multiple=True,
+            help="Search for DESC in description of photo.",
+        ),
+        o(
+            "--no-description",
+            is_flag=True,
+            help="Search for photos with no description.",
+        ),
+        o(
+            "--place",
+            metavar="PLACE",
+            default=None,
+            multiple=True,
+            help="Search for PLACE in photo's reverse geolocation info",
+        ),
+        o(
+            "--no-place",
+            is_flag=True,
+            help="Search for photos with no associated place name info (no reverse geolocation info)",
+        ),
+        o(
+            "--location",
+            is_flag=True,
+            help="Search for photos with associated location info (e.g. GPS coordinates)",
+        ),
+        o(
+            "--no-location",
+            is_flag=True,
+            help="Search for photos with no associated location info (e.g. no GPS coordinates)",
+        ),
+        o(
+            "--label",
+            metavar="LABEL",
+            multiple=True,
+            help="Search for photos with image classification label LABEL (Photos 5 only). "
+            'If more than one label, treated as "OR", e.g. find photos matching any label',
+        ),
+        o(
+            "--uti",
+            metavar="UTI",
+            default=None,
+            multiple=False,
+            help="Search for photos whose uniform type identifier (UTI) matches UTI",
+        ),
+        o(
+            "-i",
+            "--ignore-case",
+            is_flag=True,
+            help="Case insensitive search for title, description, place, keyword, person, or album.",
+        ),
+        o("--edited", is_flag=True, help="Search for photos that have been edited."),
+        o(
+            "--external-edit",
+            is_flag=True,
+            help="Search for photos edited in external editor.",
+        ),
+        o("--favorite", is_flag=True, help="Search for photos marked favorite."),
+        o(
+            "--not-favorite",
+            is_flag=True,
+            help="Search for photos not marked favorite.",
+        ),
+        o("--hidden", is_flag=True, help="Search for photos marked hidden."),
+        o("--not-hidden", is_flag=True, help="Search for photos not marked hidden."),
+        o(
+            "--shared",
+            is_flag=True,
+            help="Search for photos in shared iCloud album (Photos 5 only).",
+        ),
+        o(
+            "--not-shared",
+            is_flag=True,
+            help="Search for photos not in shared iCloud album (Photos 5 only).",
+        ),
+        o(
+            "--burst",
+            is_flag=True,
+            help="Search for photos that were taken in a burst.",
+        ),
+        o(
+            "--not-burst",
+            is_flag=True,
+            help="Search for photos that are not part of a burst.",
+        ),
+        o("--live", is_flag=True, help="Search for Apple live photos"),
+        o(
+            "--not-live",
+            is_flag=True,
+            help="Search for photos that are not Apple live photos.",
+        ),
+        o("--portrait", is_flag=True, help="Search for Apple portrait mode photos."),
+        o(
+            "--not-portrait",
+            is_flag=True,
+            help="Search for photos that are not Apple portrait mode photos.",
+        ),
+        o("--screenshot", is_flag=True, help="Search for screenshot photos."),
+        o(
+            "--not-screenshot",
+            is_flag=True,
+            help="Search for photos that are not screenshot photos.",
+        ),
+        o("--slow-mo", is_flag=True, help="Search for slow motion videos."),
+        o(
+            "--not-slow-mo",
+            is_flag=True,
+            help="Search for photos that are not slow motion videos.",
+        ),
+        o("--time-lapse", is_flag=True, help="Search for time lapse videos."),
+        o(
+            "--not-time-lapse",
+            is_flag=True,
+            help="Search for photos that are not time lapse videos.",
+        ),
+        o("--hdr", is_flag=True, help="Search for high dynamic range (HDR) photos."),
+        o("--not-hdr", is_flag=True, help="Search for photos that are not HDR photos."),
+        o(
+            "--selfie",
+            is_flag=True,
+            help="Search for selfies (photos taken with front-facing cameras).",
+        ),
+        o("--not-selfie", is_flag=True, help="Search for photos that are not selfies."),
+        o("--panorama", is_flag=True, help="Search for panorama photos."),
+        o(
+            "--not-panorama",
+            is_flag=True,
+            help="Search for photos that are not panoramas.",
+        ),
+        o(
+            "--has-raw",
+            is_flag=True,
+            help="Search for photos with both a jpeg and raw version",
+        ),
+        o(
+            "--only-movies",
+            is_flag=True,
+            help="Search only for movies (default searches both images and movies).",
+        ),
+        o(
+            "--only-photos",
+            is_flag=True,
+            help="Search only for photos/images (default searches both images and movies).",
+        ),
+        o(
+            "--from-date",
+            help="Search by item start date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).",
+            type=DateTimeISO8601(),
+        ),
+        o(
+            "--to-date",
+            help="Search by item end date, e.g. 2000-01-12T12:00:00, 2001-01-12T12:00:00-07:00, or 2000-12-31 (ISO 8601 with/without timezone).",
+            type=DateTimeISO8601(),
+        ),
+        o(
+            "--from-time",
+            help="Search by item start time of day, e.g. 12:00, or 12:00:00.",
+            type=TimeISO8601(),
+        ),
+        o(
+            "--to-time",
+            help="Search by item end time of day, e.g. 12:00 or 12:00:00.",
+            type=TimeISO8601(),
+        ),
+        o("--has-comment", is_flag=True, help="Search for photos that have comments."),
+        o("--no-comment", is_flag=True, help="Search for photos with no comments."),
+        o("--has-likes", is_flag=True, help="Search for photos that have likes."),
+        o("--no-likes", is_flag=True, help="Search for photos with no likes."),
+        o(
+            "--is-reference",
+            is_flag=True,
+            help="Search for photos that were imported as referenced files (not copied into Photos library).",
+        ),
+        o(
+            "--in-album",
+            is_flag=True,
+            help="Search for photos that are in one or more albums.",
+        ),
+        o(
+            "--not-in-album",
+            is_flag=True,
+            help="Search for photos that are not in any albums.",
+        ),
+        o(
+            "--duplicate",
+            is_flag=True,
+            help="Search for photos with possible duplicates. osxphotos will compare signatures of photos, "
+            "evaluating date created, size, height, width, and edited status to find *possible* duplicates. "
+            "This does not compare images byte-for-byte nor compare hashes but should find photos imported multiple "
+            "times or duplicated within Photos.",
+        ),
+        o(
+            "--min-size",
+            metavar="SIZE",
+            type=BitMathSize(),
+            help="Search for photos with size >= SIZE bytes. "
+            "The size evaluated is the photo's original size (when imported to Photos). "
+            "Size may be specified as integer bytes or using SI or NIST units. "
+            "For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.",
+        ),
+        o(
+            "--max-size",
+            metavar="SIZE",
+            type=BitMathSize(),
+            help="Search for photos with size <= SIZE bytes. "
+            "The size evaluated is the photo's original size (when imported to Photos). "
+            "Size may be specified as integer bytes or using SI or NIST units. "
+            "For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'.",
+        ),
+        o(
+            "--regex",
+            metavar="REGEX TEMPLATE",
+            nargs=2,
+            multiple=True,
+            help="Search for photos where TEMPLATE matches regular expression REGEX. "
+            "For example, to find photos in an album that begins with 'Beach': '--regex \"^Beach\" \"{album}\"'. "
+            "You may specify more than one regular expression match by repeating '--regex' with different arguments.",
+        ),
+        o(
+            "--selected",
+            is_flag=True,
+            help="Filter for photos that are currently selected in Photos.",
+        ),
+        o(
+            "--exif",
+            metavar="EXIF_TAG VALUE",
+            nargs=2,
+            multiple=True,
+            help="Search for photos where EXIF_TAG exists in photo's EXIF data and contains VALUE. "
+            "For example, to find photos created by Adobe Photoshop: `--exif Software 'Adobe Photoshop' `"
+            "or to find all photos shot on a Canon camera: `--exif Make Canon`. "
+            "EXIF_TAG can be any valid exiftool tag, with or without group name, e.g. `EXIF:Make` or `Make`. "
+            "To use --exif, exiftool must be installed and in the path.",
+        ),
+        o(
+            "--query-eval",
+            metavar="CRITERIA",
+            multiple=True,
+            help="Evaluate CRITERIA to filter photos. "
+            "CRITERIA will be evaluated in context of the following python list comprehension: "
+            "`photos = [photo for photo in photos if CRITERIA]` "
+            "where photo represents a PhotoInfo object. "
+            "For example: `--query-eval photo.favorite` returns all photos that have been "
+            "favorited and is equivalent to --favorite. "
+            "You may specify more than one CRITERIA by using --query-eval multiple times. "
+            "CRITERIA must be a valid python expression. "
+            "See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.",
+        ),
+        o(
+            "--query-function",
+            metavar="filename.py::function",
+            multiple=True,
+            type=FunctionCall(),
+            help="Run function to filter photos. Use this in format: --query-function filename.py::function where filename.py is a python "
+            + "file you've created and function is the name of the function in the python file you want to call. "
+            + "Your function will be passed a list of PhotoInfo objects and is expected to return a filtered list of PhotoInfo objects. "
+            + "You may use more than one function by repeating the --query-function option with a different value. "
+            + "Your query function will be called after all other query options have been evaluated. "
+            + "See https://github.com/RhetTbull/osxphotos/blob/master/examples/query_function.py for example of how to use this option.",
+        ),
+    ]
+    for o in options[::-1]:
+        f = o(f)
+    return f
+
+
+def load_uuid_from_file(filename):
+    """Load UUIDs from file.  Does not validate UUIDs.
+        Format is 1 UUID per line, any line beginning with # is ignored.
+        Whitespace is stripped.
+
+    Arguments:
+        filename: file name of the file containing UUIDs
+
+    Returns:
+        list of UUIDs or empty list of no UUIDs in file
+
+    Raises:
+        FileNotFoundError if file does not exist
+    """
+
+    if not pathlib.Path(filename).is_file():
+        raise FileNotFoundError(f"Could not find file {filename}")
+
+    uuid = []
+    with open(filename, "r") as uuid_file:
+        for line in uuid_file:
+            line = line.strip()
+            if len(line) and line[0] != "#":
+                uuid.append(line)
+    return uuid

osxphotos/cli/debug_dump.py

@@ -0,0 +1,103 @@
+"""debug-dump command for osxphotos CLI"""
+
+import pprint
+import time
+
+import click
+from rich import print
+
+import osxphotos
+from osxphotos._constants import _PHOTOS_4_VERSION, _UNKNOWN_PLACE
+
+from .common import (
+    DB_ARGUMENT,
+    DB_OPTION,
+    JSON_OPTION,
+    OSXPHOTOS_HIDDEN,
+    get_photos_db,
+    verbose_print,
+)
+from .list import _list_libraries
+
+
+@click.command(hidden=OSXPHOTOS_HIDDEN)
+@DB_OPTION
+@DB_ARGUMENT
+@click.option(
+    "--dump",
+    metavar="ATTR",
+    help="Name of PhotosDB attribute to print; "
+    + "can also use albums, persons, keywords, photos to dump related attributes.",
+    multiple=True,
+)
+@click.option(
+    "--uuid",
+    metavar="UUID",
+    help="Use with '--dump photos' to dump only certain UUIDs. "
+    "May be repeated to include multiple UUIDs.",
+    multiple=True,
+)
+@click.option("--verbose", "-V", "verbose", is_flag=True, help="Print verbose output.")
+@click.pass_obj
+@click.pass_context
+def debug_dump(ctx, cli_obj, db, photos_library, dump, uuid, verbose):
+    """Print out debug info"""
+
+    verbose_ = verbose_print(verbose, rich=True)
+    db = get_photos_db(*photos_library, db, cli_obj.db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["debug-dump"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    start_t = time.perf_counter()
+    print(f"Opening database: {db}")
+    photosdb = osxphotos.PhotosDB(dbfile=db, verbose=verbose_)
+    stop_t = time.perf_counter()
+    print(f"Done; took {(stop_t-start_t):.2f} seconds")
+
+    for attr in dump:
+        if attr == "albums":
+            print("_dbalbums_album:")
+            pprint.pprint(photosdb._dbalbums_album)
+            print("_dbalbums_uuid:")
+            pprint.pprint(photosdb._dbalbums_uuid)
+            print("_dbalbum_details:")
+            pprint.pprint(photosdb._dbalbum_details)
+            print("_dbalbum_folders:")
+            pprint.pprint(photosdb._dbalbum_folders)
+            print("_dbfolder_details:")
+            pprint.pprint(photosdb._dbfolder_details)
+        elif attr == "keywords":
+            print("_dbkeywords_keyword:")
+            pprint.pprint(photosdb._dbkeywords_keyword)
+            print("_dbkeywords_uuid:")
+            pprint.pprint(photosdb._dbkeywords_uuid)
+        elif attr == "persons":
+            print("_dbfaces_uuid:")
+            pprint.pprint(photosdb._dbfaces_uuid)
+            print("_dbfaces_pk:")
+            pprint.pprint(photosdb._dbfaces_pk)
+            print("_dbpersons_pk:")
+            pprint.pprint(photosdb._dbpersons_pk)
+            print("_dbpersons_fullname:")
+            pprint.pprint(photosdb._dbpersons_fullname)
+        elif attr == "photos":
+            if uuid:
+                for uuid_ in uuid:
+                    print(f"_dbphotos['{uuid_}']:")
+                    try:
+                        pprint.pprint(photosdb._dbphotos[uuid_])
+                    except KeyError:
+                        print(f"Did not find uuid {uuid_} in _dbphotos")
+            else:
+                print("_dbphotos:")
+                pprint.pprint(photosdb._dbphotos)
+        else:
+            try:
+                val = getattr(photosdb, attr)
+                print(f"{attr}:")
+                pprint.pprint(val)
+            except Exception:
+                print(f"Did not find attribute {attr} in PhotosDB")

osxphotos/cli/dump.py

@@ -0,0 +1,44 @@
+"""dump command for osxphotos CLI """
+
+import click
+
+import osxphotos
+from osxphotos.queryoptions import QueryOptions
+
+from .common import DB_ARGUMENT, DB_OPTION, DELETED_OPTIONS, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+from .print_photo_info import print_photo_info
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DELETED_OPTIONS
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def dump(ctx, cli_obj, db, json_, deleted, deleted_only, photos_library):
+    """Print list of all photos & associated info from the Photos library."""
+
+    db = get_photos_db(*photos_library, db, cli_obj.db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["dump"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    # check exclusive options
+    if deleted and deleted_only:
+        click.echo("Incompatible dump options", err=True)
+        click.echo(ctx.obj.group.commands["dump"].get_help(ctx), err=True)
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    if deleted or deleted_only:
+        photos = photosdb.photos(movies=True, intrash=True)
+    else:
+        photos = []
+    if not deleted_only:
+        photos += photosdb.photos(movies=True)
+
+    print_photo_info(photos, json_ or cli_obj.json)

osxphotos/cli/exportdb.py

@@ -0,0 +1,251 @@
+"""exportdb command for osxphotos CLI"""
+
+import pathlib
+import sys
+
+import click
+from rich import print
+
+from osxphotos._constants import OSXPHOTOS_EXPORT_DB
+from osxphotos._version import __version__
+from osxphotos.export_db import OSXPHOTOS_EXPORTDB_VERSION, ExportDB
+from osxphotos.export_db_utils import (
+    export_db_check_signatures,
+    export_db_get_last_run,
+    export_db_get_version,
+    export_db_save_config_to_file,
+    export_db_touch_files,
+    export_db_update_signatures,
+    export_db_vacuum,
+)
+
+from .common import OSXPHOTOS_HIDDEN, verbose_print
+
+
+@click.command(name="exportdb", hidden=OSXPHOTOS_HIDDEN)
+@click.option("--version", is_flag=True, help="Print export database version and exit.")
+@click.option("--vacuum", is_flag=True, help="Run VACUUM to defragment the database.")
+@click.option(
+    "--check-signatures",
+    is_flag=True,
+    help="Check signatures for all exported photos in the database to find signatures that don't match.",
+)
+@click.option(
+    "--update-signatures",
+    is_flag=True,
+    help="Update signatures for all exported photos in the database to match on-disk signatures.",
+)
+@click.option(
+    "--touch-file",
+    is_flag=True,
+    help="Touch files on disk to match created date in Photos library and update export database signatures",
+)
+@click.option(
+    "--last-run",
+    is_flag=True,
+    help="Show last run osxphotos commands used with this database.",
+)
+@click.option(
+    "--save-config",
+    metavar="CONFIG_FILE",
+    help="Save last run configuration to TOML file for use by --load-config.",
+)
+@click.option(
+    "--info",
+    metavar="FILE_PATH",
+    nargs=1,
+    help="Print information about FILE_PATH contained in the database.",
+)
+@click.option(
+    "--migrate",
+    is_flag=True,
+    help="Migrate (if needed) export database to current version.",
+)
+@click.option(
+    "--sql",
+    metavar="SQL_STATEMENT",
+    help="Execute SQL_STATEMENT against export database and print results.",
+)
+@click.option(
+    "--export-dir",
+    help="Optional path to export directory (if not parent of export database).",
+    type=click.Path(exists=True, file_okay=False, dir_okay=True),
+)
+@click.option("--verbose", "-V", is_flag=True, help="Print verbose output.")
+@click.option(
+    "--dry-run",
+    is_flag=True,
+    help="Run in dry-run mode (don't actually update files), e.g. for use with --update-signatures.",
+)
+@click.argument("export_db", metavar="EXPORT_DATABASE", type=click.Path(exists=True))
+def exportdb(
+    version,
+    vacuum,
+    check_signatures,
+    update_signatures,
+    touch_file,
+    last_run,
+    save_config,
+    info,
+    migrate,
+    sql,
+    export_dir,
+    verbose,
+    dry_run,
+    export_db,
+):
+    """Utilities for working with the osxphotos export database"""
+
+    verbose_ = verbose_print(verbose, rich=True)
+
+    export_db = pathlib.Path(export_db)
+    if export_db.is_dir():
+        # assume it's the export folder
+        export_db = export_db / OSXPHOTOS_EXPORT_DB
+        if not export_db.is_file():
+            print(
+                f"[red]Error: {OSXPHOTOS_EXPORT_DB} missing from {export_db.parent}[/red]"
+            )
+            sys.exit(1)
+
+    export_dir = export_dir or export_db.parent
+
+    sub_commands = [
+        version,
+        check_signatures,
+        update_signatures,
+        touch_file,
+        last_run,
+        bool(save_config),
+        bool(info),
+        migrate,
+        bool(sql),
+    ]
+    if sum(sub_commands) > 1:
+        print("[red]Only a single sub-command may be specified at a time[/red]")
+        sys.exit(1)
+
+    if version:
+        try:
+            osxphotos_ver, export_db_ver = export_db_get_version(export_db)
+        except Exception as e:
+            print(f"[red]Error: could not read version from {export_db}: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(
+                f"osxphotos version: {osxphotos_ver}, export database version: {export_db_ver}"
+            )
+        sys.exit(0)
+
+    if vacuum:
+        try:
+            start_size = pathlib.Path(export_db).stat().st_size
+            export_db_vacuum(export_db)
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(
+                f"Vacuumed {export_db}! {start_size} bytes -> {pathlib.Path(export_db).stat().st_size} bytes"
+            )
+            sys.exit(0)
+
+    if update_signatures:
+        try:
+            updated, skipped = export_db_update_signatures(
+                export_db, export_dir, verbose_, dry_run
+            )
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(f"Done. Updated {updated} files, skipped {skipped} files.")
+            sys.exit(0)
+
+    if last_run:
+        try:
+            last_run_info = export_db_get_last_run(export_db)
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(f"last run at {last_run_info[0]}:")
+            print(f"osxphotos {last_run_info[1]}")
+            sys.exit(0)
+
+    if save_config:
+        try:
+            export_db_save_config_to_file(export_db, save_config)
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(f"Saved configuration to {save_config}")
+            sys.exit(0)
+
+    if check_signatures:
+        try:
+            matched, notmatched, skipped = export_db_check_signatures(
+                export_db, export_dir, verbose_=verbose_
+            )
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(
+                f"Done. Found {matched} matching signatures and {notmatched} signatures that don't match. Skipped {skipped} missing files."
+            )
+            sys.exit(0)
+
+    if touch_file:
+        try:
+            touched, not_touched, skipped = export_db_touch_files(
+                export_db, export_dir, verbose_=verbose_, dry_run=dry_run
+            )
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            print(
+                f"Done. Touched {touched} files, skipped {not_touched} up to date files, skipped {skipped} missing files."
+            )
+            sys.exit(0)
+
+    if info:
+        exportdb = ExportDB(export_db, export_dir)
+        try:
+            info_rec = exportdb.get_file_record(info)
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            if info_rec:
+                print(info_rec.asdict())
+            else:
+                print(f"[red]File '{info}' not found in export database[/red]")
+            sys.exit(0)
+
+    if migrate:
+        exportdb = ExportDB(export_db, export_dir)
+        if upgraded := exportdb.was_upgraded:
+            print(
+                f"Migrated export database {export_db} from version {upgraded[0]} to {upgraded[1]}"
+            )
+        else:
+            print(
+                f"Export database {export_db} is already at latest version {OSXPHOTOS_EXPORTDB_VERSION}"
+            )
+        sys.exit(0)
+
+    if sql:
+        exportdb = ExportDB(export_db, export_dir)
+        try:
+            c = exportdb._conn.cursor()
+            results = c.execute(sql)
+        except Exception as e:
+            print(f"[red]Error: {e}[/red]")
+            sys.exit(1)
+        else:
+            for row in results:
+                print(row)
+            sys.exit(0)

osxphotos/cli/grep.py

@@ -0,0 +1,57 @@
+"""grep command for osxphotos CLI """
+
+import pathlib
+
+import click
+from rich import print
+
+from osxphotos.photosdb.photosdb_utils import get_photos_library_version
+from osxphotos.sqlgrep import sqlgrep
+
+from .common import DB_OPTION, OSXPHOTOS_HIDDEN, get_photos_db
+
+
+@click.command(name="grep", hidden=OSXPHOTOS_HIDDEN)
+@DB_OPTION
+@click.pass_obj
+@click.pass_context
+@click.option(
+    "--ignore-case",
+    "-i",
+    required=False,
+    is_flag=True,
+    default=False,
+    help="Ignore case when searching (default is case-sensitive).",
+)
+@click.option(
+    "--print-filename",
+    "-p",
+    required=False,
+    is_flag=True,
+    default=False,
+    help="Print name of database file when printing results.",
+)
+@click.argument("pattern", metavar="PATTERN", required=True)
+def grep(ctx, cli_obj, db, ignore_case, print_filename, pattern):
+    """Search for PATTERN in the Photos sqlite database file"""
+    db = db or get_photos_db()
+    db = pathlib.Path(db)
+    if db.is_file():
+        # if passed the actual database, really want the parent of the database directory
+        db = db.parent.parent
+    photos_ver = get_photos_library_version(str(db))
+    if photos_ver < 5:
+        db_file = db / "database" / "photos.db"
+    else:
+        db_file = db / "database" / "Photos.sqlite"
+
+    if not db_file.is_file():
+        click.secho(f"Could not find database file {db_file}", fg="red")
+        ctx.exit(2)
+
+    db_file = str(db_file)
+
+    for table, column, row_id, value in sqlgrep(
+        db_file, pattern, ignore_case, print_filename, rich_markup=True
+    ):
+        print(", ".join([table, column, row_id, value]))

osxphotos/cli/help.py

@@ -1,7 +1,6 @@
 """Help text helper class for osxphotos CLI """
 
 import io
-import pathlib
 import re
 
 import click
@@ -9,19 +8,52 @@ import osxmetadata
 from rich.console import Console
 from rich.markdown import Markdown
 
-from ._constants import (
+from osxphotos._constants import (
     EXTENDED_ATTRIBUTE_NAMES,
     EXTENDED_ATTRIBUTE_NAMES_QUOTED,
     OSXPHOTOS_EXPORT_DB,
     POST_COMMAND_CATEGORIES,
 )
-from .phototemplate import (
+from osxphotos.phototemplate import (
     TEMPLATE_SUBSTITUTIONS,
     TEMPLATE_SUBSTITUTIONS_MULTI_VALUED,
     TEMPLATE_SUBSTITUTIONS_PATHLIB,
     get_template_help,
 )
 
+__all__ = [
+    "ExportCommand",
+    "template_help",
+    "rich_text",
+    "strip_md_header_and_links",
+    "strip_md_links",
+    "strip_html_comments",
+    "help",
+    "get_help_msg",
+]
+
+
+def get_help_msg(command):
+    """get help message for a Click command"""
+    with click.Context(command) as ctx:
+        return command.get_help(ctx)
+
+
+@click.command()
+@click.argument("topic", default=None, required=False, nargs=1)
+@click.pass_context
+def help(ctx, topic, **kw):
+    """Print help; for help on commands: help <command>."""
+    if topic is None:
+        click.echo(ctx.parent.get_help())
+        return
+    elif topic in ctx.obj.group.commands:
+        ctx.info_name = topic
+        click.echo_via_pager(ctx.obj.group.commands[topic].get_help(ctx))
+    else:
+        click.echo(f"Invalid command: {topic}", err=True)
+        click.echo(ctx.parent.get_help())
+
 
 # TODO: The following help text could probably be done as mako template
 class ExportCommand(click.Command):
@@ -207,7 +239,7 @@ The following attributes may be used with '--xattr-template':
             + "The following categories are available: "
         )
         formatter.write("\n")
-        templ_tuples = [("Catgory", "Description")]
+        templ_tuples = [("Category", "Description")]
         templ_tuples.extend((k, v) for k, v in POST_COMMAND_CATEGORIES.items())
         formatter.write_dl(templ_tuples)
         formatter.write("\n")
@@ -224,13 +256,13 @@ The following attributes may be used with '--xattr-template':
         )
         formatter.write("\n")
         formatter.write(
-            '--post-command new "echo {filepath.name|shell_quote} >> {shell_quote,{export_dir}/exported.txt}"'
+            '--post-command new "echo {filepath|shell_quote} >> {shell_quote,{export_dir}/exported.txt}"'
         )
         formatter.write("\n\n")
         formatter.write_text(
-            "In the above command, the 'shell_quote' filter is used to ensure '{filepath.name}' is properly quoted "
+            "In the above command, the 'shell_quote' filter is used to ensure '{filepath}' is properly quoted "
             + "and the '{shell_quote}' template ensures the constructed path of '{exported_dir}/exported.txt' is properly quoted. "
-            "If '{filepath.name}' is 'IMG 1234.jpeg' and '{export_dir}' is '/Volumes/Photo Export', the command "
+            "If '{filepath}' is 'IMG 1234.jpeg' and '{export_dir}' is '/Volumes/Photo Export', the command "
             "thus renders to: "
         )
         formatter.write("\n")
@@ -271,19 +303,6 @@ def template_help(width=78):
     return help_str
 
 
-def tutorial_help(width=78):
-    """Return formatted string for tutorial"""
-    sio = io.StringIO()
-    console = Console(file=sio, force_terminal=True, width=width)
-    help_md = get_tutorial_text()
-    help_md = strip_html_comments(help_md)
-    help_md = strip_md_links(help_md)
-    console.print(Markdown(help_md))
-    help_str = sio.getvalue()
-    sio.close()
-    return help_str
-
-
 def rich_text(text, width=78):
     """Return rich formatted text"""
     sio = io.StringIO()
@@ -337,12 +356,3 @@ def strip_md_links(md):
 def strip_html_comments(text):
     """Strip html comments from text (which doesn't need to be valid HTML)"""
     return re.sub(r"<!--(.|\s|\n)*?-->", "", text)
-
-
-def get_tutorial_text():
-    """Load tutorial text from file"""
-    # TODO: would be better to use importlib.abc.ResourceReader but I can't find a single example of how to do this
-    help_file = pathlib.Path(__file__).parent / "tutorial.md"
-    with open(help_file, "r") as fd:
-        md = fd.read()
-    return md

osxphotos/cli/info.py

@@ -0,0 +1,72 @@
+"""info command for osxphotos CLI"""
+
+import json
+
+import click
+import yaml
+
+import osxphotos
+from osxphotos._constants import _PHOTOS_4_VERSION
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def info(ctx, cli_obj, db, json_, photos_library):
+    """Print out descriptive info of the Photos library database."""
+
+    db = get_photos_db(*photos_library, db, cli_obj.db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["info"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    info = {"database_path": photosdb.db_path, "database_version": photosdb.db_version}
+    photos = photosdb.photos(movies=False)
+    not_shared_photos = [p for p in photos if not p.shared]
+    info["photo_count"] = len(not_shared_photos)
+
+    hidden = [p for p in photos if p.hidden]
+    info["hidden_photo_count"] = len(hidden)
+
+    movies = photosdb.photos(images=False, movies=True)
+    not_shared_movies = [p for p in movies if not p.shared]
+    info["movie_count"] = len(not_shared_movies)
+
+    if photosdb.db_version > _PHOTOS_4_VERSION:
+        shared_photos = [p for p in photos if p.shared]
+        info["shared_photo_count"] = len(shared_photos)
+
+        shared_movies = [p for p in movies if p.shared]
+        info["shared_movie_count"] = len(shared_movies)
+
+    keywords = photosdb.keywords_as_dict
+    info["keywords_count"] = len(keywords)
+    info["keywords"] = keywords
+
+    albums = photosdb.albums_as_dict
+    info["albums_count"] = len(albums)
+    info["albums"] = albums
+
+    if photosdb.db_version > _PHOTOS_4_VERSION:
+        albums_shared = photosdb.albums_shared_as_dict
+        info["shared_albums_count"] = len(albums_shared)
+        info["shared_albums"] = albums_shared
+
+    persons = photosdb.persons_as_dict
+
+    info["persons_count"] = len(persons)
+    info["persons"] = persons
+
+    if cli_obj.json or json_:
+        click.echo(json.dumps(info, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(info, sort_keys=False, allow_unicode=True))

osxphotos/cli/install_uninstall_run.py

@@ -0,0 +1,37 @@
+"""install/uninstall/run commands for osxphotos CLI"""
+
+import sys
+from runpy import run_module, run_path
+
+import click
+
+
+@click.command()
+@click.argument("packages", nargs=-1, required=True)
+@click.option(
+    "-U", "--upgrade", is_flag=True, help="Upgrade packages to latest version"
+)
+def install(packages, upgrade):
+    """Install Python packages into the same environment as osxphotos"""
+    args = ["pip", "install"]
+    if upgrade:
+        args += ["--upgrade"]
+    args += list(packages)
+    sys.argv = args
+    run_module("pip", run_name="__main__")
+
+
+@click.command()
+@click.argument("packages", nargs=-1, required=True)
+@click.option("-y", "--yes", is_flag=True, help="Don't ask for confirmation")
+def uninstall(packages, yes):
+    """Uninstall Python packages from the osxphotos environment"""
+    sys.argv = ["pip", "uninstall"] + list(packages) + (["-y"] if yes else [])
+    run_module("pip", run_name="__main__")
+
+
+@click.command(name="run")
+@click.argument("python_file", nargs=1, type=click.Path(exists=True))
+def run(python_file):
+    """Run a python file using same environment as osxphotos"""
+    run_path(python_file, run_name="__main__")

osxphotos/cli/keywords.py

@@ -0,0 +1,37 @@
+"""keywords command for osxphotos CLI"""
+
+import json
+
+import click
+import yaml
+
+import osxphotos
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def keywords(ctx, cli_obj, db, json_, photos_library):
+    """Print out keywords found in the Photos library."""
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["keywords"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    keywords = {"keywords": photosdb.keywords_as_dict}
+    if json_ or cli_obj.json:
+        click.echo(json.dumps(keywords, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(keywords, sort_keys=False, allow_unicode=True))

osxphotos/cli/labels.py

@@ -0,0 +1,37 @@
+"""labels command for osxphotos CLI"""
+
+import json
+
+import click
+import yaml
+
+import osxphotos
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def labels(ctx, cli_obj, db, json_, photos_library):
+    """Print out image classification labels found in the Photos library."""
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["labels"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    labels = {"labels": photosdb.labels_as_dict}
+    if json_ or cli_obj.json:
+        click.echo(json.dumps(labels, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(labels, sort_keys=False, allow_unicode=True))

osxphotos/cli/list.py

@@ -0,0 +1,57 @@
+"""list command for osxphotos CLI"""
+
+import json
+
+import click
+
+import osxphotos
+
+from .common import JSON_OPTION
+
+
+@click.command(name="list")
+@JSON_OPTION
+@click.pass_obj
+@click.pass_context
+def list_libraries(ctx, cli_obj, json_):
+    """Print list of Photos libraries found on the system."""
+
+    # implemented in _list_libraries so it can be called by other CLI functions
+    # without errors due to passing ctx and cli_obj
+    _list_libraries(json_=json_ or cli_obj.json, error=False)
+
+
+def _list_libraries(json_=False, error=True):
+    """Print list of Photos libraries found on the system.
+    If json_ == True, print output as JSON (default = False)"""
+
+    photo_libs = osxphotos.utils.list_photo_libraries()
+    sys_lib = osxphotos.utils.get_system_library_path()
+    last_lib = osxphotos.utils.get_last_library_path()
+
+    if json_:
+        libs = {
+            "photo_libraries": photo_libs,
+            "system_library": sys_lib,
+            "last_library": last_lib,
+        }
+        click.echo(json.dumps(libs, ensure_ascii=False))
+    else:
+        last_lib_flag = sys_lib_flag = False
+
+        for lib in photo_libs:
+            if lib == sys_lib:
+                click.echo(f"(*)\t{lib}", err=error)
+                sys_lib_flag = True
+            elif lib == last_lib:
+                click.echo(f"(#)\t{lib}", err=error)
+                last_lib_flag = True
+            else:
+                click.echo(f"\t{lib}", err=error)
+
+        if sys_lib_flag or last_lib_flag:
+            click.echo("\n", err=error)
+        if sys_lib_flag:
+            click.echo("(*)\tSystem Photos Library", err=error)
+        if last_lib_flag:
+            click.echo("(#)\tLast opened Photos Library", err=error)

osxphotos/cli/param_types.py

@@ -0,0 +1,108 @@
+"""Click parameter types for osxphotos CLI"""
+import datetime
+import pathlib
+
+import bitmath
+import click
+
+from osxphotos.export_db_utils import export_db_get_version
+from osxphotos.utils import expand_and_validate_filepath, load_function
+
+__all__ = [
+    "BitMathSize",
+    "DateTimeISO8601",
+    "ExportDBType",
+    "FunctionCall",
+    "TimeISO8601",
+]
+
+
+class DateTimeISO8601(click.ParamType):
+
+    name = "DATETIME"
+
+    def convert(self, value, param, ctx):
+        try:
+            return datetime.datetime.fromisoformat(value)
+        except Exception:
+            self.fail(
+                f"Invalid datetime format {value}. "
+                "Valid format: YYYY-MM-DD[*HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]]]"
+            )
+
+
+class BitMathSize(click.ParamType):
+
+    name = "BITMATH"
+
+    def convert(self, value, param, ctx):
+        try:
+            value = bitmath.parse_string(value)
+        except ValueError:
+            # no units specified
+            try:
+                value = int(value)
+                value = bitmath.Byte(value)
+            except ValueError as e:
+                self.fail(
+                    f"{value} must be specified as bytes or using SI/NIST units. "
+                    + "For example, the following are all valid and equivalent sizes: '1048576' '1.048576MB', '1 MiB'."
+                )
+        return value
+
+
+class TimeISO8601(click.ParamType):
+
+    name = "TIME"
+
+    def convert(self, value, param, ctx):
+        try:
+            return datetime.time.fromisoformat(value).replace(tzinfo=None)
+        except Exception:
+            self.fail(
+                f"Invalid time format {value}. "
+                "Valid format: HH[:MM[:SS[.fff[fff]]]][+HH:MM[:SS[.ffffff]]] "
+                "however, note that timezone will be ignored."
+            )
+
+
+class FunctionCall(click.ParamType):
+    name = "FUNCTION"
+
+    def convert(self, value, param, ctx):
+        if "::" not in value:
+            self.fail(
+                f"Could not parse function name from '{value}'. "
+                "Valid format filename.py::function"
+            )
+
+        filename, funcname = value.split("::")
+
+        filename_validated = expand_and_validate_filepath(filename)
+        if not filename_validated:
+            self.fail(f"'{filename}' does not appear to be a file")
+
+        try:
+            function = load_function(filename_validated, funcname)
+        except Exception as e:
+            self.fail(f"Could not load function {funcname} from {filename_validated}")
+
+        return (function, value)
+
+
+class ExportDBType(click.ParamType):
+
+    name = "EXPORTDB"
+
+    def convert(self, value, param, ctx):
+        try:
+            export_db_name = pathlib.Path(value)
+            if export_db_name.is_dir():
+                raise click.BadParameter(f"{value} is a directory")
+            if export_db_name.is_file():
+                # verify it's actually an osxphotos export_db
+                # export_db_get_version will raise an error if it's not valid
+                osxphotos_ver, export_db_ver = export_db_get_version(value)
+            return value
+        except Exception:
+            self.fail(f"{value} exists but is not a valid osxphotos export database. ")

osxphotos/cli/persons.py

@@ -0,0 +1,36 @@
+"""persons command for osxphotos CLI"""
+import json
+
+import click
+import yaml
+
+import osxphotos
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def persons(ctx, cli_obj, db, json_, photos_library):
+    """Print out persons (faces) found in the Photos library."""
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["persons"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    persons = {"persons": photosdb.persons_as_dict}
+    if json_ or cli_obj.json:
+        click.echo(json.dumps(persons, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(persons, sort_keys=False, allow_unicode=True))

osxphotos/cli/places.py

@@ -0,0 +1,62 @@
+"""places command for osxphotos CLI"""
+
+import json
+
+import click
+import yaml
+
+import osxphotos
+from osxphotos._constants import _PHOTOS_4_VERSION, _UNKNOWN_PLACE
+
+from .common import DB_ARGUMENT, DB_OPTION, JSON_OPTION, get_photos_db
+from .list import _list_libraries
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def places(ctx, cli_obj, db, json_, photos_library):
+    """Print out places found in the Photos library."""
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["places"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    place_names = {}
+    for photo in photosdb.photos(movies=True):
+        if photo.place:
+            try:
+                place_names[photo.place.name] += 1
+            except Exception:
+                place_names[photo.place.name] = 1
+        else:
+            try:
+                place_names[_UNKNOWN_PLACE] += 1
+            except Exception:
+                place_names[_UNKNOWN_PLACE] = 1
+
+    # sort by place count
+    places = {
+        "places": {
+            name: place_names[name]
+            for name in sorted(
+                place_names.keys(), key=lambda key: place_names[key], reverse=True
+            )
+        }
+    }
+
+    # below needed for to make CliRunner work for testing
+    cli_json = cli_obj.json if cli_obj is not None else None
+    if json_ or cli_json:
+        click.echo(json.dumps(places, ensure_ascii=False))
+    else:
+        click.echo(yaml.dump(places, sort_keys=False, allow_unicode=True))

osxphotos/cli/print_photo_info.py

@@ -0,0 +1,112 @@
+"""print_photo_info function to print PhotoInfo objects"""
+
+import csv
+import sys
+from typing import Callable, List
+
+from osxphotos.photoinfo import PhotoInfo
+
+
+def print_photo_info(
+    photos: List[PhotoInfo], json: bool = False, print_func: Callable = print
+):
+    dump = []
+    if json:
+        dump.extend(p.json() for p in photos)
+        print_func(f"[{', '.join(dump)}]")
+    else:
+        # dump as CSV
+        csv_writer = csv.writer(
+            sys.stdout, delimiter=",", quotechar='"', quoting=csv.QUOTE_MINIMAL
+        )
+        # add headers
+        dump.append(
+            [
+                "uuid",
+                "filename",
+                "original_filename",
+                "date",
+                "description",
+                "title",
+                "keywords",
+                "albums",
+                "persons",
+                "path",
+                "ismissing",
+                "hasadjustments",
+                "external_edit",
+                "favorite",
+                "hidden",
+                "shared",
+                "latitude",
+                "longitude",
+                "path_edited",
+                "isphoto",
+                "ismovie",
+                "uti",
+                "burst",
+                "live_photo",
+                "path_live_photo",
+                "iscloudasset",
+                "incloud",
+                "date_modified",
+                "portrait",
+                "screenshot",
+                "slow_mo",
+                "time_lapse",
+                "hdr",
+                "selfie",
+                "panorama",
+                "has_raw",
+                "uti_raw",
+                "path_raw",
+                "intrash",
+            ]
+        )
+        for p in photos:
+            date_modified_iso = p.date_modified.isoformat() if p.date_modified else None
+            dump.append(
+                [
+                    p.uuid,
+                    p.filename,
+                    p.original_filename,
+                    p.date.isoformat(),
+                    p.description,
+                    p.title,
+                    ", ".join(p.keywords),
+                    ", ".join(p.albums),
+                    ", ".join(p.persons),
+                    p.path,
+                    p.ismissing,
+                    p.hasadjustments,
+                    p.external_edit,
+                    p.favorite,
+                    p.hidden,
+                    p.shared,
+                    p._latitude,
+                    p._longitude,
+                    p.path_edited,
+                    p.isphoto,
+                    p.ismovie,
+                    p.uti,
+                    p.burst,
+                    p.live_photo,
+                    p.path_live_photo,
+                    p.iscloudasset,
+                    p.incloud,
+                    date_modified_iso,
+                    p.portrait,
+                    p.screenshot,
+                    p.slow_mo,
+                    p.time_lapse,
+                    p.hdr,
+                    p.selfie,
+                    p.panorama,
+                    p.has_raw,
+                    p.uti_raw,
+                    p.path_raw,
+                    p.intrash,
+                ]
+            )
+        for row in dump:
+            csv_writer.writerow(row)

osxphotos/cli/query.py

@@ -0,0 +1,358 @@
+"""query command for osxphotos CLI"""
+
+import click
+
+import osxphotos
+from osxphotos.photosalbum import PhotosAlbum
+from osxphotos.queryoptions import QueryOptions
+
+from .common import (
+    CLI_COLOR_ERROR,
+    CLI_COLOR_WARNING,
+    DB_ARGUMENT,
+    DB_OPTION,
+    DELETED_OPTIONS,
+    JSON_OPTION,
+    OSXPHOTOS_HIDDEN,
+    QUERY_OPTIONS,
+    get_photos_db,
+    load_uuid_from_file,
+    set_debug,
+)
+from .list import _list_libraries
+from .print_photo_info import print_photo_info
+
+
+@click.command()
+@DB_OPTION
+@JSON_OPTION
+@QUERY_OPTIONS
+@DELETED_OPTIONS
+@click.option("--missing", is_flag=True, help="Search for photos missing from disk.")
+@click.option(
+    "--not-missing",
+    is_flag=True,
+    help="Search for photos present on disk (e.g. not missing).",
+)
+@click.option(
+    "--cloudasset",
+    is_flag=True,
+    help="Search for photos that are part of an iCloud library",
+)
+@click.option(
+    "--not-cloudasset",
+    is_flag=True,
+    help="Search for photos that are not part of an iCloud library",
+)
+@click.option(
+    "--incloud",
+    is_flag=True,
+    help="Search for photos that are in iCloud (have been synched)",
+)
+@click.option(
+    "--not-incloud",
+    is_flag=True,
+    help="Search for photos that are not in iCloud (have not been synched)",
+)
+@click.option(
+    "--add-to-album",
+    metavar="ALBUM",
+    help="Add all photos from query to album ALBUM in Photos. Album ALBUM will be created "
+    "if it doesn't exist.  All photos in the query results will be added to this album. "
+    "This only works if the Photos library being queried is the last-opened (default) library in Photos. "
+    "This feature is currently experimental.  I don't know how well it will work on large query sets.",
+)
+@click.option(
+    "--debug", required=False, is_flag=True, default=False, hidden=OSXPHOTOS_HIDDEN
+)
+@DB_ARGUMENT
+@click.pass_obj
+@click.pass_context
+def query(
+    ctx,
+    cli_obj,
+    db,
+    photos_library,
+    keyword,
+    person,
+    album,
+    folder,
+    name,
+    uuid,
+    uuid_from_file,
+    title,
+    no_title,
+    description,
+    no_description,
+    ignore_case,
+    json_,
+    edited,
+    external_edit,
+    favorite,
+    not_favorite,
+    hidden,
+    not_hidden,
+    missing,
+    not_missing,
+    shared,
+    not_shared,
+    only_movies,
+    only_photos,
+    uti,
+    burst,
+    not_burst,
+    live,
+    not_live,
+    cloudasset,
+    not_cloudasset,
+    incloud,
+    not_incloud,
+    from_date,
+    to_date,
+    from_time,
+    to_time,
+    portrait,
+    not_portrait,
+    screenshot,
+    not_screenshot,
+    slow_mo,
+    not_slow_mo,
+    time_lapse,
+    not_time_lapse,
+    hdr,
+    not_hdr,
+    selfie,
+    not_selfie,
+    panorama,
+    not_panorama,
+    has_raw,
+    place,
+    no_place,
+    location,
+    no_location,
+    label,
+    deleted,
+    deleted_only,
+    has_comment,
+    no_comment,
+    has_likes,
+    no_likes,
+    is_reference,
+    in_album,
+    not_in_album,
+    duplicate,
+    min_size,
+    max_size,
+    regex,
+    selected,
+    exif,
+    query_eval,
+    query_function,
+    add_to_album,
+    debug,
+):
+    """Query the Photos database using 1 or more search options;
+    if more than one option is provided, they are treated as "AND"
+    (e.g. search for photos matching all options).
+    """
+
+    if debug:
+        set_debug(True)
+        osxphotos._set_debug(True)
+
+    # if no query terms, show help and return
+    # sanity check input args
+    nonexclusive = [
+        keyword,
+        person,
+        album,
+        folder,
+        name,
+        uuid,
+        uuid_from_file,
+        edited,
+        external_edit,
+        uti,
+        has_raw,
+        from_date,
+        to_date,
+        from_time,
+        to_time,
+        label,
+        is_reference,
+        query_eval,
+        query_function,
+        min_size,
+        max_size,
+        regex,
+        selected,
+        exif,
+        duplicate,
+    ]
+    exclusive = [
+        (favorite, not_favorite),
+        (hidden, not_hidden),
+        (missing, not_missing),
+        (any(title), no_title),
+        (any(description), no_description),
+        (only_photos, only_movies),
+        (burst, not_burst),
+        (live, not_live),
+        (cloudasset, not_cloudasset),
+        (incloud, not_incloud),
+        (portrait, not_portrait),
+        (screenshot, not_screenshot),
+        (slow_mo, not_slow_mo),
+        (time_lapse, not_time_lapse),
+        (hdr, not_hdr),
+        (selfie, not_selfie),
+        (panorama, not_panorama),
+        (any(place), no_place),
+        (deleted, deleted_only),
+        (shared, not_shared),
+        (has_comment, no_comment),
+        (has_likes, no_likes),
+        (in_album, not_in_album),
+        (location, no_location),
+    ]
+    # print help if no non-exclusive term or a double exclusive term is given
+    if any(all(bb) for bb in exclusive) or not any(
+        nonexclusive + [b ^ n for b, n in exclusive]
+    ):
+        click.echo("Incompatible query options", err=True)
+        click.echo(ctx.obj.group.commands["query"].get_help(ctx), err=True)
+        return
+
+    # actually have something to query
+    # default searches for everything
+    photos = True
+    movies = True
+    if only_movies:
+        photos = False
+    if only_photos:
+        movies = False
+
+    # load UUIDs if necessary and append to any uuids passed with --uuid
+    if uuid_from_file:
+        uuid_list = list(uuid)  # Click option is a tuple
+        uuid_list.extend(load_uuid_from_file(uuid_from_file))
+        uuid = tuple(uuid_list)
+
+    # below needed for to make CliRunner work for testing
+    cli_db = cli_obj.db if cli_obj is not None else None
+    db = get_photos_db(*photos_library, db, cli_db)
+    if db is None:
+        click.echo(ctx.obj.group.commands["query"].get_help(ctx), err=True)
+        click.echo("\n\nLocated the following Photos library databases: ", err=True)
+        _list_libraries()
+        return
+
+    photosdb = osxphotos.PhotosDB(dbfile=db)
+    query_options = QueryOptions(
+        keyword=keyword,
+        person=person,
+        album=album,
+        folder=folder,
+        uuid=uuid,
+        title=title,
+        no_title=no_title,
+        description=description,
+        no_description=no_description,
+        ignore_case=ignore_case,
+        edited=edited,
+        external_edit=external_edit,
+        favorite=favorite,
+        not_favorite=not_favorite,
+        hidden=hidden,
+        not_hidden=not_hidden,
+        missing=missing,
+        not_missing=not_missing,
+        shared=shared,
+        not_shared=not_shared,
+        photos=photos,
+        movies=movies,
+        uti=uti,
+        burst=burst,
+        not_burst=not_burst,
+        live=live,
+        not_live=not_live,
+        cloudasset=cloudasset,
+        not_cloudasset=not_cloudasset,
+        incloud=incloud,
+        not_incloud=not_incloud,
+        from_date=from_date,
+        to_date=to_date,
+        from_time=from_time,
+        to_time=to_time,
+        portrait=portrait,
+        not_portrait=not_portrait,
+        screenshot=screenshot,
+        not_screenshot=not_screenshot,
+        slow_mo=slow_mo,
+        not_slow_mo=not_slow_mo,
+        time_lapse=time_lapse,
+        not_time_lapse=not_time_lapse,
+        hdr=hdr,
+        not_hdr=not_hdr,
+        selfie=selfie,
+        not_selfie=not_selfie,
+        panorama=panorama,
+        not_panorama=not_panorama,
+        has_raw=has_raw,
+        place=place,
+        no_place=no_place,
+        location=location,
+        no_location=no_location,
+        label=label,
+        deleted=deleted,
+        deleted_only=deleted_only,
+        has_comment=has_comment,
+        no_comment=no_comment,
+        has_likes=has_likes,
+        no_likes=no_likes,
+        is_reference=is_reference,
+        in_album=in_album,
+        not_in_album=not_in_album,
+        name=name,
+        min_size=min_size,
+        max_size=max_size,
+        query_eval=query_eval,
+        function=query_function,
+        regex=regex,
+        selected=selected,
+        exif=exif,
+        duplicate=duplicate,
+    )
+
+    try:
+        photos = photosdb.query(query_options)
+    except ValueError as e:
+        if "Invalid query_eval CRITERIA:" in str(e):
+            msg = str(e).split(":")[1]
+            raise click.BadOptionUsage(
+                "query_eval", f"Invalid query-eval CRITERIA: {msg}"
+            )
+        else:
+            raise ValueError(e)
+
+    # below needed for to make CliRunner work for testing
+    cli_json = cli_obj.json if cli_obj is not None else None
+
+    if add_to_album and photos:
+        album_query = PhotosAlbum(add_to_album, verbose=None)
+        photo_len = len(photos)
+        photo_word = "photos" if photo_len > 1 else "photo"
+        click.echo(
+            f"Adding {photo_len} {photo_word} to album '{album_query.name}'. Note: Photos may prompt you to confirm this action.",
+            err=True,
+        )
+        try:
+            album_query.add_list(photos)
+        except Exception as e:
+            click.secho(
+                f"Error adding photos to album {add_to_album}: {e}",
+                fg=CLI_COLOR_ERROR,
+                err=True,
+            )
+
+    print_photo_info(photos, cli_json or json_, print_func=click.echo)

osxphotos/cli/repl.py

@@ -0,0 +1,339 @@
+"""repl command for osxphotos CLI"""
+
+import dataclasses
+import os
+import os.path
+import pathlib
+import sys
+import time
+from typing import List
+
+import click
+import photoscript
+from rich import pretty, print
+
+import osxphotos
+from osxphotos._constants import _PHOTOS_4_VERSION
+from osxphotos.photoinfo import PhotoInfo
+from osxphotos.photosdb import PhotosDB
+from osxphotos.pyrepl import embed_repl
+from osxphotos.queryoptions import QueryOptions
+
+from .common import (
+    DB_ARGUMENT,
+    DB_OPTION,
+    DELETED_OPTIONS,
+    QUERY_OPTIONS,
+    get_photos_db,
+    load_uuid_from_file,
+)
+
+
+class IncompatibleQueryOptions(Exception):
+    pass
+
+
+@click.command(name="repl")
+@DB_OPTION
+@click.pass_obj
+@click.pass_context
+@click.option(
+    "--emacs",
+    required=False,
+    is_flag=True,
+    default=False,
+    help="Launch REPL with Emacs keybindings (default is vi bindings)",
+)
+@click.option(
+    "--beta",
+    is_flag=True,
+    default=False,
+    hidden=True,
+    help="Enable beta options.",
+)
+@QUERY_OPTIONS
+@DELETED_OPTIONS
+@click.option("--missing", is_flag=True, help="Search for photos missing from disk.")
+@click.option(
+    "--not-missing",
+    is_flag=True,
+    help="Search for photos present on disk (e.g. not missing).",
+)
+@click.option(
+    "--cloudasset",
+    is_flag=True,
+    help="Search for photos that are part of an iCloud library",
+)
+@click.option(
+    "--not-cloudasset",
+    is_flag=True,
+    help="Search for photos that are not part of an iCloud library",
+)
+@click.option(
+    "--incloud",
+    is_flag=True,
+    help="Search for photos that are in iCloud (have been synched)",
+)
+@click.option(
+    "--not-incloud",
+    is_flag=True,
+    help="Search for photos that are not in iCloud (have not been synched)",
+)
+def repl(ctx, cli_obj, db, emacs, beta, **kwargs):
+    """Run interactive osxphotos REPL shell (useful for debugging, prototyping, and inspecting your Photos library)"""
+    import logging
+
+    from objexplore import explore
+    from photoscript import Album, Photo, PhotosLibrary
+    from rich import inspect as _inspect
+
+    from osxphotos import ExifTool, PhotoInfo, PhotosDB
+    from osxphotos.albuminfo import AlbumInfo
+    from osxphotos.momentinfo import MomentInfo
+    from osxphotos.photoexporter import ExportOptions, ExportResults, PhotoExporter
+    from osxphotos.placeinfo import PlaceInfo
+    from osxphotos.queryoptions import QueryOptions
+    from osxphotos.scoreinfo import ScoreInfo
+    from osxphotos.searchinfo import SearchInfo
+
+    logger = logging.getLogger()
+    logger.disabled = True
+
+    pretty.install()
+    print(f"python version: {sys.version}")
+    print(f"osxphotos version: {osxphotos._version.__version__}")
+    db = db or get_photos_db()
+    photosdb = _load_photos_db(db)
+    # enable beta features if requested
+    if beta:
+        photosdb._beta = beta
+        print("Beta mode enabled")
+    print("Getting photos")
+    tic = time.perf_counter()
+    try:
+        query_options = _query_options_from_kwargs(**kwargs)
+    except IncompatibleQueryOptions:
+        click.echo("Incompatible query options", err=True)
+        click.echo(ctx.obj.group.commands["repl"].get_help(ctx), err=True)
+        sys.exit(1)
+    photos = _query_photos(photosdb, query_options)
+    all_photos = _get_all_photos(photosdb)
+    toc = time.perf_counter()
+    tictoc = toc - tic
+
+    # shortcut for helper functions
+    get_photo = photosdb.get_photo
+    show = _show_photo
+    spotlight = _spotlight_photo
+    get_selected = _get_selected(photosdb)
+    try:
+        selected = get_selected()
+    except Exception:
+        # get_selected sometimes fails
+        selected = []
+
+    def inspect(obj):
+        """inspect object"""
+        return _inspect(obj, methods=True)
+
+    print(f"Found {len(photos)} photos in {tictoc:0.2f} seconds\n")
+    print("The following classes have been imported from osxphotos:")
+    print(
+        "- AlbumInfo, ExifTool, PhotoInfo, PhotoExporter, ExportOptions, ExportResults, PhotosDB, PlaceInfo, QueryOptions, MomentInfo, ScoreInfo, SearchInfo\n"
+    )
+    print("The following variables are defined:")
+    print(f"- photosdb: PhotosDB() instance for {photosdb.library_path}")
+    print(
+        f"- photos: list of PhotoInfo objects for all photos filtered with any query options passed on command line (len={len(photos)})"
+    )
+    print(
+        f"- all_photos: list of PhotoInfo objects for all photos in photosdb, including those in the trash (len={len(all_photos)})"
+    )
+    print(
+        f"- selected: list of PhotoInfo objects for any photos selected in Photos (len={len(selected)})"
+    )
+    print(f"\nThe following functions may be helpful:")
+    print(
+        f"- get_photo(uuid): return a PhotoInfo object for photo with uuid; e.g. get_photo('B13F4485-94E0-41CD-AF71-913095D62E31')"
+    )
+    print(
+        f"- get_selected(); return list of PhotoInfo objects for photos selected in Photos"
+    )
+    print(
+        f"- show(photo): open a photo object in the default viewer; e.g. show(selected[0])"
+    )
+    print(
+        f"- show(path): open a file at path in the default viewer; e.g. show('/path/to/photo.jpg')"
+    )
+    print(f"- spotlight(photo): open a photo and spotlight it in Photos")
+    # print(
+    #     f"- help(object): print help text including list of methods for object; for example, help(PhotosDB)"
+    # )
+    print(
+        f"- inspect(object): print information about an object; e.g. inspect(PhotoInfo)"
+    )
+    print(
+        f"- explore(object): interactively explore an object with objexplore; e.g. explore(PhotoInfo)"
+    )
+    print(f"- q, quit, quit(), exit, exit(): exit this interactive shell\n")
+
+    embed_repl(
+        globals=globals(),
+        locals=locals(),
+        history_filename=str(pathlib.Path.home() / ".osxphotos_repl_history"),
+        quit_words=["q", "quit", "exit"],
+        vi_mode=not emacs,
+    )
+
+
+def _show_photo(photo: PhotoInfo):
+    """open image with default image viewer
+
+    Note: This is for debugging only -- it will actually open any filetype which could
+    be very, very bad.
+
+    Args:
+        photo: PhotoInfo object or a path to a photo on disk
+    """
+    photopath = photo.path if isinstance(photo, osxphotos.PhotoInfo) else photo
+
+    if not os.path.isfile(photopath):
+        return f"'{photopath}' does not appear to be a valid photo path"
+
+    os.system(f"open '{photopath}'")
+
+
+def _load_photos_db(dbpath):
+    print("Loading database")
+    tic = time.perf_counter()
+    photosdb = osxphotos.PhotosDB(dbfile=dbpath, verbose=print)
+    toc = time.perf_counter()
+    tictoc = toc - tic
+    print(f"Done: took {tictoc:0.2f} seconds")
+    return photosdb
+
+
+def _get_all_photos(photosdb):
+    """get list of all photos in photosdb"""
+    photos = photosdb.photos(images=True, movies=True)
+    photos.extend(photosdb.photos(images=True, movies=True, intrash=True))
+    return photos
+
+
+def _get_selected(photosdb):
+    """get list of PhotoInfo objects for photos selected in Photos"""
+
+    def get_selected():
+        selected = photoscript.PhotosLibrary().selection
+        if not selected:
+            return []
+        return photosdb.photos(uuid=[p.uuid for p in selected])
+
+    return get_selected
+
+
+def _spotlight_photo(photo: PhotoInfo):
+    photo_ = photoscript.Photo(photo.uuid)
+    photo_.spotlight()
+
+
+def _query_options_from_kwargs(**kwargs) -> QueryOptions:
+    """Validate query options and create a QueryOptions instance"""
+    # sanity check input args
+    nonexclusive = [
+        "keyword",
+        "person",
+        "album",
+        "folder",
+        "name",
+        "uuid",
+        "uuid_from_file",
+        "edited",
+        "external_edit",
+        "uti",
+        "has_raw",
+        "from_date",
+        "to_date",
+        "from_time",
+        "to_time",
+        "label",
+        "is_reference",
+        "query_eval",
+        "query_function",
+        "min_size",
+        "max_size",
+        "regex",
+        "selected",
+        "exif",
+        "duplicate",
+    ]
+    exclusive = [
+        ("favorite", "not_favorite"),
+        ("hidden", "not_hidden"),
+        ("missing", "not_missing"),
+        ("only_photos", "only_movies"),
+        ("burst", "not_burst"),
+        ("live", "not_live"),
+        ("cloudasset", "not_cloudasset"),
+        ("incloud", "not_incloud"),
+        ("portrait", "not_portrait"),
+        ("screenshot", "not_screenshot"),
+        ("slow_mo", "not_slow_mo"),
+        ("time_lapse", "not_time_lapse"),
+        ("hdr", "not_hdr"),
+        ("selfie", "not_selfie"),
+        ("panorama", "not_panorama"),
+        ("deleted", "deleted_only"),
+        ("shared", "not_shared"),
+        ("has_comment", "no_comment"),
+        ("has_likes", "no_likes"),
+        ("in_album", "not_in_album"),
+        ("location", "no_location"),
+    ]
+    # print help if no non-exclusive term or a double exclusive term is given
+    # TODO: add option to validate requiring at least one query arg
+    if any(all([kwargs[b], kwargs[n]]) for b, n in exclusive) or any(
+        [
+            all([any(kwargs["title"]), kwargs["no_title"]]),
+            all([any(kwargs["description"]), kwargs["no_description"]]),
+            all([any(kwargs["place"]), kwargs["no_place"]]),
+        ]
+    ):
+        raise IncompatibleQueryOptions
+
+    # actually have something to query
+    include_photos = True
+    include_movies = True  # default searches for everything
+    if kwargs["only_movies"]:
+        include_photos = False
+    if kwargs["only_photos"]:
+        include_movies = False
+
+    # load UUIDs if necessary and append to any uuids passed with --uuid
+    uuid = None
+    if kwargs["uuid_from_file"]:
+        uuid_list = list(kwargs["uuid"])  # Click option is a tuple
+        uuid_list.extend(load_uuid_from_file(kwargs["uuid_from_file"]))
+        uuid = tuple(uuid_list)
+
+    query_fields = [field.name for field in dataclasses.fields(QueryOptions)]
+    query_dict = {field: kwargs.get(field) for field in query_fields}
+    query_dict["photos"] = include_photos
+    query_dict["movies"] = include_movies
+    query_dict["uuid"] = uuid
+    return QueryOptions(**query_dict)
+
+
+def _query_photos(photosdb: PhotosDB, query_options: QueryOptions) -> List:
+    """Query photos given a QueryOptions instance"""
+    try:
+        photos = photosdb.query(query_options)
+    except ValueError as e:
+        if "Invalid query_eval CRITERIA:" not in str(e):
+            raise ValueError(e) from e
+        msg = str(e).split(":")[1]
+        raise click.BadOptionUsage(
+            "query_eval", f"Invalid query-eval CRITERIA: {msg}"
+        ) from e
+
+    return photos

osxphotos/cli/snap_diff.py

@@ -0,0 +1,157 @@
+"""snap/diff commands for osxphotos CLI"""
+
+import datetime
+import os
+import pathlib
+import shutil
+import subprocess
+
+import click
+from rich.console import Console
+from rich.syntax import Syntax
+
+import osxphotos
+
+from .common import DB_OPTION, OSXPHOTOS_SNAPSHOT_DIR, get_photos_db, verbose_print
+
+
+@click.command(name="snap")
+@click.pass_obj
+@click.pass_context
+@DB_OPTION
+def snap(ctx, cli_obj, db):
+    """Create snapshot of Photos database to use with diff command
+
+    Snapshots only the database files, not the entire library. If OSXPHOTOS_SNAPSHOT
+    environment variable is defined, will use that as snapshot directory, otherwise
+    uses '/private/tmp/osxphotos_snapshots'
+
+    Works only on Photos library versions since Catalina (10.15) or newer.
+    """
+
+    db = get_photos_db(db, cli_obj.db)
+    db_path = pathlib.Path(db)
+    if db_path.is_file():
+        # assume it's the sqlite file
+        db_path = db_path.parent.parent
+    db_path = db_path / "database"
+
+    db_folder = os.environ.get("OSXPHOTOS_SNAPSHOT", OSXPHOTOS_SNAPSHOT_DIR)
+    if not os.path.isdir(db_folder):
+        click.echo(f"Creating snapshot folder: '{db_folder}'")
+        os.mkdir(db_folder)
+
+    timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
+    destination_path = pathlib.Path(db_folder) / timestamp
+
+    # get all the sqlite files including the write ahead log if any
+    files = db_path.glob("*.sqlite*")
+    os.makedirs(destination_path)
+    fu = osxphotos.fileutil.FileUtil()
+    count = 0
+    for file in files:
+        if file.is_file():
+            fu.copy(file, destination_path)
+            count += 1
+
+    print(f"Copied {count} files from {db_path} to {destination_path}")
+
+
+@click.command(name="diff")
+@click.pass_obj
+@click.pass_context
+@DB_OPTION
+@click.option(
+    "--raw-output",
+    "-r",
+    is_flag=True,
+    default=False,
+    help="Print raw output (don't use syntax highlighting).",
+)
+@click.option(
+    "--style",
+    "-s",
+    metavar="STYLE",
+    nargs=1,
+    default="monokai",
+    help="Specify style/theme for syntax highlighting. "
+    "Theme may be any valid pygments style (https://pygments.org/styles/). "
+    "Default is 'monokai'.",
+)
+@click.argument("db2", nargs=-1, type=click.Path(exists=True))
+@click.option("--verbose", "-V", "verbose", is_flag=True, help="Print verbose output.")
+def diff(ctx, cli_obj, db, raw_output, style, db2, verbose):
+    """Compare two Photos databases and print out differences
+
+    To use the diff command, you'll need to install sqldiff via homebrew:
+
+     - Install homebrew (https://brew.sh/) if not already installed
+
+     - Install sqldiff: `brew install sqldiff`
+
+    When run with no arguments, compares the current Photos library to the
+    most recent snapshot in the the OSXPHOTOS_SNAPSHOT directory.
+
+    If run with the --db option, compares the library specified by --db to the
+    most recent snapshot in the the OSXPHOTOS_SNAPSHOT directory.
+
+    If run with just the DB2 argument, compares the current Photos library to
+    the database specified by the DB2 argument.
+
+    If run with both the --db option and the DB2 argument, compares the
+    library specified by --db to the database specified by DB2
+
+    See also `osxphotos snap`
+
+    If the OSXPHOTOS_SNAPSHOT environment variable is not set, will use
+    '/private/tmp/osxphotos_snapshots'
+
+    Works only on Photos library versions since Catalina (10.15) or newer.
+    """
+
+    verbose_ = verbose_print(verbose, rich=True)
+
+    sqldiff = shutil.which("sqldiff")
+    if not sqldiff:
+        click.echo(
+            "sqldiff not found; install via homebrew (https://brew.sh/): `brew install sqldiff`"
+        )
+        ctx.exit(2)
+    verbose_(f"sqldiff found at '{sqldiff}'")
+
+    db = get_photos_db(db, cli_obj.db)
+    db_path = pathlib.Path(db)
+    if db_path.is_file():
+        # assume it's the sqlite file
+        db_path = db_path.parent.parent
+    db_path = db_path / "database"
+    db_1 = db_path / "photos.sqlite"
+
+    if db2:
+        db_2 = pathlib.Path(db2[0])
+    else:
+        # get most recent snapshot
+        db_folder = os.environ.get("OSXPHOTOS_SNAPSHOT", OSXPHOTOS_SNAPSHOT_DIR)
+        verbose_(f"Using snapshot folder: '{db_folder}'")
+        folders = sorted([f for f in pathlib.Path(db_folder).glob("*") if f.is_dir()])
+        folder_2 = folders[-1]
+        db_2 = folder_2 / "Photos.sqlite"
+
+    if not db_1.exists():
+        print(f"database file {db_1} missing")
+    if not db_2.exists():
+        print(f"database file {db_2} missing")
+
+    verbose_(f"Comparing databases {db_1} and {db_2}")
+
+    diff_proc = subprocess.Popen([sqldiff, db_2, db_1], stdout=subprocess.PIPE)
+    console = Console()
+    for line in iter(diff_proc.stdout.readline, b""):
+        line = line.decode("UTF-8").rstrip()
+        if raw_output:
+            print(line)
+        else:
+            syntax = Syntax(
+                line, "sql", theme=style, line_numbers=False, code_width=1000
+            )
+            console.print(syntax)

osxphotos/cli/tutorial.py

@@ -0,0 +1,46 @@
+"""tutorial command for osxphotos CLI"""
+
+import io
+import pathlib
+
+import click
+from rich.console import Console
+from rich.markdown import Markdown
+
+from .help import strip_html_comments, strip_md_links
+
+
+@click.command(name="tutorial")
+@click.argument(
+    "WIDTH",
+    nargs=-1,
+    type=click.INT,
+)
+@click.pass_obj
+@click.pass_context
+def tutorial(ctx, cli_obj, width):
+    """Display osxphotos tutorial."""
+    width = width[0] if width else 100
+    click.echo_via_pager(tutorial_help(width=width))
+
+
+def tutorial_help(width=78):
+    """Return formatted string for tutorial"""
+    sio = io.StringIO()
+    console = Console(file=sio, force_terminal=True, width=width)
+    help_md = get_tutorial_text()
+    help_md = strip_html_comments(help_md)
+    help_md = strip_md_links(help_md)
+    console.print(Markdown(help_md))
+    help_str = sio.getvalue()
+    sio.close()
+    return help_str
+
+
+def get_tutorial_text():
+    """Load tutorial text from file"""
+    # TODO: would be better to use importlib.abc.ResourceReader but I can't find a single example of how to do this
+    help_file = pathlib.Path(__file__).parent / "../tutorial.md"
+    with open(help_file, "r") as fd:
+        md = fd.read()
+    return md

osxphotos/cli/uuid.py

@@ -0,0 +1,26 @@
+"""uuid command for osxphotos CLI"""
+
+import click
+import photoscript
+
+
+@click.command(name="uuid")
+@click.pass_obj
+@click.pass_context
+@click.option(
+    "--filename",
+    "-f",
+    required=False,
+    is_flag=True,
+    default=False,
+    help="Include filename of selected photos in output",
+)
+def uuid(ctx, cli_obj, filename):
+    """Print out unique IDs (UUID) of photos selected in Photos
+
+    Prints outs UUIDs in form suitable for --uuid-from-file and --skip-uuid-from-file
+    """
+    for photo in photoscript.PhotosLibrary().selection:
+        if filename:
+            print(f"# {photo.filename}")
+        print(photo.uuid)

osxphotos/configoptions.py

@@ -1,9 +1,17 @@
 """ ConfigOptions class to load/save config settings for osxphotos CLI """
+import bitmath
 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 +27,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 +61,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,27 +129,21 @@ 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
         """
         # todo: add overwrite and option to merge contents already in TOML file (under different [section] with new content)
-        data = {}
-        for attr in sorted(self._attrs.keys()):
-            val = getattr(self, attr)
-            if val in [False, ()]:
-                val = None
-            else:
-                val = list(val) if type(val) == tuple else val
-
-            data[attr] = val
-
         with open(filename, "w") as fd:
-            toml.dump({self._name: data}, fd)
+            toml.dump(self._get_toml_dict(), fd)
+
+    def write_to_str(self) -> str:
+        """Write self to TOML str"""
+        return toml.dumps(self._get_toml_dict())
 
     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
@@ -171,3 +173,21 @@ class ConfigOptions:
 
     def asdict(self):
         return {attr: getattr(self, attr) for attr in sorted(self._attrs.keys())}
+
+    def _get_toml_dict(self):
+        """Return dict for writing to TOML file"""
+        data = {}
+        for attr in sorted(self._attrs.keys()):
+            val = getattr(self, attr)
+
+            if isinstance(val, bitmath.Bitmath):
+                val = int(val.to_Byte())
+
+            if val in [False, ()]:
+                val = None
+            else:
+                val = list(val) if type(val) == tuple else val
+
+            data[attr] = val
+
+        return {self._name: data}

osxphotos/crash_reporter.py

@@ -0,0 +1,46 @@
+"""Error logger/crash reporter decorator"""
+
+import datetime
+import functools
+import platform
+import sys
+import traceback
+
+from rich import print
+
+
+def crash_reporter(filename, message, title, postamble, *extra_args):
+    """Create a crash dump file on error named filename
+
+    On error, create a crash dump file named filename with exception and stack trace.
+    message is printed to stderr
+    title is printed at beginning of crash dump file
+    postamble is printed to stderr after crash dump file is created
+    If extra_args is not None, any additional arguments to the function will be printed to the file.
+    """
+
+    def decorated(func):
+        @functools.wraps(func)
+        def wrapped(*args, **kwargs):
+            try:
+                return func(*args, **kwargs)
+            except Exception as e:
+                print(message, file=sys.stderr)
+                print(f"[red]{e}[/red]", file=sys.stderr)
+                with open(filename, "w") as f:
+                    f.write(f"{title}\n")
+                    f.write(f"Created: {datetime.datetime.now()}\n")
+                    f.write(f"Python version: {sys.version}\n")
+                    f.write(f"Platform: {platform.platform()}\n")
+                    f.write(f"sys.argv: {sys.argv}\n")
+                    for arg in extra_args:
+                        f.write(f"{arg}\n")
+                    f.write(f"Error: {e}\n")
+                    traceback.print_exc(file=f)
+                print(f"Crash log written to '{filename}'", file=sys.stderr)
+                print(f"{postamble}", file=sys.stderr)
+                sys.exit(1)
+
+        return wrapped
+
+    return decorated

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

@@ -0,0 +1,30 @@
+""" ExifInfo class to expose EXIF info from the library """
+
+from dataclasses import dataclass
+
+__all__ = ["ExifInfo"]
+
+
+@dataclass(frozen=True)
+class ExifInfo:
+    """EXIF info associated with a photo from the Photos library"""
+
+    flash_fired: bool
+    iso: int
+    metering_mode: int
+    sample_rate: int
+    track_format: int
+    white_balance: int
+    aperture: float
+    bit_rate: float
+    duration: float
+    exposure_bias: float
+    focal_length: float
+    fps: float
+    latitude: float
+    longitude: float
+    shutter_speed: float
+    camera_make: str
+    camera_model: str
+    codec: str
+    lens_model: str

osxphotos/exiftool.py

@@ -7,15 +7,27 @@
     pyexiftool: https://github.com/smarnach/pyexiftool which provides more functionality """
 
 import atexit
+import html
 import json
 import logging
 import os
+import pathlib
 import re
 import shutil
 import subprocess
 from abc import ABC, abstractmethod
 from functools import lru_cache  # pylint: disable=syntax-error
 
+__all__ = [
+    "escape_str",
+    "exiftool_can_write",
+    "ExifTool",
+    "ExifToolCaching",
+    "get_exiftool_path",
+    "terminate_exiftool",
+    "unescape_str",
+]
+
 # exiftool -stay_open commands outputs this EOF marker after command is run
 EXIFTOOL_STAYOPEN_EOF = "{ready}"
 EXIFTOOL_STAYOPEN_EOF_LEN = len(EXIFTOOL_STAYOPEN_EOF)
@@ -23,17 +35,55 @@ EXIFTOOL_STAYOPEN_EOF_LEN = len(EXIFTOOL_STAYOPEN_EOF)
 # list of exiftool processes to cleanup when exiting or when terminate is called
 EXIFTOOL_PROCESSES = []
 
+# exiftool supported file types, created by utils/exiftool_supported_types.py
+EXIFTOOL_FILETYPES_JSON = "exiftool_filetypes.json"
+with (pathlib.Path(__file__).parent / EXIFTOOL_FILETYPES_JSON).open("r") as f:
+    EXIFTOOL_SUPPORTED_FILETYPES = json.load(f)
+
+
+def exiftool_can_write(suffix: str) -> bool:
+    """Return True if exiftool supports writing to a file with the given suffix, otherwise False"""
+    if not suffix:
+        return False
+    suffix = suffix.lower()
+    if suffix[0] == ".":
+        suffix = suffix[1:]
+    return (
+        suffix in EXIFTOOL_SUPPORTED_FILETYPES
+        and EXIFTOOL_SUPPORTED_FILETYPES[suffix]["write"]
+    )
+
+
+def escape_str(s):
+    """escape string for use with exiftool -E"""
+    if type(s) != str:
+        return s
+    s = html.escape(s)
+    s = s.replace("\n", "
")
+    s = s.replace("\t", "	")
+    s = s.replace("\r", "
")
+    return s
+
+
+def unescape_str(s):
+    """unescape an HTML string returned by exiftool -E"""
+    if type(s) != str:
+        return s
+    # avoid " in values which result in json.loads() throwing an exception, #636
+    s = s.replace(""", '\\"')
+    return html.unescape(s)
+
 
 @atexit.register
 def terminate_exiftool():
-    """Terminate any running ExifTool subprocesses; call this to cleanup when done using ExifTool """
+    """Terminate any running ExifTool subprocesses; call this to cleanup when done using ExifTool"""
     for proc in EXIFTOOL_PROCESSES:
         proc._stop_proc()
 
 
 @lru_cache(maxsize=1)
 def get_exiftool_path():
-    """ return path of exiftool, cache result """
+    """return path of exiftool, cache result"""
     exiftool_path = shutil.which("exiftool")
     if exiftool_path:
         return exiftool_path.rstrip()
@@ -49,7 +99,7 @@ class _ExifToolProc:
     Creates a singleton object"""
 
     def __new__(cls, *args, **kwargs):
-        """ create new object or return instance of already created singleton """
+        """create new object or return instance of already created singleton"""
         if not hasattr(cls, "instance") or not cls.instance:
             cls.instance = super().__new__(cls)
 
@@ -57,7 +107,8 @@ class _ExifToolProc:
 
     def __init__(self, exiftool=None):
         """construct _ExifToolProc singleton object or return instance of already created object
-        exiftool: optional path to exiftool binary (if not provided, will search path to find it)"""
+        exiftool: optional path to exiftool binary (if not provided, will search path to find it)
+        """
 
         if hasattr(self, "_process_running") and self._process_running:
             # already running
@@ -67,14 +118,13 @@ class _ExifToolProc:
                     f"ignoring exiftool={exiftool}"
                 )
             return
-
         self._process_running = False
         self._exiftool = exiftool or get_exiftool_path()
         self._start_proc()
 
     @property
     def process(self):
-        """ return the exiftool subprocess """
+        """return the exiftool subprocess"""
         if self._process_running:
             return self._process
         else:
@@ -83,22 +133,25 @@ class _ExifToolProc:
 
     @property
     def pid(self):
-        """ return process id (PID) of the exiftool process """
+        """return process id (PID) of the exiftool process"""
         return self._process.pid
 
     @property
     def exiftool(self):
-        """ return path to exiftool process """
+        """return path to exiftool process"""
         return self._exiftool
 
     def _start_proc(self):
-        """ start exiftool in batch mode """
+        """start exiftool in batch mode"""
 
         if self._process_running:
             logging.warning("exiftool already running: {self._process}")
             return
 
         # open exiftool process
+        # make sure /usr/bin at start of path so exiftool can find xattr (see #636)
+        env = os.environ.copy()
+        env["PATH"] = f'/usr/bin/:{env["PATH"]}'
         self._process = subprocess.Popen(
             [
                 self._exiftool,
@@ -110,17 +163,19 @@ class _ExifToolProc:
                 "-n",  # no print conversion (e.g. print tag values in machine readable format)
                 "-P",  # Preserve file modification date/time
                 "-G",  # print group name for each tag
+                "-E",  # escape tag values for HTML (allows use of HTML 
 for newlines)
             ],
             stdin=subprocess.PIPE,
             stdout=subprocess.PIPE,
             stderr=subprocess.STDOUT,
+            env=env,
         )
         self._process_running = True
 
         EXIFTOOL_PROCESSES.append(self)
 
     def _stop_proc(self):
-        """ stop the exiftool process if it's running, otherwise, do nothing """
+        """stop the exiftool process if it's running, otherwise, do nothing"""
 
         if not self._process_running:
             return
@@ -143,7 +198,7 @@ class _ExifToolProc:
 
 
 class ExifTool:
-    """ Basic exiftool interface for reading and writing EXIF tags """
+    """Basic exiftool interface for reading and writing EXIF tags"""
 
     def __init__(self, filepath, exiftool=None, overwrite=True, flags=None):
         """Create ExifTool object
@@ -189,6 +244,7 @@ class ExifTool:
 
         if value is None:
             value = ""
+        value = escape_str(value)
         command = [f"-{tag}={value}"]
         if self.overwrite and not self._context_mgr:
             command.append("-overwrite_original")
@@ -233,6 +289,7 @@ class ExifTool:
         for value in values:
             if value is None:
                 raise ValueError("Can't add None value to tag")
+            value = escape_str(value)
             command.append(f"-{tag}+={value}")
 
         if self.overwrite and not self._context_mgr:
@@ -311,16 +368,17 @@ class ExifTool:
         error = "" if error == b"" else error.decode("utf-8")
         self.warning = warning
         self.error = error
+
         return output[:-EXIFTOOL_STAYOPEN_EOF_LEN], warning, error
 
     @property
     def pid(self):
-        """ return process id (PID) of the exiftool process """
+        """return process id (PID) of the exiftool process"""
         return self._process.pid
 
     @property
     def version(self):
-        """ returns exiftool version """
+        """returns exiftool version"""
         ver, _, _ = self.run_commands("-ver", no_file=True)
         return ver.decode("utf-8")
 
@@ -335,14 +393,15 @@ class ExifTool:
         json_str, _, _ = self.run_commands("-json")
         if not json_str:
             return dict()
+        json_str = unescape_str(json_str.decode("utf-8"))
 
         try:
             exifdict = json.loads(json_str)
         except Exception as e:
             # will fail with some commands, e.g --ext AVI which produces
             # 'No file with specified extension' instead of json
+            logging.warning(f"error loading json returned by exiftool: {e} {json_str}")
             return dict()
-
         exifdict = exifdict[0]
         if not tag_groups:
             # strip tag groups
@@ -358,12 +417,13 @@ class ExifTool:
         return exifdict
 
     def json(self):
-        """ returns JSON string containing all EXIF tags and values from exiftool """
+        """returns JSON string containing all EXIF tags and values from exiftool"""
         json, _, _ = self.run_commands("-json")
+        json = unescape_str(json.decode("utf-8"))
         return json
 
     def _read_exif(self):
-        """ read exif data from file """
+        """read exif data from file"""
         data = self.asdict()
         self.data = {k: v for k, v in data.items()}
 
@@ -384,15 +444,15 @@ class ExifTool:
 
 
 class ExifToolCaching(ExifTool):
-    """ Basic exiftool interface for reading and writing EXIF tags, with caching. 
-        Use this only when you know the file's EXIF data will not be changed by any external process. 
-        
-        Creates a singleton cached ExifTool instance """
+    """Basic exiftool interface for reading and writing EXIF tags, with caching.
+    Use this only when you know the file's EXIF data will not be changed by any external process.
+
+    Creates a singleton cached ExifTool instance"""
 
     _singletons = {}
 
     def __new__(cls, filepath, exiftool=None):
-        """ create new object or return instance of already created singleton """
+        """create new object or return instance of already created singleton"""
         if filepath not in cls._singletons:
             cls._singletons[filepath] = _ExifToolCaching(filepath, exiftool=exiftool)
         return cls._singletons[filepath]
@@ -448,7 +508,6 @@ class _ExifToolCaching(ExifTool):
             return self._asdict_cache[tag_groups][normalized]
 
     def flush_cache(self):
-        """ Clear cached data so that calls to json or asdict return fresh data """
+        """Clear cached data so that calls to json or asdict return fresh data"""
         self._json_cache = None
         self._asdict_cache = {}
-

osxphotos/export_db_utils.py

@@ -0,0 +1,255 @@
+""" Utility functions for working with export_db """
+
+
+import datetime
+import os
+import pathlib
+import sqlite3
+from typing import Callable, Optional, Tuple, Union
+
+import toml
+from rich import print
+
+from ._constants import OSXPHOTOS_EXPORT_DB
+from ._version import __version__
+from .utils import noop
+from .export_db import OSXPHOTOS_EXPORTDB_VERSION, ExportDB
+from .fileutil import FileUtil
+from .photosdb import PhotosDB
+
+__all__ = [
+    "export_db_check_signatures",
+    "export_db_get_last_run",
+    "export_db_get_version",
+    "export_db_save_config_to_file",
+    "export_db_touch_files",
+    "export_db_update_signatures",
+    "export_db_vacuum",
+]
+
+
+def isotime_from_ts(ts: int) -> str:
+    """Convert timestamp to ISO 8601 time string"""
+    return datetime.datetime.fromtimestamp(ts).isoformat()
+
+
+def export_db_get_version(
+    dbfile: Union[str, pathlib.Path]
+) -> Tuple[Optional[int], Optional[int]]:
+    """returns version from export database as tuple of (osxphotos version, export_db version)"""
+    conn = sqlite3.connect(str(dbfile))
+    c = conn.cursor()
+    row = c.execute(
+        "SELECT osxphotos, exportdb FROM version ORDER BY id DESC LIMIT 1;"
+    ).fetchone()
+    if row:
+        return (row[0], row[1])
+    return (None, None)
+
+
+def export_db_vacuum(dbfile: Union[str, pathlib.Path]) -> None:
+    """Vacuum export database"""
+    conn = sqlite3.connect(str(dbfile))
+    c = conn.cursor()
+    c.execute("VACUUM;")
+    conn.commit()
+
+
+def export_db_update_signatures(
+    dbfile: Union[str, pathlib.Path],
+    export_dir: Union[str, pathlib.Path],
+    verbose_: Callable = noop,
+    dry_run: bool = False,
+) -> Tuple[int, int]:
+    """Update signatures for all files found in the export database to match what's on disk
+
+    Returns: tuple of (updated, skipped)
+    """
+    export_dir = pathlib.Path(export_dir)
+    fileutil = FileUtil
+    conn = sqlite3.connect(str(dbfile))
+    c = conn.cursor()
+    c.execute("SELECT filepath_normalized, filepath FROM export_data;")
+    rows = c.fetchall()
+    updated = 0
+    skipped = 0
+    for row in rows:
+        filepath_normalized = row[0]
+        filepath = row[1]
+        filepath = export_dir / filepath
+        if not os.path.exists(filepath):
+            skipped += 1
+            verbose_(f"[dark_orange]Skipping missing file[/dark_orange]: '{filepath}'")
+            continue
+        updated += 1
+        file_sig = fileutil.file_sig(filepath)
+        verbose_(f"[green]Updating signature for[/green]: '{filepath}'")
+        if not dry_run:
+            c.execute(
+                "UPDATE export_data SET dest_mode = ?, dest_size = ?, dest_mtime = ? WHERE filepath_normalized = ?;",
+                (file_sig[0], file_sig[1], file_sig[2], filepath_normalized),
+            )
+
+    if not dry_run:
+        conn.commit()
+
+    return (updated, skipped)
+
+
+def export_db_get_last_run(
+    export_db: Union[str, pathlib.Path]
+) -> Tuple[Optional[str], Optional[str]]:
+    """Get last run from export database"""
+    conn = sqlite3.connect(str(export_db))
+    c = conn.cursor()
+    row = c.execute(
+        "SELECT datetime, args FROM runs ORDER BY id DESC LIMIT 1;"
+    ).fetchone()
+    if row:
+        return row[0], row[1]
+    return None, None
+
+
+def export_db_save_config_to_file(
+    export_db: Union[str, pathlib.Path], config_file: Union[str, pathlib.Path]
+) -> None:
+    """Save export_db last run config to file"""
+    export_db = pathlib.Path(export_db)
+    config_file = pathlib.Path(config_file)
+    conn = sqlite3.connect(str(export_db))
+    c = conn.cursor()
+    row = c.execute("SELECT config FROM config ORDER BY id DESC LIMIT 1;").fetchone()
+    if not row:
+        return ValueError("No config found in export_db")
+    with config_file.open("w") as f:
+        f.write(row[0])
+
+
+def export_db_check_signatures(
+    dbfile: Union[str, pathlib.Path],
+    export_dir: Union[str, pathlib.Path],
+    verbose_: Callable = noop,
+) -> Tuple[int, int, int]:
+    """Check signatures for all files found in the export database to verify what matches the on disk files
+
+    Returns: tuple of (updated, skipped)
+    """
+    export_dir = pathlib.Path(export_dir)
+    fileutil = FileUtil
+    conn = sqlite3.connect(str(dbfile))
+    c = conn.cursor()
+    c.execute("SELECT filepath_normalized, filepath FROM export_data;")
+    rows = c.fetchall()
+    exportdb = ExportDB(dbfile, export_dir)
+    matched = 0
+    notmatched = 0
+    skipped = 0
+    for row in rows:
+        filepath_normalized = row[0]
+        filepath = row[1]
+        filepath = export_dir / filepath
+        if not filepath.exists():
+            skipped += 1
+            verbose_(f"[dark_orange]Skipping missing file[/dark_orange]: '{filepath}'")
+            continue
+        file_sig = fileutil.file_sig(filepath)
+        file_rec = exportdb.get_file_record(filepath)
+        if file_rec.dest_sig == file_sig:
+            matched += 1
+            verbose_(f"[green]Signatures matched[/green]: '{filepath}'")
+        else:
+            notmatched += 1
+            verbose_(f"[deep_pink3]Signatures do not match[/deep_pink3]: '{filepath}'")
+
+    return (matched, notmatched, skipped)
+
+
+def export_db_touch_files(
+    dbfile: Union[str, pathlib.Path],
+    export_dir: Union[str, pathlib.Path],
+    verbose_: Callable = noop,
+    dry_run: bool = False,
+) -> Tuple[int, int, int]:
+    """Touch files on disk to match the Photos library created date
+
+    Returns: tuple of (touched, not_touched, skipped)
+    """
+    export_dir = pathlib.Path(export_dir)
+
+    # open and close exportdb to ensure it gets migrated
+    exportdb = ExportDB(dbfile, export_dir)
+    upgraded = exportdb.was_upgraded
+    if upgraded:
+        verbose_(
+            f"Upgraded export database {dbfile} from version {upgraded[0]} to {upgraded[1]}"
+        )
+    exportdb.close()
+
+    conn = sqlite3.connect(str(dbfile))
+    c = conn.cursor()
+    # get most recent config
+    row = c.execute("SELECT config FROM config ORDER BY id DESC LIMIT 1;").fetchone()
+    if row:
+        config = toml.loads(row[0])
+        try:
+            photos_db_path = config["export"].get("db", None)
+        except KeyError:
+            photos_db_path = None
+    else:
+        # TODO: parse the runs table to get the last --db
+        # in the mean time, photos_db_path = None will use the default library
+        photos_db_path = None
+
+    photosdb = PhotosDB(dbfile=photos_db_path, verbose=verbose_)
+    exportdb = ExportDB(dbfile, export_dir)
+    c.execute(
+        "SELECT filepath_normalized, filepath, uuid, dest_mode, dest_size FROM export_data;"
+    )
+    rows = c.fetchall()
+    touched = 0
+    not_touched = 0
+    skipped = 0
+    for row in rows:
+        filepath_normalized = row[0]
+        filepath = row[1]
+        filepath = export_dir / filepath
+        uuid = row[2]
+        dest_mode = row[3]
+        dest_size = row[4]
+        if not filepath.exists():
+            skipped += 1
+            verbose_(
+                f"[dark_orange]Skipping missing file (not in export directory)[/dark_orange]: '{filepath}'"
+            )
+            continue
+
+        photo = photosdb.get_photo(uuid)
+        if not photo:
+            skipped += 1
+            verbose_(
+                f"[dark_orange]Skipping missing photo (did not find in Photos Library)[/dark_orange]: '{filepath}' ({uuid})"
+            )
+            continue
+
+        ts = int(photo.date.timestamp())
+        stat = os.stat(str(filepath))
+        mtime = stat.st_mtime
+        if mtime == ts:
+            not_touched += 1
+            verbose_(
+                f"[green]Skipping file (timestamp matches)[/green]: '{filepath}' [dodger_blue1]{isotime_from_ts(ts)} ({ts})[/dodger_blue1]"
+            )
+            continue
+
+        touched += 1
+        verbose_(
+            f"[deep_pink3]Touching file[/deep_pink3]: '{filepath}' "
+            f"[dodger_blue1]{isotime_from_ts(mtime)} ({mtime}) -> {isotime_from_ts(ts)} ({ts})[/dodger_blue1]"
+        )
+
+        if not dry_run:
+            os.utime(str(filepath), (ts, ts))
+            rec = exportdb.get_file_record(filepath)
+            rec.dest_sig = (dest_mode, dest_size, ts)
+
+    return (touched, not_touched, skipped)

osxphotos/fileutil.py

@@ -7,13 +7,15 @@ import subprocess
 import sys
 from abc import ABC, abstractmethod
 
-import CoreFoundation
+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
@@ -114,7 +116,7 @@ class FileUtilMacOS(FileUtilABC):
         if dest.is_dir():
             dest /= src.name
 
-        filemgr = CoreFoundation.NSFileManager.defaultManager()
+        filemgr = Foundation.NSFileManager.defaultManager()
         error = filemgr.copyItemAtPath_toPath_error_(str(src), str(dest), None)
         # error is a tuple of (bool, error_string)
         # error[0] is True if copy succeeded
@@ -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,8 +142,8 @@ class FileUtilMacOS(FileUtilABC):
 
     @classmethod
     def utime(cls, path, times):
-        """ Set the access and modified time of path. """
-        os.utime(path, times)
+        """Set the access and modified time of path."""
+        os.utime(path, times=times)
 
     @classmethod
     def cmp(cls, f1, f2, mtime1=None):
@@ -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 as tuple of (mode, size, mtime)"""
         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,27 +15,29 @@ 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. """
+    """Base class for exceptions in this module."""
 
     pass
 
 
 class ImageConverter:
-    """ Convert images to jpeg.  This class is a singleton
-        which will re-use the Core Image CIContext to avoid
-        creating a new context for every conversion. """
+    """Convert images to jpeg.  This class is a singleton
+    which will re-use the Core Image CIContext to avoid
+    creating a new context for every conversion."""
 
     def __new__(cls, *args, **kwargs):
-        """ create new object or return instance of already created singleton """
+        """create new object or return instance of already created singleton"""
         if not hasattr(cls, "instance") or not cls.instance:
             cls.instance = super().__new__(cls)
 
         return cls.instance
 
     def __init__(self):
-        """ return existing singleton or create a new one """
+        """return existing singleton or create a new one"""
 
         if hasattr(self, "context"):
             return
@@ -47,13 +49,10 @@ class ImageConverter:
                 "workingFormat": Quartz.kCIFormatRGBAh,
             }
         )
-        mtldevice = Metal.MTLCreateSystemDefaultDevice()
-        self.context = Quartz.CIContext.contextWithMTLDevice_options_(
-            mtldevice, context_options
-        )
+        self.context = Quartz.CIContext.contextWithOptions_(context_options)
 
     def write_jpeg(self, input_path, output_path, compression_quality=1.0):
-        """ convert image to jpeg and write image to output_path
+        """convert image to jpeg and write image to output_path
 
         Args:
             input_path: path to input image (e.g. '/path/to/import/file.CR2') as str or pathlib.Path
@@ -104,8 +103,11 @@ class ImageConverter:
             if input_image is None:
                 raise ImageConversionError(f"Could not create CIImage for {input_path}")
 
-            output_colorspace = input_image.colorSpace() or Quartz.CGColorSpaceCreateWithName(
-                Quartz.CoreGraphics.kCGColorSpaceSRGB
+            output_colorspace = (
+                input_image.colorSpace()
+                or Quartz.CGColorSpaceCreateWithName(
+                    Quartz.CoreGraphics.kCGColorSpaceSRGB
+                )
             )
 
             output_options = NSDictionary.dictionaryWithDictionary_(
@@ -123,4 +125,3 @@ class ImageConverter:
                 raise ImageConversionError(
                     f"Error converting file {input_path} to jpeg at {output_path}: {error}"
                 )
-

osxphotos/momentinfo.py

@@ -0,0 +1,70 @@
+__all__ = ["MomentInfo"]
+"""MomentInfo class with details about photo moments."""
+
+
+class MomentInfo:
+    """Info about a photo moment"""
+
+    def __init__(self, db, moment_pk):
+        """Initialize with a moment PK; returns None if PK not found."""
+        self._db = db
+        self._pk = moment_pk
+
+        self._moment = self._db._db_moment_pk.get(moment_pk)
+        if not self._moment:
+            raise ValueError(f"No moment with PK {moment_pk}")
+
+    @property
+    def pk(self):
+        """Primary key of the moment."""
+        return self._pk
+
+    @property
+    def location(self):
+        """Location of the moment."""
+        return (self._moment.get("latitude"), self._moment.get("longitude"))
+
+    @property
+    def title(self):
+        """Title of the moment."""
+        return self._moment.get("title")
+
+    @property
+    def subtitle(self):
+        """Subtitle of the moment."""
+        return self._moment.get("subtitle")
+
+    @property
+    def start_date(self):
+        """Start date of the moment."""
+        return self._moment.get("startDate")
+
+    @property
+    def end_date(self):
+        """Stop date of the moment."""
+        return self._moment.get("endDate")
+
+    @property
+    def date(self):
+        """Date of the moment."""
+        return self._moment.get("representativeDate")
+
+    @property
+    def modification_date(self):
+        """Modification date of the moment."""
+        return self._moment.get("modificationDate")
+
+    @property
+    def photos(self):
+        """All photos in this moment"""
+        try:
+            return self._photos
+        except AttributeError:
+            photo_uuids = [
+                uuid
+                for uuid, photo in self._db._dbphotos.items()
+                if photo["momentID"] == self._pk
+            ]
+
+            self._photos = self._db.photos_by_uuid(photo_uuids)
+            return self._photos

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):
@@ -141,7 +143,7 @@ class FaceInfo:
         self.manual = face["manual"]
         self.face_type = face["facetype"]
         self.age_type = face["agetype"]
-        self.bald_type = face["baldtype"]
+        # self.bald_type = face["baldtype"]
         self.eye_makeup_type = face["eyemakeuptype"]
         self.eye_state = face["eyestate"]
         self.facial_hair_type = face["facialhairtype"]
@@ -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,
@@ -438,7 +440,7 @@ class FaceInfo:
             "manual": self.manual,
             "face_type": self.face_type,
             "age_type": self.age_type,
-            "bald_type": self.bald_type,
+            # "bald_type": self.bald_type,
             "eye_makeup_type": self.eye_makeup_type,
             "eye_state": self.eye_state,
             "facial_hair_type": self.facial_hair_type,
@@ -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

@@ -14,15 +14,20 @@ from datetime import timedelta, timezone
 from typing import Optional
 
 import yaml
+from osxmetadata import OSXMetaData
 
-from .._constants import (
+from ._constants import (
     _MOVIE_TYPE,
     _PHOTO_TYPE,
     _PHOTOS_4_ALBUM_KIND,
+    _PHOTOS_4_ALBUM_TYPE_ALBUM,
+    _PHOTOS_4_ALBUM_TYPE_PROJECT,
+    _PHOTOS_4_ALBUM_TYPE_SLIDESHOW,
     _PHOTOS_4_ROOT_FOLDER,
     _PHOTOS_4_VERSION,
     _PHOTOS_5_ALBUM_KIND,
     _PHOTOS_5_IMPORT_SESSION_ALBUM_KIND,
+    _PHOTOS_5_PROJECT_ALBUM_KIND,
     _PHOTOS_5_SHARED_ALBUM_KIND,
     _PHOTOS_5_SHARED_PHOTO_PATH,
     _PHOTOS_5_VERSION,
@@ -30,14 +35,28 @@ from .._constants import (
     BURST_KEY,
     BURST_NOT_SELECTED,
     BURST_SELECTED,
+    SIDECAR_EXIFTOOL,
+    SIDECAR_JSON,
+    SIDECAR_XMP,
+    TEXT_DETECTION_CONFIDENCE_THRESHOLD,
 )
-from ..adjustmentsinfo import AdjustmentsInfo
-from ..albuminfo import AlbumInfo, ImportInfo
-from ..personinfo import FaceInfo, PersonInfo
-from ..phototemplate import PhotoTemplate, RenderOptions
-from ..placeinfo import PlaceInfo4, PlaceInfo5
-from ..uti import get_preferred_uti_extension, get_uti_for_extension
-from ..utils import _debug, _get_resource_loc, findfiles
+from .adjustmentsinfo import AdjustmentsInfo
+from .albuminfo import AlbumInfo, ImportInfo, ProjectInfo
+from .exifinfo import ExifInfo
+from .exiftool import ExifToolCaching, get_exiftool_path
+from .momentinfo import MomentInfo
+from .personinfo import FaceInfo, PersonInfo
+from .photoexporter import ExportOptions, PhotoExporter
+from .phototemplate import PhotoTemplate, RenderOptions
+from .placeinfo import PlaceInfo4, PlaceInfo5
+from .query_builder import get_query
+from .scoreinfo import ScoreInfo
+from .searchinfo import SearchInfo
+from .text_detection import detect_text
+from .uti import get_preferred_uti_extension, get_uti_for_extension
+from .utils import _debug, _get_resource_loc, list_directory, _debug
+
+__all__ = ["PhotoInfo", "PhotoInfoNone"]
 
 
 class PhotoInfo:
@@ -46,42 +65,12 @@ class PhotoInfo:
     including keywords, persons, albums, uuid, path, etc.
     """
 
-    # import additional methods
-    from ._photoinfo_comments import comments, likes
-    from ._photoinfo_exifinfo import ExifInfo, exif_info
-    from ._photoinfo_exiftool import exiftool
-    from ._photoinfo_export import (
-        ExportResults,
-        _exiftool_dict,
-        _exiftool_json_sidecar,
-        _export_photo,
-        _export_photo_with_photos_export,
-        _get_exif_keywords,
-        _get_exif_persons,
-        _write_exif_data,
-        _write_sidecar,
-        _xmp_sidecar,
-        export,
-        export2,
-    )
-    from ._photoinfo_scoreinfo import ScoreInfo, score
-    from ._photoinfo_searchinfo import (
-        SearchInfo,
-        labels,
-        labels_normalized,
-        search_info,
-        search_info_normalized,
-    )
-
     def __init__(self, db=None, uuid=None, info=None):
         self._uuid = uuid
         self._info = info
         self._db = db
         self._verbose = self._db._verbose
 
-        # TODO: remove this once refactor of PhotoExporter is done
-        self._render_options = RenderOptions()
-
     @property
     def filename(self):
         """filename of the picture"""
@@ -342,6 +331,37 @@ class PhotoInfo:
 
         return photopath
 
+    @property
+    def path_edited_live_photo(self):
+        """return path to edited version of live photo movie; only valid for Photos 5+"""
+        if self._db._db_version < _PHOTOS_5_VERSION:
+            return None
+
+        try:
+            return self._path_edited_live_photo
+        except AttributeError:
+            self._path_edited_live_photo = self._path_edited_5_live_photo()
+            return self._path_edited_live_photo
+
+    def _path_edited_5_live_photo(self):
+        """return path_edited_live_photo for Photos >= 5"""
+        if self._db._db_version < _PHOTOS_5_VERSION:
+            raise RuntimeError("Wrong database format!")
+
+        if self.live_photo and self._info["hasAdjustments"]:
+            library = self._db._library_path
+            directory = self._uuid[0]  # first char of uuid
+            filename = f"{self._uuid}_2_100_a.mov"
+            photopath = os.path.join(
+                library, "resources", "renders", directory, filename
+            )
+            if not os.path.isfile(photopath):
+                photopath = None
+        else:
+            photopath = None
+
+        return photopath
+
     @property
     def path_raw(self):
         """absolute path of associated RAW image or None if there is not one"""
@@ -349,7 +369,7 @@ class PhotoInfo:
         # In Photos 5, raw is in same folder as original but with _4.ext
         # Unless "Copy Items to the Photos Library" is not checked
         # then RAW image is not renamed but has same name is jpeg buth with raw extension
-        # Current implementation uses findfiles to find images with the correct raw UTI extension
+        # Current implementation finds images with the correct raw UTI extension
         # in same folder as the original and with same stem as original in form: original_stem*.raw_ext
         # TODO: I don't like this -- would prefer a more deterministic approach but until I have more
         # data on how Photos stores and retrieves RAW images, this seems to be working
@@ -385,8 +405,7 @@ class PhotoInfo:
             # raw files have same name as original but with _4.raw_ext appended
             # I believe the _4 maps to PHAssetResourceTypeAlternatePhoto = 4
             # see: https://developer.apple.com/documentation/photokit/phassetresourcetype/phassetresourcetypealternatephoto?language=objc
-            glob_str = f"{filestem}_4*"
-            raw_file = findfiles(glob_str, filepath)
+            raw_file = list_directory(filepath, startswith=f"{filestem}_4")
             if not raw_file:
                 photopath = None
             else:
@@ -459,6 +478,18 @@ class PhotoInfo:
                 self._faceinfo = []
             return self._faceinfo
 
+    @property
+    def moment(self):
+        """Moment photo belongs to"""
+        try:
+            return self._moment
+        except AttributeError:
+            try:
+                self._moment = MomentInfo(db=self._db, moment_pk=self._info["momentID"])
+            except ValueError:
+                self._moment = None
+            return self._moment
+
     @property
     def albums(self):
         """list of albums picture is contained in"""
@@ -522,6 +553,18 @@ class PhotoInfo:
             )
             return self._import_info
 
+    @property
+    def project_info(self):
+        """list of AlbumInfo objects representing projects for the photo or None if no projects"""
+        try:
+            return self._project_info
+        except AttributeError:
+            project_uuids = self._get_album_uuids(project=True)
+            self._project_info = [
+                ProjectInfo(db=self._db, uuid=album) for album in project_uuids
+            ]
+            return self._project_info
+
     @property
     def keywords(self):
         """list of keywords for picture"""
@@ -530,7 +573,12 @@ class PhotoInfo:
     @property
     def title(self):
         """name / title of picture"""
-        return self._info["name"]
+        # if user sets then deletes title, Photos sets it to empty string in DB instead of NULL
+        # in this case, return None so result is the same as if title had never been set (which returns NULL)
+        # issue #512
+        title = self._info["name"]
+        title = None if title == "" else title
+        return title
 
     @property
     def uuid(self):
@@ -540,6 +588,7 @@ class PhotoInfo:
     @property
     def ismissing(self):
         """returns true if photo is missing from disk (which means it's not been downloaded from iCloud)
+
         NOTE:   the photos.db database uses an asynchrounous write-ahead log so changes in Photos
                 do not immediately get written to disk. In particular, I've noticed that downloading
                 an image from the cloud does not force the database to be updated until something else
@@ -681,8 +730,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"]
@@ -803,7 +854,7 @@ class PhotoInfo:
         if self._db._db_version <= _PHOTOS_4_VERSION:
             if self.live_photo and not self.ismissing:
                 live_model_id = self._info["live_model_id"]
-                if live_model_id == None:
+                if live_model_id is None:
                     logging.debug(f"missing live_model_id: {self._uuid}")
                     photopath = None
                 else:
@@ -824,48 +875,55 @@ class PhotoInfo:
                         # photos 4 has "isOnDisk" column we could check
                         # or could do the actual check with "isfile"
                         # TODO: should this be a warning or debug?
-                        logging.debug(
-                            f"MISSING PATH: live photo path for UUID {self._uuid} should be at {photopath} but does not appear to exist"
-                        )
                         photopath = None
             else:
                 photopath = None
-        else:
-            # Photos 5
-            if self.live_photo and not self.ismissing:
-                filename = pathlib.Path(self.path)
-                photopath = filename.parent.joinpath(f"{filename.stem}_3.mov")
-                photopath = str(photopath)
-                if not os.path.isfile(photopath):
-                    # In testing, I've seen occasional missing movie for live photo
-                    # these appear to be valid -- e.g. video component not yet downloaded from iCloud
-                    # TODO: should this be a warning or debug?
-                    logging.debug(
-                        f"MISSING PATH: live photo path for UUID {self._uuid} should be at {photopath} but does not appear to exist"
-                    )
-                    photopath = None
-            else:
+        elif self.live_photo and self.path and not self.ismissing:
+            filename = pathlib.Path(self.path)
+            photopath = filename.parent.joinpath(f"{filename.stem}_3.mov")
+            photopath = str(photopath)
+            if not os.path.isfile(photopath):
+                # In testing, I've seen occasional missing movie for live photo
+                # these appear to be valid -- e.g. video component not yet downloaded from iCloud
+                # TODO: should this be a warning or debug?
                 photopath = None
+        else:
+            photopath = None
 
         return photopath
 
     @property
     def path_derivatives(self):
         """Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)"""
-        if self._db._db_version <= _PHOTOS_4_VERSION:
-            return self._path_derivatives_4()
+        try:
+            return self._path_derivatives
+        except AttributeError:
+            if self._db._db_version <= _PHOTOS_4_VERSION:
+                self._path_derivatives = self._path_derivatives_4()
+                return self._path_derivatives
 
-        directory = self._uuid[0]  # first char of uuid
-        derivative_path = (
-            pathlib.Path(self._db._library_path)
-            / "resources"
-            / "derivatives"
-            / directory
-        )
-        files = derivative_path.glob(f"{self.uuid}*.*")
-        files = sorted(files, reverse=True, key=lambda f: f.stat().st_size)
-        # return list of filename but skip .THM files (these are actually low-res thumbnails in JPEG format but with .THM extension)
-        return [str(filename) for filename in files if filename.suffix != ".THM"]
+            directory = self._uuid[0]  # first char of uuid
+            derivative_path = (
+                pathlib.Path(self._db._library_path)
+                / "resources"
+                / "derivatives"
+                / directory
+            )
+            files = derivative_path.glob(f"{self.uuid}*.*")
+            files = sorted(files, reverse=True, key=lambda f: f.stat().st_size)
+            # return list of filename but skip .THM files (these are actually low-res thumbnails in JPEG format but with .THM extension)
+            derivatives = [
+                str(filename) for filename in files if filename.suffix != ".THM"
+            ]
+            if (
+                self.isphoto
+                and len(derivatives) > 1
+                and derivatives[0].endswith(".mov")
+            ):
+                derivatives[1], derivatives[0] = derivatives[0], derivatives[1]
+
+            self._path_derivatives = derivatives
+            return self._path_derivatives
 
     def _path_derivatives_4(self):
         """Return paths to all derivative (preview) files for Photos <= 4"""
@@ -974,7 +1032,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):
@@ -1000,15 +1058,15 @@ class PhotoInfo:
             return self._info["orientation"]
 
         # For Photos 5+, try to get the adjusted orientation
-        if self.hasadjustments:
-            if self.adjustments:
-                return self.adjustments.adj_orientation
-            else:
-                # can't reliably determine orientation for edited photo if adjustmentinfo not available
-                return 0
-        else:
+        if not self.hasadjustments:
             return self._info["orientation"]
 
+        if self.adjustments:
+            return self.adjustments.adj_orientation
+        else:
+            # can't reliably determine orientation for edited photo if adjustmentinfo not available
+            return 0
+
     @property
     def original_height(self):
         """returns height of the original photo version in pixels"""
@@ -1044,6 +1102,317 @@ class PhotoInfo:
             logging.warning(f"Did not find signature for {self.uuid} in _db_signatures")
         return duplicates
 
+    @property
+    def owner(self):
+        """Return name of photo owner for shared photos (Photos 5+ only), or None if not shared"""
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return None
+
+        try:
+            return self._owner
+        except AttributeError:
+            try:
+                personid = self._info["cloudownerhashedpersonid"]
+                self._owner = (
+                    self._db._db_hashed_person_id[personid]["full_name"]
+                    if personid
+                    else None
+                )
+            except KeyError:
+                self._owner = None
+            return self._owner
+
+    @property
+    def score(self):
+        """Computed score information for a photo
+
+        Returns:
+            ScoreInfo instance
+        """
+
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            logging.debug(f"score not implemented for this database version")
+            return None
+
+        try:
+            return self._scoreinfo  # pylint: disable=access-member-before-definition
+        except AttributeError:
+            try:
+                scores = self._db._db_scoreinfo_uuid[self.uuid]
+                self._scoreinfo = ScoreInfo(
+                    overall=scores["overall_aesthetic"],
+                    curation=scores["curation"],
+                    promotion=scores["promotion"],
+                    highlight_visibility=scores["highlight_visibility"],
+                    behavioral=scores["behavioral"],
+                    failure=scores["failure"],
+                    harmonious_color=scores["harmonious_color"],
+                    immersiveness=scores["immersiveness"],
+                    interaction=scores["interaction"],
+                    interesting_subject=scores["interesting_subject"],
+                    intrusive_object_presence=scores["intrusive_object_presence"],
+                    lively_color=scores["lively_color"],
+                    low_light=scores["low_light"],
+                    noise=scores["noise"],
+                    pleasant_camera_tilt=scores["pleasant_camera_tilt"],
+                    pleasant_composition=scores["pleasant_composition"],
+                    pleasant_lighting=scores["pleasant_lighting"],
+                    pleasant_pattern=scores["pleasant_pattern"],
+                    pleasant_perspective=scores["pleasant_perspective"],
+                    pleasant_post_processing=scores["pleasant_post_processing"],
+                    pleasant_reflection=scores["pleasant_reflection"],
+                    pleasant_symmetry=scores["pleasant_symmetry"],
+                    sharply_focused_subject=scores["sharply_focused_subject"],
+                    tastefully_blurred=scores["tastefully_blurred"],
+                    well_chosen_subject=scores["well_chosen_subject"],
+                    well_framed_subject=scores["well_framed_subject"],
+                    well_timed_shot=scores["well_timed_shot"],
+                )
+                return self._scoreinfo
+            except KeyError:
+                self._scoreinfo = ScoreInfo(
+                    overall=0.0,
+                    curation=0.0,
+                    promotion=0.0,
+                    highlight_visibility=0.0,
+                    behavioral=0.0,
+                    failure=0.0,
+                    harmonious_color=0.0,
+                    immersiveness=0.0,
+                    interaction=0.0,
+                    interesting_subject=0.0,
+                    intrusive_object_presence=0.0,
+                    lively_color=0.0,
+                    low_light=0.0,
+                    noise=0.0,
+                    pleasant_camera_tilt=0.0,
+                    pleasant_composition=0.0,
+                    pleasant_lighting=0.0,
+                    pleasant_pattern=0.0,
+                    pleasant_perspective=0.0,
+                    pleasant_post_processing=0.0,
+                    pleasant_reflection=0.0,
+                    pleasant_symmetry=0.0,
+                    sharply_focused_subject=0.0,
+                    tastefully_blurred=0.0,
+                    well_chosen_subject=0.0,
+                    well_framed_subject=0.0,
+                    well_timed_shot=0.0,
+                )
+                return self._scoreinfo
+
+    @property
+    def search_info(self):
+        """returns SearchInfo object for photo
+        only valid on Photos 5, on older libraries, returns None
+        """
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return None
+
+        # memoize SearchInfo object
+        try:
+            return self._search_info
+        except AttributeError:
+            self._search_info = SearchInfo(self)
+            return self._search_info
+
+    @property
+    def search_info_normalized(self):
+        """returns SearchInfo object for photo that produces normalized results
+        only valid on Photos 5, on older libraries, returns None
+        """
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return None
+
+        # memoize SearchInfo object
+        try:
+            return self._search_info_normalized
+        except AttributeError:
+            self._search_info_normalized = SearchInfo(self, normalized=True)
+            return self._search_info_normalized
+
+    @property
+    def labels(self):
+        """returns list of labels applied to photo by Photos image categorization
+        only valid on Photos 5, on older libraries returns empty list
+        """
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return []
+
+        return self.search_info.labels
+
+    @property
+    def labels_normalized(self):
+        """returns normalized list of labels applied to photo by Photos image categorization
+        only valid on Photos 5, on older libraries returns empty list
+        """
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            return []
+
+        return self.search_info_normalized.labels
+
+    @property
+    def comments(self):
+        """Returns list of Comment objects for any comments on the photo (sorted by date)"""
+        try:
+            return self._db._db_comments_uuid[self.uuid]["comments"]
+        except:
+            return []
+
+    @property
+    def likes(self):
+        """Returns list of Like objects for any likes on the photo (sorted by date)"""
+        try:
+            return self._db._db_comments_uuid[self.uuid]["likes"]
+        except:
+            return []
+
+    @property
+    def exif_info(self):
+        """Returns an ExifInfo object with the EXIF data for photo
+        Note: the returned EXIF data is the data Photos stores in the database on import;
+        ExifInfo does not provide access to the EXIF info in the actual image file
+        Some or all of the fields may be None
+        Only valid for Photos 5; on earlier database returns None
+        """
+
+        if self._db._db_version <= _PHOTOS_4_VERSION:
+            logging.debug(f"exif_info not implemented for this database version")
+            return None
+
+        try:
+            exif = self._db._db_exifinfo_uuid[self.uuid]
+            exif_info = ExifInfo(
+                iso=exif["ZISO"],
+                flash_fired=True if exif["ZFLASHFIRED"] == 1 else False,
+                metering_mode=exif["ZMETERINGMODE"],
+                sample_rate=exif["ZSAMPLERATE"],
+                track_format=exif["ZTRACKFORMAT"],
+                white_balance=exif["ZWHITEBALANCE"],
+                aperture=exif["ZAPERTURE"],
+                bit_rate=exif["ZBITRATE"],
+                duration=exif["ZDURATION"],
+                exposure_bias=exif["ZEXPOSUREBIAS"],
+                focal_length=exif["ZFOCALLENGTH"],
+                fps=exif["ZFPS"],
+                latitude=exif["ZLATITUDE"],
+                longitude=exif["ZLONGITUDE"],
+                shutter_speed=exif["ZSHUTTERSPEED"],
+                camera_make=exif["ZCAMERAMAKE"],
+                camera_model=exif["ZCAMERAMODEL"],
+                codec=exif["ZCODEC"],
+                lens_model=exif["ZLENSMODEL"],
+            )
+        except KeyError:
+            logging.debug(f"Could not find exif record for uuid {self.uuid}")
+            exif_info = ExifInfo(
+                iso=None,
+                flash_fired=None,
+                metering_mode=None,
+                sample_rate=None,
+                track_format=None,
+                white_balance=None,
+                aperture=None,
+                bit_rate=None,
+                duration=None,
+                exposure_bias=None,
+                focal_length=None,
+                fps=None,
+                latitude=None,
+                longitude=None,
+                shutter_speed=None,
+                camera_make=None,
+                camera_model=None,
+                codec=None,
+                lens_model=None,
+            )
+
+        return exif_info
+
+    @property
+    def exiftool(self):
+        """Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
+        Requires that exiftool (https://exiftool.org/) be installed
+        If exiftool not installed, logs warning and returns None
+        If photo path is missing, returns None
+        """
+        try:
+            # return the memoized instance if it exists
+            return self._exiftool
+        except AttributeError:
+            try:
+                exiftool_path = self._db._exiftool_path or get_exiftool_path()
+                if self.path is not None and os.path.isfile(self.path):
+                    exiftool = ExifToolCaching(self.path, exiftool=exiftool_path)
+                else:
+                    exiftool = None
+            except FileNotFoundError:
+                # get_exiftool_path raises FileNotFoundError if exiftool not found
+                exiftool = None
+                logging.warning(
+                    "exiftool not in path; download and install from https://exiftool.org/"
+                )
+
+            self._exiftool = exiftool
+            return self._exiftool
+
+    def detected_text(self, confidence_threshold=TEXT_DETECTION_CONFIDENCE_THRESHOLD):
+        """Detects text in photo and returns lists of results as (detected text, confidence)
+
+        confidence_threshold: float between 0.0 and 1.0. If text detection confidence is below this threshold,
+        text will not be returned. Default is TEXT_DETECTION_CONFIDENCE_THRESHOLD
+
+        If photo is edited, uses the edited photo, otherwise the original; falls back to the preview image if neither edited or original is available
+
+        Returns: list of (detected text, confidence) tuples
+        """
+
+        try:
+            return self._detected_text_cache[confidence_threshold]
+        except (AttributeError, KeyError) as e:
+            if isinstance(e, AttributeError):
+                self._detected_text_cache = {}
+
+            try:
+                detected_text = self._detected_text()
+            except Exception as e:
+                logging.warning(f"Error detecting text in photo {self.uuid}: {e}")
+                detected_text = []
+
+            self._detected_text_cache[confidence_threshold] = [
+                (text, confidence)
+                for text, confidence in detected_text
+                if confidence >= confidence_threshold
+            ]
+            return self._detected_text_cache[confidence_threshold]
+
+    def _detected_text(self):
+        """detect text in photo, either from cached extended attribute or by attempting text detection"""
+        path = (
+            self.path_edited if self.hasadjustments and self.path_edited else self.path
+        )
+        path = path or self.path_derivatives[0] if self.path_derivatives else None
+        if not path:
+            return []
+
+        md = OSXMetaData(path)
+        detected_text = md.get_attribute("osxphotos_detected_text")
+        if detected_text is None:
+            orientation = self.orientation or None
+            detected_text = detect_text(path, orientation)
+            md.set_attribute("osxphotos_detected_text", detected_text)
+        return detected_text
+
+    @property
+    def _longitude(self):
+        """Returns longitude, in degrees"""
+        return self._info["longitude"]
+
+    @property
+    def _latitude(self):
+        """Returns latitude, in degrees"""
+        return self._info["latitude"]
+
     def render_template(
         self, template_str: str, options: Optional[RenderOptions] = None
     ):
@@ -1060,44 +1429,155 @@ class PhotoInfo:
         template = PhotoTemplate(self, exiftool_path=self._db._exiftool_path)
         return template.render(template_str, options)
 
-    @property
-    def _longitude(self):
-        """Returns longitude, in degrees"""
-        return self._info["longitude"]
+    def export(
+        self,
+        dest,
+        filename=None,
+        edited=False,
+        live_photo=False,
+        raw_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,
+        keyword_template=None,
+        description_template=None,
+        render_options: Optional[RenderOptions] = None,
+    ):
+        """export photo
+        dest: must be valid destination path (or exception raised)
+        filename: (optional): name of exported picture; 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 export the photo using the
+                    incorrect file extension (unless use_photos_export is true, in which case export will
+                    use the extension provided by Photos upon export; in this case, an incorrect extension is
+                    silently ignored).
+                    e.g. to get the extension of the edited photo,
+                    reference PhotoInfo.path_edited
+        edited: (boolean, default=False); if True will export the edited version of the photo, otherwise exports the original version
+                (or raise exception if no edited version)
+        live_photo: (boolean, default=False); if True, will also export the associated .mov for live photos
+        raw_photo: (boolean, default=False); if True, will also export the associated RAW photo
+        export_as_hardlink: (boolean, default=False); if True, will hardlink files instead of copying them
+        overwrite: (boolean, default=False); if True will overwrite files if they already exist
+        increment: (boolean, default=True); if True, will increment file name until a non-existant name is found
+                    if overwrite=False and increment=False, export will fail if destination file already exists
+        sidecar_json: if set will write a json sidecar with data in format readable by exiftool
+                    sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. `exiftool -G -j`)
+        sidecar_exiftool: if set will write a json sidecar with data in format readable by exiftool
+                    sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. `exiftool -j`)
+        sidecar_xmp: if set will write an XMP sidecar with IPTC data
+                    sidecar filename will be dest/filename.xmp
+        use_photos_export: (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos
+        timeout: (int, default=120) timeout in seconds used with use_photos_export
+        exiftool: (boolean, default = False); if True, will use exiftool to write metadata to export file
+        returns list of full paths to the exported files
+        use_albums_as_keywords: (boolean, default = False); if True, will include album names in keywords
+        when exporting metadata with exiftool or sidecar
+        use_persons_as_keywords: (boolean, default = False); if True, will include person names in keywords
+        when exporting metadata with exiftool or sidecar
+        keyword_template: (list of strings); list of template strings that will be rendered as used as keywords
+        description_template: string; optional template string that will be rendered for use as photo description
+        render_options: an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer
 
-    @property
-    def _latitude(self):
-        """Returns latitude, in degrees"""
-        return self._info["latitude"]
+        Returns:
+            list of photos exported
+        """
 
-    def _get_album_uuids(self):
+        exporter = PhotoExporter(self)
+        sidecar = 0
+        if sidecar_json:
+            sidecar |= SIDECAR_JSON
+        if sidecar_exiftool:
+            sidecar |= SIDECAR_EXIFTOOL
+        if sidecar_xmp:
+            sidecar |= SIDECAR_XMP
+
+        if not filename:
+            if not edited:
+                filename = self.original_filename
+            else:
+                original_name = pathlib.Path(self.original_filename)
+                if self.path_edited:
+                    ext = pathlib.Path(self.path_edited).suffix
+                else:
+                    uti = self.uti_edited if edited and self.uti_edited else self.uti
+                    ext = get_preferred_uti_extension(uti)
+                    ext = "." + ext
+                filename = original_name.stem + "_edited" + ext
+
+        options = ExportOptions(
+            description_template=description_template,
+            edited=edited,
+            exiftool=exiftool,
+            export_as_hardlink=export_as_hardlink,
+            increment=increment,
+            keyword_template=keyword_template,
+            live_photo=live_photo,
+            overwrite=overwrite,
+            raw_photo=raw_photo,
+            render_options=render_options,
+            sidecar=sidecar,
+            timeout=timeout,
+            use_albums_as_keywords=use_albums_as_keywords,
+            use_persons_as_keywords=use_persons_as_keywords,
+            use_photos_export=use_photos_export,
+        )
+
+        results = exporter.export(dest, filename=filename, options=options)
+        return results.exported
+
+    def _get_album_uuids(self, project=False):
         """Return list of album UUIDs this photo is found in
 
             Filters out albums in the trash and any special album types
 
+            if project is True, returns special "My Project" albums (e.g. cards, calendars, slideshows)
+
         Returns: list of album UUIDs
         """
         if self._db._db_version <= _PHOTOS_4_VERSION:
-            version4 = True
             album_kind = [_PHOTOS_4_ALBUM_KIND]
-        else:
-            version4 = False
-            album_kind = [_PHOTOS_5_SHARED_ALBUM_KIND, _PHOTOS_5_ALBUM_KIND]
+            album_type = (
+                [_PHOTOS_4_ALBUM_TYPE_PROJECT, _PHOTOS_4_ALBUM_TYPE_SLIDESHOW]
+                if project
+                else [_PHOTOS_4_ALBUM_TYPE_ALBUM]
+            )
+            album_list = []
+            for album in self._info["albums"]:
+                detail = self._db._dbalbum_details[album]
+                if (
+                    detail["kind"] in album_kind
+                    and detail["albumType"] in album_type
+                    and not detail["intrash"]
+                    and detail["folderUuid"] != _PHOTOS_4_ROOT_FOLDER
+                    # in Photos <= 4, special albums like "printAlbum" have kind _PHOTOS_4_ALBUM_KIND
+                    # but should not be listed here; they can be distinguished by looking
+                    # for folderUuid of _PHOTOS_4_ROOT_FOLDER as opposed to _PHOTOS_4_TOP_LEVEL_ALBUM
+                ):
+                    album_list.append(album)
+            return album_list
+
+        # Photos 5+
+        album_kind = (
+            [_PHOTOS_5_PROJECT_ALBUM_KIND]
+            if project
+            else [_PHOTOS_5_SHARED_ALBUM_KIND, _PHOTOS_5_ALBUM_KIND]
+        )
 
         album_list = []
         for album in self._info["albums"]:
             detail = self._db._dbalbum_details[album]
-            if (
-                detail["kind"] in album_kind
-                and not detail["intrash"]
-                and (
-                    not version4
-                    # in Photos <= 4, special albums like "printAlbum" have kind _PHOTOS_4_ALBUM_KIND
-                    # but should not be listed here; they can be distinguished by looking
-                    # for folderUuid of _PHOTOS_4_ROOT_FOLDER as opposed to _PHOTOS_4_TOP_LEVEL_ALBUM
-                    or (version4 and detail["folderUuid"] != _PHOTOS_4_ROOT_FOLDER)
-                )
-            ):
+            if detail["kind"] in album_kind and not detail["intrash"]:
                 album_list.append(album)
         return album_list
 
@@ -1250,7 +1730,11 @@ class PhotoInfo:
             if isinstance(o, (datetime.date, datetime.datetime)):
                 return o.isoformat()
 
-        return json.dumps(self.asdict(), sort_keys=True, default=default)
+        dict_data = self.asdict()
+        for k, v in dict_data.items():
+            if v and isinstance(v, (list, tuple)) and not isinstance(v[0], dict):
+                dict_data[k] = sorted(v)
+        return json.dumps(dict_data, sort_keys=True, default=default)
 
     def __eq__(self, other):
         """Compare two PhotoInfo objects for equality"""

osxphotos/photoinfo/__init__.py

@@ -1,10 +0,0 @@
-"""
-PhotoInfo class
-Represents a single photo in the Photos library and provides access to the photo's attributes
-PhotosDB.photos() returns a list of PhotoInfo objects
-"""
-
-from ._photoinfo_exifinfo import ExifInfo
-from ._photoinfo_export import ExportResults
-from ._photoinfo_scoreinfo import ScoreInfo
-from .photoinfo import PhotoInfo, PhotoInfoNone

osxphotos/photoinfo/_photoinfo_comments.py

@@ -1,17 +0,0 @@
-""" PhotoInfo methods to expose comments and likes for shared photos """ 
-
-@property
-def comments(self):
-    """ Returns list of Comment objects for any comments on the photo (sorted by date) """
-    try:
-        return self._db._db_comments_uuid[self.uuid]["comments"]
-    except:
-        return []
-
-@property
-def likes(self):
-    """ Returns list of Like objects for any likes on the photo (sorted by date) """
-    try:
-        return self._db._db_comments_uuid[self.uuid]["likes"]
-    except:
-        return []

osxphotos/photoinfo/_photoinfo_exifinfo.py

@@ -1,94 +0,0 @@
-""" PhotoInfo methods to expose EXIF info from the library """
-
-import logging
-from dataclasses import dataclass
-
-from .._constants import _PHOTOS_4_VERSION
-
-
-@dataclass(frozen=True)
-class ExifInfo:
-    """ EXIF info associated with a photo from the Photos library """
-
-    flash_fired: bool
-    iso: int
-    metering_mode: int
-    sample_rate: int
-    track_format: int
-    white_balance: int
-    aperture: float
-    bit_rate: float
-    duration: float
-    exposure_bias: float
-    focal_length: float
-    fps: float
-    latitude: float
-    longitude: float
-    shutter_speed: float
-    camera_make: str
-    camera_model: str
-    codec: str
-    lens_model: str
-
-
-@property
-def exif_info(self):
-    """ Returns an ExifInfo object with the EXIF data for photo
-        Note: the returned EXIF data is the data Photos stores in the database on import;
-        ExifInfo does not provide access to the EXIF info in the actual image file
-        Some or all of the fields may be None
-        Only valid for Photos 5; on earlier database returns None
-        """
-
-    if self._db._db_version <= _PHOTOS_4_VERSION:
-        logging.debug(f"exif_info not implemented for this database version")
-        return None
-
-    try:
-        exif = self._db._db_exifinfo_uuid[self.uuid]
-        exif_info = ExifInfo(
-            iso=exif["ZISO"],
-            flash_fired=True if exif["ZFLASHFIRED"] == 1 else False,
-            metering_mode=exif["ZMETERINGMODE"],
-            sample_rate=exif["ZSAMPLERATE"],
-            track_format=exif["ZTRACKFORMAT"],
-            white_balance=exif["ZWHITEBALANCE"],
-            aperture=exif["ZAPERTURE"],
-            bit_rate=exif["ZBITRATE"],
-            duration=exif["ZDURATION"],
-            exposure_bias=exif["ZEXPOSUREBIAS"],
-            focal_length=exif["ZFOCALLENGTH"],
-            fps=exif["ZFPS"],
-            latitude=exif["ZLATITUDE"],
-            longitude=exif["ZLONGITUDE"],
-            shutter_speed=exif["ZSHUTTERSPEED"],
-            camera_make=exif["ZCAMERAMAKE"],
-            camera_model=exif["ZCAMERAMODEL"],
-            codec=exif["ZCODEC"],
-            lens_model=exif["ZLENSMODEL"],
-        )
-    except KeyError:
-        logging.debug(f"Could not find exif record for uuid {self.uuid}")
-        exif_info = ExifInfo(
-            iso=None,
-            flash_fired=None,
-            metering_mode=None,
-            sample_rate=None,
-            track_format=None,
-            white_balance=None,
-            aperture=None,
-            bit_rate=None,
-            duration=None,
-            exposure_bias=None,
-            focal_length=None,
-            fps=None,
-            latitude=None,
-            longitude=None,
-            shutter_speed=None,
-            camera_make=None,
-            camera_model=None,
-            codec=None,
-            lens_model=None,
-        )
-
-    return exif_info

osxphotos/photoinfo/_photoinfo_exiftool.py

@@ -1,34 +0,0 @@
-""" Implementation for PhotoInfo.exiftool property which returns ExifTool object for a photo """
-
-import logging
-import os
-
-from ..exiftool import ExifToolCaching, get_exiftool_path
-
-
-@property
-def exiftool(self):
-    """ Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
-        Requires that exiftool (https://exiftool.org/) be installed
-        If exiftool not installed, logs warning and returns None
-        If photo path is missing, returns None
-    """
-    try:
-        # return the memoized instance if it exists
-        return self._exiftool
-    except AttributeError:
-        try:
-            exiftool_path = self._db._exiftool_path or get_exiftool_path()
-            if self.path is not None and os.path.isfile(self.path):
-                exiftool = ExifToolCaching(self.path, exiftool=exiftool_path)
-            else:
-                exiftool = None
-        except FileNotFoundError:
-            # get_exiftool_path raises FileNotFoundError if exiftool not found
-            exiftool = None
-            logging.warning(
-                f"exiftool not in path; download and install from https://exiftool.org/"
-            )
-
-        self._exiftool = exiftool
-        return self._exiftool

osxphotos/photoinfo/_photoinfo_scoreinfo.py

@@ -1,119 +0,0 @@
-""" PhotoInfo methods to expose computed score info from the library """
-
-import logging
-from dataclasses import dataclass
-
-from .._constants import _PHOTOS_4_VERSION
-
-
-@dataclass(frozen=True)
-class ScoreInfo:
-    """ Computed photo score info associated with a photo from the Photos library """
-
-    overall: float
-    curation: float
-    promotion: float
-    highlight_visibility: float
-    behavioral: float
-    failure: float
-    harmonious_color: float
-    immersiveness: float
-    interaction: float
-    interesting_subject: float
-    intrusive_object_presence: float
-    lively_color: float
-    low_light: float
-    noise: float
-    pleasant_camera_tilt: float
-    pleasant_composition: float
-    pleasant_lighting: float
-    pleasant_pattern: float
-    pleasant_perspective: float
-    pleasant_post_processing: float
-    pleasant_reflection: float
-    pleasant_symmetry: float
-    sharply_focused_subject: float
-    tastefully_blurred: float
-    well_chosen_subject: float
-    well_framed_subject: float
-    well_timed_shot: float
-
-
-@property
-def score(self):
-    """ Computed score information for a photo
-
-    Returns:
-        ScoreInfo instance
-    """
-
-    if self._db._db_version <= _PHOTOS_4_VERSION:
-        logging.debug(f"score not implemented for this database version")
-        return None
-
-    try:
-        return self._scoreinfo  # pylint: disable=access-member-before-definition
-    except AttributeError:
-        try:
-            scores = self._db._db_scoreinfo_uuid[self.uuid]
-            self._scoreinfo = ScoreInfo(
-                overall=scores["overall_aesthetic"],
-                curation=scores["curation"],
-                promotion=scores["promotion"],
-                highlight_visibility=scores["highlight_visibility"],
-                behavioral=scores["behavioral"],
-                failure=scores["failure"],
-                harmonious_color=scores["harmonious_color"],
-                immersiveness=scores["immersiveness"],
-                interaction=scores["interaction"],
-                interesting_subject=scores["interesting_subject"],
-                intrusive_object_presence=scores["intrusive_object_presence"],
-                lively_color=scores["lively_color"],
-                low_light=scores["low_light"],
-                noise=scores["noise"],
-                pleasant_camera_tilt=scores["pleasant_camera_tilt"],
-                pleasant_composition=scores["pleasant_composition"],
-                pleasant_lighting=scores["pleasant_lighting"],
-                pleasant_pattern=scores["pleasant_pattern"],
-                pleasant_perspective=scores["pleasant_perspective"],
-                pleasant_post_processing=scores["pleasant_post_processing"],
-                pleasant_reflection=scores["pleasant_reflection"],
-                pleasant_symmetry=scores["pleasant_symmetry"],
-                sharply_focused_subject=scores["sharply_focused_subject"],
-                tastefully_blurred=scores["tastefully_blurred"],
-                well_chosen_subject=scores["well_chosen_subject"],
-                well_framed_subject=scores["well_framed_subject"],
-                well_timed_shot=scores["well_timed_shot"],
-            )
-            return self._scoreinfo
-        except KeyError:
-            self._scoreinfo = ScoreInfo(
-                overall=0.0,
-                curation=0.0,
-                promotion=0.0,
-                highlight_visibility=0.0,
-                behavioral=0.0,
-                failure=0.0,
-                harmonious_color=0.0,
-                immersiveness=0.0,
-                interaction=0.0,
-                interesting_subject=0.0,
-                intrusive_object_presence=0.0,
-                lively_color=0.0,
-                low_light=0.0,
-                noise=0.0,
-                pleasant_camera_tilt=0.0,
-                pleasant_composition=0.0,
-                pleasant_lighting=0.0,
-                pleasant_pattern=0.0,
-                pleasant_perspective=0.0,
-                pleasant_post_processing=0.0,
-                pleasant_reflection=0.0,
-                pleasant_symmetry=0.0,
-                sharply_focused_subject=0.0,
-                tastefully_blurred=0.0,
-                well_chosen_subject=0.0,
-                well_framed_subject=0.0,
-                well_timed_shot=0.0,
-            )
-            return self._scoreinfo

osxphotos/photokit.py

@@ -6,8 +6,6 @@
 """
 
 # NOTES:
-# - This likely leaks memory like a sieve as I need to ensure all the
-#   Objective C objects are cleaned up.
 # - There are several techniques used for handling PhotoKit's various
 #   asynchronous calls used in this code: event loop+notification, threading
 #   event, while loop. I've experimented with each to find the one that works.
@@ -32,11 +30,34 @@ import Photos
 import Quartz
 from Foundation import NSNotificationCenter, NSObject
 from PyObjCTools import AppHelper
+from wurlitzer import pipes
 
 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
@@ -200,16 +221,6 @@ class PHAssetResourceData:
         self.data = b""
 
 
-# class LivePhotoData:
-#     """ Simple class to hold the data passed to the handler for
-#         requestLivePhotoForAsset:targetSize:contentMode:options:resultHandler:
-#     """
-
-#     def __init__(self):
-#         self.live_photo = None
-#         self.info = None
-
-
 class PhotoKitNotificationDelegate(NSObject):
     """Handles notifications from NotificationCenter;
     used with asynchronous PhotoKit requests to stop event loop when complete
@@ -487,6 +498,7 @@ class PhotoAsset:
         version=PHOTOS_VERSION_CURRENT,
         overwrite=False,
         raw=False,
+        **kwargs,
     ):
         """Export image to path
 
@@ -496,6 +508,7 @@ class PhotoAsset:
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
             overwrite: bool, if True, overwrites destination file if it already exists; default is False
             raw: bool, if True, export RAW component of RAW+JPEG pair, default is False
+            **kwargs: used only to avoid issues with each asset type having slightly different export arguments
 
         Returns:
             List of path to exported image(s)
@@ -504,73 +517,75 @@ class PhotoAsset:
             ValueError if dest is not a valid directory
         """
 
-        # if self.live:
-        #     raise NotImplementedError("Live photos not implemented yet")
-
         with objc.autorelease_pool():
-            filename = (
-                pathlib.Path(filename)
-                if filename
-                else pathlib.Path(self.original_filename)
-            )
+            with pipes() as (out, err):
+                filename = (
+                    pathlib.Path(filename)
+                    if filename
+                    else pathlib.Path(self.original_filename)
+                )
 
-            dest = pathlib.Path(dest)
-            if not dest.is_dir():
-                raise ValueError("dest must be a valid directory: {dest}")
+                dest = pathlib.Path(dest)
+                if not dest.is_dir():
+                    raise ValueError("dest must be a valid directory: {dest}")
 
-            output_file = None
-            if self.isphoto:
-                # will hold exported image data and needs to be cleaned up at end
-                imagedata = None
-                if raw:
-                    # export the raw component
-                    resources = self._resources()
-                    for resource in resources:
-                        if resource.type() == Photos.PHAssetResourceTypeAlternatePhoto:
-                            data = self._request_resource_data(resource)
-                            ext = pathlib.Path(self.raw_filename).suffix[1:]
-                            break
+                output_file = None
+                if self.isphoto:
+                    # will hold exported image data and needs to be cleaned up at end
+                    imagedata = None
+                    if raw:
+                        # export the raw component
+                        resources = self._resources()
+                        for resource in resources:
+                            if (
+                                resource.type()
+                                == Photos.PHAssetResourceTypeAlternatePhoto
+                            ):
+                                data = self._request_resource_data(resource)
+                                suffix = pathlib.Path(self.raw_filename).suffix
+                                ext = suffix[1:] if suffix else ""
+                                break
+                        else:
+                            raise PhotoKitExportError(
+                                "Could not get image data for RAW photo"
+                            )
                     else:
-                        raise PhotoKitExportError(
-                            "Could not get image data for RAW photo"
-                        )
-                else:
-                    # TODO: if user has selected use RAW as original, this returns the RAW
-                    # can get the jpeg with resource.type() == Photos.PHAssetResourceTypePhoto
-                    imagedata = self._request_image_data(version=version)
-                    if not imagedata.image_data:
-                        raise PhotoKitExportError("Could not get image data")
-                    ext = get_preferred_uti_extension(imagedata.uti)
-                    data = imagedata.image_data
+                        # TODO: if user has selected use RAW as original, this returns the RAW
+                        # can get the jpeg with resource.type() == Photos.PHAssetResourceTypePhoto
+                        imagedata = self._request_image_data(version=version)
+                        if not imagedata.image_data:
+                            raise PhotoKitExportError("Could not get image data")
+                        ext = get_preferred_uti_extension(imagedata.uti)
+                        data = imagedata.image_data
 
-                output_file = dest / f"{filename.stem}.{ext}"
+                    output_file = dest / f"{filename.stem}.{ext}"
 
-                if not overwrite:
-                    output_file = pathlib.Path(increment_filename(output_file))
+                    if not overwrite:
+                        output_file = pathlib.Path(increment_filename(output_file))
 
-                with open(output_file, "wb") as fd:
-                    fd.write(data)
+                    with open(output_file, "wb") as fd:
+                        fd.write(data)
 
-                if imagedata:
-                    del imagedata
-            elif self.ismovie:
-                videodata = self._request_video_data(version=version)
-                if videodata.asset is None:
-                    raise PhotoKitExportError("Could not get video for asset")
+                    if imagedata:
+                        del imagedata
+                elif self.ismovie:
+                    videodata = self._request_video_data(version=version)
+                    if videodata.asset is None:
+                        raise PhotoKitExportError("Could not get video for asset")
 
-                url = videodata.asset.URL()
-                path = pathlib.Path(NSURL_to_path(url))
-                if not path.is_file():
-                    raise FileNotFoundError("Could not get path to video file")
-                ext = path.suffix
-                output_file = dest / f"{filename.stem}{ext}"
+                    url = videodata.asset.URL()
+                    path = pathlib.Path(NSURL_to_path(url))
+                    if not path.is_file():
+                        raise FileNotFoundError("Could not get path to video file")
+                    ext = path.suffix
+                    output_file = dest / f"{filename.stem}{ext}"
 
-                if not overwrite:
-                    output_file = pathlib.Path(increment_filename(output_file))
+                    if not overwrite:
+                        output_file = pathlib.Path(increment_filename(output_file))
 
-                FileUtil.copy(path, output_file)
+                    FileUtil.copy(path, output_file)
 
-            return [str(output_file)]
+                return [str(output_file)]
 
     def _request_image_data(self, version=PHOTOS_VERSION_ORIGINAL):
         """Request image data and metadata for self._phasset
@@ -615,9 +630,7 @@ class PhotoAsset:
 
                 nonlocal requestdata
 
-                options = {}
-                # pylint: disable=no-member
-                options[Quartz.kCGImageSourceShouldCache] = Foundation.kCFBooleanFalse
+                options = {Quartz.kCGImageSourceShouldCache: Foundation.kCFBooleanFalse}
                 imgSrc = Quartz.CGImageSourceCreateWithData(imageData, options)
                 requestdata.metadata = Quartz.CGImageSourceCopyPropertiesAtIndex(
                     imgSrc, 0, options
@@ -701,9 +714,7 @@ class PhotoAsset:
 
             nonlocal data
 
-            options = {}
-            # pylint: disable=no-member
-            options[Quartz.kCGImageSourceShouldCache] = Foundation.kCFBooleanFalse
+            options = {Quartz.kCGImageSourceShouldCache: Foundation.kCFBooleanFalse}
             imgSrc = Quartz.CGImageSourceCreateWithData(imageData, options)
             data.metadata = Quartz.CGImageSourceCopyPropertiesAtIndex(
                 imgSrc, 0, options
@@ -789,7 +800,6 @@ class SlowMoVideoExporter(NSObject):
         self.url = None
         self.done = None
         self.nc = None
-        # super(NSObject, self).dealloc()
 
 
 class VideoAsset(PhotoAsset):
@@ -801,7 +811,12 @@ class VideoAsset(PhotoAsset):
     # https://developer.apple.com/documentation/photokit/phimagemanager/1616981-requestexportsessionforvideo?language=objc
     # above 10.15 only
     def export(
-        self, dest, filename=None, version=PHOTOS_VERSION_CURRENT, overwrite=False
+        self,
+        dest,
+        filename=None,
+        version=PHOTOS_VERSION_CURRENT,
+        overwrite=False,
+        **kwargs,
     ):
         """Export video to path
 
@@ -810,6 +825,7 @@ class VideoAsset(PhotoAsset):
             filename: str, optional name of exported file; if not provided, defaults to asset's original filename
             version: which version of image (PHOTOS_VERSION_ORIGINAL or PHOTOS_VERSION_CURRENT)
             overwrite: bool, if True, overwrites destination file if it already exists; default is False
+            **kwargs: used only to avoid issues with each asset type having slightly different export arguments
 
         Returns:
             List of path to exported image(s)
@@ -819,42 +835,46 @@ class VideoAsset(PhotoAsset):
         """
 
         with objc.autorelease_pool():
-            if self.slow_mo and version == PHOTOS_VERSION_CURRENT:
-                return [
-                    self._export_slow_mo(
-                        dest, filename=filename, version=version, overwrite=overwrite
-                    )
-                ]
+            with pipes() as (out, err):
+                if self.slow_mo and version == PHOTOS_VERSION_CURRENT:
+                    return [
+                        self._export_slow_mo(
+                            dest,
+                            filename=filename,
+                            version=version,
+                            overwrite=overwrite,
+                        )
+                    ]
 
-            filename = (
-                pathlib.Path(filename)
-                if filename
-                else pathlib.Path(self.original_filename)
-            )
+                filename = (
+                    pathlib.Path(filename)
+                    if filename
+                    else pathlib.Path(self.original_filename)
+                )
 
-            dest = pathlib.Path(dest)
-            if not dest.is_dir():
-                raise ValueError("dest must be a valid directory: {dest}")
+                dest = pathlib.Path(dest)
+                if not dest.is_dir():
+                    raise ValueError("dest must be a valid directory: {dest}")
 
-            output_file = None
-            videodata = self._request_video_data(version=version)
-            if videodata.asset is None:
-                raise PhotoKitExportError("Could not get video for asset")
+                output_file = None
+                videodata = self._request_video_data(version=version)
+                if videodata.asset is None:
+                    raise PhotoKitExportError("Could not get video for asset")
 
-            url = videodata.asset.URL()
-            path = pathlib.Path(NSURL_to_path(url))
-            del videodata
-            if not path.is_file():
-                raise FileNotFoundError("Could not get path to video file")
-            ext = path.suffix
-            output_file = dest / f"{filename.stem}{ext}"
+                url = videodata.asset.URL()
+                path = pathlib.Path(NSURL_to_path(url))
+                del videodata
+                if not path.is_file():
+                    raise FileNotFoundError("Could not get path to video file")
+                ext = path.suffix
+                output_file = dest / f"{filename.stem}{ext}"
 
-            if not overwrite:
-                output_file = pathlib.Path(increment_filename(output_file))
+                if not overwrite:
+                    output_file = pathlib.Path(increment_filename(output_file))
 
-            FileUtil.copy(path, output_file)
+                FileUtil.copy(path, output_file)
 
-            return [str(output_file)]
+                return [str(output_file)]
 
     def _export_slow_mo(
         self, dest, filename=None, version=PHOTOS_VERSION_CURRENT, overwrite=False
@@ -1043,6 +1063,7 @@ class LivePhotoAsset(PhotoAsset):
         overwrite=False,
         photo=True,
         video=True,
+        **kwargs,
     ):
         """Export image to path
 
@@ -1053,6 +1074,7 @@ class LivePhotoAsset(PhotoAsset):
             overwrite: bool, if True, overwrites destination file if it already exists; default is False
             photo: bool, if True, export photo component of live photo
             video: bool, if True, export live video component of live photo
+            **kwargs: used only to avoid issues with each asset type having slightly different export arguments
 
         Returns:
             list of [path to exported image and/or video]
@@ -1063,132 +1085,69 @@ class LivePhotoAsset(PhotoAsset):
         """
 
         with objc.autorelease_pool():
-            filename = (
-                pathlib.Path(filename)
-                if filename
-                else pathlib.Path(self.original_filename)
-            )
-
-            dest = pathlib.Path(dest)
-            if not dest.is_dir():
-                raise ValueError("dest must be a valid directory: {dest}")
-
-            request = LivePhotoRequest.alloc().initWithManager_Asset_(
-                self._manager, self.phasset
-            )
-            resources = request.requestLivePhotoResources(version=version)
-
-            video_resource = None
-            photo_resource = None
-            for resource in resources:
-                if resource.type() == Photos.PHAssetResourceTypePairedVideo:
-                    video_resource = resource
-                elif resource.type() == Photos.PHAssetMediaTypeImage:
-                    photo_resource = resource
-
-            if not video_resource or not photo_resource:
-                raise PhotoKitExportError(
-                    "Did not find photo/video resources for live photo"
+            with pipes() as (out, err):
+                filename = (
+                    pathlib.Path(filename)
+                    if filename
+                    else pathlib.Path(self.original_filename)
                 )
 
-            photo_ext = get_preferred_uti_extension(
-                photo_resource.uniformTypeIdentifier()
-            )
-            photo_output_file = dest / f"{filename.stem}.{photo_ext}"
-            video_ext = get_preferred_uti_extension(
-                video_resource.uniformTypeIdentifier()
-            )
-            video_output_file = dest / f"{filename.stem}.{video_ext}"
+                dest = pathlib.Path(dest)
+                if not dest.is_dir():
+                    raise ValueError("dest must be a valid directory: {dest}")
 
-            if not overwrite:
-                photo_output_file = pathlib.Path(increment_filename(photo_output_file))
-                video_output_file = pathlib.Path(increment_filename(video_output_file))
+                request = LivePhotoRequest.alloc().initWithManager_Asset_(
+                    self._manager, self.phasset
+                )
+                resources = request.requestLivePhotoResources(version=version)
 
-            # def handler(error):
-            #     if error:
-            #         raise PhotoKitExportError(f"writeDataForAssetResource error: {error}")
+                video_resource = None
+                photo_resource = None
+                for resource in resources:
+                    if resource.type() == Photos.PHAssetResourceTypePairedVideo:
+                        video_resource = resource
+                    elif resource.type() == Photos.PHAssetMediaTypeImage:
+                        photo_resource = resource
 
-            # resource_manager = Photos.PHAssetResourceManager.defaultManager()
-            # options = Photos.PHAssetResourceRequestOptions.alloc().init()
-            # options.setNetworkAccessAllowed_(True)
-            # exported = []
-            # Note: Tried writeDataForAssetResource_toFile_options_completionHandler_ which works
-            # but sets quarantine flag and for reasons I can't determine (maybe quarantine flag)
-            # causes pathlib.Path().is_file() to fail in tests
+                if not video_resource or not photo_resource:
+                    raise PhotoKitExportError(
+                        "Did not find photo/video resources for live photo"
+                    )
 
-            # if photo:
-            #     photo_output_url = path_to_NSURL(photo_output_file)
-            #     resource_manager.writeDataForAssetResource_toFile_options_completionHandler_(
-            #         photo_resource, photo_output_url, options, handler
-            #     )
-            #     exported.append(str(photo_output_file))
+                photo_ext = get_preferred_uti_extension(
+                    photo_resource.uniformTypeIdentifier()
+                )
+                photo_output_file = dest / f"{filename.stem}.{photo_ext}"
+                video_ext = get_preferred_uti_extension(
+                    video_resource.uniformTypeIdentifier()
+                )
+                video_output_file = dest / f"{filename.stem}.{video_ext}"
 
-            # if video:
-            #     video_output_url = path_to_NSURL(video_output_file)
-            #     resource_manager.writeDataForAssetResource_toFile_options_completionHandler_(
-            #         video_resource, video_output_url, options, handler
-            #     )
-            #     exported.append(str(video_output_file))
+                if not overwrite:
+                    photo_output_file = pathlib.Path(
+                        increment_filename(photo_output_file)
+                    )
+                    video_output_file = pathlib.Path(
+                        increment_filename(video_output_file)
+                    )
 
-            # def completion_handler(error):
-            #     if error:
-            #         raise PhotoKitExportError(f"writeDataForAssetResource error: {error}")
+                exported = []
+                if photo:
+                    data = self._request_resource_data(photo_resource)
+                    # image_data = self.request_image_data(version=version)
+                    with open(photo_output_file, "wb") as fd:
+                        fd.write(data)
+                    exported.append(str(photo_output_file))
+                    del data
+                if video:
+                    data = self._request_resource_data(video_resource)
+                    with open(video_output_file, "wb") as fd:
+                        fd.write(data)
+                    exported.append(str(video_output_file))
+                    del data
 
-            # would be nice to be able to usewriteDataForAssetResource_toFile_options_completionHandler_
-            # but it sets quarantine flags that cause issues so instead, request the data and write the files directly
-
-            exported = []
-            if photo:
-                data = self._request_resource_data(photo_resource)
-                # image_data = self.request_image_data(version=version)
-                with open(photo_output_file, "wb") as fd:
-                    fd.write(data)
-                exported.append(str(photo_output_file))
-                del data
-            if video:
-                data = self._request_resource_data(video_resource)
-                with open(video_output_file, "wb") as fd:
-                    fd.write(data)
-                exported.append(str(video_output_file))
-                del data
-
-            request.dealloc()
-            return exported
-
-    # def request_image_data(self, version=PHOTOS_VERSION_CURRENT):
-    #     # Returns an NSImage which isn't overly useful
-    #     # https://developer.apple.com/documentation/photokit/phimagemanager/1616964-requestimageforasset?language=objc
-
-    #     # requestImageForAsset:targetSize:contentMode:options:resultHandler:
-
-    #     options = Photos.PHImageRequestOptions.alloc().init()
-    #     options.setVersion_(version)
-    #     options.setNetworkAccessAllowed_(True)
-    #     options.setSynchronous_(True)
-    #     options.setDeliveryMode_(
-    #         Photos.PHImageRequestOptionsDeliveryModeHighQualityFormat
-    #     )
-
-    #     event = threading.Event()
-    #     image_data = ImageData()
-
-    #     def handler(result, info):
-    #         nonlocal image_data
-    #         if not info["PHImageResultIsDegradedKey"]:
-    #             image_data.image_data = result
-    #             image_data.info = info
-    #             event.set()
-
-    #     self._manager.requestImageForAsset_targetSize_contentMode_options_resultHandler_(
-    #         self._phasset,
-    #         Photos.PHImageManagerMaximumSize,
-    #         Photos.PHImageContentModeDefault,
-    #         options,
-    #         handler,
-    #     )
-    #     event.wait()
-    #     options.dealloc()
-    #     return image_data
+                request.dealloc()
+                return exported
 
 
 class PhotoLibrary:

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
 
@@ -70,12 +70,24 @@ def _process_comments_5(photosdb):
     results = conn.execute(
         """
         SELECT DISTINCT
-        ZINVITEEHASHEDPERSONID,
-        ZINVITEEFIRSTNAME,
-        ZINVITEELASTNAME,
-        ZINVITEEFULLNAME
-        FROM
-        ZCLOUDSHAREDALBUMINVITATIONRECORD
+        ZINVITEEHASHEDPERSONID AS HASHEDPERSONID,
+        ZINVITEEFIRSTNAME AS FIRSTNAME,
+        ZINVITEELASTNAME AS LASTNAME,
+        ZINVITEEFULLNAME AS FULLNAME
+        FROM ZCLOUDSHAREDALBUMINVITATIONRECORD
+        WHERE HASHEDPERSONID IS NOT NULL
+        AND HASHEDPERSONID != ""
+        AND NOT (FIRSTNAME IS NULL AND LASTNAME IS NULL)
+        UNION
+        SELECT DISTINCT
+        ZCLOUDOWNERHASHEDPERSONID AS HASHEDPERSONID,
+        ZCLOUDOWNERFIRSTNAME AS FIRSTNAME,
+        ZCLOUDOWNERLASTNAME AS LASTNAME,
+        ZCLOUDOWNERFULLNAME AS FULLNAME
+        FROM ZGENERICALBUM
+        WHERE HASHEDPERSONID IS NOT NULL
+        AND HASHEDPERSONID != ""
+        AND NOT (FIRSTNAME IS NULL AND LASTNAME IS NULL)
         """
     )
 
@@ -148,10 +160,10 @@ def _process_comments_5(photosdb):
             db_comments["comments"].append(CommentInfo(dt, user_name, ismine, text))
 
     # sort results
-    for uuid in photosdb._db_comments_uuid:
+    for uuid, value in photosdb._db_comments_uuid.items():
         if photosdb._db_comments_uuid[uuid]["likes"]:
             photosdb._db_comments_uuid[uuid]["likes"].sort(key=lambda x: x.datetime)
         if photosdb._db_comments_uuid[uuid]["comments"]:
-            photosdb._db_comments_uuid[uuid]["comments"].sort(key=lambda x: x.datetime)
+            value["comments"].sort(key=lambda x: x.datetime)
 
     conn.close()

osxphotos/photosdb/_photosdb_process_exif.py

@@ -4,13 +4,14 @@
 import logging
 
 from .._constants import _DB_TABLE_NAMES, _PHOTOS_4_VERSION
-from ..utils import _db_is_locked, _debug, _open_sql_file
+from ..utils import _db_is_locked, _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
@@ -146,7 +145,6 @@ def _process_faceinfo_4(photosdb):
 
         # Photos 5 only
         face["agetype"] = None
-        face["baldtype"] = None
         face["eyemakeuptype"] = None
         face["eyestate"] = None
         face["facialhairtype"] = None
@@ -173,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
@@ -194,7 +192,7 @@ def _process_faceinfo_5(photosdb):
         ZDETECTEDFACE.ZPERSON,
         ZPERSON.ZFULLNAME,
         ZDETECTEDFACE.ZAGETYPE,
-        ZDETECTEDFACE.ZBALDTYPE,
+        NULL, -- ZDETECTEDFACE.ZBALDTYPE (Removed in Monterey)
         ZDETECTEDFACE.ZEYEMAKEUPTYPE,
         ZDETECTEDFACE.ZEYESSTATE,
         ZDETECTEDFACE.ZFACIALHAIRTYPE,
@@ -239,7 +237,7 @@ def _process_faceinfo_5(photosdb):
     # 3    ZDETECTEDFACE.ZPERSON,
     # 4    ZPERSON.ZFULLNAME,
     # 5    ZDETECTEDFACE.ZAGETYPE,
-    # 6    ZDETECTEDFACE.ZBALDTYPE,
+    # 6    ZDETECTEDFACE.ZBALDTYPE,  (Not available on Monterey)
     # 7    ZDETECTEDFACE.ZEYEMAKEUPTYPE,
     # 8    ZDETECTEDFACE.ZEYESSTATE,
     # 9    ZDETECTEDFACE.ZFACIALHAIRTYPE,
@@ -284,7 +282,6 @@ def _process_faceinfo_5(photosdb):
         face["person"] = person_pk
         face["fullname"] = normalize_unicode(row[4])
         face["agetype"] = row[5]
-        face["baldtype"] = row[6]
         face["eyemakeuptype"] = row[7]
         face["eyestate"] = row[8]
         face["facialhairtype"] = row[9]

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()