Deployed 5a5173a with MkDocs version: 1.5.3

nekitdev · Dec 1, 2023 · 6d379b8 · 6d379b8
1 parent dcec02e
commit 6d379b8
Show file tree

Hide file tree

Showing 7 changed files with 126 additions and 41 deletions.
diff --git a/changelog/index.html b/changelog/index.html
@@ -542,6 +542,39 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#0150-2023-12-01" class="md-nav__link">
+    <span class="md-ellipsis">
+      0.15.0 (2023-12-01)
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="0.15.0 (2023-12-01)">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#changes" class="md-nav__link">
+    <span class="md-ellipsis">
+      Changes
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#internal" class="md-nav__link">
+    <span class="md-ellipsis">
+      Internal
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#0141-2023-12-01" class="md-nav__link">
     <span class="md-ellipsis">
@@ -562,7 +595,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal" class="md-nav__link">
+  <a href="#internal_1" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -610,7 +643,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_1" class="md-nav__link">
+  <a href="#internal_2" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -634,7 +667,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes" class="md-nav__link">
+  <a href="#changes_1" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -658,7 +691,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_2" class="md-nav__link">
+  <a href="#internal_3" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -682,7 +715,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_3" class="md-nav__link">
+  <a href="#internal_4" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -778,7 +811,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_4" class="md-nav__link">
+  <a href="#internal_5" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -802,7 +835,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_1" class="md-nav__link">
+  <a href="#changes_2" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -826,7 +859,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_2" class="md-nav__link">
+  <a href="#changes_3" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -850,7 +883,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_3" class="md-nav__link">
+  <a href="#changes_4" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -874,7 +907,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_4" class="md-nav__link">
+  <a href="#changes_5" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -987,6 +1020,39 @@
     </label>
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#0150-2023-12-01" class="md-nav__link">
+    <span class="md-ellipsis">
+      0.15.0 (2023-12-01)
+    </span>
+  </a>
+
+    <nav class="md-nav" aria-label="0.15.0 (2023-12-01)">
+      <ul class="md-nav__list">
+
+          <li class="md-nav__item">
+  <a href="#changes" class="md-nav__link">
+    <span class="md-ellipsis">
+      Changes
+    </span>
+  </a>
+
+</li>
+
+          <li class="md-nav__item">
+  <a href="#internal" class="md-nav__link">
+    <span class="md-ellipsis">
+      Internal
+    </span>
+  </a>
+
+</li>
+
+      </ul>
+    </nav>
+
+</li>
+
         <li class="md-nav__item">
   <a href="#0141-2023-12-01" class="md-nav__link">
     <span class="md-ellipsis">
@@ -1007,7 +1073,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal" class="md-nav__link">
+  <a href="#internal_1" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -1055,7 +1121,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_1" class="md-nav__link">
+  <a href="#internal_2" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -1079,7 +1145,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes" class="md-nav__link">
+  <a href="#changes_1" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -1103,7 +1169,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_2" class="md-nav__link">
+  <a href="#internal_3" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -1127,7 +1193,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_3" class="md-nav__link">
+  <a href="#internal_4" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -1223,7 +1289,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#internal_4" class="md-nav__link">
+  <a href="#internal_5" class="md-nav__link">
     <span class="md-ellipsis">
       Internal
     </span>
@@ -1247,7 +1313,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_1" class="md-nav__link">
+  <a href="#changes_2" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -1271,7 +1337,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_2" class="md-nav__link">
+  <a href="#changes_3" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -1295,7 +1361,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_3" class="md-nav__link">
+  <a href="#changes_4" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -1319,7 +1385,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#changes_4" class="md-nav__link">
+  <a href="#changes_5" class="md-nav__link">
     <span class="md-ellipsis">
       Changes
     </span>
@@ -1362,10 +1428,21 @@
 <h1 id="changelog">Changelog</h1>
 <!-- changelogging: start -->
 
+<h2 id="0150-2023-12-01">0.15.0 (2023-12-01)</h2>
+<h3 id="changes">Changes</h3>
+<ul>
+<li>Changed <code>reduce</code> and <code>reduce_await</code> on <code>Iter[T]</code> and <code>AsyncIter[T]</code> to return <code>Option[T]</code>
+  instead of erroring on empty iterators.</li>
+</ul>
+<h3 id="internal">Internal</h3>
+<ul>
+<li>Changed <code>variable is marker</code> and <code>variable is no_default</code>
+  to <code>is_marker(variable)</code> and <code>is_no_default(variable)</code> respectively.</li>
+</ul>
 <h2 id="0141-2023-12-01">0.14.1 (2023-12-01)</h2>
 <p>No significant changes.</p>
 <h2 id="0140-2023-12-01">0.14.0 (2023-12-01)</h2>
