add unique id ending function and get full id function

and write ascii data file function
This commit is contained in:
2019-07-29 19:08:42 +02:00
parent 2503ee1f64
commit 5b6d8b77ae
35 changed files with 426 additions and 221 deletions

View File

@@ -35,14 +35,40 @@
<div class="section" id="module-data">
<span id="data-module"></span><h1>data module<a class="headerlink" href="#module-data" title="Permalink to this headline"></a></h1>
<p>Read and write data to or from file.</p>
<dl class="field-list simple">
<dt class="field-odd">Date</dt>
<dd class="field-odd"><p>2019-07-29</p>
</dd>
</dl>
<span class="target" id="module-data"></span><dl class="function">
<dt id="data.data_load">
<code class="descname">data_load</code><span class="sig-paren">(</span><em>file_name</em>, <em>verbose=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#data_load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.data_load" title="Permalink to this definition"></a></dt>
<dt id="data.get_id">
<code class="sig-name descname">get_id</code><span class="sig-paren">(</span><em class="sig-param">ids</em>, <em class="sig-param">uide</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.get_id" title="Permalink to this definition"></a></dt>
<dd><p>Get full id from unique id ending.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ids</strong> (<em>list</em>) ids</p></li>
<li><p><strong>uide</strong> (<em>str</em>) unique id ending</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>full id</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>str or int</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="data.load">
<code class="sig-name descname">load</code><span class="sig-paren">(</span><em class="sig-param">file_name</em>, <em class="sig-param">default=None</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#load"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.load" title="Permalink to this definition"></a></dt>
<dd><p>Load stored program objects from binary file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file_name</strong> (<em>str</em>) file to load</p></li>
<li><p><strong>default</strong> (<em>object</em>) return object if data loading fails</p></li>
<li><p><strong>verbose</strong> (<em>bool</em>) verbose information (default = False)</p></li>
</ul>
</dd>
@@ -56,8 +82,8 @@
</dd></dl>
<dl class="function">
<dt id="data.data_read">
<code class="descname">data_read</code><span class="sig-paren">(</span><em>file_name</em>, <em>x_column</em>, <em>y_column</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#data_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.data_read" title="Permalink to this definition"></a></dt>
<dt id="data.read">
<code class="sig-name descname">read</code><span class="sig-paren">(</span><em class="sig-param">file_name</em>, <em class="sig-param">x_column</em>, <em class="sig-param">y_column</em>, <em class="sig-param">default=None</em>, <em class="sig-param">verbose=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.read" title="Permalink to this definition"></a></dt>
<dd><p>Read ascii data file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@@ -65,6 +91,8 @@
<li><p><strong>filename</strong> (<em>str</em>) file to read</p></li>
<li><p><strong>x_column</strong> (<em>int</em>) column index for the x data (first column is 0)</p></li>
<li><p><strong>y_column</strong> (<em>int</em>) column index for the y data (first column is 0)</p></li>
<li><p><strong>default</strong> (<em>object</em>) return object if data loading fails</p></li>
<li><p><strong>verbose</strong> (<em>bool</em>) verbose information (default = False)</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
@@ -77,8 +105,8 @@
</dd></dl>
<dl class="function">
<dt id="data.data_store">
<code class="descname">data_store</code><span class="sig-paren">(</span><em>file_name</em>, <em>object_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#data_store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.data_store" title="Permalink to this definition"></a></dt>
<dt id="data.store">
<code class="sig-name descname">store</code><span class="sig-paren">(</span><em class="sig-param">file_name</em>, <em class="sig-param">object_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#store"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.store" title="Permalink to this definition"></a></dt>
<dd><p>Store program objects to binary file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@@ -91,9 +119,37 @@
</dd></dl>
<dl class="function">
<dt id="data.main">
<code class="descname">main</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#main"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.main" title="Permalink to this definition"></a></dt>
<dd><p>Main function.</p>
<dt id="data.unique_ending">
<code class="sig-name descname">unique_ending</code><span class="sig-paren">(</span><em class="sig-param">ids</em>, <em class="sig-param">n=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#unique_ending"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.unique_ending" title="Permalink to this definition"></a></dt>
<dd><p>From id list get list with unique ending.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ids</strong> (<em>list</em>) ids</p></li>
<li><p><strong>n</strong> (<em>int</em>) minumum chars or ints</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>unique ending of ids</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="data.write">
<code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param">file_name</em>, <em class="sig-param">data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/data.html#write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#data.write" title="Permalink to this definition"></a></dt>
<dd><p>Write ascii file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>file_name</strong> (<em>str</em>) file to write</p></li>
<li><p><strong>data</strong> (<em>str</em>) data to write</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</div>
@@ -124,10 +180,10 @@
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
@@ -149,7 +205,7 @@
&copy;2019, Daniel Weschke.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.0.1</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 2.1.2</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|