New session Python module and metadata API.

docs/sphinx/en/python_api/session.rst

@@ -0,0 +1,5 @@
+Session module
+==============
+
+.. automodule:: mrv2.session
+    :members:

docs/sphinx/es/python_api/session.rst

@@ -0,0 +1,5 @@
+Módulo de Sesión
+================
+
+.. automodule:: mrv2.session
+    :members:

mrv2/docs/HISTORY.md

@@ -27,6 +27,9 @@ v0.8.2
 - Made scrubbing automatically switch to playback with audio.
 - Fixed coloring of Python functions when they were typed at the start of a
   line.
+- There's a new 'session' module to handle everything related to sessions,
+  including saving, loading and setting the metadata.
+- The metadata for sessions has changed API.  Now it is a Python dict.
 
 
 v0.8.1

mrv2/docs/en/_modules/index.html

@@ -80,6 +80,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="mrv2/media.html">mrv2.media</a></li>
 <li><a href="mrv2/playlist.html">mrv2.playlist</a></li>
 <li><a href="mrv2/plugin.html">mrv2.plugin</a></li>
+<li><a href="mrv2/session.html">mrv2.session</a></li>
 <li><a href="mrv2/settings.html">mrv2.settings</a></li>
 <li><a href="mrv2/timeline.html">mrv2.timeline</a></li>
 <li><a href="mrv2/usd.html">mrv2.usd</a></li>

mrv2/docs/en/_sources/python_api/session.rst.txt

@@ -0,0 +1,5 @@
+Session module
+==============
+
+.. automodule:: mrv2.session
+    :members:

mrv2/docs/en/genindex.html

@@ -162,6 +162,8 @@ <h2 id="C">C</h2>
       <li><a href="python_api/mrv2.html#mrv2.TimeRange.clamped">clamped() (mrv2.TimeRange method)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.clearB">clearB() (in module mrv2.media)</a>
+</li>
+      <li><a href="python_api/session.html#mrv2.session.clearMetadata">clearMetadata() (in module mrv2.session)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.close">close() (in module mrv2.cmd)</a>
 
@@ -176,11 +178,11 @@ <h2 id="C">C</h2>
 </li>
       </ul></li>
       <li><a href="python_api/image.html#mrv2.image.Color">Color (class in mrv2.image)</a>
-</li>
-      <li><a href="python_api/image.html#mrv2.image.DisplayOptions.color">color (mrv2.image.DisplayOptions attribute)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/image.html#mrv2.image.DisplayOptions.color">color (mrv2.image.DisplayOptions attribute)</a>
+</li>
       <li><a href="python_api/cmd.html#mrv2.cmd.compare">compare() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.CompareMode">CompareMode (class in mrv2.media)</a>
@@ -197,7 +199,7 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="python_api/image.html#mrv2.image.Color.contrast">contrast (mrv2.image.Color attribute)</a>
 </li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.currentSession">currentSession() (in module mrv2.cmd)</a>
+      <li><a href="python_api/session.html#mrv2.session.current">current() (in module mrv2.session)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.FileMedia.currentTime">currentTime (mrv2.FileMedia attribute)</a>
 </li>
@@ -415,6 +417,8 @@ <h2 id="L">L</h2>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="python_api/session.html#mrv2.session.load">load() (in module mrv2.session)</a>
+</li>
       <li><a href="python_api/timeline.html#mrv2.timeline.Loop">Loop (class in mrv2.timeline)</a>
 </li>
       <li><a href="python_api/mrv2.html#mrv2.FileMedia.loop">loop (mrv2.FileMedia attribute)</a>
@@ -440,6 +444,8 @@ <h2 id="M">M</h2>
       <li><a href="python_api/settings.html#mrv2.settings.memory">memory() (in module mrv2.settings)</a>
 </li>
       <li><a href="python_api/plug-ins.html#mrv2.plugin.Plugin.menus">menus() (mrv2.plugin.Plugin method)</a>
+</li>
+      <li><a href="python_api/session.html#mrv2.session.metadata">metadata() (in module mrv2.session)</a>
 </li>
       <li><a href="python_api/image.html#mrv2.image.ImageFilters.minify">minify (mrv2.image.ImageFilters attribute)</a>
 </li>
@@ -470,6 +476,8 @@ <h2 id="M">M</h2>
         <li><a href="python_api/playlist.html#module-mrv2.playlist">mrv2.playlist</a>
 </li>
         <li><a href="python_api/plug-ins.html#module-mrv2.plugin">mrv2.plugin</a>
+</li>
+        <li><a href="python_api/session.html#module-mrv2.session">mrv2.session</a>
 </li>
         <li><a href="python_api/settings.html#module-mrv2.settings">mrv2.settings</a>
 </li>
