Skip to content

Commit

Permalink
deploy: 3db9b36
Browse files Browse the repository at this point in the history
  • Loading branch information
@abbiemery
abbiemery committed Sep 26, 2023
1 parent 7b8cecc commit 56feb7c
Show file tree
Hide file tree
Showing 73 changed files with 985 additions and 631 deletions.
2 changes: 1 addition & 1 deletion rename-scheduler/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7055a22e5bb4d298a3593e2423018d70
config: 432fa2a53dc85a54b8d8f141471d2e9f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified rename-scheduler/.doctrees/developer/explanations/framework-details.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/developer/explanations/how-component-updates-are-ordered.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/user/explanations/components.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/user/explanations/framework-summary.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/user/explanations/wiring.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/user/reference/api.doctree
View file
Binary file not shown.
Binary file modified rename-scheduler/.doctrees/user/tutorials/create-a-device.doctree
View file
Binary file not shown.
6 changes: 3 additions & 3 deletions rename-scheduler/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; tickit 0.4.3.dev7+gaaa0c61e documentation</title>
<title>Overview: module code &#8212; tickit 0.4.3.dev11+g3db9b366 documentation</title>



Expand Down Expand Up @@ -37,9 +37,9 @@
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
<script src="../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=d2ecf0b9"></script>
<script src="../_static/documentation_options.js?v=d9128996"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=30646c52"></script>
<script src="../_static/design-tabs.js?v=36754332"></script>
Expand Down
40 changes: 29 additions & 11 deletions rename-scheduler/_modules/tickit/core/adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tickit.core.adapter &#8212; tickit 0.4.3.dev7+gaaa0c61e documentation</title>
<title>tickit.core.adapter &#8212; tickit 0.4.3.dev11+g3db9b366 documentation</title>



Expand Down Expand Up @@ -37,9 +37,9 @@
<link rel="preload" as="script" href="../../../_static/scripts/pydata-sphinx-theme.js?digest=ac02cc09edc035673794" />
<script src="../../../_static/vendor/fontawesome/6.1.2/js/all.min.js?digest=ac02cc09edc035673794"></script>

<script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js?v=d2ecf0b9"></script>
<script src="../../../_static/documentation_options.js?v=d9128996"></script>
<script src="../../../_static/doctools.js?v=888ff710"></script>
<script src="../../../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../../_static/copybutton.js?v=30646c52"></script>
<script src="../../../_static/design-tabs.js?v=36754332"></script>
Expand Down Expand Up @@ -440,26 +440,34 @@ <h1>Source code for tickit.core.adapter</h1><div class="highlight"><pre>
<span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;T&quot;</span><span class="p">)</span>


<div class="viewcode-block" id="RaiseInterrupt"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.RaiseInterrupt">[docs]</a><span class="k">class</span> <span class="nc">RaiseInterrupt</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
<div class="viewcode-block" id="RaiseInterrupt">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.RaiseInterrupt">[docs]</a>
<span class="k">class</span> <span class="nc">RaiseInterrupt</span><span class="p">(</span><span class="n">Protocol</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A raise_interrupt function that should be passed the adapter.&quot;&quot;&quot;</span>

<span class="k">async</span> <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The actual call signature.&quot;&quot;&quot;</span>
<span class="k">pass</span></div>



<span class="n">A</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;A&quot;</span><span class="p">)</span>


<div class="viewcode-block" id="AdapterIo"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterIo">[docs]</a><span class="k">class</span> <span class="nc">AdapterIo</span><span class="p">(</span><span class="n">ABC</span><span class="p">,</span> <span class="n">Generic</span><span class="p">[</span><span class="n">A</span><span class="p">]):</span>
<div class="viewcode-block" id="AdapterIo">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterIo">[docs]</a>
<span class="k">class</span> <span class="nc">AdapterIo</span><span class="p">(</span><span class="n">ABC</span><span class="p">,</span> <span class="n">Generic</span><span class="p">[</span><span class="n">A</span><span class="p">]):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Io logic with a setup method for an adapter object.&quot;&quot;&quot;</span>

