OSXPhotos Python API¶

In addition to a command line interface, OSXPhotos provides a access to a Python API that allows you to easily access a Photos library, often with just a few lines of code.

Table of Contents¶

Example uses of the Python package¶

Print filename, date created, title, and keywords for all photos in a library¶

"""print filename, date created, title, and keywords for all photos in Photos library"""

import osxphotos

if __name__ == "__main__":
    photosdb = osxphotos.PhotosDB()
    for photo in photosdb.photos():
        print(photo.original_filename, photo.date, photo.title, photo.keywords)

The primary interface to the Photos library is the PhotosDB object. The PhotosDB object provides access to the photos in the library via the photos method and the query. These methods returns a list of PhotoInfo objects, one for each photo in the library. The PhotoInfo object provides access to the metadata for each photo.

Building simple command line tools¶

osxphotos provides several useful helper functions to make it easy to build simple command line tools. For example, the following code will print information about all photos in a library or a subset of photos filtered by one or more query options. This mirrors the osxphotos query command line tool. Tools built using these helper functions can be easily distributed as a single file and run via osxphotos run script.py so the user doesn’t need to install python, any dependencies, or create a virtual environment.

Here’s a simple example showing how to use the query_command decorator to implement a simple command line tool. The query_command decorator turns your function into a full-fledged Click command line app that can be run via osxphotos run example.py or python example.py if you have pip installed osxphotos. Your command will include all the query options available in osxphotos query as command line options as well as --verbose and other convenient options.

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

Here is a more advanced example that shows how to implement a script with a “dry run” and “resume” capability that preserves state between runs. Using the built-in helpers allows you to implement complex behavior in just a few lines of code.

"""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_2.py` or `python cli_example_2.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_2.py --selected

To run the command on all photos with the keyword "foo":

    osxphotos run cli_example_2.py --keyword foo

The following helper functions may be useful and can be imported from osxphotos.cli:

    abort(message: str, exit_code: int = 1)
        Abort with error message and exit code
    echo(message: str)
        Print message to stdout using rich formatting
    echo_error(message: str)
        Print message to stderr using rich formatting
    logger: logging.Logger
        Python logger for osxphotos; for example, logger.debug("debug message")
    verbose(*args, level: int = 1)
        Print args to stdout if --verbose option is set
    query_command: decorator to create an osxphotos query command
    kvstore(name: str) -> SQLiteKVStore useful for storing state between runs

The verbose, echo, and echo_error functions use rich formatting to print messages to stdout and stderr.
See https://github.com/Textualize/rich for more information on rich formatting.

In addition to standard rich formatting styles, the following styles will be defined
(and can be changed using --theme):

    [change]: something change
    [no_change]: indicate no change
    [count]: a count
    [error]: an error
    [filename]: a filename
    [filepath]: a filepath
    [num]: a number
    [time]: a time or date
    [tz]: a timezone
    [warning]: a warning
    [uuid]: a uuid

The tags should be closed with [/] to end the style.  For example:

    echo("[filename]foo[/] [time]bar[/]")

For simpler examples, see `cli_example_1.py`
"""

from __future__ import annotations

import datetime

import click

import osxphotos
from osxphotos.cli import (
    abort,
    echo,
    echo_error,
    kvstore,
    logger,
    query_command,
    verbose,
)


