Skip to content

Commit

Permalink
deploy: 50eb143
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelSasser committed Oct 10, 2024
1 parent 1bcba81 commit f435539
Show file tree
Hide file tree
Showing 11 changed files with 197 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
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: 24734863feda8b621d8b2b07eeb297d3
config: e23d5ffcccfe60d3b77e3bf85eeb0727
tags: 645f666f9bcd5a90fca523b33c5a78b7
1 change: 1 addition & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ <h1>All modules for which code is available</h1>
<li><a href="matrixctl/print_helpers.html">matrixctl.print_helpers</a></li>
<li><a href="matrixctl/sanitizers.html">matrixctl.sanitizers</a></li>
<li><a href="matrixctl/structures.html">matrixctl.structures</a></li>
<li><a href="tests/matrixctl/handlers/conftest.html">tests.matrixctl.handlers.conftest</a></li>
<li><a href="tests/matrixctl/handlers/test_yaml.html">tests.matrixctl.handlers.test_yaml</a></li>
<li><a href="tests/matrixctl/test_sanitizers.html">tests.matrixctl.test_sanitizers</a></li>
</ul>
Expand Down
155 changes: 155 additions & 0 deletions _modules/tests/matrixctl/handlers/conftest.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>tests.matrixctl.handlers.conftest &mdash; MatrixCtl 0.12.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../../../../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css?v=fd3f3429" />


<script src="../../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../../_static/documentation_options.js?v=61ccb1f1"></script>
<script src="../../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../../../index.html" class="icon icon-home">
MatrixCtl
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../contributer_documentation/index.html">Contributor Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html#changelog-deprecated">Changelog (deprecated)</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">MatrixCtl</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../../../index.html">Module code</a></li>
<li class="breadcrumb-item active">tests.matrixctl.handlers.conftest</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<h1>Source code for tests.matrixctl.handlers.conftest</h1><div class="highlight"><pre>
<span></span><span class="c1"># matrixctl</span>
<span class="c1"># Copyright (c) 2021-2023 Michael Sasser &lt;[email protected]&gt;</span>
<span class="c1">#</span>
<span class="c1"># This program is free software: you can redistribute it and/or modify</span>
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c1"># (at your option) any later version.</span>
<span class="c1">#</span>
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="c1"># GNU General Public License for more details.</span>
<span class="c1">#</span>
<span class="c1"># You should have received a copy of the GNU General Public License</span>
<span class="c1"># along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>

<span class="sd">&quot;&quot;&quot;Create handler fixtures for testing.&quot;&quot;&quot;</span>

<span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>

<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>

<span class="kn">import</span> <span class="nn">pytest</span>

<span class="kn">from</span> <span class="nn">matrixctl.handlers.yaml</span> <span class="kn">import</span> <span class="n">YAML</span>


<span class="n">__author__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;Michael Sasser&quot;</span>
<span class="n">__email__</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;[email protected]&quot;</span>


<div class="viewcode-block" id="yaml">
<a class="viewcode-back" href="../../../../contributer_documentation/tests.html#tests.matrixctl.handlers.conftest.yaml">[docs]</a>
<span class="nd">@pytest</span><span class="o">.</span><span class="n">fixture</span><span class="p">(</span><span class="n">scope</span><span class="o">=</span><span class="s2">&quot;session&quot;</span><span class="p">,</span> <span class="n">autouse</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">yaml</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">YAML</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create a fixture for the YAML class.&quot;&quot;&quot;</span>
<span class="c1"># Setup</span>
<span class="n">yaml_</span><span class="p">:</span> <span class="n">YAML</span> <span class="o">=</span> <span class="n">YAML</span><span class="p">({</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;tests/matrixctl/handlers/configs/config.yaml&quot;</span><span class="p">)})</span>

<span class="c1"># Exercise - None</span>

<span class="c1"># Verify - None</span>

<span class="c1"># Cleanup -None</span>
<span class="k">return</span> <span class="n">yaml_</span></div>



