007f0e0960
* Added query_command and example * Refactored QUERY_OPTIONS, added query_command, refactored verbose, #930, #931 * Added query options to debug-dump, #966 * Refactored query, #602 * Added precedence test for --load-config * Refactored handling of query options * Refactored export_photo * Removed extraneous print * Updated API_README * Updated examples
68 lines
2.5 KiB
Python
68 lines
2.5 KiB
Python
"""Sample query command for osxphotos
|
|
|
|
This shows how simple it is to create a command line tool using osxphotos to process your photos.
|
|
|
|
Using the @query_command decorator turns your function to a full-fledged command line app that
|
|
can be run via `osxphotos run cli_example_1.py` or `python cli_example_1.py` if you have pip installed osxphotos.
|
|
|
|
Using this decorator makes it very easy to create a quick command line tool that can operate on
|
|
a subset of your photos. Additionally, writing a command in this way makes it easy to later
|
|
incorporate the command into osxphotos as a full-fledged command.
|
|
|
|
The decorator will add all the query options available in `osxphotos query` as command line options
|
|
as well as the following options:
|
|
--verbose
|
|
--timestamp
|
|
--theme
|
|
--db
|
|
--debug (hidden, won't show in help)
|
|
|
|
The decorated function will perform the query and pass the list of filtered PhotoInfo objects
|
|
to your function. You can then do whatever you want with the photos.
|
|
|
|
For example, to run the command on only selected photos:
|
|
|
|
osxphotos run cli_example_1.py --selected
|
|
|
|
To run the command on all photos with the keyword "foo":
|
|
|
|
osxphotos run cli_example_1.py --keyword foo
|
|
|
|
For more advanced example, see `cli_example_2.py`
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import osxphotos
|
|
from osxphotos.cli import query_command, verbose
|
|
|
|
|
|
@query_command
|
|
def example(photos: list[osxphotos.PhotoInfo], **kwargs):
|
|
"""Sample query command for osxphotos. Prints out the filename and date of each photo.
|
|
|
|
Whatever text you put in the function's docstring here, will be used as the command's
|
|
help text when run via `osxphotos run cli_example_1.py --help` or `python cli_example_1.py --help`
|
|
"""
|
|
|
|
# verbose() will print to stdout if --verbose option is set
|
|
# you can optionally provide a level (default is 1) to print only if --verbose is set to that level
|
|
# for example: -VV or --verbose --verbose == level 2
|
|
verbose(f"Found {len(photos)} photo(s)")
|
|
verbose("This message will only be printed if verbose level 2 is set", level=2)
|
|
|
|
# do something with photos here
|
|
for photo in photos:
|
|
# photos is a list of PhotoInfo objects
|
|
# see: https://rhettbull.github.io/osxphotos/reference.html#osxphotos.PhotoInfo
|
|
verbose(f"Processing {photo.original_filename}")
|
|
print(f"{photo.original_filename} {photo.date}")
|
|
...
|
|
|
|
|
|
if __name__ == "__main__":
|
|
# call your function here
|
|
# you do not need to pass any arguments to the function
|
|
# as the decorator will handle parsing the command line arguments
|
|
example()
|