@query_command()
@click.option(
    "--resume",
    is_flag=True,
    help="Resume processing from last run, do not reprocess photos",
)
@click.option(
    "--dry-run", is_flag=True, help="Do a dry run, don't actually do anything"
)
def example(resume, dry_run, 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_2.py --help` or `python cli_example_2.py --help`

    The @query_command decorator returns a click.command so you can add additional options
    using standard click decorators.  For example, the --resume and --dry-run options.
    For more information on click, see https://palletsprojects.com/p/click/.
    """

    # abort will print the message to stderr and exit with the given exit code
    if not photos:
        abort("Nothing to do!", 1)

    # 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 [count]{len(photos)}[/] photos")
    verbose("This message will only be printed if verbose level 2 is set", level=2)

    # the logger is a python logging.Logger object
    # debug messages will only be printed if --debug option is set
    logger.debug(f"{kwargs=}")

    # kvstore() returns a SQLiteKVStore object for storing state between runs
    # this is basically a persistent dictionary that can be used to store state
    # see https://github.com/RhetTbull/sqlitekvstore for more information
    kv = kvstore("cli_example_2")
    verbose(f"Using key-value cache: {kv.path}")

    # 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
        if resume and photo.uuid in kv:
            echo(
                f"Skipping processed photo [filename]{photo.original_filename}[/] ([uuid]{photo.uuid}[/])"
            )
            continue

        # store the uuid and current time in the kvstore
        # the key and value must be a type supported by SQLite: int, float, str, bytes, bool, None
        # if you need to store other values, you should serialize them to a string or bytes first
        # for example, using json.dumps() or pickle.dumps()
        kv[photo.uuid] = datetime.datetime.now().isoformat()
        echo(f"Processing [filename]{photo.original_filename}[/] [time]{photo.date}[/]")
        if not dry_run:
            # do something with the photo here
            echo(f"Doing something with [filename]{photo.original_filename}[/]")

    # echo_error will print to stderr
    # if you add [warning] or [error], it will be formatted accordingly
    # and include an emoji to make the message stand out
    echo_error("[warning]This is a warning message!")
    echo_error("[error]This is an error message!")


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

In addition to the query_command decorator, you can also use the selection_command decorator to implement a command that operates on the current selection in Photos.

"""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 @selection_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 the following options to your command:
--verbose
--timestamp
--theme
--db
--debug (hidden, won't show in help)

The decorated function will get the selected photos and pass the list of PhotoInfo objects
to your function.  You can then do whatever you want with the photos.
"""

from __future__ import annotations

import osxphotos
from osxphotos.cli import selection_command, verbose


@selection_command
def example(photos: list[osxphotos.PhotoInfo], **kwargs):
    """Sample command for osxphotos. Prints out the filename and date of each photo
    currently selected in Photos.app.

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

Concurrency¶

OSXPhotos is not currently compatible with multiprocessing as the PhotosDB class cannot be pickled which required when sharing data between processes. Photos can be exported concurrently using separate threads, however, this is only compatible with Python 3.11 and later. See issue #999. The reason for this is that internally, PhotoExporter uses a sqlite ExportDB database for managing the export, even if you don’t specify an export database. (In the case where you don’t specify an export database, a temporary in-memory database is created and then discard.) The python implementation of sqlite3 is not fully thread safe on Python < 3.11.

For example, the following code will work on Python >= 3.11. This code is available in the examples directory as concurrent_export.py.

"""Example for concurrent export of photos using osxphotos.PhotoExporter.export()

Note: concurrent export can only be used on Python 3.11 and later due to the way
python's sqlite3 module is implemented. See https://docs.python.org/3/library/sqlite3.html#sqlite3.threadsafety
for more information.
"""

import concurrent.futures
import os
import time

import click

import osxphotos
from osxphotos.cli import echo, query_command, verbose


@query_command()
@click.option(
    "--workers",
    metavar="WORKERS",
    help="Maximum number of worker threads to use for export. "
    "If not specified, it will default to the number of processors on the machine, multiplied by 5.",
    type=int,
)
@click.argument(
    "export_dir",
    type=click.Path(exists=True, file_okay=False, dir_okay=True, writable=True),
)
def export(workers, export_dir, photos: list[osxphotos.PhotoInfo], **kwargs):
    """Export photos"""
    workers = workers or os.cpu_count() * 5
    echo(f"Exporting {len(photos)} photos to {export_dir} using {workers} workers")
    start_t = time.perf_counter()
    with concurrent.futures.ThreadPoolExecutor(max_workers=workers) as executor:
        futures = [
            executor.submit(p.export, export_dir, f"{p.uuid}_{p.original_filename}")
            for p in photos
        ]
        exported = []
        for future in concurrent.futures.as_completed(futures):
            exported.extend(future.result())
    end_t = time.perf_counter()
    echo(
        f"Exported {len(exported)} photos to {export_dir} in {end_t-start_t:.4f} seconds"
    )


if __name__ == "__main__":
    export()

Calling CLI commands from Python¶

The osxphotos.cli module contains the code for the osxphotos command line tool. If you want to call the osxphotos export command from within your own code, you can do so by calling export_cli():

>>> from osxphotos.cli.export import export_cli
>>> export_cli(dest="/private/tmp", update=True)

The export_cli() function takes the same arguments as the osxphotos export command. See osxphotos help export for more information. You can also reference the implementation here.

Package Interface¶

PhotosDB¶

Read a Photos library database¶

osxphotos.PhotosDB()
osxphotos.PhotosDB(path)
osxphotos.PhotosDB(dbfile=path)

Reads the Photos library database and returns a PhotosDB object.

Pass the path to a Photos library or to a specific database file (e.g. “/Users/smith/Pictures/Photos Library.photoslibrary” or “/Users/smith/Pictures/Photos Library.photoslibrary/database/photos.db”). Normally, it’s recommended you pass the path the .photoslibrary folder, not the actual database path. Note: In Photos, users may specify a different library to open by holding down the option key while opening Photos.app. See also get_last_library_path and get_system_library_path

If an invalid path is passed, PhotosDB will raise FileNotFoundError exception.

Note: If neither path or dbfile is passed, PhotosDB will use get_last_library_path to open the last opened Photos library. This usually works but is not 100% reliable. It can also lead to loading a different library than expected if the user has held down option key when opening Photos to switch libraries. You may therefore want to explicitely pass the path to PhotosDB().

Open the default (last opened) Photos library¶

The default library is the library that would open if the user opened Photos.app.

import osxphotos
photosdb = osxphotos.PhotosDB(osxphotos.utils.get_last_library_path())

Open System Photos library¶

In Photos 5 (Catalina / MacOS 10.15), you can use get_system_library_path() to get the path to the System photo library if you want to ensure PhotosDB opens the system library. This does not work on older versions of MacOS. E.g.

import osxphotos

path = osxphotos.get_system_library_path()
photosdb = osxphotos.PhotosDB(path)

also,

import osxphotos

path = osxphotos.get_system_library_path()
photosdb = osxphotos.PhotosDB(dbfile=path)

Open a specific Photos library¶

import osxphotos

photosdb = osxphotos.PhotosDB(dbfile="/Users/smith/Pictures/Test.photoslibrary/database/photos.db")

import osxphotos

photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Test.photoslibrary")

Pass the fully qualified path to the Photos library or the actual database file inside the library. The database is called photos.db and resides in the database folder in your Photos library. If you pass only the path to the library, PhotosDB will add the database path automatically. The option to pass the actual database path is provided so database files can be queried even if separated from the actual .photoslibrary file.

Returns a PhotosDB object.

Note: If you have a large library (e.g. many thousdands of photos), creating the PhotosDB object can take a long time (10s of seconds). See Implementation Notes for additional details.

`photos(keywords=None, uuid=None, persons=None, albums=None, images=True, movies=True, from_date=None, to_date=None, intrash=False)`</a>¶

# assumes photosdb is a PhotosDB object (see above)
photos = photosdb.photos([keywords=['keyword',]], [uuid=['uuid',]], [persons=['person',]], [albums=['album',]],[from_date=datetime.datetime],[to_date=datetime.datetime])

Returns a list of PhotoInfo objects. Each PhotoInfo object represents a photo in the Photos Libary.

If called with no parameters, returns a list of every photo in the Photos library.

May be called with one or more of the following parameters to filter the list of photos returned:

photos = photosdb.photos(
    keywords = [],
    uuid = [],
    persons = [],
    albums = [],
    images = bool,
    movies = bool,
    from_date = datetime.datetime,
    to_date = datetime.datetime,
    intrash = bool,
)

keywords: list of one or more keywords. Returns only photos containing the keyword(s). If more than one keyword is provided finds photos matching any of the keywords (e.g. treated as “or”)
uuid: list of one or more uuids. Returns only photos whos UUID matches. Note: The UUID is the universally unique identifier that the Photos database uses to identify each photo. You shouldn’t normally need to use this but it is a way to access a specific photo if you know the UUID. If more than more uuid is provided, returns photos that match any of the uuids (e.g. treated as “or”)
persons: list of one or more persons. Returns only photos containing the person(s). If more than one person provided, returns photos that match any of the persons (e.g. treated as “or”)
albums: list of one or more album names. Returns only photos contained in the album(s). If more than one album name is provided, returns photos contained in any of the albums (.e.g. treated as “or”)
images: bool; if True, returns photos/images; default is True
movies: bool; if True, returns movies/videos; default is True
from_date: datetime.datetime; if provided, finds photos where creation date >= from_date; default is None
to_date: datetime.datetime; if provided, finds photos where creation date <= to_date; default is None
intrash: if True, finds only photos in the “Recently Deleted” or trash folder, if False does not find any photos in the trash; default is False

See also get_photo() which is much faster for retrieving a single photo and query which provides much more flexibility in querying the database.

If more than one of (keywords, uuid, persons, albums,from_date, to_date) is provided, they are treated as “and” criteria. E.g.

Finds all photos with (keyword = “wedding” or “birthday”) and (persons = “Juan Rodriguez”)

photos=photosdb.photos(keywords=["wedding","birthday"],persons=["Juan Rodriguez"])

Find all photos tagged with keyword “wedding”:

# assumes photosdb is a PhotosDB object (see above)
photos = photosdb.photos(keywords=["wedding"])

Find all photos of Maria Smith

# assumes photosdb is a PhotosDB object (see above)
photos=photosdb.photos(persons=["Maria Smith"])

Find all photos in album “Summer Vacation” or album “Ski Trip”

# assumes photosdb is a PhotosDB object (see above)
photos=photosdb.photos(albums=["Summer Vacation", "Ski Trip"])

Find the single photo with uuid = “osMNIO5sQFGZTbj9WrydRB”

# assumes photosdb is a PhotosDB object (see above)
photos=photosdb.photos(uuid=["osMNIO5sQFGZTbj9WrydRB"])

If you need to do more complicated searches, you can do this programmaticaly. For example, find photos with keyword = “Kids” but not in album “Vacation 2019”

# assumes photosdb is a PhotosDB object (see above)
photos1 = photosdb.photos(albums=["Vacation 2019"])
photos2 = photosdb.photos(keywords=["Kids"])
photos3 = [p for p in photos2 if p not in photos1]

To get only movies:

movies = photosdb.photos(images=False, movies=True)

Note PhotosDB.photos() may return a different number of photos than Photos.app reports in the GUI. This is because photos() returns hidden photos, shared photos, and for burst photos, all selected burst images even if non-selected burst images have not been deleted. Photos only reports 1 single photo for each set of burst images until you “finalize” the burst by selecting key photos and deleting the others using the “Make a selection” option.

For example, in my library, Photos says I have 19,386 photos and 474 movies. However, PhotosDB.photos() reports 25,002 photos. The difference is due to 5,609 shared photos and 7 hidden photos. (Note Shared photos only valid for Photos 5). Similarly, filtering for just movies returns 625 results. The difference between 625 and 474 reported by Photos is due to 151 shared movies.

>>> import osxphotos
>>> photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
>>> photos = photosdb.photos()
>>> len(photos)
25002
>>> shared = [p for p in photos if p.shared]
>>> len(shared)
5609
>>> not_shared = [p for p in photos if not p.shared]
>>> len(not_shared)
19393
>>> hidden = [p for p in photos if p.hidden]
>>> len(hidden)
7
>>> movies = photosdb.photos(movies=True, images=False)
>>> len(movies)
625
>>> shared_movies = [m for m in movies if m.shared]
>>> len(shared_movies)
151
>>>

`get_photo(uuid)`</A>¶

Returns a single PhotoInfo instance for photo with UUID matching uuid or None if no photo is found matching uuid. If you know the UUID of a photo, get_photo() is much faster than photos. See also photos().

`query(options: QueryOptions) -> List[PhotoInfo]:`</a>¶

Returns a list of PhotoInfo objects matching the query options. This is preferred method of querying the photos database. See QueryOptions for details on the options available.

`keywords`¶

# assumes photosdb is a PhotosDB object (see above)
keywords = photosdb.keywords

Returns a list of the keywords found in the Photos library that are associated with at least one photo. See also keywords_as_dict.

`album_info`¶

# assumes photosdb is a PhotosDB object (see above)
albums = photosdb.album_info

Returns a list of AlbumInfo objects representing albums in the database or empty list if there are no albums. See also albums and burst_album_info.

`albums`¶

# assumes photosdb is a PhotosDB object (see above)
album_names = photosdb.albums

Returns a list of the album names found in the Photos library. See also burst_albums.

Note: In Photos 5.0 (MacOS 10.15/Catalina), It is possible to have more than one album with the same name in Photos. Albums with duplicate names are treated as a single album and the photos in each are combined. For example, if you have two albums named “Wedding” and each has 2 photos, osxphotos will treat this as a single album named “Wedding” with 4 photos in it.

`albums_shared`¶

Returns list of shared album names found in photos database (e.g. albums shared via iCloud photo sharing)

Note: Only valid for Photos 5 / MacOS 10.15; on Photos <= 4, prints warning and returns empty list.

`import_info`¶

Returns a list of ImportInfo objects representing the import sessions for the database.

`project_info`¶

Returns a list of ProjectInfo objects representing the projects/creations (cards, calendars, etc.) in the database.

`moment_info`¶

Returns the MomentInfo object for the photo or None if the photo does not have an associated moment.

`folder_info`¶

# assumes photosdb is a PhotosDB object (see above)
folders = photosdb.folder_info

Returns a list of FolderInfo objects representing top level folders in the database or empty list if there are no folders. See also folders.

Note: Currently folder_info is only implemented for Photos 5 (Catalina); will return empty list and output warning if called on earlier database versions.

`folders`¶

# assumes photosdb is a PhotosDB object (see above)
folders = photosdb.folders

Returns a list names of top level folder names in the database.

Note: Currently folders is only implemented for Photos 5 (Catalina); will return empty list and output warning if called on earlier database versions.

`persons`¶

# assumes photosdb is a PhotosDB object (see above)
persons = photosdb.persons

Returns a list of the person names (faces) found in the Photos library. Note: It is of course possible to have more than one person with the same name, e.g. “Maria Smith”, in the database. persons assumes these are the same person and will list only one person named “Maria Smith”. If you need more information about persons in the database, see person_info.

`person_info`¶

# assumes photosdb is a PhotosDB object (see above)
person_info = photosdb.person_info

Returns a list of PersonInfo objects representing persons who appear in photos in the database.

`keywords_as_dict`¶

# assumes photosdb is a PhotosDB object (see above)
keyword_dict = photosdb.keywords_as_dict

Returns a dictionary of keywords found in the Photos library where key is the keyword and value is the count of how many times that keyword appears in the library (ie. how many photos are tagged with the keyword). Resulting dictionary is in reverse sorted order (e.g. keyword with the highest count is first).

`keywords_without_photo`¶

Returns a list of keywords that are not associated with any photos in the library.

`persons_as_dict`¶

# assumes photosdb is a PhotosDB object (see above)
persons_dict = photosdb.persons_as_dict

Returns a dictionary of persons (faces) found in the Photos library where key is the person name and value is the count of how many times that person appears in the library (ie. how many photos are tagged with the person). Resulting dictionary is in reverse sorted order (e.g. person who appears in the most photos is listed first). Note: It is of course possible to have more than one person with the same name, e.g. “Maria Smith”, in the database. persons_as_dict assumes these are the same person and will list only one person named “Maria Smith”. If you need more information about persons in the database, see person_info.

`albums_as_dict`¶

# assumes photosdb is a PhotosDB object (see above)
albums_dict = photosdb.albums_as_dict

Returns a dictionary of albums found in the Photos library where key is the album name and value is the count of how many photos are in the album. Resulting dictionary is in reverse sorted order (e.g. album with the most photos is listed first).

`albums_shared_as_dict`¶

# assumes photosdb is a PhotosDB object (see above)
albums_shared_dict = photosdb.albums_shared_as_dict

Returns a dictionary of shared albums (e.g. shared via iCloud photo sharing) found in the Photos library where key is the album name and value is the count of how many photos are in the album. Resulting dictionary is in reverse sorted order (e.g. album with the most photos is listed first).

Note: Photos 5 / MacOS 10.15 only. On earlier versions of Photos, prints warning and returns empty dictionary.

`labels`¶

Returns image categorization labels associated with photos in the library as list of str.

Note: Only valid on Photos 5; on earlier versions, returns empty list. In Photos 5, Photos runs machine learning image categorization against photos in the library and automatically assigns labels to photos such as “People”, “Dog”, “Water”, etc. A photo may have zero or more labels associated with it. See also labels_normalized.

`labels_normalized`¶

Returns image categorization labels associated with photos in the library as list of str. Labels are normalized (e.g. converted to lower case). Use of normalized strings makes it easier to search if you don’t how Apple capitalizes a label.

`labels_as_dict`¶

Returns dictionary image categorization labels associated with photos in the library where key is label and value is number of photos in the library with the label.

Note: Only valid on Photos 5; on earlier versions, logs warning and returns empty dict. In Photos 5, Photos runs machine learning image categorization against photos in the library and automatically assigns labels to photos such as “People”, “Dog”, “Water”, etc. A photo may have zero or more labels associated with it. See also labels_normalized_as_dict.

`labels_normalized_as_dict`¶

Returns dictionary of image categorization labels associated with photos in the library where key is normalized label and value is number of photos in the library with that label. Labels are normalized (e.g. converted to lower case). Use of normalized strings makes it easier to search if you don’t how Apple capitalizes a label.

`library_path`¶

# assumes photosdb is a PhotosDB object (see above)
photosdb.library_path

Returns the path to the Photos library as a string

`db_path`¶

# assumes photosdb is a PhotosDB object (see above)
photosdb.db_path

Returns the path to the Photos database PhotosDB was initialized with

`db_version`¶

# assumes photosdb is a PhotosDB object (see above)
photosdb.db_version

Returns the version number for Photos library database. You likely won’t need this but it’s provided in case needed for debugging. PhotosDB will print a warning to sys.stderr if you open a database version that has not been tested.

`photos_version`¶

# assumes photosdb is a PhotosDB object (see above)
photosdb.photos_version

Returns the version number as int for version of Photos that created the library, e.g. 2, 3, 4, 5…

`get_db_connection()`¶

Returns tuple of (connection, cursor) for the working copy of the Photos database. This is useful for debugging or prototyping new features.

photosdb = osxphotos.PhotosDB()
conn, cursor = photosdb.get_db_connection()

results = conn.execute(
        "SELECT ZUUID FROM ZGENERICASSET WHERE ZFAVORITE = 1;"
).fetchall()

for row in results:
    # do something
    pass

conn.close()

`execute(sql)`¶

Execute sql statement against the Photos database and return a sqlite cursor with the results.

QueryOptions¶

QueryOptions class for PhotosDB.query()

Attributes¶

See queryoptions.py for typing information.

added_after: search for photos added after a given date
added_before: search for photos added before a given date
added_in_last: search for photos added in last X datetime.timedelta
album: list of album names to search for
burst_photos: include all associated burst photos for photos in query results
burst: search for burst photos
cloudasset: search for photos that are managed by iCloud
deleted_only: search only for deleted photos
deleted: also include deleted photos
description: list of descriptions to search for
duplicate: search for duplicate photos
edited: search for edited photos
exif: search for photos with EXIF tags that matches the given data
external_edit: search for photos edited in external apps
favorite: search for favorite photos
folder: list of folder names to search for
from_date: search for photos taken on or after this date
function: list of query functions to evaluate
has_comment: search for photos with comments
has_likes: search for shared photos with likes
has_raw: search for photos with associated raw files
hdr: search for HDR photos
hidden: search for hidden photos
ignore_case: ignore case when searching
in_album: search for photos in an album
incloud: search for cloud assets that are synched to iCloud
is_reference: search for photos stored by reference (that is, they are not managed by Photos)
keyword: list of keywords to search for
label: list of labels to search for
live: search for live photos
location: search for photos with a location
max_size: maximum size of photos to search for
min_size: minimum size of photos to search for
missing_bursts: for burst photos, also include burst photos that are missing
missing: search for missing photos
movies: search for movies
name: list of names to search for
no_comment: search for photos with no comments
no_description: search for photos with no description
no_likes: search for shared photos with no likes
no_location: search for photos with no location
no_keyword: search for photos with no keywords
no_place: search for photos with no place
no_title: search for photos with no title
not_burst: search for non-burst photos
not_cloudasset: search for photos that are not managed by iCloud
not_edited: search for photos that have not been edited
not_favorite: search for non-favorite photos
not_hdr: search for non-HDR photos
not_hidden: search for non-hidden photos
not_in_album: search for photos not in an album
not_incloud: search for cloud asset photos that are not yet synched to iCloud
not_live: search for non-live photos
not_missing: search for non-missing photos
not_panorama: search for non-panorama photos
not_portrait: search for non-portrait photos
not_reference: search for photos not stored by reference (that is, they are managed by Photos)
not_screenshot: search for non-screenshot photos
not_selfie: search for non-selfie photos
not_shared: search for non-shared photos
not_slow_mo: search for non-slow-mo photos
not_time_lapse: search for non-time-lapse photos
panorama: search for panorama photos
person: list of person names to search for
photos: search for photos
place: list of place names to search for
portrait: search for portrait photos
query_eval: list of query expressions to evaluate
regex: list of regular expressions to search for
screenshot: search for screenshot photos
selected: search for selected photos
selfie: search for selfie photos
shared: search for shared photos
slow_mo: search for slow-mo photos
time_lapse: search for time-lapse photos
title: list of titles to search for
to_date: search for photos taken on or before this date
uti: list of UTIs to search for
uuid: list of uuids to search for
year: search for photos taken in a given year

"""Find all screenshots taken in 2019"""
import osxphotos

if __name__ == "__main__":
    photosdb = osxphotos.PhotosDB()
    results = photosdb.query(osxphotos.QueryOptions(screenshot=True, year=[2019]))
    for photo in results:
        print(photo.original_filename, photo.date)

PhotoInfo¶

PhotosDB.photos() returns a list of PhotoInfo objects. Each PhotoInfo object represents a single photo in the Photos library.

`uuid`¶

Returns the universally unique identifier (uuid) of the photo. This is how Photos keeps track of individual photos within the database.

`filename`¶

Returns the current filename of the photo on disk. See also original_filename

`original_filename`¶

Returns the original filename of the photo when it was imported to Photos. Note: Photos 5.0+ renames the photo when it adds the file to the library using UUID. See also filename

`date`¶

Returns the create date of the photo as a datetime.datetime object

`date_added`¶

Returns the date the photo was added to the Photos library as a timezone aware datetime.datetime object, or None if the data added cannot be determined

`date_modified`¶

Returns the modification date of the photo as a datetime.datetime object or None if photo has no modification date

`description`¶

Returns the description of the photo

`title`¶

Returns the title of the photo

`keywords`¶

Returns a list of keywords (e.g. tags) applied to the photo

`albums`¶

Returns a list of albums the photo is contained in. See also album_info.

`album_info`¶

Returns a list of AlbumInfo objects representing the albums the photo is contained in or empty list of the photo is not in any albums. See also albums.

`import_info`¶

Returns an ImportInfo object representing the import session associated with the photo or None if there is no associated import session.

`project_info`¶

Returns a list of ProjectInfo objects representing projects/creations (cards, calendars, etc.) the photo is contained in or empty list if there are no projects associated with the photo.

`persons`¶

Returns a list of the names of the persons in the photo

`person_info`¶

Returns a list of PersonInfo objects representing persons in the photo. Each PersonInfo object is associated with one or more FaceInfo objects.

`face_info`¶

Returns a list of FaceInfo objects representing faces in the photo. Each face is associated with the a PersonInfo object.

`path`¶

Returns the absolute path to the photo on disk as a string. Note: this returns the path to the original unedited file (see hasadjustments). If the file is missing on disk, path=None (see ismissing).

`path_edited`¶

Returns the absolute path to the edited photo on disk as a string. If the photo has not been edited, returns None. See also path and hasadjustments.

Note: will also return None if the edited photo is missing on disk.

`path_derivatives`¶

Returns list of paths to any derivative preview images associated with the photo. The list of returned paths is sorted in descending order by size (the largest, presumably highest quality) preview image will be the first element in the returned list. These will be named something like this on Photos 5+:

F19E06B8-A712-4B5C-907A-C007D37BDA16_1_101_o.jpeg
F19E06B8-A712-4B5C-907A-C007D37BDA16_1_102_o.jpeg
F19E06B8-A712-4B5C-907A-C007D37BDA16_1_105_c.jpeg

On Photos <=4, they’ll be named something like:

UNADJUSTEDNONRAW_mini_6.jpg
UNADJUSTEDNONRAW_thumb_6.jpg
Y6OofYkbR96spbS6XgwOQw_mini_1.jpg

I’ve not yet decoded the suffixes to know which preview is used for which purpose but in general, if you look for the largest file, you’ll get the highest resolution preview. Note that video files and Live images may have both a .mov video preview as well as a .jpeg still-image preview (the JPEG file is the one Photos displays as the “cover” for the video.)

Returns empty list if no preview images are found.

`path_raw`¶

Returns the absolute path to the associated raw photo on disk as a string, if photo is part of a RAW+JPEG pair, otherwise returns None. See notes on Raw Photos.

`has_raw`¶

Returns True if photo has an associated raw image, otherwise False. (e.g. Photo is a RAW+JPEG pair). See also is_raw and notes on Raw Photos.

`israw`¶

Returns True if photo is a raw image. E.g. it was imported as a single raw image, not part of a RAW+JPEG pair. See also has_raw and .

`raw_original`¶

Returns True if associated raw image and the raw image is selected in Photos via “Use RAW as Original”, otherwise returns False. See notes on Raw Photos.

`height`¶

Returns height of the photo in pixels. If image has been edited, returns height of the edited image, otherwise returns height of the original image. See also original_height.

`width`¶

Returns width of the photo in pixels. If image has been edited, returns width of the edited image, otherwise returns width of the original image. See also original_width.

`orientation`¶

Returns EXIF orientation value of the photo as integer. If image has been edited, returns orientation of the edited image, otherwise returns orientation of the original image. See also original_orientation. If orientation cannot be determined, returns 0 (this happens if osxphotos cannot decode the adjustment info for an edited image).

`original_height`¶

Returns height of the original photo in pixels. See also height.

`original_width`¶

Returns width of the original photo in pixels. See also width.

`original_orientation`¶

Returns EXIF orientation value of the original photo as integer. See also orientation.

`original_filesize`¶

Returns size of the original photo in bytes as integer.

`ismissing`¶

Returns True if the original image file is missing on disk, otherwise False. This can occur if the file has been uploaded to iCloud but not yet downloaded to the local library or if the file was deleted or imported from a disk that has been unmounted and user hasn’t enabled “Copy items to the Photos library” in Photos preferences. Note: this status is computed based on data in the Photos library and ismissing does not verify if the photo is actually missing. See also path.

`hasadjustments`¶

Returns True if the picture has been edited, otherwise False

`adjustments`¶

On Photos 5+, returns an AdjustmentsInfo object representing the adjustments (edits) to the photo or None if there are no adjustments. On earlier versions of Photos, always returns None.

`external_edit`¶

Returns True if the picture was edited in an external editor (outside Photos.app), otherwise False

`favorite`¶

Returns True if the picture has been marked as a favorite, otherwise False; for iPhoto always returns False

`flagged`¶

Returns True if the picture has been marked as flagged otherwise False (iPhoto only, returns False for Photos)

`rating`¶

Returns star rating of photo as int from 0 to 5 (iPhoto only); for Photos, always returns 0.

`hidden`¶

Returns True if the picture has been marked as hidden, otherwise False

`visible`¶

Returns True if the picture is visible in library, otherwise False. e.g. non-selected burst photos are not hidden but also not visible

`intrash`¶

Returns True if the picture is in the trash (‘Recently Deleted’ folder), otherwise False

`date_trashed`¶

Returns the date the photo was placed in the trash as a datetime.datetime object or None if photo is not in the trash

`location`¶

Returns latitude and longitude as a tuple of floats (latitude, longitude). If location is not set, latitude and longitude are returned as None

`latitude`¶

Returns latitude as a float or None.

`longitude`¶

Returns longitude as a float or None.

`place`¶

Returns a PlaceInfo object with reverse geolocation data or None if there is the photo has no reverse geolocation information.

`shared`¶

Returns True if photo is in a shared album, otherwise False.

Note: *Only valid on Photos 5 / MacOS 10.15+; on Photos <= 4, returns None.

`owner`¶

Returns full name of the photo owner (person who shared the photo) for shared photos or None if photo is not shared. Also returns None if you are the person who shared the photo.

Note: *Only valid on Photos 5 / MacOS 10.15+; on Photos <= 4, returns None.

`comments`¶

Returns list of CommentInfo objects for comments on shared photos or empty list if no comments.

Note: *Only valid on Photos 5 / MacOS 10.15+; on Photos <= 4, returns empty list.

`likes`¶

Returns list of LikeInfo objects for likes on shared photos or empty list if no likes.

Note: *Only valid on Photos 5 / MacOS 10.15+; on Photos <= 4, returns empty list.

`isreference`¶

Returns True if the original image file is a referenced file (imported without copying to the Photos library) otherwise returns False.

`isphoto`¶

Returns True if type is photo/still image, otherwise False

`ismovie`¶

Returns True if type is movie/video, otherwise False

`iscloudasset`¶

Returns True if photo is a cloud asset, that is, it is in a library synched to iCloud. See also incloud

`incloud`¶

Returns True if photo is a cloud asset and is synched to iCloud otherwise False if photo is a cloud asset and not yet synched to iCloud. Returns None if photo is not a cloud asset.

Note: Applies to master (original) photo only. It’s possible for the master to be in iCloud but a local edited version is not yet synched to iCloud. incloud provides status of only the master photo. osxphotos does not yet provide a means to determine if the edited version is in iCloud. If you need this feature, please open an issue.

`syndicated`¶

Return true if photo was shared via syndication (e.g. via Messages, etc.); these are photos that appear in “Shared with you” album. Photos 7+ only; returns None if not Photos 7+.

`saved_to_library`¶

Return True if syndicated photo has been saved to library; returns False if photo is not syndicated or has not been saved to the library. Syndicated photos are photos that appear in “Shared with you” album. Photos 7+ only; returns None if not Photos 7+.

`shared_moment`¶

Return True if photo is part of a shared moment, otherwise False. Shared moments are created when multiple photos are shared via iCloud. (e.g. in Messages)

`shared_library`¶

Return True if photo is included in shared iCloud library, otherwise False. Photos 8+ only; returns False if not Photos 8+.

`uti`¶

Returns Uniform Type Identifier (UTI) for the current version of the image, for example: ‘public.jpeg’ or ‘com.apple. quicktime-movie’. If the image has been edited, uti will return the UTI for the edited image, otherwise it will return the UTI for the original image.

`uti_original`¶

Returns Uniform Type Identifier (UTI) for the original unedited image, for example: ‘public.jpeg’ or ‘com.apple.quicktime-movie’.

`uti_edited`¶

Returns Uniform Type Identifier (UTI) for the edited image, for example: ‘public.jpeg’. Returns None if the photo does not have adjustments.

`uti_raw`¶

Returns Uniform Type Identifier (UTI) for the associated raw image, if there is one; for example, ‘com.canon.cr2-raw-image’. If the image is raw but not part of a RAW+JPEG pair, uti_raw returns None. In this case, use uti, or uti_original. See also has_raw and notes on Raw Photos.

`burst`¶

Returns True if photos is a burst image (e.g. part of a set of burst images), otherwise False. See burst_photos

`burst_selected`¶

Returns True if photo is a burst photo and has been selected from the burst set by the user, otherwise False.

`burst_key`¶

Returns True if photo is a burst photo and is the key image for the burst set (the image that Photos shows on top of the burst stack), otherwise False.

`burst_default_pick`¶

Returns True if photo is a burst image and is the photo that Photos selected as the default image for the burst set, otherwise False.

`burst_photos`¶

If photo is a burst image (see burst), returns a list of PhotoInfo objects for all other photos in the same burst set. If not a burst image, returns empty list.

Example below gets list of all photos that are bursts, selects one of of them and prints out the names of the other images in the burst set. PhotosDB.photos() will only return the photos in the burst set that the user selected using “Make a Selection…” in Photos or the key image Photos selected if the user has not yet made a selection. This is similar to how Photos displays and counts burst photos. Using burst_photos you can access the other images in the burst set to export them, etc.

>>> import osxphotos
>>> photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
>>> bursts = [p for p in photosdb.photos() if p.burst]
>>> burst_photo = bursts[5]
>>> len(burst_photo.burst_photos)
4
>>> burst_photo.original_filename
'IMG_9851.JPG'
>>> for photo in burst_photo.burst_photos:
...     print(photo.original_filename)
...
IMG_9853.JPG
IMG_9852.JPG
IMG_9854.JPG
IMG_9855.JPG

`burst_albums`¶

If photo is burst photo, returns list of albums it is contained in as well as any albums the key photo is contained in, otherwise returns PhotoInfo.albums.

If a burst photo which has unselected burst images (e.g. the burst images are in the library but haven’t been selected by the user using the “Make a selection” feature) is placed in a an album, Photos treats only the selected “key” photo as in the album. The unselected burst images, while associated with the photo in the album, are not technically in the album. If you are handling one of these unselected burst photos and want to know which album it would be in based on which albums it’s selected key images are in, use burst_albums. See also burst_album_info and albums.

`burst_album_info`¶

If photo is non-selected burst photo, teturns a list of AlbumInfo objects representing the albums any other photos in the same burst set are contained in. Otherwise, returns PhotoInfo.album_info. See also burst_albums and album_info.

`live_photo`¶

Returns True if photo is an Apple live photo (ie. it has an associated “live” video component), otherwise returns False. See path_live_photo.

`path_live_photo`¶

Returns the path to the live video component of a live photo. If photo is not a live photo, returns None.

Note: will also return None if the live video component is missing on disk. It’s possible that the original photo may be on disk (ismissing==False) but the video component is missing, likely because it has not been downloaded from iCloud.

`path_edited_live_photo`¶

Returns the path to the edited live video component of an edited live photo. If photo is not a live photo or not edited, returns None.

`portrait`¶

Returns True if photo was taken in iPhone portrait mode, otherwise False.

`hdr`¶

Returns True if photo was taken in High Dynamic Range (HDR) mode, otherwise False.

`selfie`¶

Returns True if photo is a selfie (taken with front-facing camera), otherwise False.

Note: Only implemented for Photos version 3.0+. On Photos version < 3.0, returns None.

`time_lapse`¶

Returns True if photo is a time lapse video, otherwise False.

`panorama`¶

Returns True if photo is a panorama, otherwise False.

Note: The result of PhotoInfo.panorama will differ from the “Panoramas” Media Types smart album in that it will also identify panorama photos from older phones that Photos does not recognize as panoramas.

`slow_mo`¶

Returns True if photo is a slow motion video, otherwise False

`labels`¶

Returns image categorization labels associated with the photo as list of str.

`labels_normalized`¶

Returns image categorization labels associated with the photo as list of str. Labels are normalized (e.g. converted to lower case). Use of normalized strings makes it easier to search if you don’t how Apple capitalizes a label. For example:

import osxphotos

photosdb = osxphotos.PhotosDB()
for photo in photosdb.photos():
    if "statue" in photo.labels_normalized:
        print(f"I found a statue! {photo.original_filename}")

Note: Only valid on Photos 5+; on earlier versions, returns empty list. In Photos 5+, Photos runs machine learning image categorization against photos in the library and automatically assigns labels to photos such as “People”, “Dog”, “Water”, etc. A photo may have zero or more labels associated with it. See also labels.

`search_info`¶

Returns SearchInfo object that represents search metadata for the photo.

Note: Only valid on Photos 5+; on ealier versions, returns None.

`search_info_normalized`¶

Returns SearchInfo object that represents normalized search metadata for the photo. This returns a SearchInfo object just as search_info but all the properties of the object return normalized text (converted to lowercase).

Note: Only valid on Photos 5+; on ealier versions, returns None.

`exif_info`¶

Returns an ExifInfo object with EXIF details from the Photos database. See ExifInfo for additional details.

Note: Only valid on Photos 5+; on earlier versions, returns None. The EXIF details returned are a subset of the actual EXIF data in a typical image. At import Photos stores this subset in the database and it’s this stored data that exif_info returns.

`exiftool`¶

Returns an ExifToolCaching object for the photo which provides an interface to exiftool allowing you to read the actual EXIF data in the image file inside the Photos library. If exif_info doesn’t give you all the data you need, you can use exiftool to read the entire EXIF contents of the image.

If the file is missing from the library (e.g. not downloaded from iCloud), returns None.

exiftool must be installed in the path for this to work. If exiftool cannot be found in the path, calling exiftool will log a warning and return None. You can check the exiftool path using osxphotos.exiftool.get_exiftool_path which will raise FileNotFoundError if exiftool cannot be found.

>>> import osxphotos
>>> osxphotos.exiftool.get_exiftool_path()
'/usr/local/bin/exiftool'
>>>

ExifToolCaching provides the following methods:

asdict(tag_groups=True): returns all EXIF metadata found in the file as a dictionary in following form (Note: this shows just a subset of available metadata). See exiftool documentation to understand which metadata keys are available. If tag_groups is True (default) dict keys are in form “GROUP:TAG”, e.g. “IPTC:Keywords”. If tag_groups is False, dict keys do not have group names, e.g. “Keywords”.

{'Composite:Aperture': 2.2,
 'Composite:GPSPosition': '-34.9188916666667 138.596861111111',
 'Composite:ImageSize': '2754 2754',
 'EXIF:CreateDate': '2017:06:20 17:18:56',
 'EXIF:LensMake': 'Apple',
 'EXIF:LensModel': 'iPhone 6s back camera 4.15mm f/2.2',
 'EXIF:Make': 'Apple',
 'XMP:Title': 'Elder Park',
}

json(): returns same information as asdict() but as a serialized JSON string.

The ExifToolCaching class caches values read from the photo via exiftool and is read-only. This speeds access to the underlying EXIF data but any changes made to the EXIF data in the image will not be reflected in subsequent calls to exiftool. In practice, the images in the Photos Library should not be modified after import so this is unlikely to cause any issues.

Caution: I caution against writing new EXIF data to photos in the Photos library because this will overwrite the original copy of the photo and could adversely affect how Photos behaves. exiftool.asdict() is useful for getting access to all the photos information but if you want to write new EXIF data, I recommend you export the photo first then write the data. PhotoInfo.export() does this if called with exiftool=True.

`score`¶

Returns a ScoreInfo data class object which provides access to the computed aesthetic scores for each photo.

Note: Valid only for Photos 5; returns None for earlier Photos versions.

`duplicates`¶

Returns list of PhotoInfo objects for possible duplicates or empty list if no matching duplicates. Photos are considered possible duplicates if the photo’s original file size, date created, height, and width match another those of another photo. This does not do a byte-for-byte comparison or compute a hash which makes it fast and allows for identification of possible duplicates even if originals are not downloaded from iCloud. The signature-based approach should be robust enough to match duplicates created either through the “duplicate photo” menu item or imported twice into the library but you should not rely on this 100% for identification of all duplicates.

`cloud_guid`¶

For photos in iCloud, returns the cloud GUID for the photo. This is the unique identifier for the photo in iCloud. For photos not in iCloud, returns None.

`cloud_owner_hashed_id`¶

For shared photos, returns the hashed ID of the owner of the shared photo. For photos not shared, returns None.

`fingerprint`¶

Returns a unique fingerprint for the original photo file. This is a hash of the original photo file and is useful for finding duplicates or correlating photos across multiple libraries.

`hexdigest`¶

Returns a unique digest of the photo’s properties and metadata; useful for detecting changes in any property/metadata of the photo.

`tables()`¶

Returns a PhotoTables object which provides access to the underlying SQLite database tables for the photo. See PhotoTables for more details. This is useful for debugging or developing new features but is not intended for general use.

`json()`¶

Returns a JSON representation of all photo info.

`asdict()`¶

Returns a dictionary representation of all photo info.

`export()`¶

export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)

Export photo from the Photos library to another destination on disk.

dest: must be valid destination path as str (or exception raised).
filename (optional): name of picture as str; if not provided, will use current filename. NOTE: if provided, user must ensure file extension (suffix) is correct. For example, if photo is .CR2 file, edited image may be .jpeg. If you provide an extension different than what the actual file is, export will print a warning but will happily export the photo using the incorrect file extension. e.g. to get the extension of the edited photo, look at PhotoInfo.path_edited.
edited: bool; if True (default=False), will export the edited version of the photo (or raise exception if no edited version)
export_as_hardlink: bool; if True (default=False), will hardlink files instead of copying them
overwrite: bool; if True (default=False), will overwrite files if they alreay exist
live_photo: bool; if True (default=False), will also export the associted .mov for live photos; exported live photo will be named filename.mov
increment: bool; if True (default=True), will increment file name until a non-existent name is found
sidecar_json: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name
sidecar_json: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will include tag group names (e.g. exiftool -G -j)
sidecar_exiftool: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. exiftool -j)
sidecar_xmp: (bool, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name
use_photos_export: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos
use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export
timeout: (int, default=120) timeout in seconds used with use_photos_export
exiftool: (bool, default = False) if True, will use exiftool to write metadata directly to the exported photo; exiftool must be installed and in the system path
use_albums_as_keywords: (bool, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar
use_persons_as_keywords: (bool, default = False); if True, will use person names as keywords when exporting metadata with exiftool or sidecar

Returns: list of paths to exported files. More than one file could be exported, for example if live_photo=True, both the original image and the associated .mov file will be exported

The json sidecar file can be used by exiftool to apply the metadata from the json file to the image. For example:

import osxphotos

photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
photos = photosdb.photos()
photos[0].export("/tmp","photo_name.jpg",sidecar_json=True)

Then

exiftool -j=photo_name.json photo_name.jpg

If overwrite=False and increment=False, export will fail if destination file already exists

`render_template(template_str, options=None)`¶

Render template string for photo. none_str is used if template substitution results in None value and no default specified.

template_str: str in metadata template language (MTL) format. See also Template System table. See notes below regarding specific details of the syntax.
options: an optional osxphotos.phototemplate.RenderOptions object specifying the options to pass to the rendering engine.

RenderOptions has the following properties:

template: str template
nonestr: str to use default for None values, default is ‘‘
path_sep: optional string to use as path separator, default is os.path.sep
expand_inplace: expand multi-valued substitutions in-place as a single string instead of returning individual strings
inplace_sep: optional string to use as separator between multi-valued keywords with expand_inplace; default is ‘,’
filename: if True, template output will be sanitized to produce valid file name
dirname: if True, template output will be sanitized to produce valid directory name
strip: if True, strips leading/trailing whitespace from rendered templates
edited_version: set to True if you want {edited_version} to resolve to True (e.g. exporting edited version of photo)
export_dir: set to the export directory if you want to evalute {export_dir} template
filepath: set to value for filepath of the exported photo if you want to evaluate {filepath} template
quote: quote path templates for execution in the shell

Returns a tuple of (rendered, unmatched) where rendered is a list of rendered strings with all substitutions made and unmatched is a list of any strings that resembled a template substitution but did not match a known substitution. E.g. if template contained “{foo}”, unmatched would be [“foo”]. If there are unmatched strings, rendered will be []. E.g. a template statement must fully match or will result in error and return all unmatched fields in unmatched.

e.g. photo.render_template("{created.year}/{foo}") would return ([],["foo"])

Some substitutions, notably album, keyword, and person could return multiple values, hence a new string will be return for each possible substitution (hence why a list of rendered strings is returned). For example, a photo in 2 albums: ‘Vacation’ and ‘Family’ would result in the following rendered values if template was “{created.year}/{album}” and created.year == 2020: ["2020/Vacation","2020/Family"]

See Template System for additional details.

`detected_text(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 osxphotos._constants.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.

Note: This is not the same as Live Text in macOS Monterey. When using detected_text(), osxphotos will use Apple’s Vision framework to perform text detection on the image. On my circa 2013 MacBook Pro, this takes about 2 seconds per image. detected_text() does memoize the results for a given confidence_threshold so repeated calls will not re-process the photo. This works only on macOS Catalina (10.15) or later.

ExifInfo¶

PhotosInfo.exif_info returns an ExifInfo object with some EXIF data about the photo (Photos 5 only). ExifInfo contains the following properties:

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

For example:

import osxphotos

nikon_photos = [
    p
    for p in osxphotos.PhotosDB().photos()
    if p.exif_info.camera_make and "nikon" in p.exif_info.camera_make.lower()
]

AlbumInfo¶

PhotosDB.album_info and PhotoInfo.album_info return a list of AlbumInfo objects. Each AlbumInfo object represents a single album in the Photos library.

`uuid`¶

Returns the universally unique identifier (uuid) of the album. This is how Photos keeps track of individual objects within the database.

`title`¶

Returns the title or name of the album.

`photos`¶

Returns a list of PhotoInfo objects representing each photo contained in the album sorted in the same order as in Photos. (e.g. if photos were manually sorted in the Photos albums, photos returned by photos will be in same order as they appear in the Photos album)

`creation_date`¶

Returns the creation date as a timezone aware datetime.datetime object of the album.

`start_date`¶

Returns the date of earliest photo in the album as a timezone aware datetime.datetime object.

`end_date`¶

Returns the date of latest photo in the album as a timezone aware datetime.datetime object.

`folder_list`¶

Returns a hierarchical list of FolderInfo objects representing the folders the album is contained in. For example, if album “AlbumInFolder” is in SubFolder2 of Folder1 as illustrated below, would return a list of FolderInfo objects representing [“Folder1”, “SubFolder2”]

Photos Library
├── Folder1
    ├── SubFolder1
    ├── SubFolder2
        └── AlbumInFolder

`folder_names`¶

Returns a hierarchical list of names of the folders the album is contained in. For example, if album is in SubFolder2 of Folder1 as illustrated below, would return [“Folder1”, “SubFolder2”].

Photos Library
├── Folder1
    ├── SubFolder1
    ├── SubFolder2
        └── AlbumInFolder

`parent`¶

Returns a FolderInfo object representing the albums parent folder or None if album is not a in a folder.

`owner`¶

Returns full name of the album owner (person who shared the album) for shared albums or None if album is not shared.

Note: *Only valid on Photos 5 / MacOS 10.15+; on Photos <= 4, returns None.

`asdict()`¶

Returns a dictionary representation of the AlbumInfo object.

ImportInfo¶

PhotosDB.import_info returns a list of ImportInfo objects. Each ImportInfo object represents an import session in the library. PhotoInfo.import_info returns a single ImportInfo object representing the import session for the photo (or None if no associated import session).

`uuid`¶

Returns the universally unique identifier (uuid) of the import session. This is how Photos keeps track of individual objects within the database.

`photos`¶

Returns a list of PhotoInfo objects representing each photo contained in the import session.

`creation_date`¶

Returns the creation date as a timezone aware datetime.datetime object of the import session.

`start_date`¶

Returns the start date as a timezone aware datetime.datetime object for when the import session began.

`end_date`¶

Returns the end date as a timezone aware datetime.datetime object for when the import session completed.

Note: On Photos <=4, start_date and end_date will be the same as creation_date.

`asdict()`¶

Returns a dictionary representation of the import session.

ProjectInfo¶

PhotosDB.projcet_info returns a list of ProjectInfo objects. Each ProjectInfo object represents a project in the library. PhotoInfo.project_info returns a list of ProjectInfo objects for each project the photo is contained in.

Projects (found under “My Projects” in Photos) are projects or creations such as cards, calendars, and slideshows created in Photos. osxphotos provides only very basic information about projects and projects created with third party plugins may not accessible to osxphotos.

`uuid`¶

Returns the universally unique identifier (uuid) of the project. This is how Photos keeps track of individual objects within the database.

`title`¶

Returns the title or name of the project.

`photos`¶

Returns a list of PhotoInfo objects representing each photo contained in the project.

`creation_date`¶

Returns the creation date as a timezone aware datetime.datetime object of the project.

`asdict()`¶

Returns a dictionary representation of the ProjectInfo object.

MomentInfo¶

PhotoInfo.moment_info return the MomentInfo object for the photo. The MomentInfo object contains information about the photo’s moment as assigned by Photos. The MomentInfo object contains the following properties:

`pk`¶

Returns the primary key of the moment in the Photos database.

`location`¶

Returns the location of the moment as a tuple of (latitude, longitude).

`title`¶

Returns the title of the moment.

`subtitle`¶

Returns the subtitle of the moment.

`start_date`¶

Returns the start date of the moment as a timezone aware datetime.datetime object.

`end_date`¶

Returns the end date of the moment as a timezone aware datetime.datetime object.

`date`¶

Returns the date of the moment as a timezone aware datetime.datetime object.

`modification_date`¶

Returns the modification date of the moment as a timezone aware datetime.datetime object.

`photos`¶

Returns a list of [PhotoInfo] objects representing the photos in the moment.

`asdict()`¶

Returns a dictionary representation of the moment.

FolderInfo¶

PhotosDB.folder_info returns a list of FolderInfo objects representing the top level folders in the library. Each FolderInfo object represents a single folder in the Photos library.

`uuid`¶

Returns the universally unique identifier (uuid) of the folder. This is how Photos keeps track of individual objects within the database.

`title`¶

Returns the title or name of the folder.

`album_info`¶

Returns a list of AlbumInfo objects representing each album contained in the folder.

`album_info_shared`¶

Returns a list of AlbumInfo objects for each shared album in the photos database.

Note: Only valid for Photos 5+; on Photos <= 4, prints warning and returns empty list.

`subfolders`¶

Returns a list of FolderInfo objects representing the sub-folders of the folder.

`parent`¶

Returns a FolderInfo object representing the folder’s parent folder or None if album is not a in a folder.

`sort_order`¶

Returns album sort order (as AlbumSortOrder enum). On Photos <=4, always returns AlbumSortOrder.MANUAL.

AlbumSortOrder has following values:

UNKNOWN
MANUAL
NEWEST_FIRST
OLDEST_FIRST
TITLE

`photo_index(photo)`¶

Returns index of photo in album (based on album sort order).

`asdict()`¶

Returns a dictionary representation of the FolderInfo object.

Note: FolderInfo and AlbumInfo objects effectively work as a linked list. The children of a folder are contained in subfolders and album_info and the parent object of both AlbumInfo and FolderInfo is represented by parent. For example:

>>> import osxphotos
>>> photosdb = osxphotos.PhotosDB()
>>> photosdb.folder_info
[<osxphotos.albuminfo.FolderInfo object at 0x10fcc0160>]
>>> photosdb.folder_info[0].title
'Folder1'
>>> photosdb.folder_info[0].subfolders[1].title
'SubFolder2'
>>> photosdb.folder_info[0].subfolders[1].album_info[0].title
'AlbumInFolder'
>>> photosdb.folder_info[0].subfolders[1].album_info[0].parent.title
'SubFolder2'
>>> photosdb.folder_info[0].subfolders[1].album_info[0].parent.album_info[0].title
'AlbumInFolder'

PlaceInfo¶

PhotoInfo.place returns a PlaceInfo object if the photo contains valid reverse geolocation information. PlaceInfo has the following properties.

Note For Photos versions <= 4, only name, names, and country_code properties are defined. All others return None. This is because older versions of Photos do not store the more detailed reverse geolocation information.

`ishome`¶

Returns True if photo place is user’s home address, otherwise False.

`name`¶

Returns the name of the local place as str. This is what Photos displays in the Info window. Note Photos 5 uses a different algorithm to determine the name than earlier versions which means the same Photo may have a different place name in Photos 4 and Photos 5. PhotoInfo.name will return the name Photos would have shown depending on the version of the library being processed. In Photos 5, the place name is generally more detailed than in earlier versions of Photos.

For example, I have photo in my library that under Photos 4, has place name of “‎⁨Mayfair Shopping Centre⁩, ⁨Victoria⁩, ⁨Canada⁩” and under Photos 5 the same photo has place name of “Mayfair⁩, ⁨Vancouver Island⁩, ⁨Victoria⁩, ⁨British Columbia⁩, ⁨Canada⁩”.

Returns None if photo does not contain a name.

`names`¶

Returns a PlaceNames namedtuple with the following fields. Each field is a list with zero or more values, sorted by area in ascending order. E.g. names.area_of_interest could be [‘Gulf Islands National Seashore’, ‘Santa Rosa Island’], [“Knott’s Berry Farm”], or [] if area_of_interest not defined. The value shown in Photos is the first value in the list. With the exception of body_of_water each of these field corresponds to an attribute of a CLPlacemark object. Note The PlaceNames namedtuple contains reserved fields not listed below (see implementation for details), thus it should be referenced only by name (e.g. names.city) and not by index.

country; the name of the country associated with the placemark.
state_province; administrativeArea, The state or province associated with the placemark.
sub_administrative_area; additional administrative area information for the placemark.
city; locality; the city associated with the placemark.
additional_city_info; subLocality, Additional city-level information for the placemark.
ocean; the name of the ocean associated with the placemark.
area_of_interest; areasOfInterest, The relevant areas of interest associated with the placemark.
inland_water; the name of the inland water body associated with the placemark.
region; the geographic region associated with the placemark.
sub_throughfare; additional street-level information for the placemark.
postal_code; the postal code associated with the placemark.
street_address; throughfare, The street address associated with the placemark.
body_of_water; in Photos 4, any body of water; in Photos 5 contains the union of ocean and inland_water

Note: In Photos <= 4.0, only the following fields are defined; all others are set to empty list:

country
state_province
sub_administrative_area
city
additional_city_info
area_of_interest
body_of_water

`country_code`¶

Returns the country_code of place, for example “GB”. Returns None if PhotoInfo contains no country code.

`address_str`¶

Returns the full postal address as a string if defined, otherwise None.

For example: “2038 18th St NW, Washington, DC 20009, United States”

`address`¶

Returns a PostalAddress namedtuple with details of the postal address containing the following fields:

city
country
postal_code
state
street
sub_administrative_area
sub_locality
iso_country_code

For example:

>>> photo.place.address
PostalAddress(street='3700 Wailea Alanui Dr', sub_locality=None, city='Kihei', sub_administrative_area='Maui', state='HI', postal_code='96753', country='United States', iso_country_code='US')
>>> photo.place.address.postal_code
'96753'

ScoreInfo¶

PhotoInfo.score returns a ScoreInfo object that exposes the computed aesthetic scores for each photo (Photos 5+ only). I have not yet reverse engineered the meaning of each score. The overall score seems to the most useful and appears to be a composite of the other scores. The following score properties are currently available:

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

Example: find your “best” photo of food

>>> import osxphotos
>>> photos = osxphotos.PhotosDB().photos()
>>> best_food_photo = sorted([p for p in photos if "food" in p.labels_normalized], key=lambda p: p.score.overall, reverse=True)[0]

SearchInfo¶

PhotoInfo.search_info and PhotoInfo.search_info_normalized return a SearchInfo object that exposes various metadata that Photos uses when searching for photos such as labels, associated holiday, etc. (Photos 5+ only).

The following properties are available:

`labels`¶

Returns list of labels applied to photo by Photos image categorization algorithms.

`place_names`¶

Returns list of place names associated with the photo.

`streets`¶

Returns list of street names associated with the photo. (e.g. reverse geolocation of where the photo was taken)

`neighborhoods`¶

Returns list of neighborhood names associated with the photo.

`locality_names`¶

Returns list of locality names associated with the photo.

`city`¶

Returns str of city/town/municipality associated with the photo.

`state`¶

Returns str of state name associated with the photo.

`state_abbreviation`¶

Returns str of state abbreviation associated with the photo.

`country`¶

Returns str of country name associated with the photo.

`month`¶

Returns str of month name associated witht the photo (e.g. month in which the photo was taken)

`year`¶

Returns year associated with the photo.

`bodies_of_water`¶

Returns list of bodies of water associated with the photo.

`holidays`¶

Returns list of holiday names associated with the photo.

`activities`¶

Returns list of activities associated with the photo.

`season`¶

Returns str of season name associated with the photo.

`venues`¶

Returns list of venue names associated with the photo.

`venue_types`¶

Returns list of venue types associated with the photoo.

`media_types`¶

Returns list of media types associated with the photo.

`all`¶

Returns all search_info properties as a single list of strings.

`asdict()`¶

Returns all associated search_info metadata as a dict.

PersonInfo¶

PhotosDB.person_info and PhotoInfo.person_info return a list of PersonInfo objects represents persons in the database and in a photo, respectively. The PersonInfo class has the following properties and methods.

`name`¶

Returns the full name of the person represented in the photo. For example, “Maria Smith”.

`display_name`¶

Returns the display name of the person represented in the photo. For example, “Maria”.

`uuid`¶

Returns the UUID of the person as stored in the Photos library database.

`keyphoto`¶

Returns a PhotoInfo instance for the photo designated as the key photo for the person. This is the Photos uses to display the person’s face thumbnail in Photos’ “People” view.

`facecount`¶

Returns a count of how many times this person appears in images in the database.

`photos`¶

Returns a list of PhotoInfo objects representing all photos the person appears in.

`face_info`¶

Returns a list of FaceInfo objects associated with this person sorted by quality score. Highest quality face is result[0] and lowest quality face is result[n].

`favorite`¶

Returns True if Person has been marked as a favorite in Photos, otherwise False. Available on Photos 5+ only; on Photos <=4, returns False.

`sort_order`¶

Returns the sort order for the person in the Photos People view. Available on Photos 5+ only; on Photos <= 4, returns None.

`json()`¶

Returns a json string representation of the PersonInfo instance.

`asdict()`¶

Returns a dictionary representation of the PersonInfo instance.

FaceInfo¶

PhotoInfo.face_info return a list of FaceInfo objects representing detected faces in a photo. The FaceInfo class has the following properties and methods.

`uuid`¶

UUID of the face.

`name`¶

Full name of the person represented by the face or None if person hasn’t been given a name in Photos. This is a shortcut for FaceInfo.person_info.name.

`asset_uuid`¶

UUID of the photo this face is associated with.

`person_info`¶

PersonInfo object associated with this face.

`photo`¶

PhotoInfo object representing the photo that contains this face.

`mwg_rs_area`¶

Returns named tuple with following coordinates as used in Metdata Working Group (mwg) face regions in XMP files.

x = stArea:x
y = stArea:y
h = stArea:h
w = stArea:w

`mpri_reg_rect`¶

Returnes named tuple with following coordinates as used in Microsoft Photo Region Rectangle (mpri) in XMP files.

x = x coordinate of top left corner of rectangle
y = y coordinate of top left corner of rectangle
h = height of rectangle
w = width of rectangle

`face_rect()`¶

Returns list of x, y coordinates as tuples [(x0, y0), (x1, y1)] representing the corners of rectangular region that contains the face. Coordinates are in same format and reference frame as used by Pillow imaging library. Note: face_rect() and all other properties/methods that return coordinates refer to the current version of the image. E.g. if the image has been edited (``PhotoInfo.hasadjustments` <#hasadjustments>`_), these refer to ``PhotoInfo.path_edited` <#pathedited>`_. If the image has no adjustments, these coordinates refer to the original photo (``PhotoInfo.path` <#path>`_).

`center`¶

Coordinates as (x, y) tuple for the center of the detected face.

`size_pixels`¶

Diameter of detected face region in pixels.

`roll_pitch_yaw()`¶

Roll, pitch, and yaw of face region in radians. Returns a tuple of (roll, pitch, yaw)

roll¶

Roll of face region in radians.

pitch¶

Pitch of face region in radians.

Note: Only valid on Photos version <= 4, otherwise returns 0

yaw¶

Yaw of face region in radians.

Note: Only valid on Photos version <= 4, otherwise returns 0

`Additional properties`¶

The following additional properties are also available but are not yet fully documented.

center_x: x coordinate of center of face in Photos’ internal reference frame
center_y: y coordinate of center of face in Photos’ internal reference frame
size: size of face region in Photos’ internal reference frame
quality: quality measure of detected face
source_width: width in pixels of photo
source_height: height in pixels of photo
has_smile:
manual:
face_type:
age_type:
eye_makeup_type:
eye_state:
facial_hair_type:
gender_type:
glasses_type:
hair_color_type:
lip_makeup_type:
smile_type:

`asdict()`¶

Returns a dictionary representation of the FaceInfo instance.

`json()`¶

Returns a JSON representation of the FaceInfo instance.

CommentInfo¶

PhotoInfo.comments returns a list of CommentInfo objects for comments on shared photos. (Photos 5/MacOS 10.15+ only). The list of CommentInfo objects will be sorted in ascending order by date comment was made. CommentInfo contains the following fields:

datetime: datetime.datetime, date/time comment was made
user: str, name of user who made the comment
ismine: bool, True if comment was made by person who owns the Photos library being operated on
text: str, text of the actual comment

LikeInfo¶

PhotoInfo.likes returns a list of LikeInfo objects for “likes” on shared photos. (Photos 5/MacOS 10.15+ only). The list of LikeInfo objects will be sorted in ascending order by date like was made. LikeInfo contains the following fields:

datetime: datetime.datetime, date/time like was made
user: str, name of user who made the like
ismine: bool, True if like was made by person who owns the Photos library being operated on

AdjustmentsInfo¶

PhotoInfo.adjustments returns an AdjustmentsInfo object, if the photo has adjustments, or None if the photo does not have adjusments. AdjustmentsInfo has the following properties and methods:

plist: The adjustments plist file maintained by Photos as a dict.
data: The raw, undecoded adjustments info as binary blob.
editor: The editor bundle ID of the app which made the edits, e.g. com.apple.photos.
format_id: The format identifier set by the app which made the edits, e.g. com.apple.photos.
base_version: Version info set by the app which made the edits.
format_version: Version info set by the app which made the edits.
timestamp: Time stamp of the adjustment as a timezone-aware datetime.datetime object; None if no timestamp is set.
adjustments: a list of dicts containing information about the decoded adjustments to the photo or None if adjustments could not be decoded. AdjustmentsInfo can decode adjustments made by Photos but cannot decode adjustments made by external plugins or apps.
adj_metadata: a dict containing additional data about the photo decoded from the adjustment data.
adj_orientation: the EXIF orientation of the edited photo decoded from the adjustment metadata.
adj_format_version: version for adjustments format decoded from the adjustment data.
adj_version_info: version info for the application which made the adjustments to the photo decoded from the adjustments data.
asdict(): dict representation of the AdjustmentsInfo object; contains all properties with exception of plist.

PhotoTables¶

PhotoInfo.tables returns a PhotoTables object that contains information about the tables in the Photos database that contain information about the photo. The following properties are available:

ZASSET
ZADDITIONALASSETATTRIBUTES
ZDETECTEDFACE
ZPERSON

Each of these properties returns a Table object that provides access to the row(s) in the table that correspond to the photo.

The Table object has dynamically created properties that correspond to the associated column in the table and return a tuple of values for that column.

>>> photo.tables().ZADDITIONALASSETATTRIBUTES.ZTITLE
("St. James's Park",)

The Table object also provides a rows() method which returns a list a of tuples for the matching rows in the table and a rows_dict() method which returns a list of dicts for the matching rows in the table.

>>> photo.tables().ZASSET.rows()
[(6, 3, 35, 0, 0, 0, 0, 0, 0, None, None, None, None, None, 0, 0, 1, 0, 0, 0, 0, -100, 0, 1, 0, 1356, 0, 0, 0, 0, 0, 0, 0, 1, 6192599813128215, 1, 2814835671629878, 1, 0, 3, 0, 0, 5, 0, 0, 0, 0, 0, 0, 0, 2047, 7, None, 8, None, None, None, None, None, None, None, None, 3, 6, 6, 6, None, 6, 4, None, None, 8, 4, None, 2, None, 3, None, 3, None, None, 585926209.859624, 596906868.198932, 689981763.374756, None, None, None, 0.5, 561129492.501, 0.0, 596906868.198932, None, 0.03816793893129771, None, 51.50357167, -0.1318055, 689982854.802854, 0.6494140625, 0.0, 561129492.501, None, None, None, None, None, None, None, 'D', 'DC99FBDD-7A52-4100-A5BB-344131646C30.jpeg', None, 'sRGB IEC61966-2.1', 'public.jpeg', 'DC99FBDD-7A52-4100-A5BB-344131646C30', b'Ki\t@\x01\x00\x00\x00\td\tH\x01\x00\x00\x00\x93\\\tL\x01\x00\x00\x00\x1aK\x0c\x03\x0c\xa8q\x92\x00\x12C\x0c\x03\x0c"\r\x90\x00\x00<\x0c\x03\x08"\x19\x80\x00', b'\xca\xebV\tu\xc0I@/j\xf7\xab\x00\xdf\xc0\xbf\xcd\xcc\xcc\xcc\xcc\xcc\x04@\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')]

>>> photo.tables().ZASSET.rows_dict()
[{'Z_PK': 6, 'Z_ENT': 3, 'Z_OPT': 35, 'ZACTIVELIBRARYSCOPEPARTICIPATIONSTATE': 0, 'ZAVALANCHEPICKTYPE': 0, 'ZBUNDLESCOPE': 0, 'ZCAMERAPROCESSINGADJUSTMENTSTATE': 0, 'ZCLOUDDELETESTATE': 0, 'ZCLOUDDOWNLOADREQUESTS': 0, 'ZCLOUDHASCOMMENTSBYME': None, 'ZCLOUDHASCOMMENTSCONVERSATION': None, 'ZCLOUDHASUNSEENCOMMENTS': None, 'ZCLOUDISDELETABLE': None, 'ZCLOUDISMYASSET': None, 'ZCLOUDLOCALSTATE': 0, 'ZCLOUDPLACEHOLDERKIND': 0, 'ZCOMPLETE': 1, 'ZDEFERREDPROCESSINGNEEDED': 0, 'ZDEPTHTYPE': 0, 'ZDERIVEDCAMERACAPTUREDEVICE': 0, 'ZDUPLICATEASSETVISIBILITYSTATE': 0, 'ZFACEAREAPOINTS': -100, 'ZFAVORITE': 0, 'ZHASADJUSTMENTS': 1, 'ZHDRTYPE': 0, 'ZHEIGHT': 1356, 'ZHIDDEN': 0, 'ZHIGHFRAMERATESTATE': 0, 'ZISMAGICCARPET': 0, 'ZKIND': 0, 'ZKINDSUBTYPE': 0, 'ZLIBRARYSCOPESHARESTATE': 0, 'ZMONOSKITYPE': 0, 'ZORIENTATION': 1, 'ZPACKEDACCEPTABLECROPRECT': 6192599813128215, 'ZPACKEDBADGEATTRIBUTES': 1, 'ZPACKEDPREFERREDCROPRECT': 2814835671629878, 'ZPLAYBACKSTYLE': 1, 'ZPLAYBACKVARIATION': 0, 'ZSAVEDASSETTYPE': 3, 'ZSEARCHINDEXREBUILDSTATE': 0, 'ZSYNDICATIONSTATE': 0, 'ZTHUMBNAILINDEX': 5, 'ZTRASHEDSTATE': 0, 'ZVIDEOCPDURATIONVALUE': 0, 'ZVIDEOCPVISIBILITYSTATE': 0, 'ZVIDEODEFERREDPROCESSINGNEEDED': 0, 'ZVIDEOKEYFRAMETIMESCALE': 0, 'ZVIDEOKEYFRAMEVALUE': 0, 'ZVISIBILITYSTATE': 0, 'ZWIDTH': 2047, 'ZADDITIONALATTRIBUTES': 7, 'ZCLOUDFEEDASSETSENTRY': None, 'ZCOMPUTEDATTRIBUTES': 8, 'ZCONVERSATION': None, 'ZDAYGROUPHIGHLIGHTBEINGASSETS': None, 'ZDAYGROUPHIGHLIGHTBEINGEXTENDEDASSETS': None, 'ZDAYGROUPHIGHLIGHTBEINGKEYASSETPRIVATE': None, 'ZDAYGROUPHIGHLIGHTBEINGKEYASSETSHARED': None, 'ZDAYGROUPHIGHLIGHTBEINGSUMMARYASSETS': None, 'ZDUPLICATEMETADATAMATCHINGALBUM': None, 'ZDUPLICATEPERCEPTUALMATCHINGALBUM': None, 'ZEXTENDEDATTRIBUTES': 3, 'ZHIGHLIGHTBEINGASSETS': 6, 'ZHIGHLIGHTBEINGEXTENDEDASSETS': 6, 'ZHIGHLIGHTBEINGKEYASSETPRIVATE': 6, 'ZHIGHLIGHTBEINGKEYASSETSHARED': None, 'ZHIGHLIGHTBEINGSUMMARYASSETS': 6, 'ZIMPORTSESSION': 4, 'ZLIBRARYSCOPE': None, 'ZMASTER': None, 'ZMEDIAANALYSISATTRIBUTES': 8, 'ZMOMENT': 4, 'ZMOMENTSHARE': None, 'ZMONTHHIGHLIGHTBEINGKEYASSETPRIVATE': 2, 'ZMONTHHIGHLIGHTBEINGKEYASSETSHARED': None, 'ZPHOTOANALYSISATTRIBUTES': 3, 'ZTRASHEDBYPARTICIPANT': None, 'ZYEARHIGHLIGHTBEINGKEYASSETPRIVATE': 3, 'ZYEARHIGHLIGHTBEINGKEYASSETSHARED': None, 'Z_FOK_CLOUDFEEDASSETSENTRY': None, 'ZADDEDDATE': 585926209.859624, 'ZADJUSTMENTTIMESTAMP': 596906868.198932, 'ZANALYSISSTATEMODIFICATIONDATE': 689981763.374756, 'ZCLOUDBATCHPUBLISHDATE': None, 'ZCLOUDLASTVIEWEDCOMMENTDATE': None, 'ZCLOUDSERVERPUBLISHDATE': None, 'ZCURATIONSCORE': 0.5, 'ZDATECREATED': 561129492.501, 'ZDURATION': 0.0, 'ZFACEADJUSTMENTVERSION': 596906868.198932, 'ZHDRGAIN': None, 'ZHIGHLIGHTVISIBILITYSCORE': 0.03816793893129771, 'ZLASTSHAREDDATE': None, 'ZLATITUDE': 51.50357167, 'ZLONGITUDE': -0.1318055, 'ZMODIFICATIONDATE': 689982854.802854, 'ZOVERALLAESTHETICSCORE': 0.6494140625, 'ZPROMOTIONSCORE': 0.0, 'ZSORTTOKEN': 561129492.501, 'ZTRASHEDDATE': None, 'ZAVALANCHEUUID': None, 'ZCLOUDASSETGUID': None, 'ZCLOUDBATCHID': None, 'ZCLOUDCOLLECTIONGUID': None, 'ZCLOUDOWNERHASHEDPERSONID': None, 'ZDELETEREASON': None, 'ZDIRECTORY': 'D', 'ZFILENAME': 'DC99FBDD-7A52-4100-A5BB-344131646C30.jpeg', 'ZMEDIAGROUPUUID': None, 'ZORIGINALCOLORSPACE': 'sRGB IEC61966-2.1', 'ZUNIFORMTYPEIDENTIFIER': 'public.jpeg', 'ZUUID': 'DC99FBDD-7A52-4100-A5BB-344131646C30', 'ZIMAGEREQUESTHINTS': b'Ki\t@\x01\x00\x00\x00\td\tH\x01\x00\x00\x00\x93\\\tL\x01\x00\x00\x00\x1aK\x0c\x03\x0c\xa8q\x92\x00\x12C\x0c\x03\x0c"\r\x90\x00\x00<\x0c\x03\x08"\x19\x80\x00', 'ZLOCATIONDATA': b'\xca\xebV\tu\xc0I@/j\xf7\xab\x00\xdf\xc0\xbf\xcd\xcc\xcc\xcc\xcc\xcc\x04@\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'}]

Raw Photos¶

Handling raw photos in osxphotos requires a bit of extra work. Raw photos in Photos can be imported in two different ways: 1) a single raw photo with no associated JPEG image is imported 2) a raw+JPEG pair is imported – two separate images with same file stem (e.g. IMG_0001.CR2 and IMG_001.JPG) are imported.

