Update documentation

stable/.buildinfo

@@ -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: fd1ddc4e6a86d42e03a33973d700ae8e
+config: 7725c45e7b53c19d5e06ce3d3d8097fa
 tags: 645f666f9bcd5a90fca523b33c5a78b7

stable/commands/run.html

@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>
@@ -156,6 +157,12 @@ <h2>run<a class="headerlink" href="#run" title="Permalink to this heading"></
 <dd><p>An import str in format ‘&lt;module&gt;:&lt;CustomRunner&gt;’</p>
 </dd></dl>
 
+<dl class="std option">
+<dt class="sig sig-object std" id="cmdoption-run-recorder">
+<span class="sig-name descname"><span class="pre">--recorder</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;recorder&gt;</span></span><a class="headerlink" href="#cmdoption-run-recorder" title="Permalink to this definition"></a></dt>
+<dd><p>An import string in format ‘&lt;module&gt;:&lt;CustomRecorder&gt;’</p>
+</dd></dl>
+
 <dl class="std option">
 <dt class="sig sig-object std" id="cmdoption-run-x">
 <span id="cmdoption-run-max-exceptions"></span><span class="sig-name descname"><span class="pre">-x</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--max-exceptions</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;max_exceptions&gt;</span></span><a class="headerlink" href="#cmdoption-run-x" title="Permalink to this definition"></a></dt>

stable/genindex.html

@@ -47,6 +47,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>
@@ -151,15 +152,22 @@ <h2 id="Symbols">Symbols</h2>
 </li>
       </ul></li>
       <li>
-    --runner
+    --recorder
 
       <ul>
-        <li><a href="commands/run.html#cmdoption-run-runner">run command line option</a>
+        <li><a href="commands/run.html#cmdoption-run-recorder">run command line option</a>
 </li>
       </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li>
+    --runner
+
+      <ul>
+        <li><a href="commands/run.html#cmdoption-run-runner">run command line option</a>
+</li>
+      </ul></li>
+      <li>
     --verbosity
 
       <ul>
@@ -264,6 +272,10 @@ <h2 id="M">M</h2>
 
 <h2 id="N">N</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="methoddocs/exceptions.html#silverback.exceptions.NoTasksAvailableError">NoTasksAvailableError</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/exceptions.html#silverback.exceptions.NoWebsocketAvailableError">NoWebsocketAvailableError</a>
 </li>
@@ -303,8 +315,6 @@ <h2 id="P">P</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware.post_execute">post_execute() (silverback.middlewares.SilverbackMiddleware method)</a>
-</li>
-      <li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware.post_save">post_save() (silverback.middlewares.SilverbackMiddleware method)</a>
 </li>
       <li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware.pre_execute">pre_execute() (silverback.middlewares.SilverbackMiddleware method)</a>
 </li>
@@ -325,6 +335,8 @@ <h2 id="R">R</h2>
         <li><a href="commands/run.html#cmdoption-run-x">--max-exceptions</a>
 </li>
         <li><a href="commands/run.html#cmdoption-run-network">--network</a>
+</li>
+        <li><a href="commands/run.html#cmdoption-run-recorder">--recorder</a>
 </li>
         <li><a href="commands/run.html#cmdoption-run-runner">--runner</a>
 </li>
@@ -400,6 +412,8 @@ <h2 id="S">S</h2>
       <li><a href="methoddocs/exceptions.html#silverback.exceptions.SilverbackException">SilverbackException</a>
 </li>
       <li><a href="methoddocs/middlewares.html#silverback.middlewares.SilverbackMiddleware">SilverbackMiddleware (class in silverback.middlewares)</a>
+</li>
+      <li><a href="methoddocs/exceptions.html#silverback.exceptions.StartupFailure">StartupFailure</a>
 </li>
       <li><a href="methoddocs/subscriptions.html#silverback.subscriptions.SubscriptionType">SubscriptionType (class in silverback.subscriptions)</a>
 </li>

stable/index.html

@@ -49,6 +49,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>

stable/methoddocs/application.html

