Improved docs

This commit is contained in:
2021-11-02 17:45:45 +01:00
parent ca086e01d7
commit 58dccea28b
16 changed files with 691 additions and 65 deletions

View File

@@ -71,8 +71,25 @@
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="cpl-query-tests-iterable-test-module">
<h2>cpl_query.tests.iterable_test module<a class="headerlink" href="#cpl-query-tests-iterable-test-module" title="Permalink to this headline"></a></h2>
<div class="section" id="module-cpl_query.tests.iterable_test">
<span id="cpl-query-tests-iterable-test-module"></span><h2>cpl_query.tests.iterable_test module<a class="headerlink" href="#module-cpl_query.tests.iterable_test" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.tests.iterable_test.IterableTest">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_query.tests.iterable_test.</span></span><span class="sig-name descname"><span class="pre">IterableTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.iterable_test.IterableTest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">unittest.case.TestCase</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.iterable_test.IterableTest.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.tests.iterable_test.IterableTest.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.iterable_test.IterableTest.test_append">
<span class="sig-name descname"><span class="pre">test_append</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.iterable_test.IterableTest.test_append" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_query.tests.models">
<span id="cpl-query-tests-models-module"></span><h2>cpl_query.tests.models module<a class="headerlink" href="#module-cpl_query.tests.models" title="Permalink to this headline"></a></h2>
@@ -89,11 +106,179 @@
</dd></dl>
</div>
<div class="section" id="cpl-query-tests-query-test-module">
<h2>cpl_query.tests.query_test module<a class="headerlink" href="#cpl-query-tests-query-test-module" title="Permalink to this headline"></a></h2>
<div class="section" id="module-cpl_query.tests.query_test">
<span id="cpl-query-tests-query-test-module"></span><h2>cpl_query.tests.query_test module<a class="headerlink" href="#module-cpl_query.tests.query_test" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_query.tests.query_test.</span></span><span class="sig-name descname"><span class="pre">QueryTest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">methodName</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'runTest'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">unittest.case.TestCase</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.setUp">
<span class="sig-name descname"><span class="pre">setUp</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.setUp" title="Permalink to this definition"></a></dt>
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_all">
<span class="sig-name descname"><span class="pre">test_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_all" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_any">
<span class="sig-name descname"><span class="pre">test_any</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_any" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_avg">
<span class="sig-name descname"><span class="pre">test_avg</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_avg" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_contains">
<span class="sig-name descname"><span class="pre">test_contains</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_contains" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_count">
<span class="sig-name descname"><span class="pre">test_count</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_count" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_distinct">
<span class="sig-name descname"><span class="pre">test_distinct</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_distinct" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_element_at">
<span class="sig-name descname"><span class="pre">test_element_at</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_element_at" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_element_at_or_default">
<span class="sig-name descname"><span class="pre">test_element_at_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_element_at_or_default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_first">
<span class="sig-name descname"><span class="pre">test_first</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_first" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_first_or_default">
<span class="sig-name descname"><span class="pre">test_first_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_first_or_default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_for_each">
<span class="sig-name descname"><span class="pre">test_for_each</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_for_each" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_last">
<span class="sig-name descname"><span class="pre">test_last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_last" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_last_or_default">
<span class="sig-name descname"><span class="pre">test_last_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_last_or_default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_max">
<span class="sig-name descname"><span class="pre">test_max</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_max" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_min">
<span class="sig-name descname"><span class="pre">test_min</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_min" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_order_by">
<span class="sig-name descname"><span class="pre">test_order_by</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_order_by" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_order_by_descending">
<span class="sig-name descname"><span class="pre">test_order_by_descending</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_order_by_descending" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_reverse">
<span class="sig-name descname"><span class="pre">test_reverse</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_reverse" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_single">
<span class="sig-name descname"><span class="pre">test_single</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_single" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_single_or_default">
<span class="sig-name descname"><span class="pre">test_single_or_default</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_single_or_default" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_skip">
<span class="sig-name descname"><span class="pre">test_skip</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_skip" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_skip_last">
<span class="sig-name descname"><span class="pre">test_skip_last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_skip_last" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_sum">
<span class="sig-name descname"><span class="pre">test_sum</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_sum" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_take">
<span class="sig-name descname"><span class="pre">test_take</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_take" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_take_last">
<span class="sig-name descname"><span class="pre">test_take_last</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_take_last" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_then_by">
<span class="sig-name descname"><span class="pre">test_then_by</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_then_by" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_then_by_descending">
<span class="sig-name descname"><span class="pre">test_then_by_descending</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_then_by_descending" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.query_test.QueryTest.test_where">
<span class="sig-name descname"><span class="pre">test_where</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.query_test.QueryTest.test_where" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="cpl-query-tests-tester-module">
<h2>cpl_query.tests.tester module<a class="headerlink" href="#cpl-query-tests-tester-module" title="Permalink to this headline"></a></h2>
<div class="section" id="module-cpl_query.tests.tester">
<span id="cpl-query-tests-tester-module"></span><h2>cpl_query.tests.tester module<a class="headerlink" href="#module-cpl_query.tests.tester" title="Permalink to this headline"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.tests.tester.Tester">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">cpl_query.tests.tester.</span></span><span class="sig-name descname"><span class="pre">Tester</span></span><a class="headerlink" href="#cpl_query.tests.tester.Tester" 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>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.tester.Tester.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.tester.Tester.create" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.tests.tester.Tester.start">
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.tests.tester.Tester.start" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-cpl_query.tests">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.tests" title="Permalink to this headline"></a></h2>