The latter are treated by Photos as a single image. By default, Photos will treat these as a JPEG image. They are denoted in the Photos interface with a “J” icon superimposed on the image. In Photos, the user can select “Use RAW as original” in which case the “J” icon changes to an “R” icon and all subsequent edits will use the raw image as the original. To further complicate this, different versions of Photos handle these differently in their internal logic.

osxphotos attempts to simplify the handling of these raw+JPEG pairs by providing a set of attributes for accessing both the JPEG and the raw version. For example, PhotoInfo.has_raw will be True if the photo has an associated raw image but False otherwise and PhotoInfo.path_raw provides the path to the associated raw image. Reference the following table for the various attributes useful for dealing with raw images. Given the different ways Photos deals with raw images I’ve struggled with how to represent these in a logical and consistent manner. If you have suggestions for a better interface, please open an issue!

Raw-Related Attributes¶

`PhotoInfo` attribute	`IMG_0001.CR2` imported without raw+JPEG pair	`IMG_0001.CR2` + `IMG_0001.JPG` raw+JPEG pair, JPEG is original	`IMG_0001.CR2` + `IMG_0001.JPG` raw+jpeg pair, raw is original
israw	True	False	False
has_raw	False	True	True
uti	`com.canon.cr2-raw-image`	`public.jpeg`	`public.jpeg`
uti_raw	None	`com.canon.cr2-raw-image`	`com.canon.cr2-raw-image`
raw_original	False	False	True
path	`/path/to/IMG_0001.CR2`	`/path/to/IMG_0001.JPG`	`/path/to/IMG_0001.JPG`
path_raw	None	`/path/to/IMG_0001.CR2`	`/path/to/IMG_0001.CR2`

