Skip to content

Commit

Permalink
**CI** Formatted code + Updated version number and documentation. [sk…
Browse files Browse the repository at this point in the history
…ip ci]
  • Loading branch information
thorwhalen committed Sep 3, 2021
1 parent 482e0d0 commit e4ae0d1
Show file tree
Hide file tree
Showing 80 changed files with 40,006 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: d28be96559f8cc05617f7e941f75f4e3
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/.nojekyll
Empty file.
121 changes: 121 additions & 0 deletions docs/_modules/collections/abc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@

<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>collections.abc &#8212; dol 0.1.34 documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css" />
<script id="documentation_options" data-url_root="../../" 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/language_data.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for collections.abc</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">_collections_abc</span> <span class="kn">import</span> <span class="o">*</span>
<span class="kn">from</span> <span class="nn">_collections_abc</span> <span class="kn">import</span> <span class="n">__all__</span>
</pre></div>

</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">dol</a></h1>








<h3>Navigation</h3>
<p><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol.html">dol</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/appendable.html">dol.appendable</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/base.html">dol.base</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/caching.html">dol.caching</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/core.html">dol.core</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/dig.html">dol.dig</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/errors.html">dol.errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/filesys.html">dol.filesys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/mixins.html">dol.mixins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/naming.html">dol.naming</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/paths.html">dol.paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/signatures.html">dol.signatures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/sources.html">dol.sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/tests/pickability_test.html">dol.tests.pickability_test</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/tests/scrap.html">dol.tests.scrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/trans.html">dol.trans</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../module_docs/dol/util.html">dol.util</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;NO COPYRIGHT.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>




</body>
</html>
185 changes: 185 additions & 0 deletions docs/_modules/dol.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@

<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>dol &#8212; dol 0.1.34 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
<script id="documentation_options" data-url_root="../" 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/language_data.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />

<link rel="stylesheet" href="../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for dol</h1><div class="highlight"><pre>
<span></span><span class="sd">&quot;&quot;&quot;Core tools to build simple interfaces to complex data sources and bend the interface to your will (and need)&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>

<span class="c1"># from contextlib import suppress</span>

<span class="n">file_sep</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span>


<div class="viewcode-block" id="kvhead"><a class="viewcode-back" href="../module_docs/dol.html#dol.kvhead">[docs]</a><span class="k">def</span> <span class="nf">kvhead</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get the first item of a kv store, or a list of the first n items&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">for</span> <span class="n">k</span> <span class="ow">in</span> <span class="n">store</span><span class="p">:</span>
<span class="k">return</span> <span class="n">k</span><span class="p">,</span> <span class="n">store</span><span class="p">[</span><span class="n">k</span><span class="p">]</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[(</span><span class="n">k</span><span class="p">,</span> <span class="n">store</span><span class="p">[</span><span class="n">k</span><span class="p">])</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">k</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">store</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">n</span><span class="p">]</span></div>


<div class="viewcode-block" id="ihead"><a class="viewcode-back" href="../module_docs/dol.html#dol.ihead">[docs]</a><span class="k">def</span> <span class="nf">ihead</span><span class="p">(</span><span class="n">store</span><span class="p">,</span> <span class="n">n</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Get the first item of an iterable, or a list of the first n items&quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">n</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
<span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="nb">iter</span><span class="p">(</span><span class="n">store</span><span class="p">):</span>
<span class="k">return</span> <span class="n">item</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="p">[</span><span class="n">item</span> <span class="k">for</span> <span class="n">i</span><span class="p">,</span> <span class="n">item</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="n">store</span><span class="p">)</span> <span class="k">if</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">n</span><span class="p">]</span></div>


<span class="kn">from</span> <span class="nn">dol.util</span> <span class="kn">import</span> <span class="n">lazyprop</span><span class="p">,</span> <span class="n">partialclass</span><span class="p">,</span> <span class="n">groupby</span><span class="p">,</span> <span class="n">regroupby</span><span class="p">,</span> <span class="n">igroupby</span>

<span class="kn">from</span> <span class="nn">dol.base</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">Collection</span><span class="p">,</span>
<span class="n">KvReader</span><span class="p">,</span>
<span class="n">KvPersister</span><span class="p">,</span>
<span class="n">Reader</span><span class="p">,</span>
<span class="n">Persister</span><span class="p">,</span>
<span class="n">kv_walk</span><span class="p">,</span>
<span class="n">Store</span><span class="p">,</span>
<span class="p">)</span>

<span class="kn">from</span> <span class="nn">dol.trans</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">wrap_kvs</span><span class="p">,</span>
<span class="n">disable_delitem</span><span class="p">,</span>
<span class="n">disable_setitem</span><span class="p">,</span>
<span class="n">mk_read_only</span><span class="p">,</span>
<span class="n">kv_wrap</span><span class="p">,</span>
<span class="n">cached_keys</span><span class="p">,</span>
<span class="n">filt_iter</span><span class="p">,</span>
<span class="n">add_path_get</span><span class="p">,</span>
<span class="n">insert_aliases</span><span class="p">,</span>
<span class="n">add_ipython_key_completions</span><span class="p">,</span>
<span class="n">cache_iter</span><span class="p">,</span> <span class="c1"># being deprecated</span>
<span class="p">)</span>

<span class="kn">from</span> <span class="nn">dol.caching</span> <span class="kn">import</span> <span class="p">(</span>
<span class="n">WriteBackChainMap</span><span class="p">,</span>
<span class="n">mk_cached_store</span><span class="p">,</span>
<span class="n">store_cached</span><span class="p">,</span>
<span class="n">store_cached_with_single_key</span><span class="p">,</span>
<span class="n">ensure_clear_to_kv_store</span><span class="p">,</span>
<span class="n">flush_on_exit</span><span class="p">,</span>
<span class="n">mk_write_cached_store</span><span class="p">,</span>
<span class="p">)</span>

<span class="kn">from</span> <span class="nn">dol.appendable</span> <span class="kn">import</span> <span class="n">appendable</span>

<span class="kn">from</span> <span class="nn">dol.naming</span> <span class="kn">import</span> <span class="n">StrTupleDict</span><span class="p">,</span> <span class="n">mk_store_from_path_format_store_cls</span>
<span class="kn">from</span> <span class="nn">dol.paths</span> <span class="kn">import</span> <span class="n">mk_relative_path_store</span>
</pre></div>

</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">dol</a></h1>








<h3>Navigation</h3>
<p><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol.html">dol</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/appendable.html">dol.appendable</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/base.html">dol.base</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/caching.html">dol.caching</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/core.html">dol.core</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/dig.html">dol.dig</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/errors.html">dol.errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/filesys.html">dol.filesys</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/mixins.html">dol.mixins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/naming.html">dol.naming</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/paths.html">dol.paths</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/signatures.html">dol.signatures</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/sources.html">dol.sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/tests/pickability_test.html">dol.tests.pickability_test</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/tests/scrap.html">dol.tests.scrap</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/trans.html">dol.trans</a></li>
<li class="toctree-l1"><a class="reference internal" href="../module_docs/dol/util.html">dol.util</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;NO COPYRIGHT.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>




</body>
</html>
Loading

0 comments on commit e4ae0d1

Please sign in to comment.