deploy: 886dd8d

Princeton-CDH · Apr 24, 2024 · dd37377 · dd37377
1 parent 63a4786
commit dd37377
Show file tree

Hide file tree

Showing 42 changed files with 928 additions and 485 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 838f99699513809c43a29cdda50e251c
+config: 8631279f2dfd39bd81386057ed87e2a4
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/geniza/annotations/models.html b/_modules/geniza/annotations/models.html
diff --git a/_modules/geniza/annotations/views.html b/_modules/geniza/annotations/views.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geniza.annotations.views &#8212; Princeton Geniza Project 4.16.1 documentation</title>
+    <title>geniza.annotations.views &#8212; Princeton Geniza Project 4.17.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=12dfc556" />
-    <script src="../../../_static/documentation_options.js?v=c9094266"></script>
-    <script src="../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../_static/documentation_options.js?v=1ca48c26"></script>
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -38,7 +38,8 @@ <h1>Source code for geniza.annotations.views</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">django.contrib.auth.mixins</span> <span class="kn">import</span> <span class="n">AccessMixin</span><span class="p">,</span> <span class="n">PermissionRequiredMixin</span>
 <span class="kn">from</span> <span class="nn">django.contrib.contenttypes.models</span> <span class="kn">import</span> <span class="n">ContentType</span>
 <span class="kn">from</span> <span class="nn">django.core.exceptions</span> <span class="kn">import</span> <span class="n">BadRequest</span>
-<span class="kn">from</span> <span class="nn">django.http</span> <span class="kn">import</span> <span class="n">HttpResponse</span><span class="p">,</span> <span class="n">JsonResponse</span>
+<span class="kn">from</span> <span class="nn">django.http</span> <span class="kn">import</span> <span class="n">Http404</span><span class="p">,</span> <span class="n">HttpResponse</span><span class="p">,</span> <span class="n">JsonResponse</span>
+<span class="kn">from</span> <span class="nn">django.views.decorators.http</span> <span class="kn">import</span> <span class="n">condition</span>
 <span class="kn">from</span> <span class="nn">django.views.generic.base</span> <span class="kn">import</span> <span class="n">View</span>
 <span class="kn">from</span> <span class="nn">django.views.generic.detail</span> <span class="kn">import</span> <span class="n">SingleObjectMixin</span>
 <span class="kn">from</span> <span class="nn">django.views.generic.list</span> <span class="kn">import</span> <span class="n">MultipleObjectMixin</span>
@@ -330,7 +331,10 @@ <h1>Source code for geniza.annotations.views</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="AnnotationDetail">
 <a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail">[docs]</a>
 <span class="k">class</span> <span class="nc">AnnotationDetail</span><span class="p">(</span>
-    <span class="n">PermissionRequiredMixin</span><span class="p">,</span> <span class="n">ApiAccessMixin</span><span class="p">,</span> <span class="n">View</span><span class="p">,</span> <span class="n">SingleObjectMixin</span>
+    <span class="n">PermissionRequiredMixin</span><span class="p">,</span>
+    <span class="n">ApiAccessMixin</span><span class="p">,</span>
+    <span class="n">View</span><span class="p">,</span>
+    <span class="n">SingleObjectMixin</span><span class="p">,</span>
 <span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;View to read, update, or delete a single annotation.&quot;&quot;&quot;</span>
 
@@ -362,7 +366,6 @@ <h1>Source code for geniza.annotations.views</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail.post">[docs]</a>
     <span class="k">def</span> <span class="nf">post</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;update the annotation on POST&quot;&quot;&quot;</span>
-        <span class="c1"># NOTE: should use etag / if-match</span>
         <span class="n">anno</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>
         <span class="k">try</span><span class="p">:</span>
             <span class="n">anno_data</span> <span class="o">=</span> <span class="n">parse_annotation_data</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="n">request</span><span class="p">)</span>
@@ -388,7 +391,6 @@ <h1>Source code for geniza.annotations.views</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail.delete">[docs]</a>
     <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;delete the annotation on DELETE&quot;&quot;&quot;</span>
-        <span class="c1"># should use etag / if-match</span>
         <span class="c1"># deleted uuid should not be reused (relying on low likelihood of uuid collision)</span>
         <span class="n">anno</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>
         <span class="c1"># create log entry to document deletion *BEFORE* deleting</span>
