Skip to content

Commit f981e5b

Browse files
author
GitHub CI Runner
committed
**CI** Formatted code + Updated version number and documentation. [skip ci]
1 parent 9e16773 commit f981e5b

35 files changed

+75
-40
lines changed

‎docs/.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: d184bd7130d269c5f8fadf99ad2a1e03
3+
config: 304cafd21d0801eaac2018182e54aa74
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Overview: module code &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
6+
<title>Overview: module code &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/buffer_reader.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.buffer_reader &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.buffer_reader &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/simply.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.simply &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.simply &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/source_reader.html

+17-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.source_reader &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.source_reader &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -234,7 +234,22 @@ <h1>Source code for stream2py.source_reader</h1><div class="highlight"><pre>
234234
<span class="k">return</span> <span class="bp">self</span>
235235

236236
<span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
237-
<span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
237+
<span class="bp">self</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
238+
239+
<span class="k">def</span> <span class="nf">stream_buffer</span><span class="p">(</span>
240+
<span class="bp">self</span><span class="p">,</span>
241+
<span class="n">maxlen</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
242+
<span class="n">sleep_time_on_read_none_s</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">float</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
243+
<span class="n">auto_drop</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
244+
<span class="p">):</span>
245+
<span class="kn">from</span> <span class="nn">stream2py.stream_buffer</span> <span class="kn">import</span> <span class="n">StreamBuffer</span>
246+
247+
<span class="k">return</span> <span class="n">StreamBuffer</span><span class="p">(</span>
248+
<span class="bp">self</span><span class="p">,</span>
249+
<span class="n">maxlen</span><span class="o">=</span><span class="n">maxlen</span><span class="p">,</span>
250+
<span class="n">sleep_time_on_read_none_s</span><span class="o">=</span><span class="n">sleep_time_on_read_none_s</span><span class="p">,</span>
251+
<span class="n">auto_drop</span><span class="o">=</span><span class="n">auto_drop</span><span class="p">,</span>
252+
<span class="p">)</span></div>
238253

239254

240255
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">NewType</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">Iterator</span>

‎docs/_modules/stream2py/stream_buffer.html

+23-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.stream_buffer &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.stream_buffer &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -335,14 +335,34 @@ <h1>Source code for stream2py.stream_buffer</h1><div class="highlight"><pre>
335335

336336
<span class="k">def</span> <span class="nf">_open</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
337337
<span class="sd">&quot;&quot;&quot;First thing called after start/run</span>
338-
<span class="sd"> Calls source_reader.open() and then sets up source_buffer with latest source_reader.info&quot;&quot;&quot;</span>
338+
<span class="sd"> Calls source_reader.open() and then sets up source_buffer with latest</span>
339+
<span class="sd"> source_reader.info&quot;&quot;&quot;</span>
339340
<span class="bp">self</span><span class="o">.</span><span class="n">source_reader</span><span class="o">.</span><span class="n">open</span><span class="p">()</span>
340341
<span class="bp">self</span><span class="o">.</span><span class="n">source_buffer</span> <span class="o">=</span> <span class="n">_SourceBuffer</span><span class="p">(</span>
341342
<span class="n">source_reader_info</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">source_reader</span><span class="o">.</span><span class="n">info</span><span class="p">,</span>
342343
<span class="n">stop_event</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_stop_event</span><span class="p">,</span>
343344
<span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">source_reader</span><span class="o">.</span><span class="n">key</span><span class="p">,</span>
344345
<span class="n">maxlen</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_maxlen</span><span class="p">,</span>
345-
<span class="p">)</span></div>
346+
<span class="p">)</span>
347+
348+
<span class="k">def</span> <span class="nf">_mk_contextualized_iterator</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
349+
<span class="sd">&quot;&quot;&quot;Return next item (entering the context beforehand, if not running).</span>
350+
<span class="sd"> This method is meant to be called under context so that a clean exit is assured.</span>
351+
<span class="sd"> &quot;&quot;&quot;</span>
352+
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_running</span><span class="p">:</span>
353+
<span class="bp">self</span><span class="o">.</span><span class="fm">__enter__</span><span class="p">()</span>
354+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__next__</span><span class="p">()</span>
355+
356+
<span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
357+
<span class="sd">&quot;&quot;&quot;Return next item (entering the context beforehand, if not running).</span>
358+
<span class="sd"> This method is meant to be called under context so that a clean exit is assured. &quot;&quot;&quot;</span>
359+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_mk_contextualized_iterator</span><span class="p">()</span>
360+
361+
<span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
362+
<span class="k">try</span><span class="p">:</span>
363+
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__exit__</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
364+
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
365+
<span class="k">pass</span></div>
346366
</pre></div>
347367

348368
</div>

‎docs/_modules/stream2py/tests/utils_for_testing.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.tests.utils_for_testing &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.tests.utils_for_testing &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/utility/locked_sorted_deque.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.utility.locked_sorted_deque &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.locked_sorted_deque &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/utility/reader_writer_lock.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.utility.reader_writer_lock &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.reader_writer_lock &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/utility/sorted_collection.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.utility.sorted_collection &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.sorted_collection &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/utility/sorted_deque.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.utility.sorted_deque &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.sorted_deque &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_modules/stream2py/utility/typing_hints.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>stream2py.utility.typing_hints &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.typing_hints &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../../../_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />

‎docs/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.0.33',
3+
VERSION: '1.0.34',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/genindex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Index &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
6+
<title>Index &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
77
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
99
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />

‎docs/index.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Welcome to Stream2py’s documentation! &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
7+
<title>Welcome to Stream2py’s documentation! &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/copybutton.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
@@ -119,8 +119,8 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
119119
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
120120
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
121121
</ul>
122-
<p>Release: 1.0.33</p>
123-
<p>Last change: Nov 17, 2021</p>
122+
<p>Release: 1.0.34</p>
123+
<p>Last change: Nov 19, 2021</p>
124124
</section>
125125

126126

‎docs/module_docs/stream2py.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>stream2py &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
7+
<title>stream2py &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/copybutton.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />

‎docs/module_docs/stream2py/buffer_reader.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>stream2py.buffer_reader &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
7+
<title>stream2py.buffer_reader &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />

‎docs/module_docs/stream2py/simply.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>stream2py.simply &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
7+
<title>stream2py.simply &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />

‎docs/module_docs/stream2py/source_reader.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>stream2py.source_reader &mdash; stream2py 1.0.33 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
7+
<title>stream2py.source_reader &mdash; stream2py 1.0.34 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
88
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="../../_static/copybutton.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />

0 commit comments

Comments
 (0)