-<h3 id="internal">Internal</h3>
+<h3 id="internal_1">Internal</h3>
 <ul>
 <li>Migrated to Python 3.8.</li>
 </ul>
@@ -1375,22 +1452,22 @@ <h3 id="fixes">Fixes</h3>
 <li>Fixed <code>final</code> import to be compatible with Python 3.7.</li>
 </ul>
 <h2 id="0130-2023-05-21">0.13.0 (2023-05-21)</h2>
-<h3 id="internal_1">Internal</h3>
+<h3 id="internal_2">Internal</h3>
 <ul>
 <li>Migrated to using <code>typing-aliases</code> library.</li>
 </ul>
 <h2 id="0120-2023-05-10">0.12.0 (2023-05-10)</h2>
-<h3 id="changes">Changes</h3>
+<h3 id="changes_1">Changes</h3>
 <ul>
 <li>This release contains lots of breaking changes. Please refer to the API documentation.</li>
 </ul>
 <h2 id="0110-2023-01-29">0.11.0 (2023-01-29)</h2>
-<h3 id="internal_2">Internal</h3>
+<h3 id="internal_3">Internal</h3>
 <ul>
 <li><code>async-extensions</code> is now used instead of reimplementing <code>collect_iterable</code> functionality.</li>
 </ul>
 <h2 id="0100-2023-01-08">0.10.0 (2023-01-08)</h2>
-<h3 id="internal_3">Internal</h3>
+<h3 id="internal_4">Internal</h3>
 <ul>
 <li>Marked the internals of the <code>OrderedSet[Q]</code> private.</li>
 </ul>
@@ -1412,14 +1489,14 @@ <h3 id="features_2">Features</h3>
 <li>Added <code>ordered_set</code> method to <code>Iter[T]</code> and <code>AsyncIter[T]</code>.</li>
 </ul>
 <h2 id="060-2022-11-08">0.6.0 (2022-11-08)</h2>