@@ -541,6 +549,13 @@ <h2 id="M">M</h2>
 
       <ul>
         <li><a href="python_api/plug-ins.html#module-mrv2.plugin">module</a>
+</li>
+      </ul></li>
+      <li>
+    mrv2.session
+
+      <ul>
+        <li><a href="python_api/session.html#module-mrv2.session">module</a>
 </li>
       </ul></li>
       <li>
@@ -625,8 +640,6 @@ <h2 id="O">O</h2>
       <li><a href="python_api/image.html#mrv2.image.ocioView">ocioView() (in module mrv2.image)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.open">open() (in module mrv2.cmd)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.openSession">openSession() (in module mrv2.cmd)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -716,33 +729,29 @@ <h2 id="S">S</h2>
 
       <ul>
         <li><a href="python_api/playlist.html#mrv2.playlist.save">(in module mrv2.playlist)</a>
+</li>
+        <li><a href="python_api/session.html#mrv2.session.save">(in module mrv2.session)</a>
 </li>
       </ul></li>
       <li><a href="python_api/io.html#mrv2.io.SaveOptions">SaveOptions (class in mrv2.io)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.saveOTIO">saveOTIO() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.savePDF">savePDF() (in module mrv2.cmd)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.saveSession">saveSession() (in module mrv2.cmd)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.saveSessionAs">saveSessionAs() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/timeline.html#mrv2.timeline.seconds">seconds() (in module mrv2.timeline)</a>
 </li>
       <li><a href="python_api/timeline.html#mrv2.timeline.seek">seek() (in module mrv2.timeline)</a>
 </li>
       <li><a href="python_api/playlist.html#mrv2.playlist.select">select() (in module mrv2.playlist)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.sessionMetadata">sessionMetadata() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.setA">setA() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/media.html#mrv2.media.setB">setB() (in module mrv2.media)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setCompareOptions">setCompareOptions() (in module mrv2.cmd)</a>
 </li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.setCurrentSession">setCurrentSession() (in module mrv2.cmd)</a>
+      <li><a href="python_api/session.html#mrv2.session.setCurrent">setCurrent() (in module mrv2.session)</a>
 </li>
       <li><a href="python_api/cmd.html#mrv2.cmd.setDisplayOptions">setDisplayOptions() (in module mrv2.cmd)</a>
 </li>
@@ -761,6 +770,8 @@ <h2 id="S">S</h2>
       <li><a href="python_api/cmd.html#mrv2.cmd.setLUTOptions">setLUTOptions() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/settings.html#mrv2.settings.setMemory">setMemory() (in module mrv2.settings)</a>
+</li>
+      <li><a href="python_api/session.html#mrv2.session.setMetadata">setMetadata() (in module mrv2.session)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -779,8 +790,6 @@ <h2 id="S">S</h2>
       <li><a href="python_api/settings.html#mrv2.settings.setReadBehind">setReadBehind() (in module mrv2.settings)</a>
 </li>
       <li><a href="python_api/usd.html#mrv2.usd.setRenderOptions">setRenderOptions() (in module mrv2.usd)</a>
-</li>
-      <li><a href="python_api/cmd.html#mrv2.cmd.setSessionMetadata">setSessionMetadata() (in module mrv2.cmd)</a>
 </li>
       <li><a href="python_api/timeline.html#mrv2.timeline.setSpeed">setSpeed() (in module mrv2.timeline)</a>
 </li>

mrv2/docs/en/index.html

@@ -105,6 +105,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Link
 <li class="toctree-l2"><a class="reference internal" href="python_api/plug-ins.html">plugin module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python_api/plug-ins-system.html">Plug-in System</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python_api/pyFLTK.html">pyFLTK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="python_api/session.html">Session module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python_api/settings.html">settings module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python_api/timeline.html">timeline module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="python_api/usd.html">usd module</a></li>

mrv2/docs/en/py-modindex.html

@@ -130,6 +130,11 @@ <h1>Python Module Index</h1>
        <td>&#160;&#160;&#160;
        <a href="python_api/plug-ins.html#module-mrv2.plugin"><code class="xref">mrv2.plugin</code></a></td><td>
        <em></em></td></tr>
+     <tr class="cg-1">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="python_api/session.html#module-mrv2.session"><code class="xref">mrv2.session</code></a></td><td>
+       <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;

mrv2/docs/en/python_api/annotations.html

@@ -62,6 +62,7 @@
 <li class="toctree-l2"><a class="reference internal" href="plug-ins.html">plugin module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="plug-ins-system.html">Plug-in System</a></li>
 <li class="toctree-l2"><a class="reference internal" href="pyFLTK.html">pyFLTK</a></li>
+<li class="toctree-l2"><a class="reference internal" href="session.html">Session module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="settings.html">settings module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="timeline.html">timeline module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="usd.html">usd module</a></li>