Skip to content

Commit

Permalink
deploy: 92b7508
Browse files Browse the repository at this point in the history
  • Loading branch information
@maringuu
maringuu committed Nov 27, 2024
1 parent 759e6d0 commit c621d6d
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,8 @@ <h2 id="F">F</h2>
<li><a href="modules/objects.firmware.html#objects.firmware.Firmware">Firmware (class in objects.firmware)</a>
</li>
<li><a href="modules/config.html#config.Backend.firmware_file_storage_directory">firmware_file_storage_directory (config.Backend attribute)</a>
</li>
<li><a href="modules/conftest.html#conftest.firmware_file_storage_directory">firmware_file_storage_directory() (in module conftest)</a>
</li>
<li><a href="modules/helperFunctions.logging.html#helperFunctions.logging.ColoringFormatter.format">format() (helperFunctions.logging.ColoringFormatter method)</a>
</li>
Expand Down Expand Up @@ -926,8 +928,6 @@ <h2 id="P">P</h2>
<li><a href="modules/helperFunctions.web_interface.html#helperFunctions.web_interface.password_is_legal">password_is_legal() (in module helperFunctions.web_interface)</a>
</li>
<li><a href="modules/config.html#config.Frontend.Authentication.password_salt">password_salt (config.Frontend.Authentication attribute)</a>
</li>
<li><a href="modules/conftest.html#conftest.patch_config">patch_config() (in module conftest)</a>
</li>
<li><a href="modules/scheduler.analysis.plugin.html#scheduler.analysis.plugin.PluginRunner.Task.path">path (scheduler.analysis.plugin.PluginRunner.Task attribute)</a>
</li>
Expand Down
28 changes: 13 additions & 15 deletions modules/conftest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
<li class="toctree-l2"><a class="reference internal" href="#conftest.backend_config"><code class="docutils literal notranslate"><span class="pre">backend_config()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#conftest.common_config"><code class="docutils literal notranslate"><span class="pre">common_config()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#conftest.docker_mount_base_dir"><code class="docutils literal notranslate"><span class="pre">docker_mount_base_dir()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#conftest.firmware_file_storage_directory"><code class="docutils literal notranslate"><span class="pre">firmware_file_storage_directory()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#conftest.frontend_config"><code class="docutils literal notranslate"><span class="pre">frontend_config()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#conftest.patch_config"><code class="docutils literal notranslate"><span class="pre">patch_config()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="test.html">test</a></li>
Expand Down Expand Up @@ -149,7 +149,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="conftest.analysis_plugin">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">analysis_plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">patch_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.analysis_plugin" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">analysis_plugin</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_patch_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.analysis_plugin" title="Permalink to this definition"></a></dt>
<dd><p>Returns an instance of an AnalysisPlugin.
This fixture can be configured by the supplying an instance of <code class="docutils literal notranslate"><span class="pre">AnalysisPluginTestConfig</span></code> as marker of the same
name.</p>
Expand Down Expand Up @@ -188,7 +188,7 @@

<dl class="py function">
<dt class="sig sig-object py" id="conftest.backend_config">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">backend_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_firmware_file_storage_directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.backend_config" title="Permalink to this definition"></a></dt>
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">backend_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">firmware_file_storage_directory</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.backend_config" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="config.html#config.Backend" title="config.Backend"><em>Backend</em></a></p>
Expand Down Expand Up @@ -217,25 +217,23 @@
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="conftest.frontend_config">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">frontend_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.frontend_config" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="conftest.firmware_file_storage_directory">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">firmware_file_storage_directory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#conftest.firmware_file_storage_directory" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="config.html#config.Frontend" title="config.Frontend"><em>Frontend</em></a></p>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="conftest.patch_config">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">patch_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">monkeypatch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend_config</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">frontend_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.patch_config" title="Permalink to this definition"></a></dt>
<dd><p>This fixture will replace :py:data`config.common`, <a class="reference internal" href="config.html#config.backend" title="config.backend"><code class="xref py py-data docutils literal notranslate"><span class="pre">config.backend</span></code></a> and <a class="reference internal" href="config.html#config.frontend" title="config.frontend"><code class="xref py py-data docutils literal notranslate"><span class="pre">config.frontend</span></code></a>
with the default test config.</p>
<p>Defaults in the test config can be overwritten with the markers <code class="docutils literal notranslate"><span class="pre">backend_config_overwrite</span></code>,
<code class="docutils literal notranslate"><span class="pre">frontend_config_overwrite</span></code> and <code class="docutils literal notranslate"><span class="pre">common_config_overwrite</span></code>.
These three markers accept a single argument of the type <code class="docutils literal notranslate"><span class="pre">dict</span></code>.
When using <code class="docutils literal notranslate"><span class="pre">backend_config_overwrite</span></code> the dictionary has to contain valid keyword arguments for
<code class="xref py py-class docutils literal notranslate"><span class="pre">Backend</span></code>.</p>
<dt class="sig sig-object py" id="conftest.frontend_config">
<span class="sig-prename descclassname"><span class="pre">conftest.</span></span><span class="sig-name descname"><span class="pre">frontend_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">common_config</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#conftest.frontend_config" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="config.html#config.Frontend" title="config.Frontend"><em>Frontend</em></a></p>
</dd>
</dl>
</dd></dl>

</section>
Expand Down
2 changes: 2 additions & 0 deletions modules/web_interface.rest.helper.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@

<section id="module-web_interface.rest.helper">
<span id="web-interface-rest-helper-module"></span><h1>web_interface.rest.helper module<a class="headerlink" href="#module-web_interface.rest.helper" title="Permalink to this heading"></a></h1>
<p>This module offers neat wrapper functionality for use in rest endpoints.
Most wrappers target request and response parsing.</p>
<dl class="py function">
<dt class="sig sig-object py" id="web_interface.rest.helper.error_message">
<span class="sig-prename descclassname"><span class="pre">web_interface.rest.helper.</span></span><span class="sig-name descname"><span class="pre">error_message</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">targeted_url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_code</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">400</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#web_interface.rest.helper.error_message" title="Permalink to this definition"></a></dt>
Expand Down
Binary file modified objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit c621d6d

Please sign in to comment.