Update docs build

Author: eriknyquist

docs/_modules/versionedobj/exceptions.html

@@ -75,10 +75,16 @@ <h1>Source code for versionedobj.exceptions</h1><div class="highlight"><pre>
     <span class="k">pass</span></div>
 
 
-<div class="viewcode-block" id="LoadObjError"><a class="viewcode-back" href="../../versionedobj.html#versionedobj.exceptions.LoadObjError">[docs]</a><span class="k">class</span> <span class="nc">LoadObjError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+<div class="viewcode-block" id="LoadObjectError"><a class="viewcode-back" href="../../versionedobj.html#versionedobj.exceptions.LoadObjectError">[docs]</a><span class="k">class</span> <span class="nc">LoadObjectError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Exception raised whenever saved object data cannot be loaded because of a JSON parser error</span>
-<span class="sd">    or because of a failed migration path</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">pass</span></div>
+
+
+<div class="viewcode-block" id="ObjectMigrationError"><a class="viewcode-back" href="../../versionedobj.html#versionedobj.exceptions.ObjectMigrationError">[docs]</a><span class="k">class</span> <span class="nc">ObjectMigrationError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Exception raised whenever migration of a versioned object fails</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">pass</span></div>
 

docs/_modules/versionedobj/object.html

@@ -72,7 +72,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">json</span>
 <span class="kn">from</span> <span class="nn">json.decoder</span> <span class="kn">import</span> <span class="n">JSONDecodeError</span>
 
-<span class="kn">from</span> <span class="nn">versionedobj.exceptions</span> <span class="kn">import</span> <span class="n">InvalidFilterError</span><span class="p">,</span> <span class="n">LoadObjError</span><span class="p">,</span> <span class="n">InputValidationError</span><span class="p">,</span> <span class="n">InvalidVersionAttributeError</span>
+<span class="kn">from</span> <span class="nn">versionedobj.exceptions</span> <span class="kn">import</span> <span class="n">InvalidFilterError</span><span class="p">,</span> <span class="n">LoadObjectError</span><span class="p">,</span> <span class="n">ObjectMigrationError</span><span class="p">,</span> <span class="n">InputValidationError</span><span class="p">,</span> <span class="n">InvalidVersionAttributeError</span>
 
 
 <div class="viewcode-block" id="migration"><a class="viewcode-back" href="../../versionedobj.html#versionedobj.object.migration">[docs]</a><span class="k">def</span> <span class="nf">migration</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">from_version</span><span class="p">,</span> <span class="n">to_version</span><span class="p">):</span>
@@ -352,7 +352,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails.</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="p">()</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">attrs</span><span class="p">,</span> <span class="n">validate</span><span class="p">,</span> <span class="n">only</span><span class="p">,</span> <span class="n">ignore</span><span class="p">)</span></div>
@@ -371,7 +371,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails.</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="p">()</span><span class="o">.</span><span class="n">from_json</span><span class="p">(</span><span class="n">jsonstr</span><span class="p">,</span> <span class="n">validate</span><span class="p">,</span> <span class="n">only</span><span class="p">,</span> <span class="n">ignore</span><span class="p">)</span></div>
@@ -390,7 +390,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails.</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="bp">cls</span><span class="p">()</span><span class="o">.</span><span class="n">from_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">validate</span><span class="p">,</span> <span class="n">only</span><span class="p">,</span> <span class="n">ignore</span><span class="p">)</span></div>
@@ -432,7 +432,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
                     <span class="k">break</span>
 
         <span class="k">if</span> <span class="n">version_after_migration</span> <span class="o">!=</span> <span class="n">version</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="n">LoadObjError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed to migrate from version </span><span class="si">{</span><span class="n">version_before_migration</span><span class="si">}</span><span class="s2"> to </span><span class="si">{</span><span class="n">version</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="n">ObjectMigrationError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Failed to migrate from version </span><span class="si">{</span><span class="n">version_before_migration</span><span class="si">}</span><span class="s2"> to </span><span class="si">{</span><span class="n">version</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
         <span class="k">return</span> <span class="n">attrs</span>
 
@@ -549,7 +549,7 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails.</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">if</span> <span class="n">only</span> <span class="ow">and</span> <span class="n">ignore</span><span class="p">:</span>
@@ -599,13 +599,14 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if JSON parsing fails, or if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.LoadObjectError: if JSON parsing fails</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">try</span><span class="p">:</span>
             <span class="n">d</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">jsonstr</span><span class="p">)</span>
         <span class="k">except</span> <span class="n">JSONDecodeError</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="n">LoadObjError</span><span class="p">(</span><span class="s2">&quot;JSON decode failure&quot;</span><span class="p">)</span>
+            <span class="k">raise</span> <span class="n">LoadObjectError</span><span class="p">(</span><span class="s2">&quot;JSON decode failure&quot;</span><span class="p">)</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">validate</span><span class="p">,</span> <span class="n">only</span><span class="p">,</span> <span class="n">ignore</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">self</span></div>
@@ -634,7 +635,8 @@ <h1>Source code for versionedobj.object</h1><div class="highlight"><pre>
 <span class="sd">        :param list ignore: Blacklist of field names to ignore (cannot be used with whitelist)</span>
 
 <span class="sd">        :raises versionedobj.exceptions.InputValidationError: if validation of input data fails.</span>
-<span class="sd">        :raises versionedobj.exceptions.LoadObjError: if JSON parsing fails, or if migration to current version fails.</span>
+<span class="sd">        :raises versionedobj.exceptions.LoadObjectError: if JSON parsing fails</span>
+<span class="sd">        :raises versionedobj.exceptions.ObjectMigrationError: if migration to current version fails.</span>
 <span class="sd">        :raises versionedobj.exceptions.InvalidFilterError: if both &#39;only&#39; and &#39;ignore&#39; are provided.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s1">&#39;r&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>

docs/genindex.html

@@ -141,7 +141,7 @@ <h2 id="I">I</h2>
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="versionedobj.html#versionedobj.exceptions.LoadObjError">LoadObjError</a>
+      <li><a href="versionedobj.html#versionedobj.exceptions.LoadObjectError">LoadObjectError</a>
 </li>
   </ul></td>
 </tr></table>
@@ -185,6 +185,10 @@ <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="versionedobj.html#versionedobj.object.VersionedObject.object_attributes">object_attributes() (versionedobj.object.VersionedObject method)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="versionedobj.html#versionedobj.exceptions.ObjectMigrationError">ObjectMigrationError</a>
 </li>
   </ul></td>
 </tr></table>