@@ -424,6 +426,45 @@ <h1>Source code for geniza.annotations.views</h1><div class="highlight"><pre>
             <span class="n">footnote</span><span class="o">.</span><span class="n">refresh_from_db</span><span class="p">()</span>
 
         <span class="k">return</span> <span class="n">HttpResponse</span><span class="p">(</span><span class="n">status</span><span class="o">=</span><span class="mi">204</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="AnnotationDetail.get_etag">
+<a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail.get_etag">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_etag</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Get etag from annotation&quot;&quot;&quot;</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;object&quot;</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>
+            <span class="n">anno</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span>
+            <span class="k">return</span> <span class="n">anno</span><span class="o">.</span><span class="n">etag</span>
+        <span class="k">except</span> <span class="n">Http404</span><span class="p">:</span>
+            <span class="k">return</span> <span class="kc">None</span></div>
+
+
+<div class="viewcode-block" id="AnnotationDetail.get_last_modified">
+<a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail.get_last_modified">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_last_modified</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Return last modified :class:`datetime.datetime`&quot;&quot;&quot;</span>
+        <span class="k">try</span><span class="p">:</span>
+            <span class="k">if</span> <span class="ow">not</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;object&quot;</span><span class="p">):</span>
+                <span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object</span><span class="p">()</span>
+            <span class="n">anno</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span>
+            <span class="k">return</span> <span class="n">anno</span><span class="o">.</span><span class="n">modified</span>
+        <span class="k">except</span> <span class="n">Http404</span><span class="p">:</span>
+            <span class="k">return</span> <span class="kc">None</span></div>
+
+
+<div class="viewcode-block" id="AnnotationDetail.dispatch">
+<a class="viewcode-back" href="../../../codedocs/annotations.html#geniza.annotations.views.AnnotationDetail.dispatch">[docs]</a>
+    <span class="k">def</span> <span class="nf">dispatch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Wrap the dispatch method to add ETag/last modified headers when</span>
+<span class="sd">        appropriate, then return a conditional response.&quot;&quot;&quot;</span>
+
+        <span class="nd">@condition</span><span class="p">(</span><span class="n">etag_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_etag</span><span class="p">,</span> <span class="n">last_modified_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_last_modified</span><span class="p">)</span>
+        <span class="k">def</span> <span class="nf">_dispatch</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+            <span class="k">return</span> <span class="nb">super</span><span class="p">(</span><span class="n">AnnotationDetail</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">dispatch</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
+
+        <span class="k">return</span> <span class="n">_dispatch</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
 </div>
 
 </pre></div>
@@ -474,15 +515,15 @@ <h3>Navigation</h3>
 </ul>
 
 
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script><div class="powered_by">
     <p>Powered by:</p>
     <a href="http://cdh.princeton.edu/">
@@ -498,7 +539,7 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2022, Center for Digital Humanities @ Princeton.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>

diff --git a/_modules/geniza/common/fields.html b/_modules/geniza/common/fields.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geniza.common.fields &#8212; Princeton Geniza Project 4.16.1 documentation</title>
+    <title>geniza.common.fields &#8212; Princeton Geniza Project 4.17.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=12dfc556" />
-    <script src="../../../_static/documentation_options.js?v=c9094266"></script>
-    <script src="../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../_static/documentation_options.js?v=1ca48c26"></script>
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -272,15 +272,15 @@ <h3>Navigation</h3>
 </ul>
 
 
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script><div class="powered_by">
     <p>Powered by:</p>
     <a href="http://cdh.princeton.edu/">
@@ -296,7 +296,7 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2022, Center for Digital Humanities @ Princeton.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>

diff --git a/_modules/geniza/common/metadata_export.html b/_modules/geniza/common/metadata_export.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geniza.common.metadata_export &#8212; Princeton Geniza Project 4.16.1 documentation</title>
+    <title>geniza.common.metadata_export &#8212; Princeton Geniza Project 4.17.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=12dfc556" />
-    <script src="../../../_static/documentation_options.js?v=c9094266"></script>
-    <script src="../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../_static/documentation_options.js?v=1ca48c26"></script>
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -330,15 +330,15 @@ <h3>Navigation</h3>
 </ul>
 
 
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script><div class="powered_by">
     <p>Powered by:</p>
     <a href="http://cdh.princeton.edu/">
@@ -354,7 +354,7 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2022, Center for Digital Humanities @ Princeton.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>

diff --git a/_modules/geniza/common/middleware.html b/_modules/geniza/common/middleware.html
@@ -4,11 +4,11 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>geniza.common.middleware &#8212; Princeton Geniza Project 4.16.1 documentation</title>
+    <title>geniza.common.middleware &#8212; Princeton Geniza Project 4.17.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css?v=12dfc556" />
-    <script src="../../../_static/documentation_options.js?v=c9094266"></script>
-    <script src="../../../_static/doctools.js?v=888ff710"></script>
+    <script src="../../../_static/documentation_options.js?v=1ca48c26"></script>
+    <script src="../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="index" title="Index" href="../../../genindex.html" />
     <link rel="search" title="Search" href="../../../search.html" />
@@ -148,15 +148,15 @@ <h3>Navigation</h3>
 </ul>
 
 
-<div id="searchbox" style="display: none" role="search">
+<search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../../../search.html" method="get">
       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
-</div>
+</search>
 <script>document.getElementById('searchbox').style.display = "block"</script><div class="powered_by">
     <p>Powered by:</p>
     <a href="http://cdh.princeton.edu/">
@@ -172,7 +172,7 @@ <h3 id="searchlabel">Quick search</h3>
       &#169;2022, Center for Digital Humanities @ Princeton.
 
       |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.2.6</a>
+      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.3.7</a>
       &amp; <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
 
     </div>