<span class="nd">@abstractmethod</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">adapter</span><span class="p">:</span> <span class="n">A</span><span class="p">,</span> <span class="n">raise_interrupt</span><span class="p">:</span> <span class="n">RaiseInterrupt</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="o">...</span></div>


<div class="viewcode-block" id="AdapterContainer"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterContainer">[docs]</a><span class="k">class</span> <span class="nc">AdapterContainer</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">A</span><span class="p">]):</span>

<div class="viewcode-block" id="AdapterContainer">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterContainer">[docs]</a>
<span class="k">class</span> <span class="nc">AdapterContainer</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">A</span><span class="p">]):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;A container for an object specific adapter and the required functional io.&quot;&quot;&quot;</span>

<span class="n">adapter</span><span class="p">:</span> <span class="n">A</span>
Expand All @@ -469,21 +477,29 @@ <h1>Source code for tickit.core.adapter</h1><div class="highlight"><pre>
<span class="bp">self</span><span class="o">.</span><span class="n">adapter</span> <span class="o">=</span> <span class="n">adapter</span>
<span class="bp">self</span><span class="o">.</span><span class="n">io</span> <span class="o">=</span> <span class="n">io</span>

<div class="viewcode-block" id="AdapterContainer.run_forever"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterContainer.run_forever">[docs]</a> <span class="k">async</span> <span class="k">def</span> <span class="nf">run_forever</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raise_interrupt</span><span class="p">:</span> <span class="n">RaiseInterrupt</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<div class="viewcode-block" id="AdapterContainer.run_forever">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.AdapterContainer.run_forever">[docs]</a>
<span class="k">async</span> <span class="k">def</span> <span class="nf">run_forever</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">raise_interrupt</span><span class="p">:</span> <span class="n">RaiseInterrupt</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;An asynchronous method allowing indefinite running of core adapter logic.</span>

<span class="sd"> An asynchronous method allowing for indefinite running of core adapter logic</span>
<span class="sd"> (typically the hosting of a protocol server and the interpretation of commands</span>
<span class="sd"> which are supplied via it).</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">adapter</span><span class="p">,</span> <span class="n">raise_interrupt</span><span class="p">)</span></div></div>
<span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">io</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">adapter</span><span class="p">,</span> <span class="n">raise_interrupt</span><span class="p">)</span></div>
</div>



<div class="viewcode-block" id="Interpreter"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.Interpreter">[docs]</a><span class="k">class</span> <span class="nc">Interpreter</span><span class="p">(</span><span class="n">ABC</span><span class="p">,</span> <span class="n">Generic</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
<div class="viewcode-block" id="Interpreter">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.Interpreter">[docs]</a>
<span class="k">class</span> <span class="nc">Interpreter</span><span class="p">(</span><span class="n">ABC</span><span class="p">,</span> <span class="n">Generic</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;An interface for types which handle messages received by an adapter.&quot;&quot;&quot;</span>

<div class="viewcode-block" id="Interpreter.handle"><a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.Interpreter.handle">[docs]</a> <span class="nd">@abstractmethod</span>
<div class="viewcode-block" id="Interpreter.handle">
<a class="viewcode-back" href="../../../user/reference/api.html#tickit.core.adapter.Interpreter.handle">[docs]</a>
<span class="nd">@abstractmethod</span>
<span class="k">async</span> <span class="k">def</span> <span class="nf">handle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">AsyncIterable</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="nb">bool</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;An asynchronous method which handles messages received by an adapter.</span>

Expand All @@ -498,7 +514,9 @@ <h1>Source code for tickit.core.adapter</h1><div class="highlight"><pre>
<span class="sd"> Returns:</span>
<span class="sd"> Tuple[AsyncIterable[T], bool]: A tuple containing both an asynchronous</span>
<span class="sd"> iterable of reply messages and an interrupt flag.</span>
<span class="sd"> &quot;&quot;&quot;</span></div></div>
<span class="sd"> &quot;&quot;&quot;</span></div>
</div>

</pre></div>

</article>
Expand Down
Loading

0 comments on commit 56feb7c

Please sign in to comment.