Skip to content

Commit 3af5c0d

Browse files
author
GitHub CI Runner
committed
**CI** Formatted code + Updated version number and documentation. [skip ci]
1 parent 253cb1d commit 3af5c0d

36 files changed

+44
-51
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: d56b9e4954207632ff59f7833848127f
3+
config: 96f5371e0c0ddc0c4917598ff02c8ece
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.35 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
6+
<title>Overview: module code &mdash; stream2py 1.0.36 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

+6-9
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.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.buffer_reader &mdash; stream2py 1.0.36 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" />
@@ -298,7 +298,7 @@ <h1>Source code for stream2py.buffer_reader</h1><div class="highlight"><pre>
298298
<span class="n">step</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
299299
<span class="o">*</span><span class="p">,</span>
300300
<span class="n">peek</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
301-
<span class="n">ignore_no_item_found</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
301+
<span class="n">ignore_no_item_found</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
302302
<span class="n">only_new_items</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
303303
<span class="n">start_le</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
304304
<span class="n">stop_ge</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
@@ -322,6 +322,8 @@ <h1>Source code for stream2py.buffer_reader</h1><div class="highlight"><pre>
322322
<span class="sd"> stop in buffer, if ignore_no_item_found is also True, return None instead of ValueError</span>
323323
<span class="sd"> :return: list of items in range</span>
324324
<span class="sd"> &quot;&quot;&quot;</span>
325+
<span class="k">if</span> <span class="n">ignore_no_item_found</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
326+
<span class="n">ignore_no_item_found</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_read_kwargs</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;ignore_no_item_found&#39;</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span>
325327
<span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_buffer</span><span class="o">.</span><span class="n">reader_lock</span><span class="p">()</span> <span class="k">as</span> <span class="n">reader</span><span class="p">:</span>
326328
<span class="k">if</span> <span class="n">only_new_items</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_key</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
327329
<span class="n">_next</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">read</span><span class="p">(</span>
@@ -416,13 +418,8 @@ <h1>Source code for stream2py.buffer_reader</h1><div class="highlight"><pre>
416418
<span class="sd"> :param strict_n: if True, raise ValueError if n items are not available</span>
417419
<span class="sd"> :return: next item or list of next items if n &gt; 1</span>
418420
<span class="sd"> &quot;&quot;&quot;</span>
419-
<span class="n">n</span><span class="p">,</span> <span class="n">peek</span><span class="p">,</span> <span class="n">ignore_no_item_found</span><span class="p">,</span> <span class="n">strict_n</span> <span class="o">=</span> <span class="n">defaulted_values</span><span class="p">(</span>
420-
<span class="nb">dict</span><span class="p">(</span>
421-
<span class="n">n</span><span class="o">=</span><span class="n">n</span><span class="p">,</span>
422-
<span class="n">peek</span><span class="o">=</span><span class="n">peek</span><span class="p">,</span>
423-
<span class="n">ignore_no_item_found</span><span class="o">=</span><span class="n">ignore_no_item_found</span><span class="p">,</span>
424-
<span class="n">strict_n</span><span class="o">=</span><span class="n">strict_n</span><span class="p">,</span>
425-
<span class="p">),</span>
421+
<span class="n">n</span><span class="p">,</span> <span class="n">ignore_no_item_found</span><span class="p">,</span> <span class="n">strict_n</span> <span class="o">=</span> <span class="n">defaulted_values</span><span class="p">(</span>
422+
<span class="nb">dict</span><span class="p">(</span><span class="n">n</span><span class="o">=</span><span class="n">n</span><span class="p">,</span> <span class="n">ignore_no_item_found</span><span class="o">=</span><span class="n">ignore_no_item_found</span><span class="p">,</span> <span class="n">strict_n</span><span class="o">=</span><span class="n">strict_n</span><span class="p">,),</span>
426423
<span class="n">defaults</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_read_kwargs</span><span class="p">,</span>
427424
<span class="p">)</span>
428425
<span class="c1"># # Is the following alternative clearer or more efficient?</span>

‎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.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.simply &mdash; stream2py 1.0.36 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

+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.source_reader &mdash; stream2py 1.0.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.source_reader &mdash; stream2py 1.0.36 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/stream_buffer.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.stream_buffer &mdash; stream2py 1.0.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.stream_buffer &mdash; stream2py 1.0.36 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/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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.tests.utils_for_testing &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.locked_sorted_deque &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.reader_writer_lock &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.sorted_collection &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.sorted_deque &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
6+
<title>stream2py.utility.typing_hints &mdash; stream2py 1.0.36 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.35',
3+
VERSION: '1.0.36',
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.35 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
6+
<title>Index &mdash; stream2py 1.0.36 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.35 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
7+
<title>Welcome to Stream2py’s documentation! &mdash; stream2py 1.0.36 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.35</p>
123-
<p>Last change: Nov 22, 2021</p>
122+
<p>Release: 1.0.36</p>
123+
<p>Last change: Nov 24, 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.35 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
7+
<title>stream2py &mdash; stream2py 1.0.36 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

+2-2
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.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
7+
<title>stream2py.buffer_reader &mdash; stream2py 1.0.36 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" />
@@ -175,7 +175,7 @@
175175

176176
<dl class="py method">
177177
<dt id="stream2py.buffer_reader.BufferReader.range">
178-
<code class="sig-name descname">range</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start</span></em>, <em class="sig-param"><span class="n">stop</span></em>, <em class="sig-param"><span class="n">step</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">peek</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">ignore_no_item_found</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">only_new_items</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">start_le</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">stop_ge</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stream2py/buffer_reader.html#BufferReader.range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stream2py.buffer_reader.BufferReader.range" title="Permalink to this definition"></a></dt>
178+
<code class="sig-name descname">range</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start</span></em>, <em class="sig-param"><span class="n">stop</span></em>, <em class="sig-param"><span class="n">step</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">peek</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">ignore_no_item_found</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">only_new_items</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">start_le</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">stop_ge</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/stream2py/buffer_reader.html#BufferReader.range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#stream2py.buffer_reader.BufferReader.range" title="Permalink to this definition"></a></dt>
179179
<dd><p>Enables:
180180
1. Get last n minutes
181181
2. Give me data I don’t have</p>

‎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.35 documentation</title><link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
7+
<title>stream2py.simply &mdash; stream2py 1.0.36 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)