Build docs and added tutorial files
This commit is contained in:
455
docs/build/html/cpl_query.extension.html
vendored
455
docs/build/html/cpl_query.extension.html
vendored
@@ -1,70 +1,35 @@
|
||||
|
||||
|
||||
<!DOCTYPE html>
|
||||
<html class="writer-html5" lang="en" >
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>cpl_query.extension — Common Python Library documentation</title>
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<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 type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
|
||||
<script type="text/javascript" src="_static/js/theme.js"></script>
|
||||
|
||||
|
||||
<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.exceptions" href="cpl_query.exceptions.html" />
|
||||
<link rel="prev" title="Query Reference" href="cpl_query.html" />
|
||||
</head>
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
|
||||
|
||||
<body class="wy-body-for-nav">
|
||||
<div class="wy-grid-for-nav">
|
||||
|
||||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||||
<div class="wy-side-scroll">
|
||||
<div class="wy-side-nav-search" >
|
||||
|
||||
|
||||
|
||||
<a href="index.html" class="icon icon-home"> Common Python Library
|
||||
|
||||
|
||||
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
<input type="text" name="q" placeholder="Search docs" />
|
||||
@@ -72,18 +37,7 @@
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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>
|
||||
@@ -103,85 +57,43 @@
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||||
|
||||
|
||||
<nav class="wy-nav-top" aria-label="top navigation">
|
||||
|
||||
<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="breadcrumbs navigation">
|
||||
|
||||
<div role="navigation" aria-label="Page navigation">
|
||||
<ul class="wy-breadcrumbs">
|
||||
|
||||
<li><a href="index.html" class="icon icon-home"></a> »</li>
|
||||
|
||||
<li><a href="cpl_query.html">Query Reference</a> »</li>
|
||||
|
||||
<li>cpl_query.extension</li>
|
||||
|
||||
|
||||
<li class="wy-breadcrumbs-aside">
|
||||
|
||||
|
||||
<a href="_sources/cpl_query.extension.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">
|
||||
|
||||
<div class="section" id="cpl-query-extension">
|
||||
<h1>cpl_query.extension<a class="headerlink" href="#cpl-query-extension" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="module-cpl_query.extension.iterable_abc">
|
||||
<span id="cpl-query-extension-iterable-abc"></span><h2>cpl_query.extension.iterable_abc<a class="headerlink" href="#module-cpl_query.extension.iterable_abc" title="Permalink to this headline">¶</a></h2>
|
||||
|
||||
<section id="cpl-query-extension">
|
||||
<h1>cpl_query.extension<a class="headerlink" href="#cpl-query-extension" title="Permalink to this heading"></a></h1>
|
||||
<section id="module-cpl_query.extension.iterable_abc">
|
||||
<span id="cpl-query-extension-iterable-abc"></span><h2>cpl_query.extension.iterable_abc<a class="headerlink" href="#module-cpl_query.extension.iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable_abc.</span></code><code class="sig-name descname"><span class="pre">IterableABC</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">abc.ABC</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable_abc.</span></span><span class="sig-name descname"><span class="pre">IterableABC</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ABC</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code></p>
|
||||
<p>ABC to define functions on list</p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.all">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">all</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.all">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.all" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if every element of list equals result found by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -195,8 +107,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.any">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">any</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.any">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains result found by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -210,8 +122,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.append">
|
||||
<code class="sig-name descname"><span class="pre">append</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__object</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> → <span class="pre">None</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.append" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.append">
|
||||
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__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">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.append" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds element to list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -222,8 +134,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.average">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">average</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.average" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.average">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.average" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns average value of list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -237,8 +149,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.contains">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">contains</span></code><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="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.contains" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.contains">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.contains" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains value given by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -252,8 +164,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.count">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">count</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <span class="pre">int</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.count" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.count">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.count" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns length of list or count of found elements</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -267,8 +179,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.distinct">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">distinct</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.distinct" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.distinct">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.distinct" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns list without redundancies</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -286,8 +198,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.element_at">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">element_at</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.element_at">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -301,8 +213,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.element_at_or_default">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">element_at_or_default</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.element_at_or_default">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.element_at_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index or None</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -316,8 +228,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.extend">
|
||||
<code class="sig-name descname"><span class="pre">extend</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> → <span class="pre">None</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.extend" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.extend">
|
||||
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_IterableABC__iterable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.extend" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Adds elements of given list to list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -328,8 +240,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.first">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">first</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.first">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element</p>
|
||||
<blockquote>
|
||||
<div><p>First element of list: any</p>
|
||||
@@ -337,8 +249,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.first_or_default">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">first_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.first_or_default">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.first_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element or None</p>
|
||||
<blockquote>
|
||||
<div><p>First element of list: Optional[any]</p>
|
||||
@@ -346,8 +258,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.for_each">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">for_each</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.for_each" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.for_each">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.for_each" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Runs given function for each element of list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -358,8 +270,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.last">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">last</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.last">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element</p>
|
||||
<blockquote>
|
||||
<div><p>Last element of list: any</p>
|
||||
@@ -367,8 +279,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.last_or_default">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">last_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.last_or_default">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.last_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element or None</p>
|
||||
<blockquote>
|
||||
<div><p>Last element of list: Optional[any]</p>
|
||||
@@ -376,8 +288,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.max">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">max</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.max" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.max">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.max" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns highest value</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -391,8 +303,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.min">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">min</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.min" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.min">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.min" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns highest value</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -406,8 +318,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.order_by">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">order_by</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.order_by">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in ascending order</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -425,8 +337,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.order_by_descending">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">order_by_descending</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by_descending" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.order_by_descending">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.order_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in descending order</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -444,8 +356,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.reverse">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">reverse</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.reverse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.reverse">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.reverse" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reverses list</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
@@ -457,8 +369,8 @@
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.single">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">single</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.single">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<blockquote>
|
||||
<div><p>Found value: any</p>
|
||||
@@ -470,8 +382,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.single_or_default">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">single_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC.any" title="cpl_query.extension.iterable_abc.IterableABC.any"><span class="pre">cpl_query.extension.iterable_abc.IterableABC.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.single_or_default">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.single_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<blockquote>
|
||||
<div><p>Found value: Optional[any]</p>
|
||||
@@ -479,8 +391,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.skip">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">skip</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.skip">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements from index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -498,8 +410,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.skip_last">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">skip_last</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip_last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.skip_last">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.skip_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements after index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -517,8 +429,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.sum">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">sum</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.sum" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.sum">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.sum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sum of all values</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -532,8 +444,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.take">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.take">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements from index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -551,8 +463,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.take_last">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">take_last</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take_last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.take_last">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.take_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements after index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -570,8 +482,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.to_list">
|
||||
<code class="sig-name descname"><span class="pre">to_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">list</span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.to_list" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.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">→</span> <span class="sig-return-typehint"><span class="pre">list</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.to_list" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Converts :class: <cite>cpl_query.extension.iterable_abc.IterableABC</cite> to :class: <cite>list</cite></p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
@@ -582,14 +494,14 @@ Exception: when argument is None or found more than one element</p>
|
||||
</div></blockquote>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.type">
|
||||
<em class="property"><span class="pre">property</span> </em><code class="sig-name descname"><span class="pre">type</span></code><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.type" title="Permalink to this definition">¶</a></dt>
|
||||
<dl class="py property">
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.type">
|
||||
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">type</span></em><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.type" title="Permalink to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable_abc.IterableABC.where">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">where</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.where" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable_abc.IterableABC.where">
|
||||
<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable_abc.IterableABC.where" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Select element by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -608,16 +520,16 @@ Exception: when argument is None or found more than one element</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_query.extension.iterable">
|
||||
<span id="cpl-query-extension-iterable"></span><h2>cpl_query.extension.iterable<a class="headerlink" href="#module-cpl_query.extension.iterable" title="Permalink to this headline">¶</a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.extension.iterable">
|
||||
<span id="cpl-query-extension-iterable"></span><h2>cpl_query.extension.iterable<a class="headerlink" href="#module-cpl_query.extension.iterable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_query.extension.iterable.Iterable">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable.</span></code><code class="sig-name descname"><span class="pre">Iterable</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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><a class="headerlink" href="#cpl_query.extension.iterable.Iterable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.iterable.</span></span><span class="sig-name descname"><span class="pre">Iterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.all">
|
||||
<code class="sig-name descname"><span class="pre">all</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.all" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.all">
|
||||
<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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.all" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if every element of list equals result found by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -631,8 +543,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.any">
|
||||
<code class="sig-name descname"><span class="pre">any</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.any" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.any">
|
||||
<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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.any" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains result found by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -646,8 +558,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.average">
|
||||
<code class="sig-name descname"><span class="pre">average</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.average" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.average">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.average" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns average value of list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -661,8 +573,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.contains">
|
||||
<code class="sig-name descname"><span class="pre">contains</span></code><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="n"><span class="pre">object</span></span></em><span class="sig-paren">)</span> → <span class="pre">bool</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.contains" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.contains" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Checks if list contains value given by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -676,8 +588,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.count">
|
||||
<code class="sig-name descname"><span class="pre">count</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">int</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.count" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.count">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.count" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns length of list or count of found elements</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -691,8 +603,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.distinct">
|
||||
<code class="sig-name descname"><span class="pre">distinct</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.distinct" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.distinct">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.distinct" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns list without redundancies</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -710,8 +622,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.element_at">
|
||||
<code class="sig-name descname"><span class="pre">element_at</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -725,8 +637,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.element_at_or_default">
|
||||
<code class="sig-name descname"><span class="pre">element_at_or_default</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.element_at_or_default">
|
||||
<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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.element_at_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns element at given index or None</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -740,8 +652,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.first">
|
||||
<code class="sig-name descname"><span class="pre">first</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element</p>
|
||||
<blockquote>
|
||||
<div><p>First element of list: any</p>
|
||||
@@ -749,8 +661,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.first_or_default">
|
||||
<code class="sig-name descname"><span class="pre">first_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.first_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns first element or None</p>
|
||||
<blockquote>
|
||||
<div><p>First element of list: Optional[any]</p>
|
||||
@@ -758,8 +670,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.for_each">
|
||||
<code class="sig-name descname"><span class="pre">for_each</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.for_each" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.for_each">
|
||||
<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></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.for_each" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Runs given function for each element of list</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -770,8 +682,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.last">
|
||||
<code class="sig-name descname"><span class="pre">last</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element</p>
|
||||
<blockquote>
|
||||
<div><p>Last element of list: any</p>
|
||||
@@ -779,8 +691,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.last_or_default">
|
||||
<code class="sig-name descname"><span class="pre">last_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.last_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns last element or None</p>
|
||||
<blockquote>
|
||||
<div><p>Last element of list: Optional[any]</p>
|
||||
@@ -788,8 +700,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.max">
|
||||
<code class="sig-name descname"><span class="pre">max</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.max" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.max">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.max" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns highest value</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -803,8 +715,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.min">
|
||||
<code class="sig-name descname"><span class="pre">min</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.min" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.min">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.min" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns highest value</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -818,8 +730,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.order_by">
|
||||
<code class="sig-name descname"><span class="pre">order_by</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.order_by">
|
||||
<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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in ascending order</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -837,8 +749,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.order_by_descending">
|
||||
<code class="sig-name descname"><span class="pre">order_by_descending</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by_descending" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.order_by_descending">
|
||||
<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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.order_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts elements by function in descending order</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -856,8 +768,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.reverse">
|
||||
<code class="sig-name descname"><span class="pre">reverse</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.reverse" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.reverse" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Reverses list</p>
|
||||
<blockquote>
|
||||
<div><dl class="field-list simple">
|
||||
@@ -869,8 +781,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.single">
|
||||
<code class="sig-name descname"><span class="pre">single</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><span class="pre">any</span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<blockquote>
|
||||
<div><p>Found value: any</p>
|
||||
@@ -882,8 +794,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.single_or_default">
|
||||
<code class="sig-name descname"><span class="pre">single_or_default</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span> → <span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#cpl_query.extension.iterable.Iterable.any" title="cpl_query.extension.iterable.Iterable.any"><span class="pre">cpl_query.extension.iterable.Iterable.any</span></a><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single_or_default" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.single_or_default">
|
||||
<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">→</span> <span class="sig-return-typehint"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.single_or_default" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Returns one single element of list</p>
|
||||
<blockquote>
|
||||
<div><p>Found value: Optional[any]</p>
|
||||
@@ -891,8 +803,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.skip">
|
||||
<code class="sig-name descname"><span class="pre">skip</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements from index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -910,8 +822,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.skip_last">
|
||||
<code class="sig-name descname"><span class="pre">skip_last</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip_last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.skip_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Skips all elements after index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -929,8 +841,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.sum">
|
||||
<code class="sig-name descname"><span class="pre">sum</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></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="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span> </span><span class="pre">float</span><span class="p"><span class="pre">,</span> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.sum" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.sum">
|
||||
<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">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">complex</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.sum" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sum of all values</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -944,8 +856,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.take">
|
||||
<code class="sig-name descname"><span class="pre">take</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements from index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -963,8 +875,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.take_last">
|
||||
<code class="sig-name descname"><span class="pre">take_last</span></code><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="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take_last" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.take_last" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Takes all elements after index</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -982,8 +894,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.iterable.Iterable.where">
|
||||
<code class="sig-name descname"><span class="pre">where</span></code><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="n"><span class="pre">Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></a><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.where" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.iterable.Iterable.where">
|
||||
<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></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><span class="pre">IterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.iterable.Iterable.where" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Select element by function</p>
|
||||
<blockquote>
|
||||
<div><dl class="simple">
|
||||
@@ -1002,26 +914,26 @@ Exception: when argument is None or found more than one element</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_query.extension.list">
|
||||
<span id="cpl-query-extension-list"></span><h2>cpl_query.extension.list<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this headline">¶</a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.extension.list">
|
||||
<span id="cpl-query-extension-list"></span><h2>cpl_query.extension.list<a class="headerlink" href="#module-cpl_query.extension.list" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_query.extension.list.List">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></code><code class="sig-name descname"><span class="pre">List</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></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><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.iterable.Iterable</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.list.List">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.list.</span></span><span class="sig-name descname"><span class="pre">List</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.list.List" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl_query.extension.iterable.Iterable</cite></p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_query.extension.ordered_iterable_abc">
|
||||
<span id="cpl-query-extension-ordered-iterable-abc"></span><h2>cpl_query.extension.ordered_iterable_abc<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable_abc" title="Permalink to this headline">¶</a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.extension.ordered_iterable_abc">
|
||||
<span id="cpl-query-extension-ordered-iterable-abc"></span><h2>cpl_query.extension.ordered_iterable_abc<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable_abc" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable_abc.</span></code><code class="sig-name descname"><span class="pre">OrderedIterableABC</span></code><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="n"><span class="pre">type</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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">collections.abc.Callable</span><span class="p"><span class="pre">]</span></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><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.iterable_abc.IterableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable_abc.</span></span><span class="sig-name descname"><span class="pre">OrderedIterableABC</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">_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">Callable</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable_abc.IterableABC" title="cpl_query.extension.iterable_abc.IterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">IterableABC</span></code></a></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">then_by</span></code><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="n"><span class="pre">collections.abc.Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||
<blockquote>
|
||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
@@ -1032,8 +944,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by_descending">
|
||||
<em class="property"><span class="pre">abstract</span> </em><code class="sig-name descname"><span class="pre">then_by_descending</span></code><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="n"><span class="pre">collections.abc.Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by_descending" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||
<blockquote>
|
||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
@@ -1045,17 +957,17 @@ Exception: when argument is None or found more than one element</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="module-cpl_query.extension.ordered_iterable">
|
||||
<span id="cpl-query-extension-ordered-iterable"></span><h2>cpl_query.extension.ordered_iterable<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable" title="Permalink to this headline">¶</a></h2>
|
||||
</section>
|
||||
<section id="module-cpl_query.extension.ordered_iterable">
|
||||
<span id="cpl-query-extension-ordered-iterable"></span><h2>cpl_query.extension.ordered_iterable<a class="headerlink" href="#module-cpl_query.extension.ordered_iterable" title="Permalink to this heading"></a></h2>
|
||||
<dl class="py class">
|
||||
<dt id="cpl_query.extension.ordered_iterable.OrderedIterable">
|
||||
<em class="property"><span class="pre">class</span> </em><code class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable.</span></code><code class="sig-name descname"><span class="pre">OrderedIterable</span></code><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="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span> <span class="o"><span class="pre">=</span></span> <span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.iterable.Iterable</span></code></a>, <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></code></a></p>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">cpl_query.extension.ordered_iterable.</span></span><span class="sig-name descname"><span class="pre">OrderedIterable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_t</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">type</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="#cpl_query.extension.iterable.Iterable" title="cpl_query.extension.iterable.Iterable"><code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code></a>, <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><code class="xref py py-class docutils literal notranslate"><span class="pre">OrderedIterableABC</span></code></a></p>
|
||||
<p>Implementation of :class: <cite>cpl_query.extension.Iterable</cite> <cite>cpl_query.extension.OrderedIterableABC</cite></p>
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.ordered_iterable.OrderedIterable.then_by">
|
||||
<code class="sig-name descname"><span class="pre">then_by</span></code><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="n"><span class="pre">collections.abc.Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in ascending order by function</p>
|
||||
<blockquote>
|
||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
@@ -1066,8 +978,8 @@ Exception: when argument is None or found more than one element</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="cpl_query.extension.ordered_iterable.OrderedIterable.then_by_descending">
|
||||
<code class="sig-name descname"><span class="pre">then_by_descending</span></code><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="n"><span class="pre">collections.abc.Callable</span></span></em><span class="sig-paren">)</span> → <a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">cpl_query.extension.ordered_iterable_abc.OrderedIterableABC</span></a><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by_descending" title="Permalink to this definition">¶</a></dt>
|
||||
<dt class="sig sig-object py" id="cpl_query.extension.ordered_iterable.OrderedIterable.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">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#cpl_query.extension.ordered_iterable_abc.OrderedIterableABC" title="cpl_query.extension.ordered_iterable_abc.OrderedIterableABC"><span class="pre">OrderedIterableABC</span></a></span></span><a class="headerlink" href="#cpl_query.extension.ordered_iterable.OrderedIterable.then_by_descending" title="Permalink to this definition"></a></dt>
|
||||
<dd><p>Sorts OrderedList in descending order by function</p>
|
||||
<blockquote>
|
||||
<div><p>func: <code class="xref py py-class docutils literal notranslate"><span class="pre">Callable</span></code></p>
|
||||
@@ -1079,55 +991,38 @@ Exception: when argument is None or found more than one element</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<footer>
|
||||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||||
<a href="cpl_query.exceptions.html" class="btn btn-neutral float-right" title="cpl_query.exceptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
<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>
|
||||
<a href="cpl_query.exceptions.html" class="btn btn-neutral float-right" title="cpl_query.exceptions" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||||
</div>
|
||||
|
||||
<hr/>
|
||||
|
||||
<div role="contentinfo">
|
||||
<p>
|
||||
© Copyright 2021, Sven Heidemann.
|
||||
|
||||
</p>
|
||||
<p>© Copyright 2021, Sven Heidemann.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||||
|
||||
|
||||
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>.
|
||||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||||
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</section>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
<script>
|
||||
jQuery(function () {
|
||||
SphinxRtdTheme.Navigation.enable(true);
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
Reference in New Issue
Block a user