Update documentation

fsspec · Aug 25, 2023 · 14639db · 14639db
1 parent 44ebe01
commit 14639db
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 4 deletions.
diff --git a/_modules/kerchunk/netCDF3.html b/_modules/kerchunk/netCDF3.html
@@ -141,6 +141,7 @@ <h1>Source code for kerchunk.netCDF3</h1><div class="highlight"><pre>
         <span class="bp">self</span><span class="o">.</span><span class="n">threshold</span> <span class="o">=</span> <span class="n">inline_threshold</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">max_chunk_size</span> <span class="o">=</span> <span class="n">max_chunk_size</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">out</span> <span class="o">=</span> <span class="p">{}</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">storage_options</span> <span class="o">=</span> <span class="n">storage_options</span>
         <span class="k">with</span> <span class="n">fsspec</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="o">**</span><span class="p">(</span><span class="n">storage_options</span> <span class="ow">or</span> <span class="p">{}))</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span>
             <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span>
                 <span class="n">fp</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">mmap</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">&quot;r&quot;</span><span class="p">,</span> <span class="n">maskandscale</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span>
@@ -341,7 +342,7 @@ <h1>Source code for kerchunk.netCDF3</h1><div class="highlight"><pre>
         <span class="p">)</span>
 
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">threshold</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
-            <span class="n">out</span> <span class="o">=</span> <span class="n">do_inline</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">threshold</span><span class="p">)</span>
+            <span class="n">out</span> <span class="o">=</span> <span class="n">do_inline</span><span class="p">(</span><span class="n">out</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">threshold</span><span class="p">,</span> <span class="n">remote_options</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">storage_options</span><span class="p">)</span>
         <span class="n">out</span> <span class="o">=</span> <span class="n">_encode_for_JSON</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
 
         <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;version&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> <span class="s2">&quot;refs&quot;</span><span class="p">:</span> <span class="n">out</span><span class="p">}</span></div></div>

diff --git a/_modules/kerchunk/utils.html b/_modules/kerchunk/utils.html
@@ -216,13 +216,18 @@ <h1>Source code for kerchunk.utils</h1><div class="highlight"><pre>
     <span class="k">return</span> <span class="n">store</span>
 
 
-<div class="viewcode-block" id="do_inline"><a class="viewcode-back" href="../../reference.html#kerchunk.utils.do_inline">[docs]</a><span class="k">def</span> <span class="nf">do_inline</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">threshold</span><span class="p">,</span> <span class="n">remote_options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+<div class="viewcode-block" id="do_inline"><a class="viewcode-back" href="../../reference.html#kerchunk.utils.do_inline">[docs]</a><span class="k">def</span> <span class="nf">do_inline</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">threshold</span><span class="p">,</span> <span class="n">remote_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">remote_protocol</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Replace short chunks with the value of that chunk</span>
 
 <span class="sd">    The chunk may need encoding with base64 if not ascii, so actual</span>
 <span class="sd">    length may be larger than threshold.</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">fs</span> <span class="o">=</span> <span class="n">fsspec</span><span class="o">.</span><span class="n">filesystem</span><span class="p">(</span><span class="s2">&quot;reference&quot;</span><span class="p">,</span> <span class="n">fo</span><span class="o">=</span><span class="n">store</span><span class="p">,</span> <span class="o">**</span><span class="p">(</span><span class="n">remote_options</span> <span class="ow">or</span> <span class="p">{}))</span>
+    <span class="n">fs</span> <span class="o">=</span> <span class="n">fsspec</span><span class="o">.</span><span class="n">filesystem</span><span class="p">(</span>
+        <span class="s2">&quot;reference&quot;</span><span class="p">,</span>
+        <span class="n">fo</span><span class="o">=</span><span class="n">store</span><span class="p">,</span>
+        <span class="n">remote_options</span><span class="o">=</span><span class="n">remote_options</span><span class="p">,</span>
+        <span class="n">remote_protocol</span><span class="o">=</span><span class="n">remote_protocol</span><span class="p">,</span>
+    <span class="p">)</span>
     <span class="n">out</span> <span class="o">=</span> <span class="n">fs</span><span class="o">.</span><span class="n">references</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
     <span class="n">get_keys</span> <span class="o">=</span> <span class="p">[</span>
         <span class="n">k</span>
@@ -314,6 +319,7 @@ <h1>Source code for kerchunk.utils</h1><div class="highlight"><pre>
 <span class="sd">    modified store</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">fs</span> <span class="o">=</span> <span class="n">fsspec</span><span class="o">.</span><span class="n">filesystem</span><span class="p">(</span><span class="s2">&quot;reference&quot;</span><span class="p">,</span> <span class="n">fo</span><span class="o">=</span><span class="n">store</span><span class="p">)</span>
+    <span class="n">store</span> <span class="o">=</span> <span class="n">copy</span><span class="o">.</span><span class="n">deepcopy</span><span class="p">(</span><span class="n">store</span><span class="p">)</span>
     <span class="n">meta_file</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{variable}</span><span class="s2">/.zarray&quot;</span>
     <span class="n">meta</span> <span class="o">=</span> <span class="n">ujson</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">fs</span><span class="o">.</span><span class="n">cat</span><span class="p">(</span><span class="n">meta_file</span><span class="p">))</span>
     <span class="k">if</span> <span class="n">meta</span><span class="p">[</span><span class="s2">&quot;compressor&quot;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

diff --git a/reference.html b/reference.html
@@ -804,7 +804,7 @@ <h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this he
 
 <dl class="function">
 <dt id="kerchunk.utils.do_inline">
-<code class="sig-prename descclassname">kerchunk.utils.</code><code class="sig-name descname">do_inline</code><span class="sig-paren">(</span><em class="sig-param">store</em>, <em class="sig-param">threshold</em>, <em class="sig-param">remote_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/kerchunk/utils.html#do_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#kerchunk.utils.do_inline" title="Permalink to this definition">¶</a></dt>
+<code class="sig-prename descclassname">kerchunk.utils.</code><code class="sig-name descname">do_inline</code><span class="sig-paren">(</span><em class="sig-param">store</em>, <em class="sig-param">threshold</em>, <em class="sig-param">remote_options=None</em>, <em class="sig-param">remote_protocol=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/kerchunk/utils.html#do_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#kerchunk.utils.do_inline" title="Permalink to this definition">¶</a></dt>
 <dd><p>Replace short chunks with the value of that chunk</p>
 <p>The chunk may need encoding with base64 if not ascii, so actual
 length may be larger than threshold.</p>