2936 lines
292 KiB
HTML
2936 lines
292 KiB
HTML
<!doctype html>
|
||
<html class="no-js">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Example uses of the OSXPhotos python package" href="package_overview.html" />
|
||
|
||
<meta name="generator" content="sphinx-4.4.0, furo 2022.04.07"/>
|
||
<title>OSXPhotos python API - osxphotos 0.47.10 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
|
||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||
|
||
|
||
|
||
|
||
<style>
|
||
body {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: black;
|
||
|
||
}
|
||
@media not print {
|
||
body[data-theme="dark"] {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
@media (prefers-color-scheme: dark) {
|
||
body:not([data-theme="light"]) {
|
||
--color-code-background: #202020;
|
||
--color-code-foreground: #d0d0d0;
|
||
|
||
}
|
||
}
|
||
}
|
||
</style></head>
|
||
<body>
|
||
|
||
<script>
|
||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||
</script>
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
<title>Light mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
<circle cx="12" cy="12" r="5"></circle>
|
||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
<title>Dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
<title>Auto light/dark mode</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
<circle cx="12" cy="12" r="9" />
|
||
<path d="M13 12h5" />
|
||
<path d="M13 15h4" />
|
||
<path d="M13 18h1" />
|
||
<path d="M13 9h4" />
|
||
<path d="M13 6h1" />
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation">
|
||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||
</label>
|
||
<label class="overlay toc-overlay" for="__toc">
|
||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||
</label>
|
||
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<div class="header-left">
|
||
<label class="nav-overlay-icon" for="__navigation">
|
||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<div class="header-center">
|
||
<a href="index.html"><div class="brand">osxphotos 0.47.10 documentation</div></a>
|
||
</div>
|
||
<div class="header-right">
|
||
<div class="theme-toggle-container theme-toggle-header">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||
|
||
|
||
<span class="sidebar-brand-text">osxphotos 0.47.10 documentation</span>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form>
|
||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="overview.html">osxphotos</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">OSXPhotos Tutorial</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="template_help.html">OSXPhotos Template System</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="package_overview.html">Example uses of the OSXPhotos python package</a></li>
|
||
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">OSXPhotos python API</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<div class="main">
|
||
<div class="content">
|
||
<div class="article-container">
|
||
<a href="#" class="back-to-top muted-link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||
</svg>
|
||
<span>Back to top</span>
|
||
</a>
|
||
<div class="content-icon-container"><div class="theme-toggle-container theme-toggle-content">
|
||
<button class="theme-toggle">
|
||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||
</button>
|
||
</div>
|
||
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
|
||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
</div>
|
||
<article role="main">
|
||
<section id="module-osxphotos">
|
||
<span id="osxphotos-python-api"></span><h1>OSXPhotos python API<a class="headerlink" href="#module-osxphotos" title="Permalink to this headline">#</a></h1>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">AlbumInfo</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#AlbumInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Info about a specific Album, contains all the details about the album
|
||
including folders, photos, etc.</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.folder_list">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_list</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.folder_list" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return hierarchical list of folders the album is contained in
|
||
as list of FolderInfo objects in form
|
||
[“Top level folder”, “sub folder 1”, “sub folder 2”, …]
|
||
returns empty list if album is not in any folders</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.folder_names">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_names</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.folder_names" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return hierarchical list of folders the album is contained in
|
||
the folder list is in form:
|
||
[“Top level folder”, “sub folder 1”, “sub folder 2”, …]
|
||
returns empty list if album is not in any folders</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.parent">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.parent" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns FolderInfo object for parent folder or None if no parent (e.g. top-level album)</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.photo_index">
|
||
<span class="sig-name descname"><span class="pre">photo_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#AlbumInfo.photo_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumInfo.photo_index" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return index of photo in album (based on album sort order)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.photos">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return list of photos contained in album sorted in same sort order as Photos</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.sort_order">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sort_order</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.sort_order" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return sort order of album</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return title / name of album</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.AlbumSortOrder">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">AlbumSortOrder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/_constants.html#AlbumSortOrder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumSortOrder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Album Sort Order</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.CommentInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">CommentInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ismine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/_photosdb_process_comments.html#CommentInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.CommentInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Class for shared photo comments</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exifinfo.html#ExifInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>EXIF info associated with a photo from the Photos library</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExifTool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</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>, <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">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</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/exiftool.html#ExifTool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Basic exiftool interface for reading and writing EXIF tags</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.addvalues">
|
||
<span class="sig-name descname"><span class="pre">addvalues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.addvalues"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.addvalues" title="Permalink to this definition">#</a></dt>
|
||
<dd><dl class="simple">
|
||
<dt>Add one or more value(s) to tag</dt><dd><p>If more than one value is passed, each value will be added to the tag</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag</strong> – str; tag to set</p></li>
|
||
<li><p><strong>*values</strong> – str; one or more values to set</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p>True if success otherwise False</p>
|
||
<p>If error generated by exiftool, returns False and sets self.error to error string
|
||
If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
|
||
If called in context manager, returns True (execution is delayed until exiting context manager)</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
<dl class="simple">
|
||
<dt>Notes: exiftool may add duplicate values for some tags so the caller must ensure</dt><dd><p>the values being added are not already in the EXIF data
|
||
For some tags, such as IPTC:Keywords, this will add a new value to the list of keywords,
|
||
but for others, such as EXIF:ISO, this will literally add a value to the existing value.
|
||
It’s up to the caller to know what exiftool will do for each tag
|
||
If setvalue called before addvalues, exiftool does not appear to add duplicates,
|
||
but if addvalues called without first calling setvalue, exiftool will add duplicate values</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.asdict">
|
||
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_groups</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">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="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.asdict" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return dictionary of all EXIF tags and values from exiftool
|
||
returns empty dict if no tags</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag_groups</strong> – if True (default), dict keys have tag groups, e.g. “IPTC:Keywords”; if False, drops groups from keys, e.g. “Keywords”</p></li>
|
||
<li><p><strong>normalized</strong> – if True, dict keys are all normalized to lower case (default is False)</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.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/exiftool.html#ExifTool.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns JSON string containing all EXIF tags and values from exiftool</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.pid">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pid</span></span><a class="headerlink" href="#osxphotos.ExifTool.pid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return process id (PID) of the exiftool process</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.run_commands">
|
||
<span class="sig-name descname"><span class="pre">run_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">commands</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_file</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/exiftool.html#ExifTool.run_commands"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.run_commands" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Run commands in the exiftool process and return result.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>*commands</strong> – exiftool commands to run</p></li>
|
||
<li><p><strong>no_file</strong> – (bool) do not pass the filename to exiftool (default=False)
|
||
by default, all commands will be run against self.file
|
||
use no_file=True to run a command without passing the filename</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>(output, warning, errror)
|
||
output: bytes is containing output of exiftool commands
|
||
warning: if exiftool generated warnings, string containing warning otherwise empty string
|
||
error: if exiftool generated errors, string containing otherwise empty string</p>
|
||
</dd>
|
||
</dl>
|
||
<p>Note: Also sets self.warning and self.error if warning or error generated.</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.setvalue">
|
||
<span class="sig-name descname"><span class="pre">setvalue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.setvalue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.setvalue" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set tag to value(s); if value is None, will delete tag</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>tag</strong> – str; name of tag to set</p></li>
|
||
<li><p><strong>value</strong> – str; value to set tag to</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p><p>True if success otherwise False</p>
|
||
<p>If error generated by exiftool, returns False and sets self.error to error string
|
||
If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
|
||
If called in context manager, returns True (execution is delayed until exiting context manager)</p>
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ExifTool.version">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#osxphotos.ExifTool.version" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns exiftool version</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_dir</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Interface to sqlite3 database used to store state information for osxphotos export command</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.close">
|
||
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.close" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>close the database connection</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.create_file_record">
|
||
<span class="sig-name descname"><span class="pre">create_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">pathlib.Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">osxphotos.export_db.ExportRecord</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.create_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.create_file_record" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>create a new record for filename and uuid</p>
|
||
<p>Returns: an ExportRecord object</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.create_or_get_file_record">
|
||
<span class="sig-name descname"><span class="pre">create_or_get_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">pathlib.Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</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">osxphotos.export_db.ExportRecord</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.create_or_get_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.create_or_get_file_record" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>create a new record for filename and uuid or return existing record</p>
|
||
<p>Returns: an ExportRecord object</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.export_dir">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">export_dir</span></span><a class="headerlink" href="#osxphotos.ExportDB.export_dir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns path to export directory</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_file_record">
|
||
<span class="sig-name descname"><span class="pre">get_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">pathlib.Path</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></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">osxphotos.export_db.ExportRecord</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_file_record" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>get info for filename and uuid</p>
|
||
<p>Returns: an ExportRecord object</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_photoinfo_for_uuid">
|
||
<span class="sig-name descname"><span class="pre">get_photoinfo_for_uuid</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/export_db.html#ExportDB.get_photoinfo_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_photoinfo_for_uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns the photoinfo JSON struct for a UUID</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_previous_uuids">
|
||
<span class="sig-name descname"><span class="pre">get_previous_uuids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_previous_uuids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_previous_uuids" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns list of UUIDs of previously exported photos found in export database</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_uuid_for_file">
|
||
<span class="sig-name descname"><span class="pre">get_uuid_for_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_uuid_for_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_uuid_for_file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>query database for filename and return UUID
|
||
returns None if filename not found in database</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.path">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><a class="headerlink" href="#osxphotos.ExportDB.path" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns path to export database</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_config">
|
||
<span class="sig-name descname"><span class="pre">set_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_config" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>set config in the database</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_photoinfo_for_uuid">
|
||
<span class="sig-name descname"><span class="pre">set_photoinfo_for_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_photoinfo_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_photoinfo_for_uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>sets the photoinfo JSON struct for a UUID</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">convert_to_jpeg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_run</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.ExportDB" title="osxphotos.export_db.ExportDB"><span class="pre">osxphotos.export_db.ExportDB</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">face_regions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileutil</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.FileUtil" title="osxphotos.fileutil.FileUtil"><span class="pre">osxphotos.fileutil.FileUtil</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_date_modified</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_ext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live_photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_exif_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_exif_persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preview_suffix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'_preview'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preview</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</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="w"> </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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_drop_ext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">120</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">touch_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_photokit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmpdir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#ExportOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportOptions" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Options class for exporting photos with export</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.convert_to_jpeg">
|
||
<span class="sig-name descname"><span class="pre">convert_to_jpeg</span></span><a class="headerlink" href="#osxphotos.ExportOptions.convert_to_jpeg" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, converts non-jpeg images to jpeg</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.description_template">
|
||
<span class="sig-name descname"><span class="pre">description_template</span></span><a class="headerlink" href="#osxphotos.ExportOptions.description_template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>t.Optional template string that will be rendered for use as photo description</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.download_missing">
|
||
<span class="sig-name descname"><span class="pre">download_missing</span></span><a class="headerlink" href="#osxphotos.ExportOptions.download_missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=False): if True will attempt to export photo via applescript interaction with Photos if missing (see also use_photokit, use_photos_export)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.dry_run">
|
||
<span class="sig-name descname"><span class="pre">dry_run</span></span><a class="headerlink" href="#osxphotos.ExportOptions.dry_run" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=False): set to True to run in “dry run” mode</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.edited">
|
||
<span class="sig-name descname"><span class="pre">edited</span></span><a class="headerlink" href="#osxphotos.ExportOptions.edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=False): if True will export the edited version of the photo otherwise exports the original version</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.exiftool_flags">
|
||
<span class="sig-name descname"><span class="pre">exiftool_flags</span></span><a class="headerlink" href="#osxphotos.ExportOptions.exiftool_flags" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>t.Optional list of flags to pass to exiftool when using exiftool option, e.g [“-m”, “-F”]</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>list of str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.exiftool">
|
||
<span class="sig-name descname"><span class="pre">exiftool</span></span><a class="headerlink" href="#osxphotos.ExportOptions.exiftool" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default = False): if True, will use exiftool to write metadata to export file</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.export_as_hardlink">
|
||
<span class="sig-name descname"><span class="pre">export_as_hardlink</span></span><a class="headerlink" href="#osxphotos.ExportOptions.export_as_hardlink" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=False): if True, will hardlink files instead of copying them</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.export_db">
|
||
<span class="sig-name descname"><span class="pre">export_db</span></span><a class="headerlink" href="#osxphotos.ExportOptions.export_db" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(ExportDB): instance of a class that conforms to ExportDB with methods for getting/setting data related to exported files to compare update state</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[<a class="reference internal" href="#osxphotos.ExportDB" title="osxphotos.export_db.ExportDB">osxphotos.export_db.ExportDB</a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.face_regions">
|
||
<span class="sig-name descname"><span class="pre">face_regions</span></span><a class="headerlink" href="#osxphotos.ExportOptions.face_regions" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=True): if True, will export face regions</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.fileutil">
|
||
<span class="sig-name descname"><span class="pre">fileutil</span></span><a class="headerlink" href="#osxphotos.ExportOptions.fileutil" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(FileUtilABC): class that conforms to FileUtilABC with various file utilities</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[<a class="reference internal" href="#osxphotos.FileUtil" title="osxphotos.fileutil.FileUtil">osxphotos.fileutil.FileUtil</a>]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.force_update">
|
||
<span class="sig-name descname"><span class="pre">force_update</span></span><a class="headerlink" href="#osxphotos.ExportOptions.force_update" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(bool, default=False): if True, will export photo if any metadata has changed but export otherwise would not be triggered (e.g. metadata changed but not using exiftool)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.ignore_date_modified">
|
||
<span class="sig-name descname"><span class="pre">ignore_date_modified</span></span><a class="headerlink" href="#osxphotos.ExportOptions.ignore_date_modified" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.ignore_signature">
|
||
<span class="sig-name descname"><span class="pre">ignore_signature</span></span><a class="headerlink" href="#osxphotos.ExportOptions.ignore_signature" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>ignore file signature when used with update (look only at filename)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.increment">
|
||
<span class="sig-name descname"><span class="pre">increment</span></span><a class="headerlink" href="#osxphotos.ExportOptions.increment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will increment file name until a non-existant name is found if overwrite=False and increment=False, export will fail if destination file already exists</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=True</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.jpeg_ext">
|
||
<span class="sig-name descname"><span class="pre">jpeg_ext</span></span><a class="headerlink" href="#osxphotos.ExportOptions.jpeg_ext" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>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 “.”</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.jpeg_quality">
|
||
<span class="sig-name descname"><span class="pre">jpeg_quality</span></span><a class="headerlink" href="#osxphotos.ExportOptions.jpeg_quality" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>a value of 1.0 specifies use best quality, a value of 0.0 specifies use maximum compression.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>float in range 0.0 <= jpeg_quality <= 1.0</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.keyword_template">
|
||
<span class="sig-name descname"><span class="pre">keyword_template</span></span><a class="headerlink" href="#osxphotos.ExportOptions.keyword_template" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of template strings that will be rendered as used as keywords</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>list of str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.live_photo">
|
||
<span class="sig-name descname"><span class="pre">live_photo</span></span><a class="headerlink" href="#osxphotos.ExportOptions.live_photo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will also export the associated .mov for live photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.location">
|
||
<span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.ExportOptions.location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, include location in exported metadata</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.merge_exif_keywords">
|
||
<span class="sig-name descname"><span class="pre">merge_exif_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.merge_exif_keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, merged keywords found in file’s exif data (requires exiftool)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.merge_exif_persons">
|
||
<span class="sig-name descname"><span class="pre">merge_exif_persons</span></span><a class="headerlink" href="#osxphotos.ExportOptions.merge_exif_persons" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, merged persons found in file’s exif data (requires exiftool)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.overwrite">
|
||
<span class="sig-name descname"><span class="pre">overwrite</span></span><a class="headerlink" href="#osxphotos.ExportOptions.overwrite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True will overwrite files if they already exist</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.persons">
|
||
<span class="sig-name descname"><span class="pre">persons</span></span><a class="headerlink" href="#osxphotos.ExportOptions.persons" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, include persons in exported metadata</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.preview_suffix">
|
||
<span class="sig-name descname"><span class="pre">preview_suffix</span></span><a class="headerlink" href="#osxphotos.ExportOptions.preview_suffix" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>t.Optional string to append to end of filename for preview images</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.preview">
|
||
<span class="sig-name descname"><span class="pre">preview</span></span><a class="headerlink" href="#osxphotos.ExportOptions.preview" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, also exports preview image</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.raw_photo">
|
||
<span class="sig-name descname"><span class="pre">raw_photo</span></span><a class="headerlink" href="#osxphotos.ExportOptions.raw_photo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will also export the associated RAW photo</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.render_options">
|
||
<span class="sig-name descname"><span class="pre">render_options</span></span><a class="headerlink" href="#osxphotos.ExportOptions.render_options" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>t.Optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>RenderOptions</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.replace_keywords">
|
||
<span class="sig-name descname"><span class="pre">replace_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.replace_keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, keyword_template replaces any keywords, otherwise it’s additive</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.rich">
|
||
<span class="sig-name descname"><span class="pre">rich</span></span><a class="headerlink" href="#osxphotos.ExportOptions.rich" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will use rich markup with verbose output</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.sidecar_drop_ext">
|
||
<span class="sig-name descname"><span class="pre">sidecar_drop_ext</span></span><a class="headerlink" href="#osxphotos.ExportOptions.sidecar_drop_ext" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, drops the photo’s extension from sidecar filename (e.g. ‘IMG_1234.json’ instead of ‘IMG_1234.JPG.json’)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.sidecar">
|
||
<span class="sig-name descname"><span class="pre">sidecar</span></span><a class="headerlink" href="#osxphotos.ExportOptions.sidecar" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>bit field (int): set to one or more of <cite>SIDECAR_XMP</cite>, <cite>SIDECAR_JSON</cite>, <cite>SIDECAR_EXIFTOOL</cite>
|
||
- SIDECAR_JSON: if set will write a json sidecar with data in format readable by exiftool sidecar filename will be dest/filename.json;
|
||
includes exiftool tag group names (e.g. <cite>exiftool -G -j</cite>)
|
||
- SIDECAR_EXIFTOOL: if set will write a json sidecar with data in format readable by exiftool sidecar filename will be dest/filename.json;
|
||
does not include exiftool tag group names (e.g. <cite>exiftool -j</cite>)
|
||
- SIDECAR_XMP: if set will write an XMP sidecar with IPTC data sidecar filename will be dest/filename.xmp</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>int</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.strip">
|
||
<span class="sig-name descname"><span class="pre">strip</span></span><a class="headerlink" href="#osxphotos.ExportOptions.strip" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, strip whitespace from rendered templates</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.timeout">
|
||
<span class="sig-name descname"><span class="pre">timeout</span></span><a class="headerlink" href="#osxphotos.ExportOptions.timeout" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>timeout in seconds used with use_photos_export</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>int, default=120</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.touch_file">
|
||
<span class="sig-name descname"><span class="pre">touch_file</span></span><a class="headerlink" href="#osxphotos.ExportOptions.touch_file" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, sets file’s modification time upon photo date</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.update">
|
||
<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#osxphotos.ExportOptions.update" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True export will run in update mode, that is, it will not export the photo if the current version already exists in the destination</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_albums_as_keywords">
|
||
<span class="sig-name descname"><span class="pre">use_albums_as_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_albums_as_keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will include album names in keywords when exporting metadata with exiftool or sidecar</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default = False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_persons_as_keywords">
|
||
<span class="sig-name descname"><span class="pre">use_persons_as_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_persons_as_keywords" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will include person names in keywords when exporting metadata with exiftool or sidecar</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default = False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_photos_export">
|
||
<span class="sig-name descname"><span class="pre">use_photos_export</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_photos_export" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True will attempt to export photo via applescript interaction with Photos even if not missing (see also use_photokit, download_missing)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_photokit">
|
||
<span class="sig-name descname"><span class="pre">use_photokit</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_photokit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>if True, will use photokit to export photos when use_photos_export is True</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>bool, default=False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.verbose">
|
||
<span class="sig-name descname"><span class="pre">verbose</span></span><a class="headerlink" href="#osxphotos.ExportOptions.verbose" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>optional callable function to use for printing verbose text during processing; if None (default), does not print output.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>callable</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.tmpdir">
|
||
<span class="sig-name descname"><span class="pre">tmpdir</span></span><a class="headerlink" href="#osxphotos.ExportOptions.tmpdir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>(str, default=None): Optional directory to use for temporary files, if None (default) uses system tmp directory</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[str]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportOptions.bit_flags">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bit_flags</span></span><a class="headerlink" href="#osxphotos.ExportOptions.bit_flags" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return bit flags representing options that affect export</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ExportResults">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><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">to_touch</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="reference internal" href="_modules/osxphotos/photoexporter.html#ExportResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportResults" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Results class which holds export results for export</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.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="reference internal" href="_modules/osxphotos/photoexporter.html#ExportResults.all_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.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.FileUtil">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FileUtil</span></span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtil"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtil" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Various file utilities</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FileUtilNoOp</span></span><span class="sig-paren">(</span><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><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>No-Op implementation of FileUtil for testing / dry-run mode
|
||
all methods with exception of tmpdir, cmp, cmp_file_sig and file_cmp are no-op
|
||
cmp and cmp_file_sig functions as FileUtil methods do
|
||
file_cmp returns mock data</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.convert_to_jpeg">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_jpeg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression_quality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.convert_to_jpeg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.convert_to_jpeg" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>converts image file src_file to jpeg format as dest_file</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>src_file</strong> – image file to convert</p></li>
|
||
<li><p><strong>dest_file</strong> – destination path to write converted file to</p></li>
|
||
<li><p><strong>quality</strong> (<em>compression</em>) – JPEG compression quality in range 0.0 <= compression_quality <= 1.0; default 1.0 (best quality)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>True if success, otherwise False</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.copy">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">norsrc</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/fileutil.html#FileUtilNoOp.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.copy" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Copies a file from src path to dest path</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>src</strong> – source path as string; must be a valid file path</p></li>
|
||
<li><p><strong>dest</strong> – destination path as string
|
||
dest may be either directory or file; in either case, src file must not exist in dest</p></li>
|
||
<li><p><strong>Note</strong> – src and dest may be either a string or a pathlib.Path object</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>True if copy succeeded</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>OSError if copy fails</strong> – </p></li>
|
||
<li><p><strong>TypeError if either path is None</strong> – </p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.file_sig">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">file_sig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.file_sig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.file_sig" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return os.stat signature for file f1 as tuple of (mode, size, mtime)</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.hardlink">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hardlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.hardlink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.hardlink" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Hardlinks a file from src path to dest path
|
||
src: source path as string
|
||
dest: destination path as string
|
||
Raises exception if linking fails or either path is None</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.rename">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.rename"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.rename" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Copy src to dest</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>src</strong> – path to source file</p></li>
|
||
<li><p><strong>dest</strong> – path to destination file</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>Name of renamed file (dest)</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.rmdir">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rmdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.rmdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.rmdir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>remove directory filepath; dirpath must be empty</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.tmpdir">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tmpdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</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">tempfile.TemporaryDirectory</span></span></span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.tmpdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.tmpdir" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Securely creates a temporary directory using the same rules as mkdtemp().
|
||
The resulting object can be used as a context manager.
|
||
On completion of the context or destruction of the temporary directory object,
|
||
the newly created temporary directory and all its contents are removed from the filesystem.</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.unlink">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.unlink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.unlink" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>unlink filepath; if it’s pathlib.Path, use Path.unlink, otherwise use os.unlink</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.utime">
|
||
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">utime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">times</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.utime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.utime" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Set the access and modified time of path.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FolderInfo</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#FolderInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FolderInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Info about a specific folder, contains all the details about the folder
|
||
including folders, albums, etc</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo.album_info">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><a class="headerlink" href="#osxphotos.FolderInfo.album_info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return list of albums (as AlbumInfo objects) contained in the folder</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo.parent">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#osxphotos.FolderInfo.parent" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns FolderInfo object for parent or None if no parent (e.g. top-level folder)</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo.subfolders">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subfolders</span></span><a class="headerlink" href="#osxphotos.FolderInfo.subfolders" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return list of folders (as FolderInfo objects) contained in the folder</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.FolderInfo.title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return title / name of folder</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.FolderInfo.uuid">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><a class="headerlink" href="#osxphotos.FolderInfo.uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return uuid of folder</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ImportInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ImportInfo</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#ImportInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ImportInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Information about import sessions</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.ImportInfo.photos">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.ImportInfo.photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return list of photos contained in import session</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.LikeInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">LikeInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ismine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/_photosdb_process_comments.html#LikeInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.LikeInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Class for shared photo likes</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">MomentInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">moment_pk</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/momentinfo.html#MomentInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.MomentInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Info about a photo moment</p>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.date">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Date of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.end_date">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.end_date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Stop date of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.location">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.MomentInfo.location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Location of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.modification_date">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modification_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.modification_date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Modification date of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.photos">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.MomentInfo.photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>All photos in this moment</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.pk">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pk</span></span><a class="headerlink" href="#osxphotos.MomentInfo.pk" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Primary key of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.start_date">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.start_date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Start date of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.subtitle">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subtitle</span></span><a class="headerlink" href="#osxphotos.MomentInfo.subtitle" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Subtitle of the moment.</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.MomentInfo.title">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.MomentInfo.title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Title of the moment.</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PersonInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PersonInfo</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">pk</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/personinfo.html#PersonInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Info about a person in the Photos library</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PersonInfo.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/personinfo.html#PersonInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo.asdict" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns dictionary representation of class instance</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PersonInfo.face_info">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">face_info</span></span><a class="headerlink" href="#osxphotos.PersonInfo.face_info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns a list of FaceInfo objects associated with this person sorted by quality score
|
||
Highest quality face is result[0] and lowest quality face is result[n]</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PersonInfo.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/personinfo.html#PersonInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo.json" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns JSON representation of class instance</p>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PersonInfo.photos">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.PersonInfo.photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Returns list of PhotoInfo objects associated with this person</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoExporter">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoExporter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.PhotoInfo"><span class="pre">PhotoInfo</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmpdir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#PhotoExporter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoExporter" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export a photo</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoExporter.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">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.photoexporter.ExportOptions"><span class="pre">osxphotos.photoexporter.ExportOptions</span></a><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.photoexporter.ExportResults"><span class="pre">osxphotos.photoexporter.ExportResults</span></a></span></span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#PhotoExporter.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoExporter.export" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export photo</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dest</strong> – must be valid destination path or exception raised</p></li>
|
||
<li><p><strong>filename</strong> – (optional): name of exported picture; if not provided, will use current filename
|
||
<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></li>
|
||
<li><p><strong>options</strong> (<cite>ExportOptions</cite>) – t.Optional ExportOptions instance</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>ExportResults instance</p>
|
||
</dd>
|
||
</dl>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<dl class="simple">
|
||
<dt>To use dry run mode, you must set options.dry_run=True and also pass in memory version of export_db,</dt><dd><p>and no-op fileutil (e.g. <cite>ExportDBInMemory</cite> and <cite>FileUtilNoOp</cite>) in options.export_db and options.fileutil respectively</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</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><span class="w"> </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.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 property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.adjustments">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </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><span class="w"> </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><span class="w"> </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.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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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.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><span class="w"> </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><span class="w"> </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><span class="w"> </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="w"> </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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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.html#PhotoInfo.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.export" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Export a photo</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>dest</strong> – must be valid destination path (or exception raised)</p></li>
|
||
<li><p><strong>filename</strong> – (optional): name of exported picture; if not provided, will use current filename
|
||
<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></li>
|
||
<li><p><strong>edited</strong> – (boolean, default=False); if True will export the edited version of the photo, otherwise exports the original version
|
||
(or raise exception if no edited version)</p></li>
|
||
<li><p><strong>live_photo</strong> – (boolean, default=False); if True, will also export the associated .mov for live photos</p></li>
|
||
<li><p><strong>raw_photo</strong> – (boolean, default=False); if True, will also export the associated RAW photo</p></li>
|
||
<li><p><strong>export_as_hardlink</strong> – (boolean, default=False); if True, will hardlink files instead of copying them</p></li>
|
||
<li><p><strong>overwrite</strong> – (boolean, default=False); if True will overwrite files if they already exist</p></li>
|
||
<li><p><strong>increment</strong> – (boolean, default=True); if True, will increment file name until a non-existant name is found
|
||
if overwrite=False and increment=False, export will fail if destination file already exists</p></li>
|
||
<li><p><strong>sidecar_json</strong> – if set will write a json sidecar with data in format readable by exiftool
|
||
sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. <cite>exiftool -G -j</cite>)</p></li>
|
||
<li><p><strong>sidecar_exiftool</strong> – if set will write a json sidecar with data in format readable by exiftool
|
||
sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. <cite>exiftool -j</cite>)</p></li>
|
||
<li><p><strong>sidecar_xmp</strong> – if set will write an XMP sidecar with IPTC data
|
||
sidecar filename will be dest/filename.xmp</p></li>
|
||
<li><p><strong>use_photos_export</strong> – (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos</p></li>
|
||
<li><p><strong>timeout</strong> – (int, default=120) timeout in seconds used with use_photos_export</p></li>
|
||
<li><p><strong>exiftool</strong> – (boolean, default = False); if True, will use exiftool to write metadata to export file</p></li>
|
||
<li><p><strong>files</strong> (<em>returns list of full paths to the exported</em>) – </p></li>
|
||
<li><p><strong>use_albums_as_keywords</strong> – (boolean, default = False); if True, will include album names in keywords</p></li>
|
||
<li><p><strong>sidecar</strong> (<em>when exporting metadata with exiftool or</em>) – </p></li>
|
||
<li><p><strong>use_persons_as_keywords</strong> – (boolean, default = False); if True, will include person names in keywords</p></li>
|
||
<li><p><strong>sidecar</strong> – </p></li>
|
||
<li><p><strong>keyword_template</strong> – (list of strings); list of template strings that will be rendered as used as keywords</p></li>
|
||
<li><p><strong>description_template</strong> – string; optional template string that will be rendered for use as photo description</p></li>
|
||
<li><p><strong>render_options</strong> – an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>list of photos exported</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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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)</p>
|
||
<dl class="simple">
|
||
<dt>NOTE: the photos.db database uses an asynchrounous write-ahead log so changes in Photos</dt><dd><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>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ismovie">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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.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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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.moment">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">moment</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.moment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Moment photo belongs to</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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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.owner">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owner</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.owner" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Return name of photo owner for shared photos (Photos 5+ only), or None if not shared</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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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.project_info">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project_info</span></span><a class="headerlink" href="#osxphotos.PhotoInfo.project_info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of AlbumInfo objects representing projects for the photo or None if no projects</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><span class="w"> </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="w"> </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="w"> </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="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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.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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoTemplate</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">exiftool_path</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/phototemplate.html#PhotoTemplate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>PhotoTemplate class to render a template string from a PhotoInfo object</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_media_type">
|
||
<span class="sig-name descname"><span class="pre">get_media_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_media_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_media_type" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return special media type, e.g. slow_mo, panorama, etc., defaults to photo or video if no special type</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_photo_video_type">
|
||
<span class="sig-name descname"><span class="pre">get_photo_video_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_photo_video_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_photo_video_type" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return media type, e.g. photo or video</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value">
|
||
<span class="sig-name descname"><span class="pre">get_template_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</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/phototemplate.html#PhotoTemplate.get_template_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>lookup value for template field (single-value template substitutions)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> – template field to find value for.</p></li>
|
||
<li><p><strong>default</strong> – the default value provided by the user</p></li>
|
||
<li><p><strong>bool_val</strong> – True value if expression is boolean</p></li>
|
||
<li><p><strong>delim</strong> – delimiter for expand in place</p></li>
|
||
<li><p><strong>path_sep</strong> – path separator for fields that are path-like</p></li>
|
||
<li><p><strong>subfield</strong> – subfield (value after : in field)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The matching template value (which may be None).</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises</dt>
|
||
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> – </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_exiftool">
|
||
<span class="sig-name descname"><span class="pre">get_template_value_exiftool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subfield</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_exiftool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_exiftool" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Get template value for format “{exiftool:EXIF:Model}”</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_filter_function">
|
||
<span class="sig-name descname"><span class="pre">get_template_value_filter_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_filter_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_filter_function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Filter template value from external function</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_function">
|
||
<span class="sig-name descname"><span class="pre">get_template_value_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subfield</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Get template value from external function</p>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_multi">
|
||
<span class="sig-name descname"><span class="pre">get_template_value_multi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_sep</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_multi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_multi" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>lookup value for template field (multi-value template substitutions)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>field</strong> – template field to find value for.</p></li>
|
||
<li><p><strong>subfield</strong> – the template subfield value</p></li>
|
||
<li><p><strong>path_sep</strong> – path separator to use for folder_album field</p></li>
|
||
<li><p><strong>default</strong> – value of default field</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>List of the matching template values or [].</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises</dt>
|
||
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> – </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_pathlib">
|
||
<span class="sig-name descname"><span class="pre">get_template_value_pathlib</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_pathlib"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_pathlib" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>lookup value for template pathlib template fields</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><p><strong>field</strong> – template field to find value for.</p>
|
||
</dd>
|
||
<dt class="field-even">Returns</dt>
|
||
<dd class="field-even"><p>The matching template value (which may be None).</p>
|
||
</dd>
|
||
<dt class="field-odd">Raises</dt>
|
||
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> – </p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.render">
|
||
<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </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="w"> </span><span class="n"><span class="pre">osxphotos.phototemplate.RenderOptions</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.render"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.render" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Render a filename or directory template</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters</dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>template</strong> – str template</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>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </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>, <em class="sig-param"><span class="n"><span class="pre">rich</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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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 method">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.execute">
|
||
<span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sql</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.execute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.execute" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Execute sql statement and return cursor</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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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><span class="w"> </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 property">
|
||
<dt class="sig sig-object py" id="osxphotos.PhotosDB.project_info">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.project_info" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return list of AlbumInfo projects for each project in the database</p>
|
||
</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="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.QueryOptions" title="osxphotos.queryoptions.QueryOptions"><span class="pre">osxphotos.queryoptions.QueryOptions</span></a></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"><span class="pre">osxphotos.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.PlaceInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PlaceInfo</span></span><a class="reference internal" href="_modules/osxphotos/placeinfo.html#PlaceInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PlaceInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd></dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ProjectInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ProjectInfo</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><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#ProjectInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ProjectInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>ProjectInfo with info about projects
|
||
Projects are cards, calendars, slideshows, etc.</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">QueryOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keyword</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">person</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_case</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">external_edit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favorite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_favorite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_hidden</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uti</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">burst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_burst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cloudasset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_cloudasset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incloud</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_incloud</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.datetime</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.time</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">datetime.time</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">portrait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_portrait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">screenshot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_screenshot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slow_mo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_slow_mo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_lapse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_time_lapse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hdr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_hdr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selfie</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_selfie</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">panorama</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_panorama</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">place</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_place</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_likes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_likes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_reference</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_in_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">burst_photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing_bursts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bitmath.Byte</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bitmath.Byte</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query_eval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duplicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">bool</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exif</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/queryoptions.html#QueryOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.QueryOptions" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>QueryOptions class for PhotosDB.query</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.keyword">
|
||
<span class="sig-name descname"><span class="pre">keyword</span></span><a class="headerlink" href="#osxphotos.QueryOptions.keyword" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of keywords to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.person">
|
||
<span class="sig-name descname"><span class="pre">person</span></span><a class="headerlink" href="#osxphotos.QueryOptions.person" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of person names to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.album">
|
||
<span class="sig-name descname"><span class="pre">album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of album names to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.folder">
|
||
<span class="sig-name descname"><span class="pre">folder</span></span><a class="headerlink" href="#osxphotos.QueryOptions.folder" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of folder names to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.uuid">
|
||
<span class="sig-name descname"><span class="pre">uuid</span></span><a class="headerlink" href="#osxphotos.QueryOptions.uuid" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of uuids to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.title">
|
||
<span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.QueryOptions.title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of titles to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_title">
|
||
<span class="sig-name descname"><span class="pre">no_title</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_title" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with no title</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.description">
|
||
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#osxphotos.QueryOptions.description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of descriptions to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_description">
|
||
<span class="sig-name descname"><span class="pre">no_description</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_description" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with no description</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.ignore_case">
|
||
<span class="sig-name descname"><span class="pre">ignore_case</span></span><a class="headerlink" href="#osxphotos.QueryOptions.ignore_case" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>ignore case when searching</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.edited">
|
||
<span class="sig-name descname"><span class="pre">edited</span></span><a class="headerlink" href="#osxphotos.QueryOptions.edited" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for edited photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.external_edit">
|
||
<span class="sig-name descname"><span class="pre">external_edit</span></span><a class="headerlink" href="#osxphotos.QueryOptions.external_edit" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos edited in external apps</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.favorite">
|
||
<span class="sig-name descname"><span class="pre">favorite</span></span><a class="headerlink" href="#osxphotos.QueryOptions.favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for favorite photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_favorite">
|
||
<span class="sig-name descname"><span class="pre">not_favorite</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_favorite" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-favorite photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.hidden">
|
||
<span class="sig-name descname"><span class="pre">hidden</span></span><a class="headerlink" href="#osxphotos.QueryOptions.hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for hidden photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_hidden">
|
||
<span class="sig-name descname"><span class="pre">not_hidden</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_hidden" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-hidden photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.missing">
|
||
<span class="sig-name descname"><span class="pre">missing</span></span><a class="headerlink" href="#osxphotos.QueryOptions.missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for missing photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_missing">
|
||
<span class="sig-name descname"><span class="pre">not_missing</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_missing" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-missing photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.shared">
|
||
<span class="sig-name descname"><span class="pre">shared</span></span><a class="headerlink" href="#osxphotos.QueryOptions.shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for shared photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_shared">
|
||
<span class="sig-name descname"><span class="pre">not_shared</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_shared" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-shared photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.photos">
|
||
<span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.QueryOptions.photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.movies">
|
||
<span class="sig-name descname"><span class="pre">movies</span></span><a class="headerlink" href="#osxphotos.QueryOptions.movies" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for movies</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.uti">
|
||
<span class="sig-name descname"><span class="pre">uti</span></span><a class="headerlink" href="#osxphotos.QueryOptions.uti" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of UTIs to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.burst">
|
||
<span class="sig-name descname"><span class="pre">burst</span></span><a class="headerlink" href="#osxphotos.QueryOptions.burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for burst photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_burst">
|
||
<span class="sig-name descname"><span class="pre">not_burst</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_burst" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-burst photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.live">
|
||
<span class="sig-name descname"><span class="pre">live</span></span><a class="headerlink" href="#osxphotos.QueryOptions.live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for live photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_live">
|
||
<span class="sig-name descname"><span class="pre">not_live</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_live" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-live photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.cloudasset">
|
||
<span class="sig-name descname"><span class="pre">cloudasset</span></span><a class="headerlink" href="#osxphotos.QueryOptions.cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos that are managed by iCloud</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_cloudasset">
|
||
<span class="sig-name descname"><span class="pre">not_cloudasset</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_cloudasset" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos that are not managed by iCloud</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.incloud">
|
||
<span class="sig-name descname"><span class="pre">incloud</span></span><a class="headerlink" href="#osxphotos.QueryOptions.incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for cloud assets that are synched to iCloud</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_incloud">
|
||
<span class="sig-name descname"><span class="pre">not_incloud</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_incloud" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for cloud asset photos that are not yet synched to iCloud</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.from_date">
|
||
<span class="sig-name descname"><span class="pre">from_date</span></span><a class="headerlink" href="#osxphotos.QueryOptions.from_date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos taken on or after this date</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.to_date">
|
||
<span class="sig-name descname"><span class="pre">to_date</span></span><a class="headerlink" href="#osxphotos.QueryOptions.to_date" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos taken on or before this date</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.portrait">
|
||
<span class="sig-name descname"><span class="pre">portrait</span></span><a class="headerlink" href="#osxphotos.QueryOptions.portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for portrait photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_portrait">
|
||
<span class="sig-name descname"><span class="pre">not_portrait</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_portrait" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-portrait photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.screenshot">
|
||
<span class="sig-name descname"><span class="pre">screenshot</span></span><a class="headerlink" href="#osxphotos.QueryOptions.screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for screenshot photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_screenshot">
|
||
<span class="sig-name descname"><span class="pre">not_screenshot</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_screenshot" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-screenshot photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.slow_mo">
|
||
<span class="sig-name descname"><span class="pre">slow_mo</span></span><a class="headerlink" href="#osxphotos.QueryOptions.slow_mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for slow-mo photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_slow_mo">
|
||
<span class="sig-name descname"><span class="pre">not_slow_mo</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_slow_mo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-slow-mo photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.time_lapse">
|
||
<span class="sig-name descname"><span class="pre">time_lapse</span></span><a class="headerlink" href="#osxphotos.QueryOptions.time_lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for time-lapse photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_time_lapse">
|
||
<span class="sig-name descname"><span class="pre">not_time_lapse</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_time_lapse" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-time-lapse photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.hdr">
|
||
<span class="sig-name descname"><span class="pre">hdr</span></span><a class="headerlink" href="#osxphotos.QueryOptions.hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for HDR photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_hdr">
|
||
<span class="sig-name descname"><span class="pre">not_hdr</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_hdr" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-HDR photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.selfie">
|
||
<span class="sig-name descname"><span class="pre">selfie</span></span><a class="headerlink" href="#osxphotos.QueryOptions.selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for selfie photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_selfie">
|
||
<span class="sig-name descname"><span class="pre">not_selfie</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_selfie" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-selfie photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.panorama">
|
||
<span class="sig-name descname"><span class="pre">panorama</span></span><a class="headerlink" href="#osxphotos.QueryOptions.panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for panorama photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_panorama">
|
||
<span class="sig-name descname"><span class="pre">not_panorama</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_panorama" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for non-panorama photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_raw">
|
||
<span class="sig-name descname"><span class="pre">has_raw</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_raw" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with associated raw files</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.place">
|
||
<span class="sig-name descname"><span class="pre">place</span></span><a class="headerlink" href="#osxphotos.QueryOptions.place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of place names to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_place">
|
||
<span class="sig-name descname"><span class="pre">no_place</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_place" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with no place</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.label">
|
||
<span class="sig-name descname"><span class="pre">label</span></span><a class="headerlink" href="#osxphotos.QueryOptions.label" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of labels to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.deleted">
|
||
<span class="sig-name descname"><span class="pre">deleted</span></span><a class="headerlink" href="#osxphotos.QueryOptions.deleted" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>also include deleted photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.deleted_only">
|
||
<span class="sig-name descname"><span class="pre">deleted_only</span></span><a class="headerlink" href="#osxphotos.QueryOptions.deleted_only" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search only for deleted photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_comment">
|
||
<span class="sig-name descname"><span class="pre">has_comment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with comments</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_comment">
|
||
<span class="sig-name descname"><span class="pre">no_comment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_comment" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with no comments</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_likes">
|
||
<span class="sig-name descname"><span class="pre">has_likes</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for shared photos with likes</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_likes">
|
||
<span class="sig-name descname"><span class="pre">no_likes</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_likes" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for shared photos with no likes</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.is_reference">
|
||
<span class="sig-name descname"><span class="pre">is_reference</span></span><a class="headerlink" href="#osxphotos.QueryOptions.is_reference" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos stored by reference (that is, they are not managed by Photos)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.in_album">
|
||
<span class="sig-name descname"><span class="pre">in_album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.in_album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos in an album</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_in_album">
|
||
<span class="sig-name descname"><span class="pre">not_in_album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_in_album" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos not in an album</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.burst_photos">
|
||
<span class="sig-name descname"><span class="pre">burst_photos</span></span><a class="headerlink" href="#osxphotos.QueryOptions.burst_photos" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for burst photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.missing_bursts">
|
||
<span class="sig-name descname"><span class="pre">missing_bursts</span></span><a class="headerlink" href="#osxphotos.QueryOptions.missing_bursts" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>for burst photos, also include burst photos that are missing</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.name">
|
||
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#osxphotos.QueryOptions.name" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of names to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.min_size">
|
||
<span class="sig-name descname"><span class="pre">min_size</span></span><a class="headerlink" href="#osxphotos.QueryOptions.min_size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>minimum size of photos to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bitmath.Byte]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.max_size">
|
||
<span class="sig-name descname"><span class="pre">max_size</span></span><a class="headerlink" href="#osxphotos.QueryOptions.max_size" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>maximum size of photos to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bitmath.Byte]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.regex">
|
||
<span class="sig-name descname"><span class="pre">regex</span></span><a class="headerlink" href="#osxphotos.QueryOptions.regex" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of regular expressions to search for</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[Tuple[str, str]]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.query_eval">
|
||
<span class="sig-name descname"><span class="pre">query_eval</span></span><a class="headerlink" href="#osxphotos.QueryOptions.query_eval" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of query expressions to evaluate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.duplicate">
|
||
<span class="sig-name descname"><span class="pre">duplicate</span></span><a class="headerlink" href="#osxphotos.QueryOptions.duplicate" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for duplicate photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.location">
|
||
<span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.QueryOptions.location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with a location</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_location">
|
||
<span class="sig-name descname"><span class="pre">no_location</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_location" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with no location</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.function">
|
||
<span class="sig-name descname"><span class="pre">function</span></span><a class="headerlink" href="#osxphotos.QueryOptions.function" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>list of query functions to evaluate</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[List[Tuple[callable, str]]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.selected">
|
||
<span class="sig-name descname"><span class="pre">selected</span></span><a class="headerlink" href="#osxphotos.QueryOptions.selected" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for selected photos</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[bool]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.exif">
|
||
<span class="sig-name descname"><span class="pre">exif</span></span><a class="headerlink" href="#osxphotos.QueryOptions.exif" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos with EXIF tags that matches the given data</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[Tuple[str, str]]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="osxphotos.QueryOptions.year">
|
||
<span class="sig-name descname"><span class="pre">year</span></span><a class="headerlink" href="#osxphotos.QueryOptions.year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>search for photos taken in a given year</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type</dt>
|
||
<dd class="field-odd"><p>Optional[Iterable[int]]</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.ScoreInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </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="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/scoreinfo.html#ScoreInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ScoreInfo" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>Computed photo score info associated with a photo from the Photos library</p>
|
||
</dd></dl>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="osxphotos.SearchInfo">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><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="reference internal" href="_modules/osxphotos/searchinfo.html#SearchInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.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.SearchInfo.activities">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">activities</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.all">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all</span></span><a class="headerlink" href="#osxphotos.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.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="reference internal" href="_modules/osxphotos/searchinfo.html#SearchInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.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.SearchInfo.bodies_of_water">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bodies_of_water</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.city">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">city</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.country">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">country</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.holidays">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">holidays</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.labels">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.locality_names">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">locality_names</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.media_types">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media_types</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.month">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">month</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.neighborhoods">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">neighborhoods</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.place_names">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">place_names</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.season">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">season</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.state">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.state_abbreviation">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state_abbreviation</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.streets">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">streets</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.venue_types">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">venue_types</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.venues">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">venues</span></span><a class="headerlink" href="#osxphotos.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.SearchInfo.year">
|
||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">year</span></span><a class="headerlink" href="#osxphotos.SearchInfo.year" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>returns year</p>
|
||
</dd></dl>
|
||
</dd></dl>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="osxphotos.is_debug">
|
||
<span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">is_debug</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/debug.html#is_debug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.is_debug" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>return debug flag</p>
|
||
</dd></dl>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="osxphotos.set_debug">
|
||
<span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">set_debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/debug.html#set_debug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.set_debug" title="Permalink to this definition">#</a></dt>
|
||
<dd><p>set debug flag</p>
|
||
</dd></dl>
|
||
</section>
|
||
|
||
</article>
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
|
||
<a class="prev-page" href="package_overview.html">
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Previous</span>
|
||
</div>
|
||
|
||
<div class="title">Example uses of the OSXPhotos python package</div>
|
||
|
||
</div>
|
||
</a>
|
||
</div>
|
||
<div class="bottom-of-page">
|
||
<div class="left-details">
|
||
<div class="copyright">
|
||
Copyright © 2021, Rhet Turnbull
|
||
</div>
|
||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
|
||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||
|
||
</div>
|
||
<div class="right-details">
|
||
<div class="icons">
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer no-toc">
|
||
|
||
|
||
|
||
</aside>
|
||
</div>
|
||
</div><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>
|
||
<script src="_static/scripts/furo.js"></script>
|
||
<script src="_static/clipboard.min.js"></script>
|
||
<script src="_static/copybutton.js"></script>
|
||
</body>
|
||
</html> |