Added cpl-mail
Some checks failed
Build on push / prepare (push) Successful in 9s
Build on push / core (push) Successful in 18s
Build on push / query (push) Successful in 25s
Build on push / translation (push) Failing after 8s
Build on push / mail (push) Successful in 14s

This commit is contained in:
2025-09-15 20:56:07 +02:00
parent 3b120370b8
commit 25b4ca0696
344 changed files with 4567 additions and 4946 deletions

View File

@@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>cpl_query.enumerable package &mdash; Common Python Library documentation</title>
<title>cpl.query.enumerable package &mdash; 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]>
@@ -19,8 +19,8 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="cpl_query.extension package" href="cpl_query.extension.html" />
<link rel="prev" title="cpl_query.base package" href="cpl_query.base.html" />
<link rel="next" title="cpl.query.extension package" href="cpl.query.extension.html" />
<link rel="prev" title="cpl.query.base package" href="cpl.query.base.html" />
</head>
<body class="wy-body-for-nav">
@@ -48,29 +48,29 @@
<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="deprecated.html">Deprecated</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.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 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 package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.enumerable package</a><ul>
<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 package</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl.query.enumerable 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.enumerable.enumerable">cpl_query.enumerable.enumerable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable.enumerable">cpl.query.enumerable.enumerable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.enumerable.Enumerable"><code class="docutils literal notranslate"><span class="pre">Enumerable</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable.enumerable_abc">cpl_query.enumerable.enumerable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable.enumerable_abc">cpl.query.enumerable.enumerable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.enumerable">Module contents</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl.query.enumerable">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#cpl.query.enumerable.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.extension.html">cpl_query.extension package</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable 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"><a class="reference internal" href="cpl.query.iterable.html">cpl.query.iterable package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</a></li>
@@ -90,10 +90,10 @@
<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="cpl_query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl_query.enumerable package</li>
<li class="breadcrumb-item"><a href="cpl.query.html">Query reference</a></li>
<li class="breadcrumb-item active">cpl.query.enumerable package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.enumerable.rst.txt" rel="nofollow"> View page source</a>
<a href="_sources/cpl.query.enumerable.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
@@ -102,35 +102,35 @@
<div itemprop="articleBody">
<section id="cpl-query-enumerable-package">
<h1>cpl_query.enumerable package<a class="headerlink" href="#cpl-query-enumerable-package" title="Permalink to this heading"></a></h1>
<h1>cpl.query.enumerable package<a class="headerlink" href="#cpl-query-enumerable-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.enumerable.enumerable">
<span id="cpl-query-enumerable-enumerable-module"></span><h2>cpl_query.enumerable.enumerable module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
<section id="module-cpl.query.enumerable.enumerable">
<span id="cpl-query-enumerable-enumerable-module"></span><h2>cpl.query.enumerable.enumerable module<a class="headerlink" href="#module-cpl.query.enumerable.enumerable" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable.Enumerable">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</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">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl_query.enumerable.enumerable_abc.EnumerableABC" title="cpl_query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
<p>Implementation of :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite></p>
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable.Enumerable">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.enumerable.</span></span><span class="sig-name descname"><span class="pre">Enumerable</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">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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.enumerable.enumerable.Enumerable" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#cpl.query.enumerable.enumerable_abc.EnumerableABC" title="cpl.query.enumerable.enumerable_abc.EnumerableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">EnumerableABC</span></code></a></p>
<p>Implementation of :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite></p>
</dd></dl>
</section>
<section id="module-cpl_query.enumerable.enumerable_abc">
<span id="cpl-query-enumerable-enumerable-abc-module"></span><h2>cpl_query.enumerable.enumerable_abc module<a class="headerlink" href="#module-cpl_query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
<section id="module-cpl.query.enumerable.enumerable_abc">
<span id="cpl-query-enumerable-enumerable-abc-module"></span><h2>cpl.query.enumerable.enumerable_abc module<a class="headerlink" href="#module-cpl.query.enumerable.enumerable_abc" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</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">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl_query.base.html#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable_abc.EnumerableABC">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.enumerable_abc.</span></span><span class="sig-name descname"><span class="pre">EnumerableABC</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">type</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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">list</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</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.enumerable.enumerable_abc.EnumerableABC" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="cpl.query.base.html#cpl.query.base.queryable_abc.QueryableABC" title="cpl.query.base.queryable_abc.QueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></p>
<p>ABC to define functions on list</p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.enumerable.enumerable_abc.EnumerableABC.to_iterable">
<span class="sig-name descname"><span class="pre">to_iterable</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"><a class="reference internal" href="cpl_query.iterable.html#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.enumerable.enumerable_abc.EnumerableABC.to_iterable" title="Permalink to this definition"></a></dt>
<dd><p>Converts :class: <cite>cpl_query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
<dt class="sig sig-object py" id="cpl.query.enumerable.enumerable_abc.EnumerableABC.to_iterable">
<span class="sig-name descname"><span class="pre">to_iterable</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"><a class="reference internal" href="cpl.query.iterable.html#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.enumerable.enumerable_abc.EnumerableABC.to_iterable" title="Permalink to this definition"></a></dt>
<dd><p>Converts :class: <cite>cpl.query.enumerable.enumerable_abc.EnumerableABC</cite> to :class: <cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.iterable.iterable_abc.IterableABC</cite></p>
<dd class="field-odd"><p><cite>cpl.query.iterable.iterable_abc.IterableABC</cite></p>
</dd>
</dl>
</dd>
@@ -140,8 +140,8 @@
</dd></dl>
</section>
<section id="module-cpl_query.enumerable">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.enumerable" title="Permalink to this heading"></a></h2>
<section id="module-cpl.query.enumerable">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl.query.enumerable" 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>
@@ -157,24 +157,24 @@
</dl>
</section>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.enumerable.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.enumerable.</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.enumerable.VersionInfo" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl.query.enumerable.</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.enumerable.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.enumerable.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.major" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl.query.enumerable.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.enumerable.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.micro" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl.query.enumerable.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.enumerable.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.enumerable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dt class="sig sig-object py" id="cpl.query.enumerable.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl.query.enumerable.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
@@ -187,8 +187,8 @@
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cpl_query.base.html" class="btn btn-neutral float-left" title="cpl_query.base package" 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-right" title="cpl_query.extension package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="cpl.query.base.html" class="btn btn-neutral float-left" title="cpl.query.base package" 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-right" title="cpl.query.extension package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>