Updated docs
This commit is contained in:
138
docs/build/html/cpl_query.iterable.html
vendored
138
docs/build/html/cpl_query.iterable.html
vendored
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>cpl_query.iterable — Common Python Library documentation</title>
|
||||
<title>cpl_query.iterable package — Common Python Library documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -20,7 +20,7 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="next" title="Translation reference" href="cpl_translation.html" />
|
||||
<link rel="prev" title="cpl_query.extension" href="cpl_query.extension.html" />
|
||||
<link rel="prev" title="cpl_query.extension package" href="cpl_query.extension.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
@@ -44,14 +44,19 @@
|
||||
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_cli.html">CLI reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord reference</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">cpl_discord package</a></li>
|
||||
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.iterable</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.base.html">cpl_query.base package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.enumerable.html">cpl_query.enumerable package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
|
||||
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.iterable package</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable">cpl_query.iterable.iterable module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable.iterable_abc">cpl_query.iterable.iterable_abc module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.iterable">Module contents</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@@ -74,7 +79,7 @@
|
||||
<ul class="wy-breadcrumbs">
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
<li><a href="cpl_query.html">Query reference</a> »</li>
|
||||
<li>cpl_query.iterable</li>
|
||||
<li>cpl_query.iterable package</li>
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
<a href="_sources/cpl_query.iterable.rst.txt" rel="nofollow"> View page source</a>
|
||||
</li>
|
||||
@@ -84,10 +89,13 @@
|
||||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||||
<div itemprop="articleBody">
|
||||
|
||||
<section id="cpl-query-iterable">
|
||||
<h1>cpl_query.iterable<a class="headerlink" href="#cpl-query-iterable" title="Permalink to this heading"></a></h1>
|
||||
<section id="cpl-query-iterable-package">
|
||||
<h1>cpl_query.iterable package<a class="headerlink" href="#cpl-query-iterable-package" title="Permalink to this heading"></a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable.iterable">
|
||||
<span id="cpl-query-iterable-iterable"></span><h2>cpl_query.iterable.iterable<a class="headerlink" href="#module-cpl_query.iterable.iterable" title="Permalink to this heading"></a></h2>
|
||||
<span id="cpl-query-iterable-iterable-module"></span><h2>cpl_query.iterable.iterable module<a class="headerlink" href="#module-cpl_query.iterable.iterable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable.Iterable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable.Iterable" title="Permalink to this definition"></a></dt>
|
||||
@@ -96,7 +104,7 @@
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable.iterable_abc">
|
||||
<span id="cpl-query-iterable-iterable-abc"></span><h2>cpl_query.iterable.iterable_abc<a class="headerlink" href="#module-cpl_query.iterable.iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<span id="cpl-query-iterable-iterable-abc-module"></span><h2>cpl_query.iterable.iterable_abc module<a class="headerlink" href="#module-cpl_query.iterable.iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Iterable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
|
||||
@@ -105,85 +113,117 @@
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.add">
|
||||
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.add" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds element to list
|
||||
Parameter
|
||||
———</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dd><p>Adds element to list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>_object: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.append">
|
||||
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.append" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Append object to the end of the list.</p>
|
||||
</dd></dl>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.extend">
|
||||
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.iterable.iterable_abc.IterableABC" title="cpl_query.iterable.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.extend" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds elements of given list to list
|
||||
Parameter
|
||||
———</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dd><p>Adds elements of given list to list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>__iterable: :class: <cite>cpl_query.extension.iterable.Iterable</cite></dt><dd><p>index</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.remove">
|
||||
<span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_object</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.remove" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Removes element from list
|
||||
Parameter
|
||||
———</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dd><p>Removes element from list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>_object: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.remove_at">
|
||||
<span class="sig-name descname"><span class="pre">remove_at</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_index</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.remove_at" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Removes element from list
|
||||
Parameter
|
||||
———</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
<dd><p>Removes element from list</p>
|
||||
<dl class="simple">
|
||||
<dt>Parameter:</dt><dd><dl class="simple">
|
||||
<dt>_object: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.to_enumerable">
|
||||
<span class="sig-name descname"><span class="pre">to_enumerable</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="cpl_query.enumerable.html#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><span class="pre">EnumerableABC</span></a></span></span><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.to_enumerable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite> to :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
<dl class="simple">
|
||||
<dt>Returns:</dt><dd><dl class="field-list simple">
|
||||
<dt class="field-odd">class</dt>
|
||||
<dd class="field-odd"><p><cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div></blockquote>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.iterable_abc.IterableABC.type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_query.iterable.iterable_abc.IterableABC.type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
<section id="module-cpl_query.iterable">
|
||||
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.iterable" title="Permalink to this heading"></a></h2>
|
||||
<section id="cpl-query-cpl-queries">
|
||||
<h3>cpl-query CPL Queries<a class="headerlink" href="#cpl-query-cpl-queries" title="Permalink to this heading"></a></h3>
|
||||
<p>CPL Python integrated Queries</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">copyright</dt>
|
||||
<dd class="field-odd"><ol class="loweralpha simple" start="3">
|
||||
<li><p>2021 - 2023 sh-edraft.de</p></li>
|
||||
</ol>
|
||||
</dd>
|
||||
<dt class="field-even">license</dt>
|
||||
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.iterable.</span></span><span class="sig-name descname"><span class="pre">VersionInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">major</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">minor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">micro</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.iterable.VersionInfo" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.major">
|
||||
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.major" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 0</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.micro">
|
||||
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 2</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="cpl_query.iterable.VersionInfo.minor">
|
||||
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.iterable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Alias for field number 1</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
@@ -191,7 +231,7 @@ Parameter
|
||||
</div>
|
||||
</div>
|
||||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||||
<a href="cpl_query.extension.html" class="btn btn-neutral float-left" title="cpl_query.extension" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_query.extension.html" class="btn btn-neutral float-left" title="cpl_query.extension package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||||
<a href="cpl_translation.html" class="btn btn-neutral float-right" title="Translation reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user