-<h3 id="internal_4">Internal</h3>
+<h3 id="internal_5">Internal</h3>
 <ul>
 <li>Migrated to using <a href="https://github.com/nekitdev/named"><code>named</code></a> and
   <a href="https://github.com/nekitdev/solus"><code>solus</code></a> packages instead of
   reimplementing their functionality. (<a href="https://github.com/nekitdev/iters/pull/18">#18</a>)</li>
 </ul>
 <h2 id="050-2022-10-11">0.5.0 (2022-10-11)</h2>
-<h3 id="changes_1">Changes</h3>
+<h3 id="changes_2">Changes</h3>
 <ul>
 <li>Functions taking <code>Predicate[T]</code> have been updated to accept <code>Optional[Predicate[T]]</code>.
   Passing <code>None</code> as an argument is identical to passing <code>bool</code>.</li>
@@ -1430,21 +1507,21 @@ <h3 id="changes_1">Changes</h3>
   - <code>take_while</code></p>
 <p>This choice is motivated by the fact that it does not make much sense to <code>do_while(None)</code>.</p>
 <h2 id="040-2022-10-08">0.4.0 (2022-10-08)</h2>
-<h3 id="changes_2">Changes</h3>
+<h3 id="changes_3">Changes</h3>
 <ul>
 <li>The following functions have been changed:</li>
 <li><code>async_iter</code> is now an alias of <code>AsyncIter</code>;</li>
 <li><code>iter</code> is now an alias of <code>Iter</code>;</li>
 <li><code>reversed</code> is now an alias of <code>iter.reversed</code>.</li>
 </ul>
 <h2 id="030-2022-08-17">0.3.0 (2022-08-17)</h2>
-<h3 id="changes_3">Changes</h3>
+<h3 id="changes_4">Changes</h3>
 <ul>
 <li>Changed functions of various arity returning <code>Awaitable[T]</code> to async functions returning <code>T</code>.
   (<a href="https://github.com/nekitdev/iters/pull/15">#15</a>)</li>
 </ul>
 <h2 id="020-2022-08-15">0.2.0 (2022-08-15)</h2>
-<h3 id="changes_4">Changes</h3>
+<h3 id="changes_5">Changes</h3>
 <ul>
 <li>Added <code>await async_iter</code>, equivalent to <code>await async_iter.list()</code>.</li>
 </ul>

diff --git a/index.html b/index.html
@@ -921,7 +921,7 @@ <h3 id="poetry">poetry</h3>
 </code></pre></div>
 <p>Or by directly specifying it in the configuration like so:</p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.poetry.dependencies]</span>
-<span class="n">iters</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;^0.14.1&quot;</span>
+<span class="n">iters</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;^0.15.0&quot;</span>
 </code></pre></div>
 <p>Alternatively, you can add it directly from the source:</p>
 <div class="highlight"><pre><span></span><code><span class="k">[tool.poetry.dependencies.iters]</span>

diff --git a/objects.inv b/objects.inv
diff --git a/reference/async_iters/index.html b/reference/async_iters/index.html
@@ -3111,7 +3111,11 @@ <h2 id="iters.async_iters.AsyncIter" class="doc doc-heading">
 <span class="normal">2700</span>
 <span class="normal">2701</span>
 <span class="normal">2702</span>
-<span class="normal">2703</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">AsyncIter</span><span class="p">(</span><span class="n">AsyncIterator</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
+<span class="normal">2703</span>
+<span class="normal">2704</span>
+<span class="normal">2705</span>
+<span class="normal">2706</span>
+<span class="normal">2707</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">AsyncIter</span><span class="p">(</span><span class="n">AsyncIterator</span><span class="p">[</span><span class="n">T</span><span class="p">]):</span>
     <span class="c1"># internals</span>
 
     <span class="n">_iterator</span><span class="p">:</span> <span class="n">AsyncIterator</span><span class="p">[</span><span class="n">T</span><span class="p">]</span>
@@ -4050,13 +4054,17 @@ <h2 id="iters.async_iters.AsyncIter" class="doc doc-heading">
     <span class="k">async</span> <span class="k">def</span> <span class="nf">contains_identity</span><span class="p">(</span><span class="bp">self</span><span class="p">:</span> <span class="n">AsyncIter</span><span class="p">[</span><span class="n">V</span><span class="p">],</span> <span class="n">item</span><span class="p">:</span> <span class="n">V</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
         <span class="k">return</span> <span class="k">await</span> <span class="n">async_contains_identity</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterator</span><span class="p">)</span>
 
-    <span class="nd">@wrap_future</span>
-    <span class="k">async</span> <span class="k">def</span> <span class="nf">reduce</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">Binary</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
-        <span class="k">return</span> <span class="k">await</span> <span class="n">async_reduce</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterator</span><span class="p">)</span>
+    <span class="nd">@wrap_future_option</span>
+    <span class="k">async</span> <span class="k">def</span> <span class="nf">reduce</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">Binary</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Option</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span>
+        <span class="k">return</span> <span class="n">wrap_marked</span><span class="p">(</span>
+            <span class="k">await</span> <span class="n">async_reduce</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterator</span><span class="p">,</span> <span class="n">marker</span><span class="p">)</span>  <span class="c1"># type: ignore  # weird</span>
+        <span class="p">)</span>
 
-    <span class="nd">@wrap_future</span>
-    <span class="k">async</span> <span class="k">def</span> <span class="nf">reduce_await</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">AsyncBinary</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
-        <span class="k">return</span> <span class="k">await</span> <span class="n">async_reduce_await</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterator</span><span class="p">)</span>
+    <span class="nd">@wrap_future_option</span>
+    <span class="k">async</span> <span class="k">def</span> <span class="nf">reduce_await</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">AsyncBinary</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">T</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Option</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span>
+        <span class="k">return</span> <span class="n">wrap_marked</span><span class="p">(</span>
+            <span class="k">await</span> <span class="n">async_reduce_await</span><span class="p">(</span><span class="n">function</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">iterator</span><span class="p">,</span> <span class="n">marker</span><span class="p">)</span>  <span class="c1"># type: ignore  # weird</span>
+        <span class="p">)</span>
 
     <span class="nd">@wrap_future</span>
     <span class="k">async</span> <span class="k">def</span> <span class="nf">fold</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial</span><span class="p">:</span> <span class="n">V</span><span class="p">,</span> <span class="n">function</span><span class="p">:</span> <span class="n">Binary</span><span class="p">[</span><span class="n">V</span><span class="p">,</span> <span class="n">T</span><span class="p">,</span> <span class="n">V</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">V</span><span class="p">:</span>