forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docs

Browse Source
This commit is contained in:
Rhet Turnbull
2022-04-22 20:51:37 -07:00
parent 16a2000e64
commit b1aa9238d3
138 changed files with 48276 additions and 13099 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
osxphotos/queryoptions.py
View File

@@ -12,6 +12,86 @@ __all__ = ["QueryOptions"]
@dataclass
class QueryOptions:
"""QueryOptions class for PhotosDB.query
Attributes:
keyword: list of keywords to search for
person: list of person names to search for
album: list of album names to search for
folder: list of folder names to search for
uuid: list of uuids to search for
title: list of titles to search for
no_title: search for photos with no title
description: list of descriptions to search for
no_description: search for photos with no description
ignore_case: ignore case when searching
edited: search for edited photos
external_edit: search for photos edited in external apps
favorite: search for favorite photos
not_favorite: search for non-favorite photos
hidden: search for hidden photos
not_hidden: search for non-hidden photos
missing: search for missing photos
not_missing: search for non-missing photos
shared: search for shared photos
not_shared: search for non-shared photos
photos: search for photos
movies: search for movies
uti: list of UTIs to search for
burst: search for burst photos
not_burst: search for non-burst photos
live: search for live photos
not_live: search for non-live photos
cloudasset: search for photos that are managed by iCloud
not_cloudasset: search for photos that are not managed by iCloud
incloud: search for cloud assets that are synched to iCloud
not_incloud: search for cloud asset photos that are not yet synched to iCloud
from_date: search for photos taken on or after this date
to_date: search for photos taken on or before this date
portrait: search for portrait photos
not_portrait: search for non-portrait photos
screenshot: search for screenshot photos
not_screenshot: search for non-screenshot photos
slow_mo: search for slow-mo photos
not_slow_mo: search for non-slow-mo photos
time_lapse: search for time-lapse photos
not_time_lapse: search for non-time-lapse photos
hdr: search for HDR photos
not_hdr: search for non-HDR photos
selfie: search for selfie photos
not_selfie: search for non-selfie photos
panorama: search for panorama photos
not_panorama: search for non-panorama photos
has_raw: search for photos with associated raw files
place: list of place names to search for
no_place: search for photos with no place
label: list of labels to search for
deleted: also include deleted photos
deleted_only: search only for deleted photos
has_comment: search for photos with comments
no_comment: search for photos with no comments
has_likes: search for shared photos with likes
no_likes: search for shared photos with no likes
is_reference: search for photos stored by reference (that is, they are not managed by Photos)
in_album: search for photos in an album
not_in_album: search for photos not in an album
burst_photos: search for burst photos
missing_bursts: for burst photos, also include burst photos that are missing
name: list of names to search for
min_size: minimum size of photos to search for
max_size: maximum size of photos to search for
regex: list of regular expressions to search for
query_eval: list of query expressions to evaluate
duplicate: search for duplicate photos
location: search for photos with a location
no_location: search for photos with no location
function: list of query functions to evaluate
selected: search for selected photos
exif: search for photos with EXIF tags that matches the given data
year: search for photos taken in a given year
"""
keyword: Optional[Iterable[str]] = None
person: Optional[Iterable[str]] = None
album: Optional[Iterable[str]] = None
@@ -87,7 +167,7 @@ class QueryOptions:
function: Optional[List[Tuple[callable, str]]] = None
selected: Optional[bool] = None
exif: Optional[Iterable[Tuple[str, str]]] = None
year: Optional[int] = None
year: Optional[Iterable[int]] = None
def asdict(self):
return asdict(self)