sh-edraft.de/sh_cpl
1
1
Fork 0
Code Issues 4 Pull Requests 1 Actions Packages Projects 1 Releases 12 Wiki Activity
04f610c799
sh_cpl/docs/build/html/cpl_query.base.html

945 lines
73 KiB
HTML
Raw Normal View History

Updated docs
2022-12-04 00:50:24 +01:00
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
Updated docs
2023-04-05 21:43:21 +02:00
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
Updated docs
2022-12-04 00:50:24 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
Updated docs
2023-02-20 15:55:20 +01:00
<title>cpl_query.base package &mdash; Common Python Library documentation</title>
Updated docs
2022-12-04 00:50:24 +01:00
<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]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
Updated docs
2023-04-05 21:43:21 +02:00
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
Updated docs
2022-12-04 00:50:24 +01:00
<script src="_static/doctools.js"></script>
Updated docs
2023-04-05 21:43:21 +02:00
<script src="_static/sphinx_highlight.js"></script>
Updated docs
2022-12-04 00:50:24 +01:00
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Updated docs
2023-02-20 15:55:20 +01:00
<link rel="next" title="cpl_query.enumerable package" href="cpl_query.enumerable.html" />
Updated docs
2022-12-04 00:50:24 +01:00
<link rel="prev" title="Query reference" href="cpl_query.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" >
Updated docs
2023-04-05 21:43:21 +02:00
<a href="index.html" class="icon icon-home">
Common Python Library
Updated docs
2022-12-04 00:50:24 +01:00
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Updated docs
2023-04-05 21:43:21 +02:00
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Updated docs
2022-12-04 00:50:24 +01:00
<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">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing to CPL</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l1"><a class="reference internal" href="deprecated.html">Deprecated</a></li>
Updated docs
2022-12-04 00:50:24 +01:00
<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>
Updated docs
2023-04-04 13:16:19 +02:00
<li class="toctree-l1"><a class="reference internal" href="cpl_discord.html">Discord Reference</a></li>
Updated docs
2022-12-04 00:50:24 +01:00
<li class="toctree-l1 current"><a class="reference internal" href="cpl_query.html">Query reference</a><ul class="current">
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl_query.base package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#submodules">Submodules</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.default_lambda">cpl_query.base.default_lambda module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.default_lambda.default_lambda"><code class="docutils literal notranslate"><span class="pre">default_lambda()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable">cpl_query.base.ordered_queryable module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable.OrderedQueryable"><code class="docutils literal notranslate"><span class="pre">OrderedQueryable</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.ordered_queryable_abc">cpl_query.base.ordered_queryable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.queryable_abc">cpl_query.base.queryable_abc module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC"><code class="docutils literal notranslate"><span class="pre">QueryableABC</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base.sequence">cpl_query.base.sequence module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.sequence.Sequence"><code class="docutils literal notranslate"><span class="pre">Sequence</span></code></a></li>
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
<li class="toctree-l3"><a class="reference internal" href="#module-cpl_query.base">Module contents</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#cpl-query-cpl-queries">cpl-query CPL Queries</a></li>
Updated docs
2023-04-05 21:43:21 +02:00
<li class="toctree-l4"><a class="reference internal" href="#cpl_query.base.VersionInfo"><code class="docutils literal notranslate"><span class="pre">VersionInfo</span></code></a></li>
Updated docs
2022-12-04 00:50:24 +01:00
</ul>
</li>
Updated docs
2023-02-20 15:55:20 +01:00
</ul>
</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"><a class="reference internal" href="cpl_query.iterable.html">cpl_query.iterable package</a></li>
Updated docs
2022-12-04 00:50:24 +01:00
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cpl_translation.html">Translation reference</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">Common Python Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
Updated docs
2023-04-05 21:43:21 +02:00
<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.base package</li>
Updated docs
2022-12-04 00:50:24 +01:00
<li class="wy-breadcrumbs-aside">
<a href="_sources/cpl_query.base.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
Updated docs
2023-02-20 15:55:20 +01:00
<section id="cpl-query-base-package">
<h1>cpl_query.base package<a class="headerlink" href="#cpl-query-base-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>
Updated docs
2022-12-04 00:50:24 +01:00
<section id="module-cpl_query.base.default_lambda">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-query-base-default-lambda-module"></span><h2>cpl_query.base.default_lambda module<a class="headerlink" href="#module-cpl_query.base.default_lambda" title="Permalink to this heading"></a></h2>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py function">
<dt class="sig sig-object py" id="cpl_query.base.default_lambda.default_lambda">
<span class="sig-prename descclassname"><span class="pre">cpl_query.base.default_lambda.</span></span><span class="sig-name descname"><span class="pre">default_lambda</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</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.base.default_lambda.default_lambda" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-cpl_query.base.ordered_queryable">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-query-base-ordered-queryable-module"></span><h2>cpl_query.base.ordered_queryable module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable" title="Permalink to this heading"></a></h2>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryable</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></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"><a class="reference internal" href="cpl_query.iterable.html#cpl_query.iterable.iterable.Iterable" title="cpl_query.iterable.iterable.Iterable"><span class="pre">Iterable</span></a><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">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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.base.ordered_queryable.OrderedQueryable" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedQueryableABC</span></code></a></p>
Updated docs
2023-04-05 21:43:21 +02:00
<p>Implementation of :class: <cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by">
<span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by" title="Permalink to this definition"></a></dt>
<dd><p>Sorts OrderedList in ascending order by function</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
</dd>
Updated docs
2023-04-04 13:16:19 +02:00
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending">
<span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable.OrderedQueryable.then_by_descending" title="Permalink to this definition"></a></dt>
<dd><p>Sorts OrderedList in descending order by function</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
</dd>
Updated docs
2023-04-04 13:16:19 +02:00
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
</dd></dl>
</section>
<section id="module-cpl_query.base.ordered_queryable_abc">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-query-base-ordered-queryable-abc-module"></span><h2>cpl_query.base.ordered_queryable_abc module<a class="headerlink" href="#module-cpl_query.base.ordered_queryable_abc" title="Permalink to this heading"></a></h2>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.ordered_queryable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedQueryableABC</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></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">Iterable</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">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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.base.ordered_queryable_abc.OrderedQueryableABC" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Bases: <a class="reference internal" href="#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>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by" title="Permalink to this definition"></a></dt>
<dd><p>Sorts OrderedList in ascending order by function</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
</dd>
Updated docs
2023-04-04 13:16:19 +02:00
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending">
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">then_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC.then_by_descending" title="Permalink to this definition"></a></dt>
<dd><p>Sorts OrderedList in descending order by function</p>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="simple">
<dt>Parameter:</dt><dd><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
</dd>
Updated docs
2023-04-04 13:16:19 +02:00
<dt>Returns:</dt><dd><p>list of <a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</span></code></a></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
</dd></dl>
</section>
<section id="module-cpl_query.base.queryable_abc">
Updated docs
2023-02-20 15:55:20 +01:00
<span id="cpl-query-base-queryable-abc-module"></span><h2>cpl_query.base.queryable_abc module<a class="headerlink" href="#module-cpl_query.base.queryable_abc" title="Permalink to this heading"></a></h2>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.queryable_abc.</span></span><span class="sig-name descname"><span class="pre">QueryableABC</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></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">Iterable</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.base.queryable_abc.QueryableABC" title="Permalink to this definition"></a></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd><p>Bases: <a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a></p>
Updated docs
2022-12-04 00:50:24 +01:00
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.all">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.all" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Checks if every element of list equals result found by function</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="parameter">
<h3>Parameter<a class="headerlink" href="#parameter" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="returns">
<h3>Returns<a class="headerlink" href="#returns" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.any">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">any</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.any" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Checks if list contains result found by function</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id1">
<h3>Parameter<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id2">
<h3>Returns<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.average">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">average</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.average" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns average value of list</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id3">
<h3>Parameter<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id4">
<h3>Returns<a class="headerlink" href="#id4" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float, complex]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.contains">
<span class="sig-name descname"><span class="pre">contains</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_value</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.contains" title="Permalink to this definition"></a></dt>
<dd><p>Checks if list contains value given by function</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id5">
<h3>Parameter<a class="headerlink" href="#id5" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>value: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></dt><dd><p>value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id6">
<h3>Returns<a class="headerlink" href="#id6" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>bool</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.count">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">count</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.count" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns length of list or count of found elements</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id7">
<h3>Parameter<a class="headerlink" href="#id7" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id8">
<h3>Returns<a class="headerlink" href="#id8" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>int</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.distinct">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">distinct</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.distinct" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns list without redundancies</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id9">
<h3>Parameter<a class="headerlink" href="#id9" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id10">
<h3>Returns<a class="headerlink" href="#id10" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at">
<span class="sig-name descname"><span class="pre">element_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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at" title="Permalink to this definition"></a></dt>
<dd><p>Returns element at given index</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id11">
<h3>Parameter<a class="headerlink" href="#id11" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id12">
<h3>Returns<a class="headerlink" href="#id12" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Value at _index: any</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.element_at_or_default">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">element_at_or_default</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns element at given index or None</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id13">
<h3>Parameter<a class="headerlink" href="#id13" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id14">
<h3>Returns<a class="headerlink" href="#id14" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Value at _index: Optional[any]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first">
<span class="sig-name descname"><span class="pre">first</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">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first" title="Permalink to this definition"></a></dt>
<dd><p>Returns first element</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id15">
<h3>Returns<a class="headerlink" href="#id15" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>First element of list: any</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.first_or_default">
<span class="sig-name descname"><span class="pre">first_or_default</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">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.first_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns first element or None</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id16">
<h3>Returns<a class="headerlink" href="#id16" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>First element of list: Optional[any]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.for_each">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">for_each</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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.base.queryable_abc.QueryableABC.for_each" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Runs given function for each element of list</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id17">
<h3>Parameter<a class="headerlink" href="#id17" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: :class: <cite>Callable</cite></dt><dd><p>function to call</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.group_by">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">group_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.group_by" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Groups by func</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id18">
<h3>Returns<a class="headerlink" href="#id18" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Grouped list[list[any]]: any</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last">
<span class="sig-name descname"><span class="pre">last</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">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last" title="Permalink to this definition"></a></dt>
<dd><p>Returns last element</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id19">
<h3>Returns<a class="headerlink" href="#id19" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Last element of list: any</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.last_or_default">
<span class="sig-name descname"><span class="pre">last_or_default</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">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.last_or_default" title="Permalink to this definition"></a></dt>
<dd><p>Returns last element or None</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id20">
<h3>Returns<a class="headerlink" href="#id20" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Last element of list: Optional[any]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.max">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">max</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.max" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns the highest value</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id21">
<h3>Parameter<a class="headerlink" href="#id21" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id22">
<h3>Returns<a class="headerlink" href="#id22" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>object</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.median">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">median</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.median" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Return the median value of data elements</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id23">
<h3>Returns<a class="headerlink" href="#id23" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.min">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">min</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">object</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.min" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns the lowest value</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id24">
<h3>Parameter<a class="headerlink" href="#id24" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id25">
<h3>Returns<a class="headerlink" href="#id25" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>object</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">order_by</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Sorts elements by function in ascending order</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id26">
<h3>Parameter<a class="headerlink" href="#id26" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id27">
<h3>Returns<a class="headerlink" href="#id27" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.order_by_descending">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">order_by_descending</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.ordered_queryable_abc.OrderedQueryableABC" title="cpl_query.base.ordered_queryable_abc.OrderedQueryableABC"><span class="pre">OrderedQueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.order_by_descending" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Sorts elements by function in descending order</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id28">
<h3>Parameter<a class="headerlink" href="#id28" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id29">
<h3>Returns<a class="headerlink" href="#id29" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>cpl_query.base.ordered_queryable_abc.OrderedQueryableABC</cite></p>
Updated docs
2023-02-20 15:55:20 +01:00
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.reverse">
<span class="sig-name descname"><span class="pre">reverse</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.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.reverse" title="Permalink to this definition"></a></dt>
<dd><p>Reverses list</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id30">
<h3>Returns<a class="headerlink" href="#id30" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select">
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select" title="Permalink to this definition"></a></dt>
<dd><p>Formats each element of list to a given format</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id31">
<h3>Returns<a class="headerlink" href="#id31" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.select_many">
<span class="sig-name descname"><span class="pre">select_many</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.select_many" title="Permalink to this definition"></a></dt>
<dd><p>Flattens resulting lists to one</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id32">
<h3>Returns<a class="headerlink" href="#id32" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single">
<span class="sig-name descname"><span class="pre">single</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">any</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single" title="Permalink to this definition"></a></dt>
<dd><p>Returns one single element of list</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id33">
<h3>Returns<a class="headerlink" href="#id33" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Found value: any</p>
</div></blockquote>
</section>
<section id="raises">
<h3>Raises<a class="headerlink" href="#raises" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>ArgumentNoneException: when argument is None
Updated docs
2022-12-04 00:50:24 +01:00
Exception: when argument is None or found more than one element</p>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.single_or_default">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">single_or_default</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">any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.single_or_default" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Returns one single element of list</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id34">
<h3>Returns<a class="headerlink" href="#id34" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Found value: Optional[any]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip">
<span class="sig-name descname"><span class="pre">skip</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip" title="Permalink to this definition"></a></dt>
<dd><p>Skips all elements from index</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id35">
<h3>Parameter<a class="headerlink" href="#id35" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id36">
<h3>Returns<a class="headerlink" href="#id36" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.skip_last">
<span class="sig-name descname"><span class="pre">skip_last</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.skip_last" title="Permalink to this definition"></a></dt>
<dd><p>Skips all elements after index</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id37">
<h3>Parameter<a class="headerlink" href="#id37" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id38">
<h3>Returns<a class="headerlink" href="#id38" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2023-02-20 15:55:20 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.split">
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span></span></em><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.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.split" title="Permalink to this definition"></a></dt>
<dd><p>Splits the list by given function</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id39">
<h3>Parameter<a class="headerlink" href="#id39" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2023-02-20 15:55:20 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>seperator</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id40">
<h3>Returns<a class="headerlink" href="#id40" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.sum">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">sum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">complex</span></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.sum" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Sum of all values</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id41">
<h3>Parameter<a class="headerlink" href="#id41" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id42">
<h3>Returns<a class="headerlink" href="#id42" title="Permalink to this heading"></a></h3>
<blockquote>
<div><p>Union[int, float, complex]</p>
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take">
<span class="sig-name descname"><span class="pre">take</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take" title="Permalink to this definition"></a></dt>
<dd><p>Takes all elements from index</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id43">
<h3>Parameter<a class="headerlink" href="#id43" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id44">
<h3>Returns<a class="headerlink" href="#id44" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.take_last">
<span class="sig-name descname"><span class="pre">take_last</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.take_last" title="Permalink to this definition"></a></dt>
<dd><p>Takes all elements after index</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id45">
<h3>Parameter<a class="headerlink" href="#id45" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>_index: <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></dt><dd><p>index</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id46">
<h3>Returns<a class="headerlink" href="#id46" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.queryable_abc.QueryableABC.where">
Updated docs
2023-04-05 21:43:21 +02:00
<span class="sig-name descname"><span class="pre">where</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.queryable_abc.QueryableABC" title="cpl_query.base.queryable_abc.QueryableABC"><span class="pre">QueryableABC</span></a></span></span><a class="headerlink" href="#cpl_query.base.queryable_abc.QueryableABC.where" title="Permalink to this definition"></a></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd><p>Select element by function</p>
Updated docs
2023-04-05 21:43:21 +02:00
<section id="id47">
<h3>Parameter<a class="headerlink" href="#id47" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="simple">
Updated docs
2022-12-04 00:50:24 +01:00
<dt>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></dt><dd><p>selected value</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
<section id="id48">
<h3>Returns<a class="headerlink" href="#id48" title="Permalink to this heading"></a></h3>
<blockquote>
<div><dl class="field-list simple">
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2022-12-04 00:50:24 +01:00
<dd class="field-odd"><p><cite>cpl_query.base.queryable_abc.QueryableABC</cite></p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</div></blockquote>
</section>
Updated docs
2022-12-04 00:50:24 +01:00
</dd></dl>
</dd></dl>
</section>
Updated docs
2023-02-20 15:55:20 +01:00
<section id="module-cpl_query.base.sequence">
<span id="cpl-query-base-sequence-module"></span><h2>cpl_query.base.sequence module<a class="headerlink" href="#module-cpl_query.base.sequence" title="Permalink to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence">
Updated docs
2023-04-05 21:43:21 +02:00
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.sequence.</span></span><span class="sig-name descname"><span class="pre">Sequence</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></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">Iterable</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.base.sequence.Sequence" title="Permalink to this definition"></a></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.copy">
<span class="sig-name descname"><span class="pre">copy</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.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.copy" title="Permalink to this definition"></a></dt>
<dd><p>Creates a copy of sequence</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Sequence</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.empty">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">empty</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.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.empty" title="Permalink to this definition"></a></dt>
<dd><p>Returns an empty sequence</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Sequence object that contains no elements</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.index_of">
<span class="sig-name descname"><span class="pre">index_of</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.index_of" title="Permalink to this definition"></a></dt>
<dd><p>Returns the index of given element</p>
<dl class="simple">
<dt>Returns:</dt><dd><p>Index of object</p>
</dd>
<dt>Raises:</dt><dd><p>IndexError if object not in sequence</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.range">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">range</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.base.sequence.Sequence" title="cpl_query.base.sequence.Sequence"><span class="pre">Sequence</span></a></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.range" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.to_list">
<span class="sig-name descname"><span class="pre">to_list</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">list</span></span></span><a class="headerlink" href="#cpl_query.base.sequence.Sequence.to_list" title="Permalink to this definition"></a></dt>
<dd><p>Converts :class: <cite>cpl_query.base.sequence_abc.SequenceABC</cite> to :class: <cite>list</cite></p>
<dl class="simple">
<dt>Returns:</dt><dd><dl class="field-list simple">
Updated docs
2023-04-05 21:43:21 +02:00
<dt class="field-odd">class<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-odd"><p><cite>list</cite></p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="cpl_query.base.sequence.Sequence.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.base.sequence.Sequence.type" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-cpl_query.base">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-cpl_query.base" 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">
Updated docs
2023-04-05 21:43:21 +02:00
<dt class="field-odd">copyright<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-odd"><ol class="loweralpha simple" start="3">
<li><p>2021 - 2023 sh-edraft.de</p></li>
</ol>
</dd>
Updated docs
2023-04-05 21:43:21 +02:00
<dt class="field-even">license<span class="colon">:</span></dt>
Updated docs
2023-02-20 15:55:20 +01:00
<dd class="field-even"><p>MIT, see LICENSE for more details.</p>
</dd>
</dl>
Updated docs
2023-04-05 21:43:21 +02:00
</section>
Updated docs
2023-02-20 15:55:20 +01:00
<dl class="py class">
<dt class="sig sig-object py" id="cpl_query.base.VersionInfo">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.base.</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.base.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.base.VersionInfo.major">
<span class="sig-name descname"><span class="pre">major</span></span><a class="headerlink" href="#cpl_query.base.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.base.VersionInfo.micro">
<span class="sig-name descname"><span class="pre">micro</span></span><a class="headerlink" href="#cpl_query.base.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.base.VersionInfo.minor">
<span class="sig-name descname"><span class="pre">minor</span></span><a class="headerlink" href="#cpl_query.base.VersionInfo.minor" title="Permalink to this definition"></a></dt>
<dd><p>Alias for field number 1</p>
</dd></dl>
</dd></dl>
Updated docs
2022-12-04 00:50:24 +01:00
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="cpl_query.html" class="btn btn-neutral float-left" title="Query reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
Updated docs
2023-02-20 15:55:20 +01:00
<a href="cpl_query.enumerable.html" class="btn btn-neutral float-right" title="cpl_query.enumerable package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
Updated docs
2022-12-04 00:50:24 +01:00
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2021 - 2023, Sven Heidemann.</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>
Reference in New Issue Copy Permalink