Example¶

To get the path of every raw photo, whether it’s a single raw photo or a raw+JPEG pair, one could do something like this:

>>> import osxphotos
>>> photosdb = osxphotos.PhotosDB()
>>> photos = photosdb.photos()
>>> all_raw = [p for p in photos if p.israw or p.has_raw]
>>> for raw in all_raw:
...     path = raw.path if raw.israw else raw.path_raw
...     print(path)

Template System¶

The templating system converts one or template statements, written in osxphotos metadata templating language, to one or more rendered values using information from the photo being processed.

In its simplest form, a template statement has the form: "{template_field}", for example "{title}" which would resolve to the title of the photo.

Template statements may contain one or more modifiers. The full syntax is:

"pretext{delim+template_field:subfield(field_arg)|filter[find,replace] conditional&combine_value?bool_value,default}posttext"

Template statements are white-space sensitive meaning that white space (spaces, tabs) changes the meaning of the template statement.

pretext and posttext are free form text. For example, if a photo has title “My Photo Title” the template statement "The title of the photo is {title}", resolves to "The title of the photo is My Photo Title". The pretext in this example is "The title if the photo is " and the template_field is {title}.

delim: optional delimiter string to use when expanding multi-valued template values in-place

+: If present before template name, expands the template in place. If delim not provided, values are joined with no delimiter.