<span class="c1"># vim: set ft=python :</span>
</pre></div>

</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2024, Michael Sasser.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
2 changes: 1 addition & 1 deletion contributer_documentation/commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ <h1>Commands<a class="headerlink" href="#commands" title="Link to this heading">
<p id="module-matrixctl.commands.maintenance.addon">Use this module to add the <code class="docutils literal notranslate"><span class="pre">maintenance</span></code> subcommand to <code class="docutils literal notranslate"><span class="pre">matrixctl</span></code>.</p>
<dl class="py class">
<dt class="sig sig-object py" id="matrixctl.commands.maintenance.addon.Task">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">matrixctl.commands.maintenance.addon.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matrixctl/commands/maintenance/addon.html#Task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matrixctl.commands.maintenance.addon.Task" title="Link 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">matrixctl.commands.maintenance.addon.</span></span><span class="sig-name descname"><span class="pre">Task</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matrixctl/commands/maintenance/addon.html#Task"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matrixctl.commands.maintenance.addon.Task" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p>
<p>Use this enum for describing the maintenance task.</p>
<p>Supported tasks:</p>
Expand Down
2 changes: 1 addition & 1 deletion contributer_documentation/helpers.html
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ <h1>Helpers<a class="headerlink" href="#helpers" title="Link to this heading">
<p>Use the functions of this module as printing helpers.</p>
<dl class="py class">
<dt class="sig sig-object py" id="matrixctl.sanitizers.MessageType">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">matrixctl.sanitizers.</span></span><span class="sig-name descname"><span class="pre">MessageType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matrixctl/sanitizers.html#MessageType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matrixctl.sanitizers.MessageType" title="Link 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">matrixctl.sanitizers.</span></span><span class="sig-name descname"><span class="pre">MessageType</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/matrixctl/sanitizers.html#MessageType"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#matrixctl.sanitizers.MessageType" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p>
<p>Use this enum for describing message types.</p>
<p>Supported events:</p>
Expand Down
16 changes: 14 additions & 2 deletions contributer_documentation/tests.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,20 @@ <h1>Tests<a class="headerlink" href="#tests" title="Link to this heading"></a
<h2>Handlers<a class="headerlink" href="#handlers" title="Link to this heading"></a></h2>
<p>Handlers in MatrixCtl are used to handle the communication between the server
and the <a class="reference internal" href="commands.html#commands"><span class="std std-ref">Commands</span></a> or to load config files.</p>
<section id="fixtures">
<h3>Fixtures<a class="headerlink" href="#fixtures" title="Link to this heading"></a></h3>
<section id="module-tests.matrixctl.handlers.conftest">
<span id="fixtures"></span><h3>Fixtures<a class="headerlink" href="#module-tests.matrixctl.handlers.conftest" title="Link to this heading"></a></h3>
<p>Create handler fixtures for testing.</p>
<dl class="py function">
<dt class="sig sig-object py" id="tests.matrixctl.handlers.conftest.yaml">
<span class="sig-prename descclassname"><span class="pre">tests.matrixctl.handlers.conftest.</span></span><span class="sig-name descname"><span class="pre">yaml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/tests/matrixctl/handlers/conftest.html#yaml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#tests.matrixctl.handlers.conftest.yaml" title="Link to this definition"></a></dt>
<dd><p>Create a fixture for the YAML class.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="handlers.html#matrixctl.handlers.yaml.YAML" title="matrixctl.handlers.yaml.YAML"><code class="xref py py-class docutils literal notranslate"><span class="pre">YAML</span></code></a></span></p>
</dd>
</dl>
</dd></dl>

</section>
<section id="module-tests.matrixctl.handlers.test_yaml">
<span id="yaml"></span><h3>YAML<a class="headerlink" href="#module-tests.matrixctl.handlers.test_yaml" title="Link to this heading"></a></h3>
Expand Down
Loading

0 comments on commit f435539

Please sign in to comment.