@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>
@@ -147,7 +148,7 @@ <h1>silverback.application<a class="headerlink" href="#silverback-application" t
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>task_type</strong> – <code class="xref py py-class docutils literal notranslate"><span class="pre">TaskType</span></code>: The type of task to create.</p></li>
-<li><p><strong>container</strong> – (Union[BlockContainer, ContractEvent]): The event source to watch.</p></li>
+<li><p><strong>container</strong> – (BlockContainer | ContractEvent): The event source to watch.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
@@ -170,10 +171,10 @@ <h1>silverback.application<a class="headerlink" href="#silverback-application" t
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>container</strong> – (Union[BlockContainer, ContractEvent]): The event source to watch.</p></li>
-<li><p><strong>new_block_timeout</strong> – (Optional[int]): Override for block timeout that is acceptable.
+<li><p><strong>container</strong> – (BlockContainer | ContractEvent): The event source to watch.</p></li>
+<li><p><strong>new_block_timeout</strong> – (int | None): Override for block timeout that is acceptable.
 Defaults to whatever the app’s settings are for default polling timeout are.</p></li>
-<li><p><strong>start_block</strong> (<em>Optional</em><em>[</em><em>int</em><em>]</em>) – block number to start processing events from.
+<li><p><strong>start_block</strong> (<em>int</em><em> | </em><em>None</em>) – block number to start processing events from.
 Defaults to whatever the latest block is.</p></li>
 </ul>
 </dd>
@@ -235,7 +236,7 @@ <h1>silverback.application<a class="headerlink" href="#silverback-application" t
 
 <dl class="py class">
 <dt class="sig sig-object py" id="silverback.application.TaskData">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.application.</span></span><span class="sig-name descname"><span class="pre">TaskData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ape.managers.chain.BlockContainer</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ape.contracts.base.ContractEvent</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">NoneType</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">taskiq.decor.AsyncTaskiqDecoratedTask</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.application.TaskData" title="Permalink to this definition"></a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.application.</span></span><span class="sig-name descname"><span class="pre">TaskData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">container</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ape.managers.chain.BlockContainer</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ape.contracts.base.ContractEvent</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">taskiq.decor.AsyncTaskiqDecoratedTask</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.application.TaskData" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
 </dd></dl>
 

stable/methoddocs/exceptions.html

@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>
@@ -88,8 +89,10 @@
 <li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.Halt"><code class="docutils literal notranslate"><span class="pre">Halt</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.ImportFromStringError"><code class="docutils literal notranslate"><span class="pre">ImportFromStringError</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.InvalidContainerTypeError"><code class="docutils literal notranslate"><span class="pre">InvalidContainerTypeError</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.NoTasksAvailableError"><code class="docutils literal notranslate"><span class="pre">NoTasksAvailableError</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.NoWebsocketAvailableError"><code class="docutils literal notranslate"><span class="pre">NoWebsocketAvailableError</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.SilverbackException"><code class="docutils literal notranslate"><span class="pre">SilverbackException</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="#silverback.exceptions.StartupFailure"><code class="docutils literal notranslate"><span class="pre">StartupFailure</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="utils.html">silverback.utils</a></li>
@@ -124,7 +127,7 @@
 <dl class="py exception">
 <dt class="sig sig-object py" id="silverback.exceptions.CircuitBreaker">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">CircuitBreaker</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.CircuitBreaker" title="Permalink to this definition"></a></dt>
-<dd><p>Bases: <a class="reference internal" href="#silverback.exceptions.SilverbackException" title="silverback.exceptions.SilverbackException"><code class="xref py py-class docutils literal notranslate"><span class="pre">SilverbackException</span></code></a></p>
+<dd><p>Bases: <a class="reference internal" href="#silverback.exceptions.Halt" title="silverback.exceptions.Halt"><code class="xref py py-class docutils literal notranslate"><span class="pre">Halt</span></code></a></p>
 <p>Custom exception (created by user) that will trigger an application shutdown.</p>
 </dd></dl>
 
@@ -152,6 +155,12 @@
 <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
 </dd></dl>
 
+<dl class="py exception">
+<dt class="sig sig-object py" id="silverback.exceptions.NoTasksAvailableError">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">NoTasksAvailableError</span></span><a class="headerlink" href="#silverback.exceptions.NoTasksAvailableError" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="#silverback.exceptions.SilverbackException" title="silverback.exceptions.SilverbackException"><code class="xref py py-class docutils literal notranslate"><span class="pre">SilverbackException</span></code></a></p>
+</dd></dl>
+
 <dl class="py exception">
 <dt class="sig sig-object py" id="silverback.exceptions.NoWebsocketAvailableError">
 <em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">NoWebsocketAvailableError</span></span><a class="headerlink" href="#silverback.exceptions.NoWebsocketAvailableError" title="Permalink to this definition"></a></dt>
@@ -165,6 +174,12 @@
 <p>Base Exception for any Silverback runtime faults.</p>
 </dd></dl>
 
+<dl class="py exception">
+<dt class="sig sig-object py" id="silverback.exceptions.StartupFailure">
+<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">silverback.exceptions.</span></span><span class="sig-name descname"><span class="pre">StartupFailure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">exceptions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">Exception</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.exceptions.StartupFailure" title="Permalink to this definition"></a></dt>
+<dd><p>Bases: <a class="reference internal" href="#silverback.exceptions.SilverbackException" title="silverback.exceptions.SilverbackException"><code class="xref py py-class docutils literal notranslate"><span class="pre">SilverbackException</span></code></a></p>
+</dd></dl>
+
 </section>
 
 

stable/methoddocs/middlewares.html

@@ -50,6 +50,7 @@
               <option value="">Select version...</option>
               <option value="latest">latest</option>
               <option value="stable">stable</option>
+                <option value="v0.3.3">v0.3.3</option>
                 <option value="v0.3.2">v0.3.2</option>
                 <option value="v0.3.1">v0.3.1</option>
                 <option value="v0.3.0">v0.3.0</option>
@@ -83,7 +84,6 @@
 <li class="toctree-l1 current"><a class="current reference internal" href="#">silverback.middlewares</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#silverback.middlewares.SilverbackMiddleware"><code class="docutils literal notranslate"><span class="pre">SilverbackMiddleware</span></code></a><ul>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.middlewares.SilverbackMiddleware.post_execute"><code class="docutils literal notranslate"><span class="pre">SilverbackMiddleware.post_execute()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#silverback.middlewares.SilverbackMiddleware.post_save"><code class="docutils literal notranslate"><span class="pre">SilverbackMiddleware.post_save()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.middlewares.SilverbackMiddleware.pre_execute"><code class="docutils literal notranslate"><span class="pre">SilverbackMiddleware.pre_execute()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#silverback.middlewares.SilverbackMiddleware.pre_send"><code class="docutils literal notranslate"><span class="pre">SilverbackMiddleware.pre_send()</span></code></a></li>
 </ul>
@@ -143,22 +143,6 @@ <h1>silverback.middlewares<a class="headerlink" href="#silverback-middlewares" t
 </dl>
 </dd></dl>
 
-<dl class="py method">
-<dt class="sig sig-object py" id="silverback.middlewares.SilverbackMiddleware.post_save">
-<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">post_save</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TaskiqMessage</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TaskiqResult</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#silverback.middlewares.SilverbackMiddleware.post_save" title="Permalink to this definition"></a></dt>
-<dd><p>Post save hook.</p>
-<p>This function is called after result of
-the executions is saved in the result_backend.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>message</strong> – processed message.</p></li>
-<li><p><strong>result</strong> – returned value.</p></li>
-</ul>
-</dd>
-</dl>
-</dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="silverback.middlewares.SilverbackMiddleware.pre_execute">
 <span class="sig-name descname"><span class="pre">pre_execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">TaskiqMessage</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">TaskiqMessage</span></span></span><a class="headerlink" href="#silverback.middlewares.SilverbackMiddleware.pre_execute" title="Permalink to this definition"></a></dt>