pylib
/
stringtools
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Python Library Stringtools
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
Tree: b86248c1a3
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'b86248c1a3'
${ noResults }
stringtools/_docs_/index.html

index.html 46KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463 
  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">

  6.   <head>

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  8.     <title>Welcome to stringtools’s documentation! &#8212; stringtools  documentation</title>

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

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

  11.     <script type="text/javascript">

  12.       var DOCUMENTATION_OPTIONS = {

  13.         URL_ROOT:    './',

  14.         VERSION:     '',

  15.         COLLAPSE_INDEX: false,

  16.         FILE_SUFFIX: '.html',

  17.         HAS_SOURCE:  true,

  18.         SOURCELINK_SUFFIX: '.txt'

  19.       };

  20.     </script>

  21.     <script type="text/javascript" src="_static/jquery.js"></script>

  22.     <script type="text/javascript" src="_static/underscore.js"></script>

  23.     <script type="text/javascript" src="_static/doctools.js"></script>

  24.     <link rel="index" title="Index" href="genindex.html" />

  25.     <link rel="search" title="Search" href="search.html" />

  26.    

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

  28.   

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

  30. 

  31.   </head>

  32.   <body>

  33.   

  34. 

  35.     <div class="document">

  36.       <div class="documentwrapper">

  37.         <div class="bodywrapper">

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

  39.             

  40.   <div class="section" id="module-stringtools">

  41. <span id="welcome-to-stringtools-s-documentation"></span><h1>Welcome to stringtools’s documentation!<a class="headerlink" href="#module-stringtools" title="Permalink to this headline">¶</a></h1>

  42. <div class="section" id="stringtools-stringtools">

  43. <h2>stringtools (Stringtools)<a class="headerlink" href="#stringtools-stringtools" title="Permalink to this headline">¶</a></h2>

  44. <p><strong>Author:</strong></p>

  45. <ul class="simple">

  46. <li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>

  47. </ul>

  48. <p><strong>Description:</strong></p>

  49. <blockquote>

  50. <div>This Module supports functionality around string operations.</div></blockquote>

  51. <p><strong>Submodules:</strong></p>

  52. <ul class="simple">

  53. <li><a class="reference internal" href="#module-stringtools.csp" title="stringtools.csp"><code class="xref py py-mod docutils literal"><span class="pre">stringtools.csp</span></code></a></li>

  54. <li><a class="reference internal" href="#module-stringtools.stp" title="stringtools.stp"><code class="xref py py-mod docutils literal"><span class="pre">stringtools.stp</span></code></a></li>

  55. <li><a class="reference internal" href="#stringtools.gzip_compress" title="stringtools.gzip_compress"><code class="xref py py-func docutils literal"><span class="pre">gzip_compress()</span></code></a></li>

  56. <li><a class="reference internal" href="#stringtools.gzip_extract" title="stringtools.gzip_extract"><code class="xref py py-func docutils literal"><span class="pre">gzip_extract()</span></code></a></li>

  57. <li><a class="reference internal" href="#stringtools.hexlify" title="stringtools.hexlify"><code class="xref py py-func docutils literal"><span class="pre">hexlify()</span></code></a></li>

  58. </ul>

  59. <p><strong>Unittest:</strong></p>

  60. <blockquote>

  61. <div>See also the <a class="reference download internal" href="_downloads/unittest.pdf" download=""><code class="xref download docutils literal"><span class="pre">unittest</span></code></a> documentation.</div></blockquote>

  62. <p><strong>Module Documentation:</strong></p>

  63. <dl class="function">

  64. <dt id="stringtools.gzip_compress">

  65. <code class="descclassname">stringtools.</code><code class="descname">gzip_compress</code><span class="sig-paren">(</span><em>s</em>, <em>compresslevel=9</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.gzip_compress" title="Permalink to this definition">¶</a></dt>

  66. <dd><p>Method to compress a stream of bytes.</p>

  67. <table class="docutils field-list" frame="void" rules="none">

  68. <col class="field-name" />

  69. <col class="field-body" />

  70. <tbody valign="top">

  71. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">

  72. <li><strong>s</strong> (<em>str</em>) – The bytestream (string) to be compressed</li>

  73. <li><strong>compresslevel</strong> (<em>int</em>) – An optional compressionn level (default is 9)</li>

  74. </ul>

  75. </td>

  76. </tr>

  77. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The compressed bytestream</p>

  78. </td>

  79. </tr>

  80. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>

  81. </td>

  82. </tr>

  83. </tbody>

  84. </table>

  85. <p><strong>Example:</strong></p>

  86. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">stringtools</span>

  87. <span class="kn">import</span> <span class="nn">report</span>

  88. <span class="kn">import</span> <span class="nn">logging</span>

  89. <span class="kn">import</span> <span class="nn">sys</span>

  90. 

  91. 

  92. <span class="n">logger</span> <span class="o">=</span> <span class="n">report</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">,</span> <span class="p">[(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">))],</span> <span class="n">report</span><span class="o">.</span><span class="n">SHORT_FMT</span><span class="p">)</span>

  93. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">gzip_compress</span><span class="p">(</span><span class="mi">15</span> <span class="o">*</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\x00</span><span class="s1">&#39;</span> <span class="o">+</span> <span class="mi">15</span> <span class="o">*</span> <span class="sa">b</span><span class="s1">&#39;</span><span class="se">\xff</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">)))</span>

  94. 

  95. </pre></div>

  96. </div>

  97. <p>Will result to the following output:</p>

  98. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">19</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">02</span><span class="p">,</span><span class="mi">852</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">Finished</span> <span class="n">to</span> <span class="n">compress</span> <span class="n">a</span> <span class="n">string</span> <span class="p">(</span><span class="n">compression_rate</span><span class="o">=</span><span class="mf">0.867</span><span class="p">,</span> <span class="n">consumed_time</span><span class="o">=</span><span class="mf">0.0</span><span class="n">s</span><span class="p">)</span><span class="o">.</span>

  99. <span class="p">(</span><span class="mi">26</span><span class="p">):</span> <span class="mi">1</span><span class="n">f</span> <span class="mi">8</span><span class="n">b</span> <span class="mi">08</span> <span class="mi">00</span> <span class="mi">5</span><span class="n">a</span> <span class="mi">83</span> <span class="n">e5</span> <span class="mi">5</span><span class="n">c</span> <span class="mi">02</span> <span class="n">ff</span> <span class="mi">63</span> <span class="mi">60</span> <span class="mi">40</span> <span class="mi">01</span> <span class="n">ff</span> <span class="mi">51</span> <span class="mi">01</span> <span class="mi">00</span> <span class="mi">2</span><span class="n">d</span> <span class="mi">8</span><span class="n">a</span> <span class="mi">7</span><span class="n">d</span> <span class="n">de</span> <span class="mi">1</span><span class="n">e</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span>

  100. </pre></div>

  101. </div>

  102. </dd></dl>

  103. 

  104. <dl class="function">

  105. <dt id="stringtools.gzip_extract">

  106. <code class="descclassname">stringtools.</code><code class="descname">gzip_extract</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.gzip_extract" title="Permalink to this definition">¶</a></dt>

  107. <dd><p>Method to extract data from a compress stream of bytes.</p>

  108. <table class="docutils field-list" frame="void" rules="none">

  109. <col class="field-name" />

  110. <col class="field-body" />

  111. <tbody valign="top">

  112. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>s</strong> (<em>str</em>) – The compressed bytestream (string) to be extracted</td>

  113. </tr>

  114. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The extracted data</td>

  115. </tr>

  116. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  117. </tr>

  118. </tbody>

  119. </table>

  120. <p><strong>Example:</strong></p>

  121. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">stringtools</span>

  122. <span class="kn">import</span> <span class="nn">report</span>

  123. <span class="kn">import</span> <span class="nn">logging</span>

  124. <span class="kn">import</span> <span class="nn">sys</span>

  125. 

  126. 

  127. <span class="n">logger</span> <span class="o">=</span> <span class="n">report</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">,</span> <span class="p">[(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">))],</span> <span class="n">report</span><span class="o">.</span><span class="n">SHORT_FMT</span><span class="p">)</span>

  128. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">gzip_extract</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;</span><span class="se">\x1f\x8b\x08\x00\xd0\x82\xe5\x5c\x02\xff\x63\x60\x40\x01\xff\x51\x01\x00\x2d\x8a\x7d\xde\x1e\x00\x00\x00</span><span class="s1">&#39;</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">)))</span>

  129. 

  130. </pre></div>

  131. </div>

  132. <p>Will result to the following output:</p>

  133. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">19</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">09</span><span class="p">,</span><span class="mi">390</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">Finished</span> <span class="n">to</span> <span class="n">extract</span> <span class="n">a</span> <span class="n">string</span> <span class="p">(</span><span class="n">compression_rate</span><span class="o">=</span><span class="mf">0.867</span><span class="p">,</span> <span class="n">consumed_time</span><span class="o">=</span><span class="mf">0.0</span><span class="n">s</span><span class="p">)</span><span class="o">.</span>

  134. <span class="p">(</span><span class="mi">30</span><span class="p">):</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="mi">00</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span> <span class="n">ff</span>

  135. </pre></div>

  136. </div>

  137. </dd></dl>

  138. 

  139. <dl class="function">

  140. <dt id="stringtools.hexlify">

  141. <code class="descclassname">stringtools.</code><code class="descname">hexlify</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.hexlify" title="Permalink to this definition">¶</a></dt>

  142. <dd><p>Method to hexlify a string.</p>

  143. <table class="docutils field-list" frame="void" rules="none">

  144. <col class="field-name" />

  145. <col class="field-body" />

  146. <tbody valign="top">

  147. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>s</strong> (<em>str</em>) – A string including the bytes to be hexlified.</td>

  148. </tr>

  149. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The hexlified string</td>

  150. </tr>

  151. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  152. </tr>

  153. </tbody>

  154. </table>

  155. <p><strong>Example:</strong></p>

  156. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">stringtools</span>

  157. 

  158. 

  159. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;A stringexample with non printable characters like </span><span class="se">\x12</span><span class="s1">&#39;</span><span class="p">))</span>

  160. </pre></div>

  161. </div>

  162. <p>Will result to the following output:</p>

  163. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="mi">52</span><span class="p">):</span> <span class="mi">41</span> <span class="mi">20</span> <span class="mi">73</span> <span class="mi">74</span> <span class="mi">72</span> <span class="mi">69</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">67</span> <span class="mi">65</span> <span class="mi">78</span> <span class="mi">61</span> <span class="mi">6</span><span class="n">d</span> <span class="mi">70</span> <span class="mi">6</span><span class="n">c</span> <span class="mi">65</span> <span class="mi">20</span> <span class="mi">77</span> <span class="mi">69</span> <span class="mi">74</span> <span class="mi">68</span> <span class="mi">20</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">6</span><span class="n">f</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">20</span> <span class="mi">70</span> <span class="mi">72</span> <span class="mi">69</span> <span class="mi">6</span><span class="n">e</span> <span class="mi">74</span> <span class="mi">61</span> <span class="mi">62</span> <span class="mi">6</span><span class="n">c</span> <span class="mi">65</span> <span class="mi">20</span> <span class="mi">63</span> <span class="mi">68</span> <span class="mi">61</span> <span class="mi">72</span> <span class="mi">61</span> <span class="mi">63</span> <span class="mi">74</span> <span class="mi">65</span> <span class="mi">72</span> <span class="mi">73</span> <span class="mi">20</span> <span class="mi">6</span><span class="n">c</span> <span class="mi">69</span> <span class="mi">6</span><span class="n">b</span> <span class="mi">65</span> <span class="mi">20</span> <span class="mi">12</span>

  164. </pre></div>

  165. </div>

  166. </dd></dl>

  167. 

  168. </div>

  169. <span class="target" id="module-stringtools.csp"></span><div class="section" id="csp-carriage-return-seperation-protocol">

  170. <h2>csp (Carriage-Return seperation protocol)<a class="headerlink" href="#csp-carriage-return-seperation-protocol" title="Permalink to this headline">¶</a></h2>

  171. <p><strong>Author:</strong></p>

  172. <ul class="simple">

  173. <li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>

  174. </ul>

  175. <p><strong>Description:</strong></p>

  176. <blockquote>

  177. <div>This module is a submodule of <a class="reference internal" href="#module-stringtools" title="stringtools"><code class="xref py py-mod docutils literal"><span class="pre">stringtools</span></code></a> and creates an frame to transmit and receive messages via an serial interface.</div></blockquote>

  178. <p><strong>Submodules:</strong></p>

  179. <ul class="simple">

  180. <li><a class="reference internal" href="#stringtools.csp.csp" title="stringtools.csp.csp"><code class="xref py py-class docutils literal"><span class="pre">stringtools.csp.csp</span></code></a></li>

  181. <li><a class="reference internal" href="#stringtools.csp.build_frame" title="stringtools.csp.build_frame"><code class="xref py py-func docutils literal"><span class="pre">stringtools.csp.build_frame()</span></code></a></li>

  182. </ul>

  183. <dl class="function">

  184. <dt id="stringtools.csp.build_frame">

  185. <code class="descclassname">stringtools.csp.</code><code class="descname">build_frame</code><span class="sig-paren">(</span><em>msg</em>, <em>seperator='\n'</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.csp.build_frame" title="Permalink to this definition">¶</a></dt>

  186. <dd><p>This Method builds an “csp-frame” to be transfered via a stream.</p>

  187. <table class="docutils field-list" frame="void" rules="none">

  188. <col class="field-name" />

  189. <col class="field-body" />

  190. <tbody valign="top">

  191. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>str</em>) – A String (Bytes) to be framed</td>

  192. </tr>

  193. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The “csp-framed” message to be sent</td>

  194. </tr>

  195. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  196. </tr>

  197. </tbody>

  198. </table>

  199. <p><strong>Example:</strong></p>

  200. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">stringtools</span>

  201. 

  202. <span class="n">data</span> <span class="o">=</span> <span class="sa">b</span><span class="s1">&#39;message&#39;</span>

  203. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>

  204. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">hexlify</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">csp</span><span class="o">.</span><span class="n">build_frame</span><span class="p">(</span><span class="n">data</span><span class="p">)))</span>

  205. 

  206. </pre></div>

  207. </div>

  208. <p>Will result to the following output:</p>

  209. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="mi">7</span><span class="p">):</span> <span class="mi">6</span><span class="n">d</span> <span class="mi">65</span> <span class="mi">73</span> <span class="mi">73</span> <span class="mi">61</span> <span class="mi">67</span> <span class="mi">65</span>

  210. <span class="p">(</span><span class="mi">8</span><span class="p">):</span> <span class="mi">6</span><span class="n">d</span> <span class="mi">65</span> <span class="mi">73</span> <span class="mi">73</span> <span class="mi">61</span> <span class="mi">67</span> <span class="mi">65</span> <span class="mi">0</span><span class="n">a</span>

  211. </pre></div>

  212. </div>

  213. </dd></dl>

  214. 

  215. <dl class="class">

  216. <dt id="stringtools.csp.csp">

  217. <em class="property">class </em><code class="descclassname">stringtools.csp.</code><code class="descname">csp</code><span class="sig-paren">(</span><em>seperator='n'</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.csp.csp" title="Permalink to this definition">¶</a></dt>

  218. <dd><p>This class extracts messages from an “csp-stream”.</p>

  219. <p><strong>Example:</strong></p>

  220. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>

  221. <span class="kn">import</span> <span class="nn">report</span>

  222. <span class="kn">import</span> <span class="nn">stringtools</span>

  223. <span class="kn">import</span> <span class="nn">sys</span>

  224. 

  225. <span class="n">logger</span> <span class="o">=</span> <span class="n">report</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">,</span> <span class="p">[(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">))],</span> <span class="n">report</span><span class="o">.</span><span class="n">SHORT_FMT</span><span class="p">)</span>

  226. <span class="n">s</span> <span class="o">=</span> <span class="n">stringtools</span><span class="o">.</span><span class="n">csp</span><span class="o">.</span><span class="n">csp</span><span class="p">()</span>

  227. <span class="k">for</span> <span class="n">byte</span> <span class="ow">in</span> <span class="sa">b</span><span class="s1">&#39;message</span><span class="se">\n</span><span class="s1">&#39;</span><span class="p">:</span>

  228.     <span class="n">data</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">byte</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>

  229.     <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

  230.         <span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  231. 

  232. </pre></div>

  233. </div>

  234. <p>Will result to the following output:</p>

  235. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;m&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  236. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;e&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  237. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;s&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  238. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;s&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  239. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;a&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  240. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;g&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  241. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Adding</span> <span class="sa">b</span><span class="s1">&#39;e&#39;</span> <span class="n">to</span> <span class="n">buffer</span>

  242. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">41</span><span class="p">:</span><span class="mi">54</span><span class="p">,</span><span class="mi">305</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">CSP</span><span class="p">:</span>       <span class="n">Message</span> <span class="n">identified</span> <span class="n">by</span> <span class="n">seperator</span> <span class="mi">0</span><span class="n">a</span>

  243. <span class="sa">b</span><span class="s1">&#39;message&#39;</span>

  244. </pre></div>

  245. </div>

  246. <dl class="method">

  247. <dt id="stringtools.csp.csp.process">

  248. <code class="descname">process</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.csp.csp.process" title="Permalink to this definition">¶</a></dt>

  249. <dd><p>This processes a byte out of a “stp-stream”.</p>

  250. <table class="docutils field-list" frame="void" rules="none">

  251. <col class="field-name" />

  252. <col class="field-body" />

  253. <tbody valign="top">

  254. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>) – A byte stream</td>

  255. </tr>

  256. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A list of the extracted message(s)</td>

  257. </tr>

  258. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">list</td>

  259. </tr>

  260. </tbody>

  261. </table>

  262. </dd></dl>

  263. 

  264. </dd></dl>

  265. 

  266. </div>

  267. <span class="target" id="module-stringtools.stp"></span><div class="section" id="stp-serial-transfer-protocol">

  268. <h2>stp (Serial transfer protocol)<a class="headerlink" href="#stp-serial-transfer-protocol" title="Permalink to this headline">¶</a></h2>

  269. <p><strong>Author:</strong></p>

  270. <ul class="simple">

  271. <li>Dirk Alders &lt;<a class="reference external" href="mailto:sudo-dirk&#37;&#52;&#48;mount-mockery&#46;de">sudo-dirk<span>&#64;</span>mount-mockery<span>&#46;</span>de</a>&gt;</li>

  272. </ul>

  273. <p><strong>Description:</strong></p>

  274. <blockquote>

  275. <div>This module is a submodule of <a class="reference internal" href="#module-stringtools" title="stringtools"><code class="xref py py-mod docutils literal"><span class="pre">stringtools</span></code></a> and creates an serial frame to transmit and receive messages via an serial interface.</div></blockquote>

  276. <p><strong>Submodules:</strong></p>

  277. <ul class="simple">

  278. <li><a class="reference internal" href="#stringtools.stp.stp" title="stringtools.stp.stp"><code class="xref py py-class docutils literal"><span class="pre">stringtools.stp.stp</span></code></a></li>

  279. <li><a class="reference internal" href="#stringtools.stp.build_frame" title="stringtools.stp.build_frame"><code class="xref py py-func docutils literal"><span class="pre">stringtools.stp.build_frame()</span></code></a></li>

  280. </ul>

  281. <dl class="data">

  282. <dt id="stringtools.stp.DATA_CLEAR_BUFFER">

  283. <code class="descclassname">stringtools.stp.</code><code class="descname">DATA_CLEAR_BUFFER</code><em class="property"> = '&lt;'</em><a class="headerlink" href="#stringtools.stp.DATA_CLEAR_BUFFER" title="Permalink to this definition">¶</a></dt>

  284. <dd><p>The clear buffer byte (‘\x3a\x3c’ -&gt; start of message)</p>

  285. </dd></dl>

  286. 

  287. <dl class="data">

  288. <dt id="stringtools.stp.DATA_STORE_SYNC_VALUE">

  289. <code class="descclassname">stringtools.stp.</code><code class="descname">DATA_STORE_SYNC_VALUE</code><em class="property"> = '='</em><a class="headerlink" href="#stringtools.stp.DATA_STORE_SYNC_VALUE" title="Permalink to this definition">¶</a></dt>

  290. <dd><p>The store sync value byte (‘\x3a\x3d’ -&gt; ‘\x3a’ inside a message)</p>

  291. </dd></dl>

  292. 

  293. <dl class="data">

  294. <dt id="stringtools.stp.DATA_SYNC">

  295. <code class="descclassname">stringtools.stp.</code><code class="descname">DATA_SYNC</code><em class="property"> = ':'</em><a class="headerlink" href="#stringtools.stp.DATA_SYNC" title="Permalink to this definition">¶</a></dt>

  296. <dd><p>The data sync byte</p>

  297. </dd></dl>

  298. 

  299. <dl class="data">

  300. <dt id="stringtools.stp.DATA_VALID_MSG">

  301. <code class="descclassname">stringtools.stp.</code><code class="descname">DATA_VALID_MSG</code><em class="property"> = '&gt;'</em><a class="headerlink" href="#stringtools.stp.DATA_VALID_MSG" title="Permalink to this definition">¶</a></dt>

  302. <dd><p>The valid message byte (‘\x3a\x3e’ -&gt; end of message)</p>

  303. </dd></dl>

  304. 

  305. <dl class="data">

  306. <dt id="stringtools.stp.STP_STATE_ESCAPE_1">

  307. <code class="descclassname">stringtools.stp.</code><code class="descname">STP_STATE_ESCAPE_1</code><em class="property"> = 1</em><a class="headerlink" href="#stringtools.stp.STP_STATE_ESCAPE_1" title="Permalink to this definition">¶</a></dt>

  308. <dd><p>Escape 1 state definition (‘\x3a\x3c’ found)</p>

  309. </dd></dl>

  310. 

  311. <dl class="data">

  312. <dt id="stringtools.stp.STP_STATE_ESCAPE_2">

  313. <code class="descclassname">stringtools.stp.</code><code class="descname">STP_STATE_ESCAPE_2</code><em class="property"> = 2</em><a class="headerlink" href="#stringtools.stp.STP_STATE_ESCAPE_2" title="Permalink to this definition">¶</a></dt>

  314. <dd><p>Escape 2 state definition (‘\x3a’ found inside a message)</p>

  315. </dd></dl>

  316. 

  317. <dl class="data">

  318. <dt id="stringtools.stp.STP_STATE_IDLE">

  319. <code class="descclassname">stringtools.stp.</code><code class="descname">STP_STATE_IDLE</code><em class="property"> = 0</em><a class="headerlink" href="#stringtools.stp.STP_STATE_IDLE" title="Permalink to this definition">¶</a></dt>

  320. <dd><p>Idle state definition (default)</p>

  321. </dd></dl>

  322. 

  323. <dl class="data">

  324. <dt id="stringtools.stp.STP_STATE_STORE_DATA">

  325. <code class="descclassname">stringtools.stp.</code><code class="descname">STP_STATE_STORE_DATA</code><em class="property"> = 3</em><a class="headerlink" href="#stringtools.stp.STP_STATE_STORE_DATA" title="Permalink to this definition">¶</a></dt>

  326. <dd><p>Store data state definition (start of message found; data will be stored)</p>

  327. </dd></dl>

  328. 

  329. <dl class="function">

  330. <dt id="stringtools.stp.build_frame">

  331. <code class="descclassname">stringtools.stp.</code><code class="descname">build_frame</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.stp.build_frame" title="Permalink to this definition">¶</a></dt>

  332. <dd><p>This Method builds an “stp-frame” to be transfered via a stream.</p>

  333. <table class="docutils field-list" frame="void" rules="none">

  334. <col class="field-name" />

  335. <col class="field-body" />

  336. <tbody valign="top">

  337. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>str</em>) – A String (Bytes) to be framed</td>

  338. </tr>

  339. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The “stp-framed” message to be sent</td>

  340. </tr>

  341. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  342. </tr>

  343. </tbody>

  344. </table>

  345. <p><strong>Example:</strong></p>

  346. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">stringtools</span>

  347. 

  348. <span class="nb">print</span><span class="p">(</span><span class="n">stringtools</span><span class="o">.</span><span class="n">stp</span><span class="o">.</span><span class="n">build_frame</span><span class="p">(</span><span class="sa">b</span><span class="s1">&#39;:message:&#39;</span><span class="p">))</span>

  349. </pre></div>

  350. </div>

  351. <p>Will result to the following output:</p>

  352. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="sa">b</span><span class="s1">&#39;:&lt;:=message:=:&gt;&#39;</span>

  353. </pre></div>

  354. </div>

  355. </dd></dl>

  356. 

  357. <dl class="class">

  358. <dt id="stringtools.stp.stp">

  359. <em class="property">class </em><code class="descclassname">stringtools.stp.</code><code class="descname">stp</code><a class="headerlink" href="#stringtools.stp.stp" title="Permalink to this definition">¶</a></dt>

  360. <dd><p>This class extracts messages from an “stp-stream”.</p>

  361. <p><strong>Example:</strong></p>

  362. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>

  363. <span class="kn">import</span> <span class="nn">report</span>

  364. <span class="kn">import</span> <span class="nn">stringtools</span>

  365. <span class="kn">import</span> <span class="nn">sys</span>

  366. 

  367. <span class="n">logger</span> <span class="o">=</span> <span class="n">report</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">,</span> <span class="p">[(</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">logging</span><span class="o">.</span><span class="n">StreamHandler</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">stdout</span><span class="p">))],</span> <span class="n">report</span><span class="o">.</span><span class="n">SHORT_FMT</span><span class="p">)</span>

  368. <span class="n">s</span> <span class="o">=</span> <span class="n">stringtools</span><span class="o">.</span><span class="n">stp</span><span class="o">.</span><span class="n">stp</span><span class="p">()</span>

  369. <span class="k">for</span> <span class="n">byte</span> <span class="ow">in</span> <span class="sa">b</span><span class="s1">&#39;:&lt;:=message:=:&gt;&#39;</span><span class="p">:</span>

  370.     <span class="n">data</span> <span class="o">=</span> <span class="n">s</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">byte</span><span class="p">,</span> <span class="n">logger</span><span class="p">)</span>

  371.     <span class="k">if</span> <span class="n">data</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>

  372.         <span class="nb">print</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>

  373. 

  374. </pre></div>

  375. </div>

  376. <p>Will result to the following output:</p>

  377. <div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">data</span> <span class="n">sync</span> <span class="p">(</span><span class="mi">3</span><span class="n">a</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_IDLE</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_ESCAPE_1</span>

  378. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">clear</span> <span class="n">buffer</span> <span class="p">(</span><span class="mi">3</span><span class="n">c</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_ESCAPE_1</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_STORE_DATA</span>

  379. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">data</span> <span class="n">sync</span> <span class="p">(</span><span class="mi">3</span><span class="n">a</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_STORE_DATA</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_ESCAPE_2</span>

  380. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">store</span> <span class="n">sync</span> <span class="n">value</span> <span class="p">(</span><span class="mi">3</span><span class="n">d</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_ESCAPE_2</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_STORE_DATA</span>

  381. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">data</span> <span class="n">sync</span> <span class="p">(</span><span class="mi">3</span><span class="n">a</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_STORE_DATA</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_ESCAPE_2</span>

  382. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">store</span> <span class="n">sync</span> <span class="n">value</span> <span class="p">(</span><span class="mi">3</span><span class="n">d</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_ESCAPE_2</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_STORE_DATA</span>

  383. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">data</span> <span class="n">sync</span> <span class="p">(</span><span class="mi">3</span><span class="n">a</span><span class="p">)</span> <span class="n">received</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_STORE_DATA</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_ESCAPE_2</span>

  384. <span class="mi">2019</span><span class="o">-</span><span class="mi">05</span><span class="o">-</span><span class="mi">22</span> <span class="mi">18</span><span class="p">:</span><span class="mi">43</span><span class="p">:</span><span class="mi">14</span><span class="p">,</span><span class="mi">476</span><span class="p">:</span> <span class="n">DEBUG</span>   <span class="o">-</span> <span class="n">STP</span><span class="p">:</span>       <span class="n">message</span> <span class="n">completed</span> <span class="p">(</span><span class="mi">3</span><span class="n">e</span><span class="p">)</span> <span class="o">=&gt;</span> <span class="n">changing</span> <span class="n">state</span> <span class="n">STP_STATE_ESCAPE_2</span> <span class="o">-&gt;</span> <span class="n">STP_STATE_IDLE</span>

  385. <span class="sa">b</span><span class="s1">&#39;:message:&#39;</span>

  386. </pre></div>

  387. </div>

  388. <dl class="method">

  389. <dt id="stringtools.stp.stp.process">

  390. <code class="descname">process</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#stringtools.stp.stp.process" title="Permalink to this definition">¶</a></dt>

  391. <dd><p>This processes a byte out of a “stp-stream”.</p>

  392. <table class="docutils field-list" frame="void" rules="none">

  393. <col class="field-name" />

  394. <col class="field-body" />

  395. <tbody valign="top">

  396. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>bytes</em>) – A byte stream</td>

  397. </tr>

  398. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The extracted message or None, if no message is identified yet</td>

  399. </tr>

  400. <tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">str</td>

  401. </tr>

  402. </tbody>

  403. </table>

  404. </dd></dl>

  405. 

  406. </dd></dl>

  407. 

  408. </div>

  409. <div class="toctree-wrapper compound">

  410. </div>

  411. </div>

  412. <div class="section" id="indices-and-tables">

  413. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

  414. <ul class="simple">

  415. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>

  416. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>

  417. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>

  418. </ul>

  419. </div>

  420. 

  421. 

  422.           </div>

  423.         </div>

  424.       </div>

  425.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  426.         <div class="sphinxsidebarwrapper"><div class="relations">

  427. <h3>Related Topics</h3>

  428. <ul>

  429.   <li><a href="#">Documentation overview</a><ul>

  430.   </ul></li>

  431. </ul>

  432. </div>

  433. <div id="searchbox" style="display: none" role="search">

  434.   <h3>Quick search</h3>

  435.     <form class="search" action="search.html" method="get">

  436.       <div><input type="text" name="q" /></div>

  437.       <div><input type="submit" value="Go" /></div>

  438.       <input type="hidden" name="check_keywords" value="yes" />

  439.       <input type="hidden" name="area" value="default" />

  440.     </form>

  441. </div>

  442. <script type="text/javascript">$('#searchbox').show(0);</script>

  443.         </div>

  444.       </div>

  445.       <div class="clearer"></div>

  446.     </div>

  447.     <div class="footer">

  448.       &copy;2019, Dirk Alders.

  449.       

  450.       |

  451.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>

  452.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>

  453.       

  454.       |

  455.       <a href="_sources/index.rst.txt"

  456.           rel="nofollow">Page source</a>

  457.     </div>

  458. 

  459.     

  460. 

  461.     

  462.   </body>

  463. </html>