e.g. if Photo keywords are ["foo","bar"]:

"{keyword}" renders to "foo", "bar"
"{,+keyword}" renders to: "foo,bar"
"{; +keyword}" renders to: "foo; bar"
"{+keyword}" renders to "foobar"

template_field: The template field to resolve. See Template Substitutions for full list of template fields.

:subfield: Some templates have sub-fields, For example, {exiftool:IPTC:Make}`; the template_field is``exiftooland the sub-field isIPTC:Make`.

(field_arg): optional arguments to pass to the field; for example, with {folder_album} this is used to pass the path separator used for joining folders and albums when rendering the field (default is “/” for {folder_album}).

|filter: You may optionally append one or more filter commands to the end of the template field using the vertical pipe (‘|’) symbol. Filters may be combined, separated by ‘|’ as in: {keyword|capitalize|parens}.

Valid filters are:

lower: Convert value to lower case, e.g. ‘Value’ => ‘value’.
upper: Convert value to upper case, e.g. ‘Value’ => ‘VALUE’.
strip: Strip whitespace from beginning/end of value, e.g. ‘ Value ‘ => ‘Value’.
titlecase: Convert value to title case, e.g. ‘my value’ => ‘My Value’.
capitalize: Capitalize first word of value and convert other words to lower case, e.g. ‘MY VALUE’ => ‘My value’.
braces: Enclose value in curly braces, e.g. ‘value => ‘{value}’.
parens: Enclose value in parentheses, e.g. ‘value’ => ‘(value’)
brackets: Enclose value in brackets, e.g. ‘value’ => ‘[value]’
shell_quote: Quotes the value for safe usage in the shell, e.g. My file.jpeg => ‘My file.jpeg’; only adds quotes if needed.
function: Run custom python function to filter value; use in format ‘function:/path/to/file.py::function_name’. See example at https://github.com/RhetTbull/osxphotos/blob/master/examples/template_filter.py
split(x): Split value into a list of values using x as delimiter, e.g. ‘value1;value2’ => [‘value1’, ‘value2’] if used with split(;).
autosplit: Automatically split delimited string into separate values; will split strings delimited by comma, semicolon, or space, e.g. ‘value1,value2’ => [‘value1’, ‘value2’].
chop(x): Remove x characters off the end of value, e.g. chop(1): ‘Value’ => ‘Valu’; when applied to a list, chops characters from each list value, e.g. chop(1): [‘travel’, ‘beach’]=> [‘trave’, ‘beac’].
chomp(x): Remove x characters from the beginning of value, e.g. chomp(1): [‘Value’] => [‘alue’]; when applied to a list, removes characters from each list value, e.g. chomp(1): [‘travel’, ‘beach’]=> [‘ravel’, ‘each’].
sort: Sort list of values, e.g. [‘c’, ‘b’, ‘a’] => [‘a’, ‘b’, ‘c’].
rsort: Sort list of values in reverse order, e.g. [‘a’, ‘b’, ‘c’] => [‘c’, ‘b’, ‘a’].
reverse: Reverse order of values, e.g. [‘a’, ‘b’, ‘c’] => [‘c’, ‘b’, ‘a’].
uniq: Remove duplicate values, e.g. [‘a’, ‘b’, ‘c’, ‘b’, ‘a’] => [‘a’, ‘b’, ‘c’].
join(x): Join list of values with delimiter x, e.g. join(,): [‘a’, ‘b’, ‘c’] => ‘a,b,c’; the DELIM option functions similar to join(x) but with DELIM, the join happens before being passed to any filters.May optionally be used without an argument, that is ‘join()’ which joins values together with no delimiter. e.g. join(): [‘a’, ‘b’, ‘c’] => ‘abc’.
append(x): Append x to list of values, e.g. append(d): [‘a’, ‘b’, ‘c’] => [‘a’, ‘b’, ‘c’, ‘d’].
prepend(x): Prepend x to list of values, e.g. prepend(d): [‘a’, ‘b’, ‘c’] => [‘d’, ‘a’, ‘b’, ‘c’].
appends(x): Append s[tring] Append x to each value of list of values, e.g. appends(d): [‘a’, ‘b’, ‘c’] => [‘ad’, ‘bd’, ‘cd’].
prepends(x): Prepend s[tring] x to each value of list of values, e.g. prepends(d): [‘a’, ‘b’, ‘c’] => [‘da’, ‘db’, ‘dc’].
remove(x): Remove x from list of values, e.g. remove(b): [‘a’, ‘b’, ‘c’] => [‘a’, ‘c’].
slice(start:stop:step): Slice list using same semantics as Python’s list slicing, e.g. slice(1:3): [‘a’, ‘b’, ‘c’, ‘d’] => [‘b’, ‘c’]; slice(1:4:2): [‘a’, ‘b’, ‘c’, ‘d’] => [‘b’, ‘d’]; slice(1:): [‘a’, ‘b’, ‘c’, ‘d’] => [‘b’, ‘c’, ‘d’]; slice(:-1): [‘a’, ‘b’, ‘c’, ‘d’] => [‘a’, ‘b’, ‘c’]; slice(::-1): [‘a’, ‘b’, ‘c’, ‘d’] => [‘d’, ‘c’, ‘b’, ‘a’]. See also sslice().
sslice(start:stop:step): [s(tring) slice] Slice values in a list using same semantics as Python’s string slicing, e.g. sslice(1:3):’abcd => ‘bc’; sslice(1:4:2): ‘abcd’ => ‘bd’, etc. See also slice().
filter(x): Filter list of values using predicate x; for example, {folder_album|filter(contains Events)} returns only folders/albums containing the word ‘Events’ in their path.
int: Convert values in list to integer, e.g. 1.0 => 1. If value cannot be converted to integer, remove value from list. [‘1.1’, ‘x’] => [‘1’]. See also float.
float: Convert values in list to floating point number, e.g. 1 => 1.0. If value cannot be converted to float, remove value from list. [‘1’, ‘x’] => [‘1.0’]. See also int.

