1434 lines
121 KiB
HTML
1434 lines
121 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>osxphotos package — osxphotos 0.42.83 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="prev" title="osxphotos command line interface (CLI)" href="cli.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<div class="section" id="osxphotos-package">
|
||
<h1>osxphotos package<a class="headerlink" href="#osxphotos-package" title="Permalink to this headline">¶</a></h1>
|
||
<div class="section" id="osxphotos-module">
|
||
<h2>osxphotos module<a class="headerlink" href="#osxphotos-module" title="Permalink to this headline">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotosDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbfile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Processes a Photos.app library database to extract information about photos</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.album_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">album_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.album_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of AlbumInfo objects for each album in the photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.album_info_shared">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">album_info_shared</span></span><a class="headerlink" href="#osxphotos.PhotosDB.album_info_shared" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of AlbumInfo objects for each shared album in the photos database
|
||
only valid for Photos 5; on Photos <= 4, prints warning and returns empty list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">albums</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of albums found in photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">albums_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return albums as dict of albums, count in reverse sorted order (descending)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_shared">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">albums_shared</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_shared" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of shared albums found in photos database
|
||
only valid for Photos 5; on Photos <= 4, prints warning and returns empty list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_shared_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">albums_shared_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_shared_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns shared albums as dict of albums, count in reverse sorted order (descending)
|
||
valid only on Photos 5; on Photos <= 4, prints warning and returns empty dict</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.db_path">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">db_path</span></span><a class="headerlink" href="#osxphotos.PhotosDB.db_path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns path to the Photos library database PhotosDB was initialized with</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.db_version">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">db_version</span></span><a class="headerlink" href="#osxphotos.PhotosDB.db_version" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return the database version as stored in LiGlobals table</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.folder_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">folder_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.folder_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list FolderInfo objects representing top-level folders in the photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.folders">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">folders</span></span><a class="headerlink" href="#osxphotos.PhotosDB.folders" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of top-level folder names in the photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.get_db_connection">
|
||
<span class="sig-name descname"><span class="pre">get_db_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.get_db_connection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.get_db_connection" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Get connection to the working copy of the Photos database</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>tuple of (connection, cursor) to sqlite3 database</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.get_photo">
|
||
<span class="sig-name descname"><span class="pre">get_photo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.get_photo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.get_photo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a single photo matching uuid</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>uuid</strong> – the UUID of photo to get</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>PhotoInfo instance for photo with UUID matching uuid or None if no match</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.import_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">import_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.import_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of ImportInfo objects for each import session in the database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.keywords">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">keywords</span></span><a class="headerlink" href="#osxphotos.PhotosDB.keywords" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of keywords found in photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.keywords_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">keywords_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.keywords_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return keywords as dict of keyword, count in reverse sorted order (descending)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of all search info labels found in the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>count in reverse sorted order (descending)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>return labels as dict of label</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_normalized">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels_normalized</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_normalized" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of all normalized search info labels found in the library</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_normalized_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels_normalized_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_normalized_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>count in reverse sorted order (descending)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>return normalized labels as dict of label</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.library_path">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">library_path</span></span><a class="headerlink" href="#osxphotos.PhotosDB.library_path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns path to the Photos library PhotosDB was initialized with</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.person_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">person_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.person_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of PersonInfo objects for each person in the photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.persons">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">persons</span></span><a class="headerlink" href="#osxphotos.PhotosDB.persons" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of persons found in photos database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.persons_as_dict">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">persons_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.persons_as_dict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return persons as dict of person, count in reverse sorted order (descending)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.photos">
|
||
<span class="sig-name descname"><span class="pre">photos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persons</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">albums</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">images</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">movies</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_date</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intrash</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.photos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.photos" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return a list of PhotoInfo objects
|
||
If called with no args, returns the entire database of photos
|
||
If called with args, returns photos matching the args (e.g. keywords, persons, etc.)
|
||
If more than one arg, returns photos matching all the criteria (e.g. keywords AND persons)
|
||
If more than one keyword, uuid, persons, albums is passed, they are treated as “OR” criteria
|
||
e.g. keywords=[“wedding”,”vacation”] returns photos matching either keyword
|
||
from_date and to_date may be either naive or timezone-aware datetime.datetime objects.
|
||
If naive, timezone will be assumed to be local timezone.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>keywords</strong> – list of keywords to search for</p></li>
|
||
<li><p><strong>uuid</strong> – list of UUIDs to search for</p></li>
|
||
<li><p><strong>persons</strong> – list of persons to search for</p></li>
|
||
<li><p><strong>albums</strong> – list of album names to search for</p></li>
|
||
<li><p><strong>images</strong> – if True, returns image files, if False, does not return images; default is True</p></li>
|
||
<li><p><strong>movies</strong> – if True, returns movie files, if False, does not return movies; default is True</p></li>
|
||
<li><p><strong>from_date</strong> – return photos with creation date >= from_date (datetime.datetime object, default None)</p></li>
|
||
<li><p><strong>to_date</strong> – return photos with creation date <= to_date (datetime.datetime object, default None)</p></li>
|
||
<li><p><strong>intrash</strong> – if True, returns only images in “Recently deleted items” folder,
|
||
if False returns only photos that aren’t deleted; default is False</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>list of PhotoInfo objects</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.photos_by_uuid">
|
||
<span class="sig-name descname"><span class="pre">photos_by_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuids</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.photos_by_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.photos_by_uuid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>Returns a list of photos with UUID in uuids.</dt><dd><p>Does not generate error if invalid or missing UUID passed.
|
||
This is faster than using PhotosDB.photos if you have list of UUIDs.
|
||
Returns photos regardless of intrash state.</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>uuid</strong> – list of UUIDs of photos to get</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>list of PhotoInfo instance for photo with UUID matching uuid or [] if no match</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.query">
|
||
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">osxphotos.queryoptions.QueryOptions</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.photoinfo.PhotoInfo"><span class="pre">osxphotos.photoinfo.photoinfo.PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.query" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Run a query against PhotosDB to extract the photos based on user supplied options</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>options</strong> – a QueryOptions instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo/photoinfo.html#PhotoInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Info about a specific photo, contains all the details about the photo
|
||
including keywords, persons, albums, uuid, path, etc.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">ExifInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flash_fired</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iso</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metering_mode</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">track_format</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">white_balance</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aperture</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bit_rate</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exposure_bias</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">focal_length</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fps</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">latitude</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">longitude</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutter_speed</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_make</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_model</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">codec</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lens_model</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>EXIF info associated with a photo from the Photos library</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.aperture">
|
||
<span class="sig-name descname"><span class="pre">aperture</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.aperture" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.bit_rate">
|
||
<span class="sig-name descname"><span class="pre">bit_rate</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.bit_rate" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.camera_make">
|
||
<span class="sig-name descname"><span class="pre">camera_make</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.camera_make" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.camera_model">
|
||
<span class="sig-name descname"><span class="pre">camera_model</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.camera_model" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.codec">
|
||
<span class="sig-name descname"><span class="pre">codec</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.codec" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.duration">
|
||
<span class="sig-name descname"><span class="pre">duration</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.duration" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.exposure_bias">
|
||
<span class="sig-name descname"><span class="pre">exposure_bias</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.exposure_bias" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.flash_fired">
|
||
<span class="sig-name descname"><span class="pre">flash_fired</span></span><em class="property"><span class="pre">:</span> <span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.flash_fired" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.focal_length">
|
||
<span class="sig-name descname"><span class="pre">focal_length</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.focal_length" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.fps">
|
||
<span class="sig-name descname"><span class="pre">fps</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.fps" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.iso">
|
||
<span class="sig-name descname"><span class="pre">iso</span></span><em class="property"><span class="pre">:</span> <span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.iso" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.latitude">
|
||
<span class="sig-name descname"><span class="pre">latitude</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.latitude" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.lens_model">
|
||
<span class="sig-name descname"><span class="pre">lens_model</span></span><em class="property"><span class="pre">:</span> <span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.lens_model" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.longitude">
|
||
<span class="sig-name descname"><span class="pre">longitude</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.longitude" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.metering_mode">
|
||
<span class="sig-name descname"><span class="pre">metering_mode</span></span><em class="property"><span class="pre">:</span> <span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.metering_mode" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.sample_rate">
|
||
<span class="sig-name descname"><span class="pre">sample_rate</span></span><em class="property"><span class="pre">:</span> <span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.sample_rate" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.shutter_speed">
|
||
<span class="sig-name descname"><span class="pre">shutter_speed</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.shutter_speed" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.track_format">
|
||
<span class="sig-name descname"><span class="pre">track_format</span></span><em class="property"><span class="pre">:</span> <span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.track_format" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExifInfo.white_balance">
|
||
<span class="sig-name descname"><span class="pre">white_balance</span></span><em class="property"><span class="pre">:</span> <span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ExifInfo.white_balance" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExportResults">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">ExportResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">exported</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exif_updated</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">touched</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">converted_to_jpeg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json_written</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json_skipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool_written</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool_skipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp_written</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp_skipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_warning</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_error</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xattr_written</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xattr_skipped</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_files</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_directories</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exported_album</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped_album</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing_album</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.ExportResults" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>holds export results for export2</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ExportResults.all_files">
|
||
<span class="sig-name descname"><span class="pre">all_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.ExportResults.all_files" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return all filenames contained in results</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">ScoreInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">overall</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curation</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">promotion</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">highlight_visibility</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">behavioral</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failure</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">harmonious_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">immersiveness</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interaction</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interesting_subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intrusive_object_presence</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lively_color</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">low_light</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_camera_tilt</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_composition</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_lighting</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_pattern</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_perspective</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_post_processing</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_reflection</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_symmetry</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharply_focused_subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tastefully_blurred</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_chosen_subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_framed_subject</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_timed_shot</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Computed photo score info associated with a photo from the Photos library</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.behavioral">
|
||
<span class="sig-name descname"><span class="pre">behavioral</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.behavioral" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.curation">
|
||
<span class="sig-name descname"><span class="pre">curation</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.curation" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.failure">
|
||
<span class="sig-name descname"><span class="pre">failure</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.failure" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.harmonious_color">
|
||
<span class="sig-name descname"><span class="pre">harmonious_color</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.harmonious_color" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.highlight_visibility">
|
||
<span class="sig-name descname"><span class="pre">highlight_visibility</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.highlight_visibility" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.immersiveness">
|
||
<span class="sig-name descname"><span class="pre">immersiveness</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.immersiveness" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.interaction">
|
||
<span class="sig-name descname"><span class="pre">interaction</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.interaction" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.interesting_subject">
|
||
<span class="sig-name descname"><span class="pre">interesting_subject</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.interesting_subject" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.intrusive_object_presence">
|
||
<span class="sig-name descname"><span class="pre">intrusive_object_presence</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.intrusive_object_presence" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.lively_color">
|
||
<span class="sig-name descname"><span class="pre">lively_color</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.lively_color" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.low_light">
|
||
<span class="sig-name descname"><span class="pre">low_light</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.low_light" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.noise">
|
||
<span class="sig-name descname"><span class="pre">noise</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.noise" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.overall">
|
||
<span class="sig-name descname"><span class="pre">overall</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.overall" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_camera_tilt">
|
||
<span class="sig-name descname"><span class="pre">pleasant_camera_tilt</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_camera_tilt" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_composition">
|
||
<span class="sig-name descname"><span class="pre">pleasant_composition</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_composition" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_lighting">
|
||
<span class="sig-name descname"><span class="pre">pleasant_lighting</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_lighting" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_pattern">
|
||
<span class="sig-name descname"><span class="pre">pleasant_pattern</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_pattern" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_perspective">
|
||
<span class="sig-name descname"><span class="pre">pleasant_perspective</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_perspective" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_post_processing">
|
||
<span class="sig-name descname"><span class="pre">pleasant_post_processing</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_post_processing" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_reflection">
|
||
<span class="sig-name descname"><span class="pre">pleasant_reflection</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_reflection" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.pleasant_symmetry">
|
||
<span class="sig-name descname"><span class="pre">pleasant_symmetry</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.pleasant_symmetry" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.promotion">
|
||
<span class="sig-name descname"><span class="pre">promotion</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.promotion" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.sharply_focused_subject">
|
||
<span class="sig-name descname"><span class="pre">sharply_focused_subject</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.sharply_focused_subject" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.tastefully_blurred">
|
||
<span class="sig-name descname"><span class="pre">tastefully_blurred</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.tastefully_blurred" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.well_chosen_subject">
|
||
<span class="sig-name descname"><span class="pre">well_chosen_subject</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.well_chosen_subject" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.well_framed_subject">
|
||
<span class="sig-name descname"><span class="pre">well_framed_subject</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.well_framed_subject" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ScoreInfo.well_timed_shot">
|
||
<span class="sig-name descname"><span class="pre">well_timed_shot</span></span><em class="property"><span class="pre">:</span> <span class="pre">float</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ScoreInfo.well_timed_shot" title="Permalink to this definition">¶</a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo">
|
||
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">SearchInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Info about search terms such as machine learning labels that Photos knows about a photo</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.activities">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">activities</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.activities" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of activity names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.all">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">all</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.all" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return all search info properties in a single list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.asdict">
|
||
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.asdict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return dict of search info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.bodies_of_water">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">bodies_of_water</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.bodies_of_water" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of body of water names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.city">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">city</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.city" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns city/town</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.country">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">country</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.country" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns country name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.holidays">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">holidays</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.holidays" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of holiday names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.labels">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.labels" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of labels associated with Photo</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.locality_names">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">locality_names</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.locality_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of other locality names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.media_types">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">media_types</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.media_types" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of media types (photo, video, panorama, etc)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.month">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">month</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.month" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns month name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.neighborhoods">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">neighborhoods</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.neighborhoods" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of neighborhoods</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.place_names">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">place_names</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.place_names" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of place names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.season">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">season</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.season" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns season name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.state">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">state</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.state" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns state name</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.state_abbreviation">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">state_abbreviation</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.state_abbreviation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns state abbreviation</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.streets">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">streets</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.streets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of street names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.venue_types">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">venue_types</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.venue_types" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of venue types</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.venues">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">venues</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.venues" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of venue names</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.SearchInfo.year">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">year</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.SearchInfo.year" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns year</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.adjustments">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">adjustments</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.adjustments" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns AdjustmentsInfo class for adjustment data or None if no adjustments; Photos 5+ only</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.album_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">album_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.album_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of AlbumInfo objects representing albums the photo is contained in</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.albums">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">albums</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.albums" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of albums picture is contained in</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.asdict">
|
||
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo/photoinfo.html#PhotoInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.asdict" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return dict representation</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is part of a Burst photo set, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_album_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_album_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_album_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If photo is a burst photo, returns list of AlbumInfo objects representing albums the photo is contained in as well as albums the burst key photo is contained in, otherwise returns self.album_info.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_albums">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_albums</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_albums" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If photo is burst photo, list of albums it is contained in as well as any albums the key photo is contained in, otherwise returns self.albums</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_default_pick">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_default_pick</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_default_pick" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_key">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_key</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_key" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>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</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_photos">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_photos</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_photos" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If photo is a burst photo, returns list of PhotoInfo objects
|
||
that are part of the same burst photo set; otherwise returns empty list.
|
||
self is not included in the returned list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_selected">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">burst_selected</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.burst_selected" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a burst photo and has been selected from the burst set by the user, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.comments">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">comments</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.comments" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns list of Comment objects for any comments on the photo (sorted by date)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">date</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.date" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>image creation date as timezone aware datetime object</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_added">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">date_added</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.date_added" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Date photo was added to the database</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_modified">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">date_modified</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.date_modified" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>image modification date as timezone aware datetime object
|
||
or None if no modification date set</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_trashed">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">date_trashed</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.date_trashed" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Date asset was placed in the trash or None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.description">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.description" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>long / extended description of picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.detected_text">
|
||
<span class="sig-name descname"><span class="pre">detected_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confidence_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.75</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo/photoinfo.html#PhotoInfo.detected_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.detected_text" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Detects text in photo and returns lists of results as (detected text, confidence)</p>
|
||
<p>confidence_threshold: float between 0.0 and 1.0. If text detection confidence is below this threshold,
|
||
text will not be returned. Default is TEXT_DETECTION_CONFIDENCE_THRESHOLD</p>
|
||
<p>If photo is edited, uses the edited photo, otherwise the original; falls back to the preview image if neither edited or original is available</p>
|
||
<p>Returns: list of (detected text, confidence) tuples</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.duplicates">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">duplicates</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.duplicates" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return list of PhotoInfo objects for possible duplicates (matching signature of original size, date, height, width) or empty list if no matching duplicates</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.exif_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">exif_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.exif_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns an ExifInfo object with the EXIF data for photo
|
||
Note: the returned EXIF data is the data Photos stores in the database on import;
|
||
ExifInfo does not provide access to the EXIF info in the actual image file
|
||
Some or all of the fields may be None
|
||
Only valid for Photos 5; on earlier database returns None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.exiftool">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">exiftool</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.exiftool" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
|
||
Requires that exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) be installed
|
||
If exiftool not installed, logs warning and returns None
|
||
If photo path is missing, returns None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.export">
|
||
<span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live_photo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_photo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_as_hardlink</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">increment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_photos_export</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">120</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_albums_as_keywords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_persons_as_keywords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">render_options</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">osxphotos.phototemplate.RenderOptions</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.export" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>export photo
|
||
dest: must be valid destination path (or exception raised)
|
||
filename: (optional): name of exported picture; if not provided, will use current filename</p>
|
||
<blockquote>
|
||
<div><p><strong>NOTE</strong>: if provided, user must ensure file extension (suffix) is correct.
|
||
For example, if photo is .CR2 file, edited image may be .jpeg.
|
||
If you provide an extension different than what the actual file is,
|
||
export will print a warning but will export the photo using the
|
||
incorrect file extension (unless use_photos_export is true, in which case export will
|
||
use the extension provided by Photos upon export; in this case, an incorrect extension is
|
||
silently ignored).
|
||
e.g. to get the extension of the edited photo,
|
||
reference PhotoInfo.path_edited</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>edited: (boolean, default=False); if True will export the edited version of the photo, otherwise exports the original version</dt><dd><p>(or raise exception if no edited version)</p>
|
||
</dd>
|
||
</dl>
|
||
<p>live_photo: (boolean, default=False); if True, will also export the associated .mov for live photos
|
||
raw_photo: (boolean, default=False); if True, will also export the associated RAW photo
|
||
export_as_hardlink: (boolean, default=False); if True, will hardlink files instead of copying them
|
||
overwrite: (boolean, default=False); if True will overwrite files if they already exist
|
||
increment: (boolean, default=True); if True, will increment file name until a non-existant name is found</p>
|
||
<blockquote>
|
||
<div><p>if overwrite=False and increment=False, export will fail if destination file already exists</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>sidecar_json: if set will write a json sidecar with data in format readable by exiftool</dt><dd><p>sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. <cite>exiftool -G -j</cite>)</p>
|
||
</dd>
|
||
<dt>sidecar_exiftool: if set will write a json sidecar with data in format readable by exiftool</dt><dd><p>sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. <cite>exiftool -j</cite>)</p>
|
||
</dd>
|
||
<dt>sidecar_xmp: if set will write an XMP sidecar with IPTC data</dt><dd><p>sidecar filename will be dest/filename.xmp</p>
|
||
</dd>
|
||
</dl>
|
||
<p>use_photos_export: (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos
|
||
timeout: (int, default=120) timeout in seconds used with use_photos_export
|
||
exiftool: (boolean, default = False); if True, will use exiftool to write metadata to export file
|
||
returns list of full paths to the exported files
|
||
use_albums_as_keywords: (boolean, default = False); if True, will include album names in keywords
|
||
when exporting metadata with exiftool or sidecar
|
||
use_persons_as_keywords: (boolean, default = False); if True, will include person names in keywords
|
||
when exporting metadata with exiftool or sidecar
|
||
keyword_template: (list of strings); list of template strings that will be rendered as used as keywords
|
||
description_template: string; optional template string that will be rendered for use as photo description
|
||
render_options: an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer</p>
|
||
<p>Returns: list of photos exported</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.export2">
|
||
<span class="sig-name descname"><span class="pre">export2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">dest</span></em>, <em class="sig-param"><span class="pre">original=True</span></em>, <em class="sig-param"><span class="pre">original_filename=None</span></em>, <em class="sig-param"><span class="pre">edited=False</span></em>, <em class="sig-param"><span class="pre">edited_filename=None</span></em>, <em class="sig-param"><span class="pre">live_photo=False</span></em>, <em class="sig-param"><span class="pre">raw_photo=False</span></em>, <em class="sig-param"><span class="pre">export_as_hardlink=False</span></em>, <em class="sig-param"><span class="pre">overwrite=False</span></em>, <em class="sig-param"><span class="pre">increment=True</span></em>, <em class="sig-param"><span class="pre">sidecar=0</span></em>, <em class="sig-param"><span class="pre">sidecar_drop_ext=False</span></em>, <em class="sig-param"><span class="pre">use_photos_export=False</span></em>, <em class="sig-param"><span class="pre">timeout=120</span></em>, <em class="sig-param"><span class="pre">exiftool=False</span></em>, <em class="sig-param"><span class="pre">use_albums_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">use_persons_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">keyword_template=None</span></em>, <em class="sig-param"><span class="pre">description_template=None</span></em>, <em class="sig-param"><span class="pre">update=False</span></em>, <em class="sig-param"><span class="pre">ignore_signature=False</span></em>, <em class="sig-param"><span class="pre">export_db=None</span></em>, <em class="sig-param"><span class="pre">fileutil=<class</span> <span class="pre">'osxphotos.fileutil.FileUtil'></span></em>, <em class="sig-param"><span class="pre">dry_run=False</span></em>, <em class="sig-param"><span class="pre">touch_file=False</span></em>, <em class="sig-param"><span class="pre">convert_to_jpeg=False</span></em>, <em class="sig-param"><span class="pre">jpeg_quality=1.0</span></em>, <em class="sig-param"><span class="pre">ignore_date_modified=False</span></em>, <em class="sig-param"><span class="pre">use_photokit=False</span></em>, <em class="sig-param"><span class="pre">verbose=None</span></em>, <em class="sig-param"><span class="pre">exiftool_flags=None</span></em>, <em class="sig-param"><span class="pre">merge_exif_keywords=False</span></em>, <em class="sig-param"><span class="pre">merge_exif_persons=False</span></em>, <em class="sig-param"><span class="pre">jpeg_ext=None</span></em>, <em class="sig-param"><span class="pre">persons=True</span></em>, <em class="sig-param"><span class="pre">location=True</span></em>, <em class="sig-param"><span class="pre">replace_keywords=False</span></em>, <em class="sig-param"><span class="pre">preview=False</span></em>, <em class="sig-param"><span class="pre">preview_suffix='_preview'</span></em>, <em class="sig-param"><span class="pre">render_options:</span> <span class="pre">Optional[osxphotos.phototemplate.RenderOptions]</span> <span class="pre">=</span> <span class="pre">None</span></em>, <em class="sig-param"><span class="pre">strip=False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.export2" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>export photo, like export but with update and dry_run options
|
||
dest: must be valid destination path or exception raised
|
||
filename: (optional): name of exported picture; if not provided, will use current filename</p>
|
||
<blockquote>
|
||
<div><p><strong>NOTE</strong>: 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,
|
||
will export the photo using the incorrect file extension (unless use_photos_export is true,
|
||
in which case export will use the extension provided by Photos upon export.
|
||
e.g. to get the extension of the edited photo,
|
||
reference PhotoInfo.path_edited</p>
|
||
</div></blockquote>
|
||
<p>original: (boolean, default=True); if True, will export the original version of the photo
|
||
edited: (boolean, default=False); if True will export the edited version of the photo
|
||
live_photo: (boolean, default=False); if True, will also export the associated .mov for live photos
|
||
raw_photo: (boolean, default=False); if True, will also export the associated RAW photo
|
||
export_as_hardlink: (boolean, default=False); if True, will hardlink files instead of copying them
|
||
overwrite: (boolean, default=False); if True will overwrite files if they already exist
|
||
increment: (boolean, default=True); if True, will increment file name until a non-existant name is found</p>
|
||
<blockquote>
|
||
<div><p>if overwrite=False and increment=False, export will fail if destination file already exists</p>
|
||
</div></blockquote>
|
||
<dl class="simple">
|
||
<dt>sidecar: bit field: set to one or more of SIDECAR_XMP, SIDECAR_JSON, SIDECAR_EXIFTOOL</dt><dd><dl class="simple">
|
||
<dt>SIDECAR_JSON: if set will write a json sidecar with data in format readable by exiftool</dt><dd><p>sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. <cite>exiftool -G -j</cite>)</p>
|
||
</dd>
|
||
<dt>SIDECAR_EXIFTOOL: if set will write a json sidecar with data in format readable by exiftool</dt><dd><p>sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. <cite>exiftool -j</cite>)</p>
|
||
</dd>
|
||
<dt>SIDECAR_XMP: if set will write an XMP sidecar with IPTC data</dt><dd><p>sidecar filename will be dest/filename.xmp</p>
|
||
</dd>
|
||
</dl>
|
||
</dd>
|
||
</dl>
|
||
<p>sidecar_drop_ext: (boolean, default=False); if True, drops the photo’s extension from sidecar filename (e.g. ‘IMG_1234.json’ instead of ‘IMG_1234.JPG.json’)
|
||
use_photos_export: (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos
|
||
timeout: (int, default=120) timeout in seconds used with use_photos_export
|
||
exiftool: (boolean, default = False); if True, will use exiftool to write metadata to export file
|
||
use_albums_as_keywords: (boolean, default = False); if True, will include album names in keywords
|
||
when exporting metadata with exiftool or sidecar
|
||
use_persons_as_keywords: (boolean, default = False); if True, will include person names in keywords
|
||
when exporting metadata with exiftool or sidecar
|
||
keyword_template: (list of strings); list of template strings that will be rendered as used as keywords
|
||
description_template: string; optional template string that will be rendered for use as photo description
|
||
update: (boolean, default=False); if True export will run in update mode, that is, it will</p>
|
||
<blockquote>
|
||
<div><p>not export the photo if the current version already exists in the destination</p>
|
||
</div></blockquote>
|
||
<p>ignore_signature: (bool, default=False), ignore file signature when used with update (look only at filename)
|
||
export_db: (ExportDB_ABC); instance of a class that conforms to ExportDB_ABC with methods</p>
|
||
<blockquote>
|
||
<div><p>for getting/setting data related to exported files to compare update state</p>
|
||
</div></blockquote>
|
||
<p>fileutil: (FileUtilABC); class that conforms to FileUtilABC with various file utilities
|
||
dry_run: (boolean, default=False); set to True to run in “dry run” mode
|
||
touch_file: (boolean, default=False); if True, sets file’s modification time upon photo date
|
||
convert_to_jpeg: boolean; if True, converts non-jpeg images to jpeg
|
||
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.
|
||
ignore_date_modified: for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set
|
||
verbose: optional callable function to use for printing verbose text during processing; if None (default), does not print output.
|
||
exiftool_flags: optional list of flags to pass to exiftool when using exiftool option, e.g [“-m”, “-F”]
|
||
merge_exif_keywords: boolean; if True, merged keywords found in file’s exif data (requires exiftool)
|
||
merge_exif_persons: boolean; if True, merged persons found in file’s exif data (requires exiftool)
|
||
jpeg_ext: 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 “.”
|
||
persons: if True, include persons in exported metadata
|
||
location: if True, include location in exported metadata
|
||
replace_keywords: if True, keyword_template replaces any keywords, otherwise it’s additive
|
||
preview: if True, also exports preview image
|
||
preview_suffix: optional string to append to end of filename for preview images
|
||
render_options: optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates
|
||
strip: if True, strip whitespace from rendered templates</p>
|
||
<dl class="simple">
|
||
<dt>Returns: ExportResults class</dt><dd><p>ExportResults has attributes:
|
||
“exported”,
|
||
“new”,
|
||
“updated”,
|
||
“skipped”,
|
||
“exif_updated”,
|
||
“touched”,
|
||
“converted_to_jpeg”,
|
||
“sidecar_json_written”,
|
||
“sidecar_json_skipped”,
|
||
“sidecar_exiftool_written”,
|
||
“sidecar_exiftool_skipped”,
|
||
“sidecar_xmp_written”,
|
||
“sidecar_xmp_skipped”,
|
||
“missing”,
|
||
“error”,
|
||
“error_str”,
|
||
“exiftool_warning”,
|
||
“exiftool_error”,</p>
|
||
</dd>
|
||
<dt>Note: to use dry run mode, you must set dry_run=True and also pass in memory version of export_db,</dt><dd><p>and no-op fileutil (e.g. ExportDBInMemory and FileUtilNoOp)</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.external_edit">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">external_edit</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.external_edit" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if picture was edited outside of Photos using external editor</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.face_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">face_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.face_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of FaceInfo objects for faces in picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.favorite">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">favorite</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.favorite" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True if picture is marked as favorite</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.filename">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">filename</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.filename" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>filename of the picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.has_raw">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">has_raw</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.has_raw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns True if photo has an associated raw image (that is, it’s a RAW+JPEG pair), otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hasadjustments">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">hasadjustments</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.hasadjustments" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True if picture has adjustments / edits</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hdr">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">hdr</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.hdr" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is an HDR photo, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.height">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">height</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.height" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns height of the current photo version in pixels</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hidden">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">hidden</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.hidden" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True if picture is hidden</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.import_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">import_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.import_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>ImportInfo object representing import session for the photo or None if no import session</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.incloud">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">incloud</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.incloud" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is cloud asset and is synched to cloud
|
||
False if photo is cloud asset and not yet synched to cloud
|
||
None if photo is not cloud asset</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.intrash">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">intrash</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.intrash" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True if picture is in trash (‘Recently Deleted’ folder)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.iscloudasset">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">iscloudasset</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.iscloudasset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a cloud asset (in an iCloud library),
|
||
otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ismissing">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">ismissing</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.ismissing" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns true if photo is missing from disk (which means it’s not been downloaded from iCloud)
|
||
NOTE: the photos.db database uses an asynchrounous write-ahead log so changes in Photos</p>
|
||
<blockquote>
|
||
<div><p>do not immediately get written to disk. In particular, I’ve noticed that downloading
|
||
an image from the cloud does not force the database to be updated until something else
|
||
e.g. an edit, keyword, etc. occurs forcing a database synch
|
||
The exact process / timing is a mystery to be but be aware that if some photos were recently
|
||
downloaded from cloud to local storate their status in the database might still show
|
||
isMissing = 1</p>
|
||
</div></blockquote>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ismovie">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">ismovie</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.ismovie" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if file is a movie, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.isphoto">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">isphoto</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.isphoto" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if file is an image, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.israw">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">israw</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.israw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns True if photo is a raw image. For images with an associated RAW+JPEG pair, see has_raw</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.isreference">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">isreference</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.isreference" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a reference (not copied to the Photos library), otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.json">
|
||
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo/photoinfo.html#PhotoInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.json" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return JSON representation</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.keywords">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">keywords</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.keywords" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of keywords for picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.labels">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.labels" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns list of labels applied to photo by Photos image categorization
|
||
only valid on Photos 5, on older libraries returns empty list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.labels_normalized">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">labels_normalized</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.labels_normalized" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns normalized list of labels applied to photo by Photos image categorization
|
||
only valid on Photos 5, on older libraries returns empty list</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.likes">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">likes</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.likes" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns list of Like objects for any likes on the photo (sorted by date)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.live_photo">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">live_photo</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.live_photo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a live photo, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.location">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.location" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns (latitude, longitude) as float in degrees or None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.orientation">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">orientation</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.orientation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns EXIF orientation of the current photo version as int or 0 if current orientation cannot be determined</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_filename">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">original_filename</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.original_filename" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>original filename of the picture
|
||
Photos 5 mangles filenames upon import</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_filesize">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">original_filesize</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.original_filesize" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns filesize of original photo in bytes as int</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_height">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">original_height</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.original_height" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns height of the original photo version in pixels</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_orientation">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">original_orientation</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.original_orientation" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns EXIF orientation of the original photo version as int</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_width">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">original_width</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.original_width" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns width of the original photo version in pixels</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.panorama">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">panorama</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.panorama" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a panorama, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>absolute path on disk of the original picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_derivatives">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path_derivatives</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path_derivatives" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_edited">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path_edited</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path_edited" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>absolute path on disk of the edited picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_edited_live_photo">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path_edited_live_photo</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path_edited_live_photo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>return path to edited version of live photo movie; only valid for Photos 5+</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_live_photo">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path_live_photo</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path_live_photo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns path to the associated video file for a live photo
|
||
If photo is not a live photo, returns None
|
||
If photo is missing, returns None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_raw">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">path_raw</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.path_raw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>absolute path of associated RAW image or None if there is not one</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.person_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">person_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.person_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of PersonInfo objects for person in picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.persons">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">persons</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.persons" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>list of persons in picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.place">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">place</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.place" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns PlaceInfo object containing reverse geolocation info</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.portrait">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">portrait</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.portrait" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a portrait, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.raw_original">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">raw_original</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.raw_original" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns True if associated raw image and the raw image is selected in Photos
|
||
via “Use RAW as Original ”
|
||
otherwise returns False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.render_template">
|
||
<span class="sig-name descname"><span class="pre">render_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_str</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">osxphotos.phototemplate.RenderOptions</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo/photoinfo.html#PhotoInfo.render_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.render_template" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Renders a template string for PhotoInfo instance using PhotoTemplate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>template_str</strong> – a template string with fields to render</p></li>
|
||
<li><p><strong>options</strong> – a RenderOptions instance</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>tuple of list of rendered strings and list of unmatched template values</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type</dt>
|
||
<dd class="field-odd"><p>([rendered_strings], [unmatched])</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.score">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">score</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.score" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Computed score information for a photo</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Returns</dt>
|
||
<dd class="field-odd"><p>ScoreInfo instance</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.screenshot">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">screenshot</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.screenshot" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is an HDR photo, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.search_info">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">search_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.search_info" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns SearchInfo object for photo
|
||
only valid on Photos 5, on older libraries, returns None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.search_info_normalized">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">search_info_normalized</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.search_info_normalized" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns SearchInfo object for photo that produces normalized results
|
||
only valid on Photos 5, on older libraries, returns None</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.selfie">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">selfie</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.selfie" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a selfie (front facing camera), otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.shared">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">shared</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.shared" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns True if photos is in a shared iCloud album otherwise false
|
||
Only valid on Photos 5; returns None on older versions</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.slow_mo">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">slow_mo</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.slow_mo" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a slow motion video, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.time_lapse">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">time_lapse</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.time_lapse" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns True if photo is a time lapse video, otherwise False</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.title">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.title" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>name / title of picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.tzoffset">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">tzoffset</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.tzoffset" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>timezone offset from UTC in seconds</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">uti</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.uti" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns Uniform Type Identifier (UTI) for the image
|
||
for example: public.jpeg or com.apple.quicktime-movie</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_edited">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">uti_edited</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.uti_edited" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns Uniform Type Identifier (UTI) for the edited image
|
||
if the photo has been edited, otherwise None;
|
||
for example: public.jpeg</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_original">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">uti_original</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.uti_original" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns Uniform Type Identifier (UTI) for the original image
|
||
for example: public.jpeg or com.apple.quicktime-movie</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_raw">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">uti_raw</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.uti_raw" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns Uniform Type Identifier (UTI) for the RAW image if there is one
|
||
for example: com.canon.cr2-raw-image
|
||
Returns None if no associated RAW image</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uuid">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">uuid</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.uuid" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>UUID of picture</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.visible">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">visible</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.visible" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>True if picture is visble</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.width">
|
||
<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">width</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.width" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>returns width of the current photo version in pixels</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">osxphotos</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="cli.html">osxphotos command line interface (CLI)</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">osxphotos package</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#osxphotos-module">osxphotos module</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="cli.html" title="previous chapter">osxphotos command line interface (CLI)</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2021, Rhet Turnbull.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/reference.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |