Skip to content

Commit

Permalink
Deploying to gh-pages from @ 421cb44 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@tilsche
tilsche committed Jun 27, 2023
1 parent 0107957 commit 256d626
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 3 deletions.
Binary file modified .doctrees/api/client-common.doctree
View file
Binary file not shown.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
12 changes: 10 additions & 2 deletions api/client-common.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ <h1>Common client operation<a class="headerlink" href="#common-client-operation"

<dl class="py method">
<dt class="sig sig-object py" id="metricq.Client.run">
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">catch_signals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('SIGINT',</span> <span class="pre">'SIGTERM')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel_on_exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#metricq.Client.run" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">catch_signals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('SIGINT',</span> <span class="pre">'SIGTERM')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel_on_exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_uvloop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#metricq.Client.run" title="Permalink to this definition"></a></dt>
<dd><p>Run an Agent by calling <a class="reference internal" href="#metricq.Client.connect" title="metricq.Client.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a> and waiting for it to be stopped via <a class="reference internal" href="#metricq.Client.stop" title="metricq.Client.stop"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stop()</span></code></a>.</p>
<p>If <a class="reference internal" href="#metricq.Client.connect" title="metricq.Client.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a> raises an exception, <a class="reference internal" href="exceptions.html#metricq.exceptions.ConnectFailed" title="metricq.exceptions.ConnectFailed"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ConnectFailed</span></code></a> is
raised, with the offending exception attached as a cause. Any
Expand All @@ -264,6 +264,10 @@ <h1>Common client operation<a class="headerlink" href="#common-client-operation"
<dt><strong>cancel_on_exception</strong> : <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</dt><dd><p>Stop the running Agent when an unhandled exception occurs.
The exception is reraised from this method.</p>
</dd>
<dt><strong>use_uvloop</strong> : <span class="annotation terse"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span><span class="annotation full"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>]</span> (default: <code class="docutils literal notranslate"><span class="pre">None</span></code>)</dt><dd><p>Use uvloop as the asyncio event loop. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, uvloop is used if available.
If <code class="docutils literal notranslate"><span class="pre">True</span></code>, uvloop is used and an ImportError is raised if it is not available.
If <code class="docutils literal notranslate"><span class="pre">False</span></code>, uvloop is not used even if it is available.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
Expand Down Expand Up @@ -660,7 +664,7 @@ <h1>Common client operation<a class="headerlink" href="#common-client-operation"

<dl class="py method">
<dt class="sig sig-object py" id="metricq.Agent.run">
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">catch_signals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('SIGINT',</span> <span class="pre">'SIGTERM')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel_on_exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#metricq.Agent.run" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">catch_signals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">('SIGINT',</span> <span class="pre">'SIGTERM')</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cancel_on_exception</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_uvloop</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#metricq.Agent.run" title="Permalink to this definition"></a></dt>
<dd><p>Run an Agent by calling <a class="reference internal" href="#metricq.Agent.connect" title="metricq.Agent.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a> and waiting for it to be stopped via <a class="reference internal" href="#metricq.Agent.stop" title="metricq.Agent.stop"><code class="xref py py-meth docutils literal notranslate"><span class="pre">stop()</span></code></a>.</p>
<p>If <a class="reference internal" href="#metricq.Agent.connect" title="metricq.Agent.connect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">connect()</span></code></a> raises an exception, <a class="reference internal" href="exceptions.html#metricq.exceptions.ConnectFailed" title="metricq.exceptions.ConnectFailed"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ConnectFailed</span></code></a> is
raised, with the offending exception attached as a cause. Any
Expand All @@ -673,6 +677,10 @@ <h1>Common client operation<a class="headerlink" href="#common-client-operation"
<dt><strong>cancel_on_exception</strong> : <a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> (default: <code class="docutils literal notranslate"><span class="pre">False</span></code>)</dt><dd><p>Stop the running Agent when an unhandled exception occurs.
The exception is reraised from this method.</p>
</dd>
<dt><strong>use_uvloop</strong> : <span class="annotation terse"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a> | <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a></span><span class="annotation full"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>]</span> (default: <code class="docutils literal notranslate"><span class="pre">None</span></code>)</dt><dd><p>Use uvloop as the asyncio event loop. If <code class="docutils literal notranslate"><span class="pre">None</span></code>, uvloop is used if available.
If <code class="docutils literal notranslate"><span class="pre">True</span></code>, uvloop is used and an ImportError is raised if it is not available.
If <code class="docutils literal notranslate"><span class="pre">False</span></code>, uvloop is not used even if it is available.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 256d626

Please sign in to comment.