e.g. if Photo keywords are ["FOO","bar"]:

"{keyword|lower}" renders to "foo", "bar"
"{keyword|upper}" renders to: "FOO", "BAR"
"{keyword|capitalize}" renders to: "Foo", "Bar"
"{keyword|lower|parens}" renders to: "(foo)", "(bar)"

e.g. if Photo description is “my description”:

"{descr|titlecase}" renders to: "My Description"

e.g. If Photo is in Album1 in Folder1:

"{folder_album}" renders to ["Folder1/Album1"]
"{folder_album(>)}" renders to ["Folder1>Album1"]
"{folder_album()}" renders to ["Folder1Album1"]

[find,replace]: optional text replacement to perform on rendered template value. For example, to replace “/” in an album name, you could use the template “{album[/,-]}”. Multiple replacements can be made by appending “|” and adding another find|replace pair. e.g. to replace both “/” and “:” in album name: "{album[/,-|:,-]}". find/replace pairs are not limited to single characters. The “|” character cannot be used in a find/replace pair.

conditional: optional conditional expression that is evaluated as boolean (True/False) for use with the ?bool_value modifier. Conditional expressions take the form ‘not operator value’ where not is an optional modifier that negates the operator. Note: the space before the conditional expression is required if you use a conditional expression. Valid comparison operators are:

contains: template field contains value, similar to python’s in
matches: template field contains exactly value, unlike contains: does not match partial matches
startswith: template field starts with value
endswith: template field ends with value
<=: template field is less than or equal to value
>=: template field is greater than or equal to value
<: template field is less than value
>: template field is greater than value
==: template field equals value
!=: template field does not equal value

The value part of the conditional expression is treated as a bare (unquoted) word/phrase. Multiple values may be separated by ‘|’ (the pipe symbol). value is itself a template statement so you can use one or more template fields in value which will be resolved before the comparison occurs.

For example:

{keyword matches Beach} resolves to True if ‘Beach’ is a keyword. It would not match keyword ‘BeachDay’.
{keyword contains Beach} resolves to True if any keyword contains the word ‘Beach’ so it would match both ‘Beach’ and ‘BeachDay’.
{photo.score.overall > 0.7} resolves to True if the photo’s overall aesthetic score is greater than 0.7.
{keyword|lower contains beach} uses the lower case filter to do case-insensitive matching to match any keyword that contains the word ‘beach’.
{keyword|lower not contains beach} uses the not modifier to negate the comparison so this resolves to True if there is no keyword that matches ‘beach’.

Examples: to export photos that contain certain keywords with the osxphotos export command’s --directory option:

--directory "{keyword|lower matches travel|vacation?Travel-Photos,Not-Travel-Photos}"

This exports any photo that has keywords ‘travel’ or ‘vacation’ into a directory ‘Travel-Photos’ and all other photos into directory ‘Not-Travel-Photos’.

This can be used to rename files as well, for example: --filename "{favorite?Favorite-{original_name},{original_name}}"

This renames any photo that is a favorite as ‘Favorite-ImageName.jpg’ (where ‘ImageName.jpg’ is the original name of the photo) and all other photos with the unmodified original name.

&combine_value: Template fields may be combined with another template statement to return multiple values. The combine_value is another template statement. For example, the template {created.year&{folder_album,}} would resolve to [“1999”, “Vacation”] if the photo was created in 1999 and was in the album Vacation. Because the combine_value is a template statement, multiple templates may be combined together by nesting the combine operator: {template1&{template2&{template3,},},}. In this example, a null default value is used to prevent the default value from being combined if any of the nested templates does not resolve to a value

?bool_value: Template fields may be evaluated as boolean (True/False) by appending “?” after the field name (and following “(field_arg)” or “[find/replace]”. If a field is True (e.g. photo is HDR and field is "{hdr}") or has any value, the value following the “?” will be used to render the template instead of the actual field value. If the template field evaluates to False (e.g. in above example, photo is not HDR) or has no value (e.g. photo has no title and field is "{title}") then the default value following a “,” will be used.

e.g. if photo is an HDR image,

"{hdr?ISHDR,NOTHDR}" renders to "ISHDR"

and if it is not an HDR image,

"{hdr?ISHDR,NOTHDR}" renders to "NOTHDR"

,default: optional default value to use if the template name has no value. This modifier is also used for the value if False for boolean-type fields (see above) as well as to hold a sub-template for values like {created.strftime}. If no default value provided, “_” is used.

e.g., if photo has no title set,

"{title}" renders to “_”
"{title,I have no title}" renders to "I have no title"

Template fields such as created.strftime use the default value to pass the template to use for strftime.

e.g., if photo date is 4 February 2020, 19:07:38,

"{created.strftime,%Y-%m-%d-%H%M%S}" renders to "2020-02-04-190738"

Some template fields such as "{media_type}" use the default value to allow customization of the output. For example, "{media_type}" resolves to the special media type of the photo such as panorama or selfie. You may use the default value to override these in form: "{media_type,video=vidéo;time_lapse=vidéo_accélérée}". In this example, if photo was a time_lapse photo, media_type would resolve to vidéo_accélérée instead of time_lapse.

Either or both bool_value or default (False value) may be empty which would result in empty string "" when rendered.

If you want to include “{” or “}” in the output, use “{openbrace}” or “{closebrace}” template substitution.

e.g. "{created.year}/{openbrace}{title}{closebrace}" would result in "2020/{Photo Title}".

Variables

You can define variables for later use in the template string using the format {var:NAME,VALUE} where VALUE is a template statement. Variables may then be referenced using the format %NAME. For example: {var:foo,bar} defines the variable %foo to have value bar. This can be useful if you want to re-use a complex template value in multiple places within your template string or for allowing the use of characters that would otherwise be prohibited in a template string. For example, the “pipe” (|) character is not allowed in a find/replace pair but you can get around this limitation like so: {var:pipe,{pipe}}{title[-,%pipe]} which replaces the - character with | (the value of %pipe).

Another use case for variables is filtering combined template values. For example, using the &combine_value mechanism to combine two template values that might result in duplicate values, you could do the following: {var:myvar,{template1&{template2,},}}{%myvar|uniq} which allows the use of the uniq filter against the combined template values.

Variables can also be referenced as fields in the template string, for example: {var:year,{created.year}}{original_name}-{%year}. In some cases, use of variables can make your template string more readable. Variables can be used as template fields, as values for filters, as values for conditional operations, or as default values. When used as a conditional value or default value, variables should be treated like any other field and enclosed in braces as conditional and default values are evaluated as template strings. For example: {var:name,Katie}{person contains {%name}?{%name},Not-{%name}}.

If you need to use a % (percent sign character), you can escape the percent sign by using %%. You can also use the {percent} template field where a template field is required. For example:

{title[:,%%]} replaces the : with % and {title contains Foo?{title}{percent},{title}} adds % to the title if it contains Foo.

The following template field substitutions are availabe for use the templating system.

Field	Description
{name}	Current filename of the photo
{original_name}	Photo’s original filename when imported to Photos
{title}	Title of the photo
{descr}	Description of the photo
{media_type}	Special media type resolved in this precedence: selfie, time_lapse, panorama, slow_mo, screenshot, screen_recording, portrait, live_photo, burst, photo, video. Defaults to ‘photo’ or ‘video’ if no special type. Customize one or more media types using format: ‘{media_type,video=vidéo;time_lapse=vidéo_accélérée}’
{photo_or_video}	‘photo’ or ‘video’ depending on what type the image is. To customize, use default value as in ‘{photo_or_video,photo=fotos;video=videos}’
{hdr}	Photo is HDR?; True/False value, use in format ‘{hdr?VALUE_IF_TRUE,VALUE_IF_FALSE}’
{edited}	True if photo has been edited (has adjustments), otherwise False; use in format ‘{edited?VALUE_IF_TRUE,VALUE_IF_FALSE}’
{edited_version}	True if template is being rendered for the edited version of a photo, otherwise False.
{favorite}	Photo has been marked as favorite?; True/False value, use in format ‘{favorite?VALUE_IF_TRUE,VALUE_IF_FALSE}’
{created}	Photo’s creation date in ISO format, e.g. ‘2020-03-22’
{created.date}	Photo’s creation date in ISO format, e.g. ‘2020-03-22’
{created.year}	4-digit year of photo creation time
{created.yy}	2-digit year of photo creation time
{created.mm}	2-digit month of the photo creation time (zero padded)
{created.month}	Month name in user’s locale of the photo creation time
{created.mon}	Month abbreviation in the user’s locale of the photo creation time
{created.dd}	2-digit day of the month (zero padded) of photo creation time
{created.dow}	Day of week in user’s locale of the photo creation time
{created.doy}	3-digit day of year (e.g Julian day) of photo creation time, starting from 1 (zero padded)
{created.hour}	2-digit hour of the photo creation time
{created.min}	2-digit minute of the photo creation time
{created.sec}	2-digit second of the photo creation time
{created.strftime}	Apply strftime template to file creation date/time. Should be used in form {created.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {created.strftime,%Y-%U} would result in year-week number of year: ‘2020-23’. If used with no template will return null value. See https://strftime.org/ for help on strftime templates.
{modified}	Photo’s modification date in ISO format, e.g. ‘2020-03-22’; uses creation date if photo is not modified
{modified.date}	Photo’s modification date in ISO format, e.g. ‘2020-03-22’; uses creation date if photo is not modified
{modified.year}	4-digit year of photo modification time; uses creation date if photo is not modified
{modified.yy}	2-digit year of photo modification time; uses creation date if photo is not modified
{modified.mm}	2-digit month of the photo modification time (zero padded); uses creation date if photo is not modified
{modified.month}	Month name in user’s locale of the photo modification time; uses creation date if photo is not modified
{modified.mon}	Month abbreviation in the user’s locale of the photo modification time; uses creation date if photo is not modified
{modified.dd}	2-digit day of the month (zero padded) of the photo modification time; uses creation date if photo is not modified
{modified.dow}	Day of week in user’s locale of the photo modification time; uses creation date if photo is not modified
{modified.doy}	3-digit day of year (e.g Julian day) of photo modification time, starting from 1 (zero padded); uses creation date if photo is not modified
{modified.hour}	2-digit hour of the photo modification time; uses creation date if photo is not modified
{modified.min}	2-digit minute of the photo modification time; uses creation date if photo is not modified
{modified.sec}	2-digit second of the photo modification time; uses creation date if photo is not modified
{modified.strftime}	Apply strftime template to file modification date/time. Should be used in form {modified.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {modified.strftime,%Y-%U} would result in year-week number of year: ‘2020-23’. If used with no template will return null value. Uses creation date if photo is not modified. See https://strftime.org/ for help on strftime templates.
{today}	Current date in iso format, e.g. ‘2020-03-22’
{today.date}	Current date in iso format, e.g. ‘2020-03-22’
{today.year}	4-digit year of current date
{today.yy}	2-digit year of current date
{today.mm}	2-digit month of the current date (zero padded)
{today.month}	Month name in user’s locale of the current date
{today.mon}	Month abbreviation in the user’s locale of the current date
{today.dd}	2-digit day of the month (zero padded) of current date
{today.dow}	Day of week in user’s locale of the current date
{today.doy}	3-digit day of year (e.g Julian day) of current date, starting from 1 (zero padded)
{today.hour}	2-digit hour of the current date
{today.min}	2-digit minute of the current date
{today.sec}	2-digit second of the current date
{today.strftime}	Apply strftime template to current date/time. Should be used in form {today.strftime,TEMPLATE} where TEMPLATE is a valid strftime template, e.g. {today.strftime,%Y-%U} would result in year-week number of year: ‘2020-23’. If used with no template will return null value. See https://strftime.org/ for help on strftime templates.
{place.name}	Place name from the photo’s reverse geolocation data, as displayed in Photos
{place.country_code}	The ISO country code from the photo’s reverse geolocation data
{place.name.country}	Country name from the photo’s reverse geolocation data
{place.name.state_province}	State or province name from the photo’s reverse geolocation data
{place.name.city}	City or locality name from the photo’s reverse geolocation data
{place.name.area_of_interest}	Area of interest name (e.g. landmark or public place) from the photo’s reverse geolocation data
{place.address}	Postal address from the photo’s reverse geolocation data, e.g. ‘2007 18th St NW, Washington, DC 20009, United States’
{place.address.street}	Street part of the postal address, e.g. ‘2007 18th St NW’
{place.address.city}	City part of the postal address, e.g. ‘Washington’
{place.address.state_province}	State/province part of the postal address, e.g. ‘DC’
{place.address.postal_code}	Postal code part of the postal address, e.g. ‘20009’
{place.address.country}	Country name of the postal address, e.g. ‘United States’
{place.address.country_code}	ISO country code of the postal address, e.g. ‘US’
{searchinfo.season}	Season of the year associated with a photo, e.g. ‘Summer’; (Photos 5+ only, applied automatically by Photos’ image categorization algorithms).
{exif.camera_make}	Camera make from original photo’s EXIF information as imported by Photos, e.g. ‘Apple’
{exif.camera_model}	Camera model from original photo’s EXIF information as imported by Photos, e.g. ‘iPhone 6s’
{exif.lens_model}	Lens model from original photo’s EXIF information as imported by Photos, e.g. ‘iPhone 6s back camera 4.15mm f/2.2’
{moment}	The moment title of the photo
{uuid}	Photo’s internal universally unique identifier (UUID) for the photo, a 36-character string unique to the photo, e.g. ‘128FB4C6-0B16-4E7D-9108-FB2E90DA1546’
{shortuuid}	A shorter representation of photo’s internal universally unique identifier (UUID) for the photo, a 22-character string unique to the photo, e.g. ‘JYsxugP9UjetmCbBCHXcmu’
{id}	A unique number for the photo based on its primary key in the Photos database. A sequential integer, e.g. 1, 2, 3…etc. Each asset associated with a photo (e.g. an image and Live Photo preview) will share the same id. May be formatted using a python string format code. For example, to format as a 5-digit integer and pad with zeros, use ‘{id:05d}’ which results in 00001, 00002, 00003…etc.
{counter}	A sequential counter, starting at 0, that increments each time it is evaluated.To start counting at a value other than 0, append append ‘(starting_value)’ to the field name.For example, to start counting at 1 instead of 0: ‘{counter(1)}’.May be formatted using a python string format code.For example, to format as a 5-digit integer and pad with zeros, use ‘{counter:05d(1)}’which results in 00001, 00002, 00003…etc.You may also specify a stop value which causes the counter to reset to the starting valuewhen the stop value is reached and a step size which causes the counter to increment bythe specified value instead of 1. Use the format ‘{counter(start,stop,step)}’ where start,stop, and step are integers. For example, to count from 1 to 10 by 2, use ‘{counter(1,11,2)}’.Note that the counter stops counting when the stop value is reached and does not return thestop value. Start, stop, and step are optional and may be omitted. For example, to countfrom 0 by 2s, use ‘{counter(,,2)}’.You may create an arbitrary number of counters by appending a unique name to the field namepreceded by a period: ‘{counter.a}’, ‘{counter.b}’, etc. Each counter will have its own stateand will start at 0 and increment by 1 unless otherwise specified. Note: {counter} is not suitable for use with ‘export’ and ‘–update’ as the counter associated with a photo may change between export sessions. See also {id}.
{album_seq}	An integer, starting at 0, indicating the photo’s index (sequence) in the containing album. Only valid when used in a ‘–filename’ template and only when ‘{album}’ or ‘{folder_album}’ is used in the ‘–directory’ template. For example ‘–directory “{folder_album}” –filename “{albumseq}{original_name}”’. To start counting at a value other than 0, append append ‘(starting_value)’ to the field name. For example, to start counting at 1 instead of 0: ‘{album_seq(1)}’. May be formatted using a python string format code. For example, to format as a 5-digit integer and pad with zeros, use ‘{album_seq:05d}’ which results in 00000, 00001, 00002…etc. To format while also using a starting value: ‘{album_seq:05d(1)}’ which results in 0001, 00002…etc.This may result in incorrect sequences if you have duplicate albums with the same name; see also ‘{folder_album_seq}’.
{folder_album_seq}	An integer, starting at 0, indicating the photo’s index (sequence) in the containing album and folder path. Only valid when used in a ‘–filename’ template and only when ‘{folder_album}’ is used in the ‘–directory’ template. For example ‘–directory “{folder_album}” –filename “{folder_albumseq}{original_name}”’. To start counting at a value other than 0, append ‘(starting_value)’ to the field name. For example, to start counting at 1 instead of 0: ‘{folder_album_seq(1)}’ May be formatted using a python string format code. For example, to format as a 5-digit integer and pad with zeros, use ‘{folder_album_seq:05d}’ which results in 00000, 00001, 00002…etc. To format while also using a starting value: ‘{folder_album_seq:05d(1)}’ which results in 0001, 00002…etc.This may result in incorrect sequences if you have duplicate albums with the same name in the same folder; see also ‘{album_seq}’.
{comma}	A comma: ‘,’
{semicolon}	A semicolon: ‘;’
{questionmark}	A question mark: ‘?’
{pipe}	A vertical pipe: ‘\|’
{percent}	A percent sign: ‘%’
{ampersand}	an ampersand symbol: ‘&’
{openbrace}	An open brace: ‘{’
{closebrace}	A close brace: ‘}’
{openparens}	An open parentheses: ‘(’
{closeparens}	A close parentheses: ‘)’
{openbracket}	An open bracket: ‘[’
{closebracket}	A close bracket: ‘]’
{newline}	A newline: ‘n’
{lf}	A line feed: ‘n’, alias for {newline}
{cr}	A carriage return: ‘r’
{crlf}	A carriage return + line feed: ‘rn’
{tab}	A tab: ‘t’
{osxphotos_version}	The osxphotos version, e.g. ‘0.68.6’
{osxphotos_cmd_line}	The full command line used to run osxphotos
{album}	Album(s) photo is contained in
{folder_album}	Folder path + album photo is contained in. e.g. ‘Folder/Subfolder/Album’ or just ‘Album’ if no enclosing folder
{project}	Project(s) photo is contained in (such as greeting cards, calendars, slideshows)
{album_project}	Album(s) and project(s) photo is contained in; treats projects as regular albums
{folder_album_project}	Folder path + album (includes projects as albums) photo is contained in. e.g. ‘Folder/Subfolder/Album’ or just ‘Album’ if no enclosing folder
{keyword}	Keyword(s) assigned to photo
{person}	Person(s) / face(s) in a photo
{label}	Image categorization label associated with a photo (Photos 5+ only). Labels are added automatically by Photos using machine learning algorithms to categorize images. These are not the same as {keyword} which refers to the user-defined keywords/tags applied in Photos.
{label_normalized}	All lower case version of ‘label’ (Photos 5+ only)
{comment}	Comment(s) on shared Photos; format is ‘Person name: comment text’ (Photos 5+ only)
{exiftool}	Format: ‘{exiftool:GROUP:TAGNAME}’; use exiftool (https://exiftool.org) to extract metadata, in form GROUP:TAGNAME, from image. E.g. ‘{exiftool:EXIF:Make}’ to get camera make, or {exiftool:IPTC:Keywords} to extract keywords. See https://exiftool.org/TagNames/ for list of valid tag names. You must specify group (e.g. EXIF, IPTC, etc) as used in `exiftool -G`. exiftool must be installed in the path to use this template.
{searchinfo.holiday}	Holiday names associated with a photo, e.g. ‘Christmas Day’; (Photos 5+ only, applied automatically by Photos’ image categorization algorithms).
{searchinfo.activity}	Activities associated with a photo, e.g. ‘Sporting Event’; (Photos 5+ only, applied automatically by Photos’ image categorization algorithms).
{searchinfo.venue}	Venues associated with a photo, e.g. name of restaurant; (Photos 5+ only, applied automatically by Photos’ image categorization algorithms).
{searchinfo.venue_type}	Venue types associated with a photo, e.g. ‘Restaurant’; (Photos 5+ only, applied automatically by Photos’ image categorization algorithms).
{photo}	Provides direct access to the PhotoInfo object for the photo. Must be used in format ‘{photo.property}’ where ‘property’ represents a PhotoInfo property. For example: ‘{photo.favorite}’ is the same as ‘{favorite}’ and ‘{photo.place.name}’ is the same as ‘{place.name}’. ‘{photo}’ provides access to properties that are not available as separate template fields but it assumes some knowledge of the underlying PhotoInfo class. See https://rhettbull.github.io/osxphotos/ for additional documentation on the PhotoInfo class.
{detected_text}	List of text strings found in the image after performing text detection. Using ‘{detected_text}’ will cause osxphotos to perform text detection on your photos using the built-in macOS text detection algorithms which will slow down your export. The results for each photo will be cached in the export database so that future exports with ‘–update’ do not need to reprocess each photo. You may pass a confidence threshold value between 0.0 and 1.0 after a colon as in ‘{detected_text:0.5}’; The default confidence threshold is 0.75. ‘{detected_text}’ works only on macOS Catalina (10.15) or later. Note: this feature is not the same thing as Live Text in macOS Monterey, which osxphotos does not yet support.
{shell_quote}	Use in form ‘{shell_quote,TEMPLATE}’; quotes the rendered TEMPLATE value(s) for safe usage in the shell, e.g. My file.jpeg => ‘My file.jpeg’; only adds quotes if needed.
{strip}	Use in form ‘{strip,TEMPLATE}’; strips whitespace from begining and end of rendered TEMPLATE value(s).
{format}	Use in form ‘{format:TYPE:FORMAT,TEMPLATE}’; converts TEMPLATE value to TYPE then formats the value using Python string formatting codes specified by FORMAT; TYPE is one of: ‘int’, ‘float’, or ‘str’. For example, ‘{format:float:.1f,{exiftool:EXIF:FocalLength}}’ will format focal length to 1 decimal place (e.g. ‘100.0’).
{function}	Execute a python function from an external file and use return value as template substitution. Use in format: {function:file.py::function_name} where ‘file.py’ is the path/name of the python file and ‘function_name’ is the name of the function to call. The file name may also be url to a python file, e.g. ‘{function:https://raw.githubusercontent.com/RhetTbull/osxphotos/main/examples/template_function.py::example}’. The function will be passed the PhotoInfo object for the photo. See https://github.com/RhetTbull/osxphotos/blob/master/examples/template_function.py for an example of how to implement a template function.

ExifTool¶

osxphotos includes its own exiftool library that can be accessed via osxphotos.exiftool:

>>> from osxphotos.exiftool import ExifTool
>>> exiftool = ExifTool("/Users/rhet/Downloads/test.jpeg")
>>> exifdict = exiftool.asdict()
>>> exifdict["EXIF:Make"]
'Canon'
>>> exiftool.setvalue("IPTC:Keywords","Keyword1")
True
>>> exiftool.asdict()["IPTC:Keywords"]
'Keyword1'
>>> exiftool.addvalues("IPTC:Keywords","Keyword2","Keyword3")
True
>>> exiftool.asdict()["IPTC:Keywords"]
['Keyword1', 'Keyword2', 'Keyword3']

ExifTool(filepath, exiftool=None, large_file_support=True)

filepath: str, path to photo
exiftool: str, optional path to exiftool; if not provided, will look for exiftool in the system path
large_file_support: bool, if True, enables large file support in exiftool (-api largefilesupport=1)

ExifTool methods¶

asdict(tag_groups=True): returns all EXIF metadata found in the file as a dictionary in following form (Note: this shows just a subset of available metadata). See exiftool documentation to understand which metadata keys are available. If tag_groups is True (default) dict keys are in form “GROUP:TAG”, e.g. “IPTC:Keywords”. If tag_groups is False, dict keys do not have group names, e.g. “Keywords”.

{'Composite:Aperture': 2.2,
 'Composite:GPSPosition': '-34.9188916666667 138.596861111111',
 'Composite:ImageSize': '2754 2754',
 'EXIF:CreateDate': '2017:06:20 17:18:56',
 'EXIF:LensMake': 'Apple',
 'EXIF:LensModel': 'iPhone 6s back camera 4.15mm f/2.2',
 'EXIF:Make': 'Apple',
 'XMP:Title': 'Elder Park',
}

json(): returns same information as asdict() but as a serialized JSON string.
setvalue(tag, value): write to the EXIF data in the photo file. To delete a tag, use setvalue with value = None. For example:

photo.exiftool.setvalue("XMP:Title", "Title of photo")

addvalues(tag, *values): Add one or more value(s) to tag. For a tag that accepts multiple values, like “IPTC:Keywords”, this will add the values as additional list values. However, for tags which are not usually lists, such as “EXIF:ISO” this will literally add the new value to the old value which is probably not the desired effect. Be sure you understand the behavior of the individual tag before using this. For example:

photo.exiftool.addvalues("IPTC:Keywords", "vacation", "beach")

osxphotos.exiftool also provides an ExifToolCaching class which caches all metadata after the first call to exiftool. This can significantly speed up repeated access to the metadata but should only be used if you do not intend to modify the file’s metadata.

``PhotoInfo.exiftool` <#exiftool>`_ returns an ExifToolCaching instance for the original image in the Photos library.

Implementation Note¶

ExifTool() runs exiftool as a subprocess using the -stay_open True flag to keep the process running in the background. The subprocess will be cleaned up when your main script terminates. ExifTool() uses a singleton pattern to ensure that only one instance of exiftool is created. Multiple instances of ExifTool() will all use the same exiftool subprocess.

PhotoExporter¶

PhotoInfo.export() provides a simple method to export a photo. This method actually calls PhotoExporter.export() to do the export. PhotoExporter provides many more options to configure the export and report results and this is what the osxphotos command line export tools uses.

`export(dest, filename=None, options: Optional[ExportOptions]=None) -> ExportResults`¶

Export a photo.

Args:

dest: must be valid destination path or exception raised
filename: (optional): name of exported picture; if not provided, will use current filename
options (ExportOptions): optional ExportOptions instance

Returns: ExportResults instance

Note: to use dry run mode, you must set options.dry_run=True and also pass in memory version of export_db, and no-op fileutil (e.g. ExportDBInMemory and FileUtilNoOp) in options.export_db and options.fileutil respectively.

`ExportOptions`¶

Options class for exporting photos with export

Attributes:

convert_to_jpeg (bool): if True, converts non-jpeg images to jpeg
description_template (str): optional template string that will be rendered for use as photo description
download_missing: (bool, default=False): if True will attempt to export photo via applescript interaction with Photos if missing (see also use_photokit, use_photos_export)
dry_run: (bool, default=False): set to True to run in “dry run” mode
edited: (bool, default=False): if True will export the edited version of the photo otherwise exports the original version
exiftool_flags (list of str): optional list of flags to pass to exiftool when using exiftool option, e.g [“-m”, “-F”]
exiftool: (bool, default = False): if True, will use exiftool to write metadata to export file
export_as_hardlink: (bool, default=False): if True, will hardlink files instead of copying them
export_db: (ExportDB): instance of a class that conforms to ExportDB with methods for getting/setting data related to exported files to compare update state
fileutil: (FileUtilABC): class that conforms to FileUtilABC with various file utilities
ignore_date_modified (bool): for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set
ignore_signature (bool, default=False): ignore file signature when used with update (look only at filename)
increment (bool, 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
jpeg_ext (str): if set, will use this value for extension on jpegs converted to jpeg with convert_to_jpeg; if not set, uses jpeg; do not include the leading “.”
jpeg_quality (float in range 0.0 <= jpeg_quality <= 1.0): a value of 1.0 specifies use best quality, a value of 0.0 specifies use maximum compression.
keyword_template (list of str): list of template strings that will be rendered as used as keywords
live_photo (bool, default=False): if True, will also export the associated .mov for live photos
location (bool): if True, include location in exported metadata
merge_exif_keywords (bool): if True, merged keywords found in file’s exif data (requires exiftool)
merge_exif_persons (bool): if True, merged persons found in file’s exif data (requires exiftool)
overwrite (bool, default=False): if True will overwrite files if they already exist
persons (bool): if True, include persons in exported metadata
preview_suffix (str): optional string to append to end of filename for preview images
preview (bool): if True, also exports preview image
raw_photo (bool, default=False): if True, will also export the associated RAW photo
render_options (RenderOptions): optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates
replace_keywords (bool): if True, keyword_template replaces any keywords, otherwise it’s additive
sidecar_drop_ext (bool, default=False): if True, drops the photo’s extension from sidecar filename (e.g. ‘IMG_1234.json’ instead of ‘IMG_1234.JPG.json’)
sidecar: bit field (int): set to one or more of SIDECAR_XMP, SIDECAR_JSON, SIDECAR_EXIFTOOL
- 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
strip (bool): if True, strip whitespace from rendered templates
timeout (int, default=120): timeout in seconds used with use_photos_export
touch_file (bool, default=False): if True, sets file’s modification time upon photo date
update (bool, default=False): if True export will run in update mode, that is, it will not export the photo if the current version already exists in the destination
use_albums_as_keywords (bool, default = False): if True, will include album names in keywords when exporting metadata with exiftool or sidecar
use_persons_as_keywords (bool, default = False): if True, will include person names in keywords when exporting metadata with exiftool or sidecar
use_photos_export (bool, default=False): if True will attempt to export photo via applescript interaction with Photos even if not missing (see also use_photokit, download_missing)
use_photokit (bool, default=False): if True, will use photokit to export photos when use_photos_export is True
verbose (Callable): optional callable function to use for printing verbose text during processing; if None (default), does not print output.
tmpfile (str): optional path to use for temporary files

`ExportResults`¶

PhotoExporter().export() returns an instance of this class.

ExportResults has the following properties:

datetime: date/time of export in ISO 8601 format
exported: list of all exported files (A single call to export could export more than one file, e.g. original file, preview, live video, raw, etc.)
new: list of new files exported when used with update=True
updated: list of updated files when used with update=True
skipped: list of skipped files when used with update=True
exif_updated: list of updated files when used with update=True and exiftool
touched: list of files touched during export (e.g. file date/time updated with touch_file=True)
to_touch: Reserved for internal use of export
converted_to_jpeg: list of files converted to jpeg when convert_to_jpeg=True
metadata_changed: list of filenames that had metadata changes since last export
sidecar_json_written: list of JSON sidecars written
sidecar_json_skipped: list of JSON sidecars skipped when update=True
sidecar_exiftool_written: list of exiftool sidecars written
sidecar_exiftool_skipped: list of exiftool sidecars skipped when update=True
sidecar_xmp_written: list of XMP sidecars written
sidecar_xmp_skipped: list of XMP sidecars skipped when update=True
missing: list of missing files
error: list of tuples containing (filename, error) if error generated during export
exiftool_warning: list of warnings generated by exiftool during export
exiftool_error: list of errors generated by exiftool during export
xattr_written: list of files with extended attributes written during export
xattr_skipped: list of files where extended attributes were skipped when update=True
deleted_files: reserved for use by osxphotos CLI
deleted_directories: reserved for use by osxphotos CLI
exported_album: reserved for use by osxphotos CLI
skipped_album: reserved for use by osxphotos CLI
missing_album: reserved for use by osxphotos CLI

ExifWriter¶

osxphotos.exifwriter.ExifWriter provides a way to write EXIF metadata (using exiftool) to files. It is used by PhotoExporter to write metadata to exported files. It can also be used independently of PhotoExporter to write metadata to files. ExifWriter uses an ExifOptions options class to configure the output metadata. For example, ExifOptions.description_template allows you to specify a template to use for writing the XMP:Description field.

ExifWriter usage:

from osxphotos.exifwriter import ExifOptions, ExifWriter
# photo is a PhotoInfo object
writer = ExifWriter(photo)
options = ExifOptions(merge_exif_keywords=True)
# filepath is the path to the file you want to write the metadata to
writer.write_exif_data(filepath, options)

You can also retrieve the dictionary that will be used to write the metadata without actually writing to file using ExifWriter().exiftool_dict().

ExifOptions has the following properties:

description_template (str): Optional template string that will be rendered for use as photo description
exiftool_flags (list of str): Optional list of flags to pass to exiftool when using exiftool option, e.g [“-m”, “-F”]
exiftool: (bool, default = False): if True, will use exiftool to write metadata to export file
face_regions: (bool, default=True): if True, will export face regions
ignore_date_modified (bool): for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set
keyword_template (list of str): list of template strings that will be rendered as used as keywords
location (bool): if True, include location in exported metadata
merge_exif_keywords (bool): if True, merged keywords found in file’s exif data (requires exiftool)
merge_exif_persons (bool): if True, merged persons found in file’s exif data (requires exiftool)
persons (bool): if True, include persons in exported metadata
render_options (RenderOptions): Optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates
replace_keywords (bool): if True, keyword_template replaces any keywords, otherwise it’s additive
strip (bool): if True, strip whitespace from rendered templates
use_albums_as_keywords (bool, default = False): if True, will include album names in keywords when exporting metadata with exiftool or sidecar
use_persons_as_keywords (bool, default = False): if True, will include person names in keywords when exporting metadata with exiftool or sidecar
favorite_rating (bool): if True, set XMP:Rating=5 for favorite images and XMP:Rating=0 for non-favorites

SidecarWriter¶

osxphotos.sidecars.SidecarWriter is a utility class used by PhotoExporter to write the sidecars (XMP, JSON, exiftool) for exported images. You can use this yourself to write sidecars if needed.

from osxphotos.sidecars import SidecarWriter

# photo is a PhotoInfo object
writer = SidecarWriter(photo)

# dest is destination folder for sidecar files, options is an ExportOptions
# returns ExportResults of sidecars written or skipped
results = writer.write_sidecar_files(dest, options)

You can get the string for the XMP sidecar with xmp_sidecar():

def xmp_sidecar(
    photo: PhotoInfo,
    options: ExportOptions | None = None,
    extension: str | None = None,
) -> str:
    """Returns string for XMP sidecar

    Args:
        photo (PhotoInfo): photo to generate sidecars
        options (ExportOptions): options for export
        extension (Optional[str]): which extension to use for SidecarForExtension property

    Returns:
        str: string containing XMP sidecar
    """

from osxphotos.sidecars import xmp_sidecar

sidecar = xmp_sidecar(photo, options, extension)

See implementation for more information.

The JSON string for the exiftool sidecar can be retrieved using the function exiftool_json_sidecar which has the following signature:

def exiftool_json_sidecar(
    photo: PhotoInfo,
    options: ExportOptions | ExifOptions | None = None,
    tag_groups: bool = True,
    filename: str | None = None,
) -> str:

from osxphotos.sidecars import exiftool_json_sidecar

sidecar = exiftool_json_sidecar(photo, options, tag_groups, filename)

See source code for full details.

PhotosAlbum¶

osxphotos.photosalbum.PhotosAlbum is a class that represents a Photos album. It is useful for creating albums and adding PhotoInfo assets to albums in Photos. It uses PhotoScript, a Python wrapper around AppleScript, to interact with Photos. An album is created or retrieved using __init__(): album = PhotosAlbum(name) will create the album if it doesn’t exist or retrieve it if it does. You can add photos to the album using append() and extend() as in Python lists or add() and update() as in Python sets (append() and add() call the same function as do extend() and update()). Albums behave as sets as adding a asset that is already in the album has no effect. Assets cannot be removed from an album using this class due to limitations in the Photos AppleScript interface.

"""Example that shows how to add PhotoInfo objects to an album in Photos"""

from osxphotos import PhotosDB
from osxphotos.photosalbum import PhotosAlbum

# If album exists it will be used, otherwise it will be created
album = PhotosAlbum("Best Photos")
best_photos = [p for p in PhotosDB(verbose=print).photos() if p.score.overall > 0.9]

# use album.add() or album.append() to add a single photo
# use album.update() or album.extend() to add an iterable of photos
album.extend(best_photos)
print(f"Added {len(best_photos)} photos to album {album.name}")
print(f"Album contains {len(album.photos())} photos")

Text Detection¶

The PhotoInfo.detected_text() and the {detected_text} template will perform text detection on the photos in your library. Text detection is a slow process so to avoid unnecessary re-processing of photos, osxphotos will cache the results of the text detection process as an extended attribute on the photo image file. Extended attributes do not modify the actual file. The extended attribute is named osxphotos.metadata:detected_text and can be viewed using the built-in xattr command or my osxmetadata tool. If you want to remove the cached attribute, you can do so with xattr as follows:

find ~/Pictures/Photos\ Library.photoslibrary | xargs -I{} xattr -c osxphotos.metadata:detected_text '{}'

Compare Libraries¶

from osxphotos.compare_libraries import compare_photos_libraries, PhotosDBDiff

`compare_photos_libraries()`¶

def compare_photos_libraries(
    library_a: PhotosDB,
    library_b: PhotosDB,
    verbose: Callable[[Any], bool] | None = None,
    signature_function: Callable[[PhotoInfo], Any] | None = None,
    diff_function: Callable[[PhotoInfo, PhotoInfo], Any] | None = None,
) -> PhotosDBDiff:
    """Compare two Photos libraries and return a PhotosDBDiff object

    Args:
        library_a: PhotosDB object for first library
        library_b: PhotosDB object for second library
        verbose: function to print verbose output, defaults to None
        signature_function: function to compute signature for a PhotoInfo object, defaults to None
        diff_function: function to compare two PhotoInfo objects, defaults to None

    Returns: PhotosDBDiff object

    Note: signature_function should take a PhotoInfo object as input and return a unique
        signature for the photo; if signature_function is None, the default signature
        function will be used which computes a signature based on the photo's fingerprint
        diff_function should take two PhotoInfo objects as input and return a truthy value
        if the objects are different or a falsy value if they are the same; if diff_function
        is None, the default diff function will be used which compares the dictionary
        representation of the PhotoInfo objects.
    """

`PhotosDBDiff`¶

@dataclasses.dataclass
class PhotosDBDiff:
    """Class to hold differences between two PhotosDB objects"""

    library_a: PhotosDB
    library_b: PhotosDB
    in_a_not_b: list[PhotoInfo]
    in_b_not_a: list[PhotoInfo]
    in_both_same: list[tuple[PhotoInfo, PhotoInfo]]
    in_both_different: list[tuple[PhotoInfo, PhotoInfo, Any]]
    signature: Callable[[PhotoInfo], Any] = photo_signature

This class also the following methods:

asdict(): return dict representation of the diff
json(self, indent=2): return JSON representation of the diff
csv(self, delimiter=",") -> str: return CSV representation of the diff

bool(PhotosDBDiff()) returns True if there are any differences between the libraries.

Utility Functions¶

The following functions are located in osxphotos.utils

`get_system_library_path()`¶

MacOS 10.15 Only Returns path to System Photo Library as string. On MacOS version < 10.15, returns None.

`get_last_library_path()`¶

Returns path to last opened Photo Library as string.

`list_photo_libraries()`¶

Returns list of Photos libraries found on the system. Note: On MacOS 10.15, this appears to list all libraries. On older systems, it may not find some libraries if they are not located in ~/Pictures. Provided for convenience but do not rely on this to find all libraries on the system.

Additional Examples¶

import osxphotos

def main():

    photosdb = osxphotos.PhotosDB("/Users/smith/Pictures/Photos Library.photoslibrary")
    print(f"db file = {photosdb.db_path}")
    print(f"db version = {photosdb.db_version}")

    print(photosdb.keywords)
    print(photosdb.persons)
    print(photosdb.albums)

    print(photosdb.keywords_as_dict)
    print(photosdb.persons_as_dict)
    print(photosdb.albums_as_dict)

    # find all photos with Keyword = Kids and containing person Katie
    photos = photosdb.photos(keywords=["Kids"], persons=["Katie"])
    print(f"found {len(photos)} photos")

    # find all photos that include Katie but do not contain the keyword wedding
    photos = [
        p
        for p in photosdb.photos(persons=["Katie"])
        if p not in photosdb.photos(keywords=["wedding"])
    ]

    # get all photos in the database
    photos = photosdb.photos()
    for p in photos:
        print(
            p.uuid,
            p.filename,
            p.date,
            p.description,
            p.title,
            p.keywords,
            p.albums,
            p.persons,
            p.path,
            p.ismissing,
            p.hasadjustments,
        )


if __name__ == "__main__":
    main()

OSXPhotos Python API¶

Table of Contents¶

Example uses of the Python package¶

Print filename, date created, title, and keywords for all photos in a library¶

Building simple command line tools¶

Concurrency¶

Calling CLI commands from Python¶

Package Interface¶

Read a Photos library database¶

Open the default (last opened) Photos library¶

Open System Photos library¶

Open a specific Photos library¶

albums_shared¶

keywords_as_dict¶

keywords_without_photo¶

persons_as_dict¶

albums_as_dict¶

albums_shared_as_dict¶

labels_as_dict¶

labels_normalized_as_dict¶

library_path¶

db_path¶

db_version¶

photos_version¶

get_db_connection()¶

execute(sql)¶

QueryOptions¶

Attributes¶

uuid¶

filename¶

original_filename¶

date¶

date_added¶

date_modified¶

description¶

title¶

keywords¶

albums¶

album_info¶

import_info¶

project_info¶

persons¶

path¶

path_edited¶

path_derivatives¶

path_raw¶

has_raw¶

israw¶

raw_original¶

height¶

width¶

orientation¶

original_height¶

original_width¶

original_orientation¶

original_filesize¶

ismissing¶

hasadjustments¶

adjustments¶

external_edit¶

favorite¶

flagged¶

rating¶

hidden¶

visible¶

intrash¶

date_trashed¶

location¶

latitude¶

longitude¶

place¶

shared¶

owner¶

comments¶

likes¶

isreference¶

isphoto¶

ismovie¶

iscloudasset¶

incloud¶

`albums_shared`¶

`keywords_as_dict`¶

`keywords_without_photo`¶

`persons_as_dict`¶

`albums_as_dict`¶

`albums_shared_as_dict`¶

`labels_as_dict`¶

`labels_normalized_as_dict`¶

`library_path`¶

`db_path`¶

`db_version`¶

`photos_version`¶

`get_db_connection()`¶

`execute(sql)`¶

`uuid`¶

`filename`¶

`original_filename`¶

`date`¶

`date_added`¶

`date_modified`¶

`description`¶

`title`¶

`keywords`¶

`albums`¶

`album_info`¶

`import_info`¶

`project_info`¶

`persons`¶

`path`¶

`path_edited`¶

`path_derivatives`¶

`path_raw`¶

`has_raw`¶

`israw`¶

`raw_original`¶

`height`¶

`width`¶

`orientation`¶

`original_height`¶

`original_width`¶

`original_orientation`¶

`original_filesize`¶

`ismissing`¶

`hasadjustments`¶

`adjustments`¶

`external_edit`¶

`favorite`¶

`flagged`¶

`rating`¶

`hidden`¶

`visible`¶

`intrash`¶

`date_trashed`¶

`location`¶

`latitude`¶

`longitude`¶

`place`¶

`shared`¶

`owner`¶

`comments`¶

`likes`¶

`isreference`¶

`isphoto`¶

`ismovie`¶

`iscloudasset`¶

`incloud`¶

`syndicated`¶

`saved_to_library`¶

`shared_moment`¶

`shared_library`¶

`share_participant_info`¶

`share_participants`¶

`uti`¶

`uti_original`¶

`uti_edited`¶

`uti_raw`¶

`burst`¶

`burst_selected`¶

`burst_key`¶

`burst_default_pick`¶