pythonic-fp.iterables 5.1.1__tar.gz → 5.1.3__tar.gz

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/CHANGELOG.rst

@@ -17,20 +17,25 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-5.1.0 - 2025-08-02
-~~~~~~~~~~~~~~~~~~
+PyPI 5.1.1 - 2025-08-02
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Only docstring changes.
+
+PyPI 5.1.0 - 2025-08-02
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - changed singletons -> sentinels
 - Removed "from __future__ import annotations"
 - Added .pyi files
 
-5.0.0 - 2025-08-02
-~~~~~~~~~~~~~~~~~~
+PyPI 5.0.0 - 2025-08-02
+~~~~~~~~~~~~~~~~~~~~~~~
 
 General consistency tweaks and fixes across all pythonic-fp projects.
 
-4.0.0 - 2025-07-16
-~~~~~~~~~~~~~~~~~~
+PyPI 4.0.0 - 2025-07-16
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Primary purpose was to bring Sphinx documentation in alignment
 with other pythonic-fp projects. Ended up making substantial
@@ -41,15 +46,15 @@ for the other pythonic-fp projects.
 
   - renamed pythonic_fp.iterables.foldl to pythonic_fp.iterables.fold_left
 
-3.0.0 - 2025-07-06
-~~~~~~~~~~~~~~~~~~
+PyPI 3.0.0 - 2025-07-06
+~~~~~~~~~~~~~~~~~~~~~~~
 
 First PyPI release as ``pythonic-fp.iterables``
 
 - dropping dtools namespace name because there is a repo by that name.
 
-2.0.0 - 2025-05-22
-~~~~~~~~~~~~~~~~~~
+PyPI 2.0.0 - 2025-05-22
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - Moved dtools.fp.iterables to its own PyPI project
 
@@ -63,8 +68,8 @@ First PyPI release as ``pythonic-fp.iterables``
 
     - will import dtools.fp.lazy directly for this functionality
 
-1.7.0 - 2025-04-22
-~~~~~~~~~~~~~~~~~~
+PyPI 1.7.0 - 2025-04-22
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Last PyPI release as dtools.fp
 
@@ -73,21 +78,21 @@ Last PyPI release as dtools.fp
 - docstring changes
 - pyproject.toml standardization
 
-1.6.0 - 2025-04-07
-~~~~~~~~~~~~~~~~~~
+PyPI 1.6.0 - 2025-04-07
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - typing improvements
 
-1.4.0 - 2025-03-16
-~~~~~~~~~~~~~~~~~~
+PyPI 1.4.0 - 2025-03-16
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - much work dtools.iterables
 
   - finally implemented scReduceL and scReduceR functions
   - tweaked API across iterables module
 
-1.3.0 - 2025-01-17
-~~~~~~~~~~~~~~~~~~
+PyPI 1.3.0 - 2025-01-17
+~~~~~~~~~~~~~~~~~~~~~~~
 
 First release as dtools.fp
 
@@ -96,85 +101,73 @@ Repo name changes.
 - GitHub: fp -> dtools-fp
 - PyPI: grscheller.fp -> dtools.fp
 
-1.0.1 - 2024-10-20
-~~~~~~~~~~~~~~~~~~
+PyPI 1.0.1 - 2024-10-20
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - removed docs from repo
 - docs for all grscheller namespace projects maintained here
  
   - https://grscheller.github.io/grscheller-pypi-namespace-docs/
 
-1.0.0 - 2024-10-18
-~~~~~~~~~~~~~~~~~~
+PyPI 1.0.0 - 2024-10-18
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Decided to make this release first stable release.
 
 - renamed module fp.woException to fp.err_handling
 - pytest improvements based on pytest documentation
 
-0.4.0 - 2024-10-03
-~~~~~~~~~~~~~~~~~~
+PyPI 0.4.0 - 2024-10-03
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Long overdue PyPI release.
 
-0.3.4.0 - 2024-09-30
-~~~~~~~~~~~~~~~~~~~~
-
-Development environment only.
-
-- API change for fp.iterables
-
-  - function name changes
-
-    - ``foldL``, ``foldR``, ``foldLsc``, ``foldRsc``
-    - ``sc`` stands for "short circuit"
-
-  - all now return class woException.MB
-
-0.3.3.7 - 2024-09-22
-~~~~~~~~~~~~~~~~~~~~
+Version 0.3.4.0 - 2024-09-30 (Devel environment only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Development environment only.
+API change for fp.iterables.
 
-- added more functions to fp.iterables module
+- function name changes
 
-  - take(it: Iterable[D], n: int) -> Iterator[D]
-  - takeWhile(it: Iterable[D], pred: Callable\[[D], bool\]) -> Iterator[D]
-  - drop(it: Iterable[D], n: int) -> Iterator[D]
-  - dropWhile(it: Iterable[D], pred: Callable\[[D], bool\]) -> Iterator[D]
+  - ``foldL``, ``foldR``, ``foldLsc``, ``foldRsc``
+  - ``sc`` stands for "short circuit"
 
-0.3.3.4 - 2024-09-16
-~~~~~~~~~~~~~~~~~~~~
+- all now return class woException.MB
 
-Development environment only.
+Version 0.3.3.7 - 2024-09-22 (Devel environment only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- fp.iterables ``foldL_sc`` & ``foldR_sc`` now have
+Added more functions to fp.iterables module.
 
-  - common paradigm
-  - similar signatures
+- take(it: Iterable[D], n: int) -> Iterator[D]
+- takeWhile(it: Iterable[D], pred: Callable\[[D], bool\]) -> Iterator[D]
+- drop(it: Iterable[D], n: int) -> Iterator[D]
+- dropWhile(it: Iterable[D], pred: Callable\[[D], bool\]) -> Iterator[D]
 
-0.3.3.3 - 2024-09-15
-~~~~~~~~~~~~~~~~~~~~
+Version 0.3.3.4 - 2024-09-16 (Devel environment only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Development environment only.
+Both ``foldL_sc`` and ``foldR_sc`` now have a common paradigm
+and similar signatures.
 
-- added fp.iterables function ``foldR_sc``
+Version 0.3.3.3 - 2024-09-15 (Devel environment only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  - shortcut version of ``foldR``
-  - not fully tested
-  - docstring not updated
+Added fp.iterables function ``foldR_sc``
 
-0.3.3.2 - 2024-09-14
-~~~~~~~~~~~~~~~~~~~~
+- shortcut version of ``foldR``
+- not fully tested
+- docstring not updated
 
-Development environment only.
+Version 0.3.3.2 - 2024-09-14 (Devel environment only)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- added fp.iterables function ``foldL_sc``
+Added ``foldL_sc``, shortcut version of foldL, 
+to fp.iterables.
 
-  - shortcut version of foldL
 
-0.3.1 - 2024-08-20
-~~~~~~~~~~~~~~~~~~
+PyPI 0.3.1 - 2024-08-20
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Now fp.iterables no longer exports ``CONCAT``, ``MERGE``, ``EXHAUST``.
 
@@ -183,8 +176,8 @@ Now fp.iterables no longer exports ``CONCAT``, ``MERGE``, ``EXHAUST``.
   - grscheller.datastructures.ftuple
   - grscheller.datastructures.split_ends
 
-0.2.0 - 2024-07-26
-~~~~~~~~~~~~~~~~~~
+PyPI 0.2.0 - 2024-07-26
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - from last PyPI release
 
@@ -192,8 +185,8 @@ Now fp.iterables no longer exports ``CONCAT``, ``MERGE``, ``EXHAUST``.
 
 - overall much better docstrings
 
-0.1.0 - 2024-07-11
-~~~~~~~~~~~~~~~~~~
+PyPI 0.1.0 - 2024-07-11
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Initial PyPI release as grscheller.fp
 

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.1.1
-Summary: Library of functions for iterating iterables
+Version: 5.1.3
+Summary: Tools for iterables
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
@@ -14,13 +14,12 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-fptools>=5.1.1
-Requires-Dist: pythonic-fp-gadgets>=3.0.1
-Requires-Dist: pythonic-fp-sentinels>=2.1.0
+Requires-Dist: pythonic-fp-fptools>=5.2.0
+Requires-Dist: pythonic-fp-gadgets>=4.0.2
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/iterables/development/build/html/releases.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/iterables/development/build/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-iterables
 Provides-Extra: test
 
@@ -43,15 +42,17 @@ Library of functions for iterating iterables.
     - all iterators are assumed to be iterable
     - for all iterators ``foo`` we assume ``iter(foo) is foo``
 
-This PyPI project is part of of the
-`pythonic-fp namespace projects <https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp>`_
+PyPI projects.
 
 Documentation
 -------------
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/iterables>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/README.rst

@@ -17,15 +17,17 @@ Library of functions for iterating iterables.
     - all iterators are assumed to be iterable
     - for all iterators ``foo`` we assume ``iter(foo) is foo``
 
-This PyPI project is part of of the
-`pythonic-fp namespace projects <https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp>`_
+PyPI projects.
 
 Documentation
 -------------
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/iterables>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-iterables"
-version = "5.1.1"
+version = "5.1.3"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -16,16 +16,15 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-fptools>=5.1.1",
-  "pythonic-fp-gadgets>=3.0.1",
-  "pythonic-fp-sentinels>=2.1.0",
+  "pythonic-fp-fptools>=5.2.0",
+  "pythonic-fp-gadgets>=4.0.2",
 ]
 dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/iterables/development/build/html/releases.html"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Documentation = "https://grscheller.github.io/pythonic-fp/iterables/development/build/html/"
+Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
 Source = "https://github.com/grscheller/pythonic-fp-iterables"
 
 [project.optional-dependencies]

pythonic_fp_iterables-5.1.3/src/pythonic_fp/iterables/__init__.py

@@ -0,0 +1,45 @@
+# Copyright 2023-2026 Geoffrey R. Scheller
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Tools for iterables
+-------------------
+
+.. admonition:: Library of functions for iterating iterables
+
+    +-----------+-------------------------------------------+
+    | Module    | Description                               |
+    +===========+===========================================+
+    | merging   | Concatenating and merging iterables       |
+    +-----------+-------------------------------------------+
+    | drop_take | Dropping and taking values from iterables |
+    +-----------+-------------------------------------------+
+    | folding   | Reducing and accumulating iterables       |
+    +-----------+-------------------------------------------+
+
+.. important::
+
+    **Assumptions:**
+
+    - iterables are not necessarily iterators
+    - at all times iterator protocol is assumed to be followed
+
+    - all iterators are assumed to be iterable
+    - for all iterators ``foobar`` we assume ``iter(foobar) is foobar``
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/drop_take.py

@@ -13,7 +13,13 @@
 # limitations under the License.
 
 """
-Module pythonic_fp.iterables.drop_take
+Drop and Take
+-------------
+
+.. admonition:: module pythonic_fp.iterables.drop_take
+
+    Functions to drop or take values from an iterable.
+
 """
 
 from collections.abc import Callable, Iterable, Iterator
@@ -30,15 +36,12 @@ __all__ = [
 ]
 
 
-## dropping and taking
-
-
 def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]:
     """Drop the next n values from iterable.
 
-    :param iterable: iterable whose values are to be dropped
-    :param n: number of values to be dropped
-    :returns: an iterator of the remaining values
+    :param iterable: Iterable whose values are to be dropped.
+    :param n: Number of values to be dropped.
+    :returns: An iterator of the remaining values.
 
     """
     iterator = iter(iterable)
@@ -53,9 +56,9 @@ def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]:
 def drop_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]:
     """Drop initial values from iterable while predicate is true.
 
-    :param iterable: iterable whose values are to be dropped
-    :param pred: Boolean valued function, the "predicate"
-    :return: an iterator beginning where pred returned false
+    :param iterable: Iterable whose values are to be dropped.
+    :param pred: Single argument Boolean valued function, the "predicate".
+    :returns: An iterator beginning where pred returned false.
 
     """
     iterator = iter(iterable)
@@ -73,9 +76,9 @@ def drop_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[
 def take[D](iterable: Iterable[D], n: int) -> Iterator[D]:
     """Return an iterator of up to n initial values of an iterable.
 
-    :param iterable: iterable providing the values to be taken
-    :param n: number of values to be dropped
-    :return: an iterator of up to n initial values from iterable
+    :param Iterable: iterable providing the values to be taken.
+    :param n: Number of values to be dropped.
+    :returns: An iterator of up to n initial values from iterable.
 
     """
     iterator = iter(iterable)
@@ -91,11 +94,12 @@ def take_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[
     """Yield values from iterable while predicate is true.
 
     .. warning::
+
         Risk of value loss if iterable is multiple referenced iterator.
 
-    :param iterable: iterable providing the values to be taken
-    :param pred: Boolean valued function, the "predicate"
-    :return: an Iterator of of values from iterable until predicate false
+    :param iterable: Iterable providing the values to be taken.
+    :param pred: Single argument Boolean valued function, the "predicate".
+    :returns: An Iterator of of values from iterable until predicate false.
 
     """
     iterator = iter(iterable)
@@ -115,12 +119,12 @@ def take_split[D](iterable: Iterable[D], n: int) -> tuple[Iterator[D], Iterator[
 
     .. Warning::
 
-       **CONTRACT:** Do not access the second returned iterator until the
-       first one is exhausted.
+        **CONTRACT:** Do not access the second returned iterator until the
+        first one is exhausted.
 
-    :param iterable: iterable providing the values to be taken
-    :param n: maximum number of values to be taken
-    :return: an iterator of values taken and an iterator of remaining values
+    :param iterable: Iterable providing the values to be taken.
+    :param n: maximum Number of values to be taken.
+    :returns: An iterator of values taken and an iterator of remaining values.
 
     """
     iterator = iter(iterable)
@@ -136,12 +140,12 @@ def take_while_split[D](
 
     .. Warning::
 
-       **CONTRACT:** Do not access the second returned iterator until
-       the first one is exhausted.
+        **CONTRACT:** Do not access the second returned iterator until
+        the first one is exhausted.
 
-    :param iterable: iterable providing the values to be taken
-    :param pred: Boolean valued function
-    :return: tuple containing an iterator of values taken and an iterator of remaining values
+    :param iterable: Iterable providing the values to be taken.
+    :param pred: Single argument Boolean valued function.
+    :returns: Tuple of iterator of values taken and an iterator of remaining values.
 
     """
 
@@ -162,4 +166,4 @@ def take_while_split[D](
     value: Box[D] = Box()
     it_pred = _take_while(iterator, pred, value)
 
-    return (it_pred, concat(value, iterator))
+    return it_pred, concat(value, iterator)

pythonic_fp_iterables-5.1.3/src/pythonic_fp/iterables/drop_take.pyi

@@ -0,0 +1,10 @@
+from collections.abc import Callable, Iterable, Iterator
+
+__all__ = ['drop', 'drop_while', 'take', 'take_while', 'take_split', 'take_while_split']
+
+def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]: ...
+def drop_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]: ...
+def take[D](iterable: Iterable[D], n: int) -> Iterator[D]: ...
+def take_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]: ...
+def take_split[D](iterable: Iterable[D], n: int) -> tuple[Iterator[D], Iterator[D]]: ...
+def take_while_split[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> tuple[Iterator[D], Iterator[D]]: ...

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/folding.py

@@ -12,13 +12,21 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module pythonic_fp.iterables.folding"""
+"""
+Folding
+-------
+
+.. admonition:: module pythonic_fp.iterables.folding
+
+    Functions to reduce and accumulate values from iterables.
+
+"""
 
 from collections.abc import Callable, Iterable, Iterator
 from typing import cast, Never
 from pythonic_fp.fptools.function import negate, swap
 from pythonic_fp.fptools.maybe import MayBe
-from pythonic_fp.sentinels.novalue import NoValue
+from pythonic_fp.gadgets.sentinels.novalue import NoValue
 from .drop_take import drop_while, take_while_split
 
 __all__ = [

pythonic_fp_iterables-5.1.3/src/pythonic_fp/iterables/folding.pyi

@@ -0,0 +1,13 @@
+from collections.abc import Callable, Iterable, Iterator
+from pythonic_fp.fptools.maybe import MayBe
+from pythonic_fp.gadgets.sentinels.novalue import NoValue
+from typing import Never
+
+__all__ = ['accumulate', 'reduce_left', 'fold_left', 'maybe_fold_left', 'sc_reduce_left', 'sc_reduce_right']
+
+def accumulate[D, L](iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = ...) -> Iterator[L]: ...
+def reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D]) -> D | Never: ...
+def fold_left[D, L](iterable: Iterable[D], f: Callable[[L, D], L], initial: L) -> L | Never: ...
+def maybe_fold_left[D, L](iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = ...) -> MayBe[L] | Never: ...
+def sc_reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D], start: Callable[[D], bool] = ..., stop: Callable[[D], bool] = ..., include_start: bool = True, include_stop: bool = True) -> tuple[MayBe[D], Iterator[D]]: ...
+def sc_reduce_right[D](iterable: Iterable[D], f: Callable[[D, D], D], start: Callable[[D], bool] = ..., stop: Callable[[D], bool] = ..., include_start: bool = True, include_stop: bool = True) -> tuple[MayBe[D], Iterator[D]]: ...

{pythonic_fp_iterables-5.1.1 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/merging.py

@@ -12,7 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module pythonic_fp.iterables.merging"""
+"""
+Merging Iterables
+-----------------
+
+.. admonition:: module pythonic_fp.iterables.merging
+
+    Functions to merge multiple iterables together into one.
+
+"""
 
 from collections.abc import Iterable, Iterator
 from enum import auto, Enum
@@ -51,8 +59,8 @@ def concat[D](*iterables: Iterable[D]) -> Iterator[D]:
 
         Performant to the standard library's ``itertools.chain``.
 
-    :param iterables: iterables to concatenate
-    :return: iterator of concatenated values from the iterables
+    :param iterables: Iterables to concatenate.
+    :returns: Iterator of concatenated values from the iterables.
 
     """
     for iterator in map(lambda x: iter(x), iterables):
@@ -69,13 +77,13 @@ def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[
 
     .. note::
 
-       When ``yield_partials`` is true, then any unmatched values from other iterables
-       already yielded when the first iterable is exhausted are yielded. This prevents
-       data lose if any of the iterables are iterators with external references.
+        When ``yield_partials`` is true, then any unmatched values from other iterables
+        already yielded when the first iterable is exhausted are yielded. This prevents
+        data lose if any of the iterables are iterators with external references.
 
-    :param iterables: iterables to merge until one gets exhausted
-    :param yield_partials: yield any unpaired yielded values from other iterables
-    :return: iterator of merged values from the iterables until one is exhausted
+    :param iterables: Iterables to merge until one gets exhausted.
+    :param yield_partials: Yield any unpaired yielded values from other iterables.
+    :returns: Iterator of merged values from the iterables until one is exhausted.
 
     """
     iter_list = list(map(lambda x: iter(x), iterables))
@@ -96,8 +104,8 @@ def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[
 def exhaust[D](*iterables: Iterable[D]) -> Iterator[D]:
     """Merge together multiple iterables until all are exhausted.
 
-    :param iterables: iterables to exhaustively merge
-    :return: iterator of merged values from the iterables until all are exhausted
+    :param iterables: Iterables to exhaustively merge.
+    :returns: Iterator of merged values from the iterables until all are exhausted.
 
     """
     iter_list = list(map(lambda x: iter(x), iterables))
@@ -126,13 +134,13 @@ def blend[D](
     merge_enum: MergeEnum = MergeEnum.Concat,
     yield_partials: bool = False,
 ) -> Iterator[D]:
-    """Base merge behavior on name only parameters.
+    """Merge behavior based on value of merge_enum parameter.
 
-    :param iterables: iterables to blend together
-    :param merge_enum: MergeEnum to determine merging behavior
-    :param yield_partials: yield yielded unpaired values from other iterables
-    :return: an iterator of type D
-    :raises ValueError: when an unknown MergeEnum is given
+    :param iterables: Iterables to blend together.
+    :param merge_enum: ``MergeEnum`` to determine merging behavior.
+    :param yield_partials: Yield unpaired values from other iterables.
+    :returns: An iterator of type ``D``.
+    :raises ValueError: When an unknown ``MergeEnum`` is given.
 
     """
     match merge_enum:

pythonic_fp_iterables-5.1.3/src/pythonic_fp/iterables/merging.pyi

@@ -0,0 +1,14 @@
+from collections.abc import Iterable, Iterator
+from enum import Enum
+
+__all__ = ['MergeEnum', 'concat', 'merge', 'exhaust', 'blend']
+
+class MergeEnum(Enum):
+    Concat = ...
+    Merge = ...
+    Exhaust = ...
+
+def concat[D](*iterables: Iterable[D]) -> Iterator[D]: ...
+def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[D]: ...
+def exhaust[D](*iterables: Iterable[D]) -> Iterator[D]: ...
+def blend[D](*iterables: Iterable[D], merge_enum: MergeEnum = ..., yield_partials: bool = False) -> Iterator[D]: ...

pythonic_fp_iterables-5.1.1/src/pythonic_fp/iterables/__init__.py

@@ -1,42 +0,0 @@
-# Copyright 2023-2024 Geoffrey R. Scheller
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""
-Library of functions for iterating iterables
-============================================
-
-+-----------+-------------------------------------------+
-| Module    | Description                               |
-+===========+===========================================+
-| merging   | Concatenating and merging iterables       |
-+-----------+-------------------------------------------+
-| drop_take | Dropping and taking values from iterables |
-+-----------+-------------------------------------------+
-| folding   | Reducing and accumulating iterables       |
-+-----------+-------------------------------------------+
-
-Assumptions
------------
-
-- iterables are not necessarily iterators
-- at all times iterator protocol is assumed to be followed
-
-  - all iterators are assumed to be iterable
-  - for all iterators ``foobar`` we assume ``iter(foobar) is foobar``
-
-"""
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'

pythonic_fp_iterables-5.1.1/src/pythonic_fp/iterables/drop_take.pyi

@@ -1,33 +0,0 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from collections.abc import Callable, Iterable, Iterator
-
-__all__ = [
-    'drop',
-    'drop_while',
-    'take',
-    'take_while',
-    'take_split',
-    'take_while_split',
-]
-
-def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]: ...
-def drop_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]: ...
-def take[D](iterable: Iterable[D], n: int) -> Iterator[D]: ...
-def take_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]: ...
-def take_split[D](iterable: Iterable[D], n: int) -> tuple[Iterator[D], Iterator[D]]: ...
-def take_while_split[D](
-    iterable: Iterable[D], pred: Callable[[D], bool]
-) -> tuple[Iterator[D], Iterator[D]]: ...

pythonic_fp_iterables-5.1.1/src/pythonic_fp/iterables/folding.pyi

@@ -1,56 +0,0 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Never
-from pythonic_fp.fptools.function import negate, swap
-from pythonic_fp.fptools.maybe import MayBe
-from pythonic_fp.sentinels.novalue import NoValue
-from .drop_take import drop_while, take_while_split
-
-__all__ = [
-    'accumulate',
-    'reduce_left',
-    'fold_left',
-    'maybe_fold_left',
-    'sc_reduce_left',
-    'sc_reduce_right',
-]
-
-def accumulate[D, L](
-    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = NoValue()
-) -> Iterator[L]: ...
-def reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D]) -> D | Never: ...
-def fold_left[D, L](
-    iterable: Iterable[D], f: Callable[[L, D], L], initial: L
-) -> L | Never: ...
-def maybe_fold_left[D, L](
-    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = NoValue()
-) -> MayBe[L] | Never: ...
-def sc_reduce_left[D](
-    iterable: Iterable[D],
-    f: Callable[[D, D], D],
-    start: Callable[[D], bool] = (lambda d: True),
-    stop: Callable[[D], bool] = (lambda d: False),
-    include_start: bool = True,
-    include_stop: bool = True,
-) -> tuple[MayBe[D], Iterator[D]]: ...
-def sc_reduce_right[D](
-    iterable: Iterable[D],
-    f: Callable[[D, D], D],
-    start: Callable[[D], bool] = (lambda d: False),
-    stop: Callable[[D], bool] = (lambda d: False),
-    include_start: bool = True,
-    include_stop: bool = True,
-) -> tuple[MayBe[D], Iterator[D]]: ...

pythonic_fp_iterables-5.1.1/src/pythonic_fp/iterables/merging.pyi

@@ -1,38 +0,0 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from collections.abc import Iterable, Iterator
-from enum import auto, Enum
-
-__all__ = [
-    'MergeEnum',
-    'concat',
-    'merge',
-    'exhaust',
-    'blend',
-]
-
-class MergeEnum(Enum):
-    Concat = auto()
-    Merge = auto()
-    Exhaust = auto()
-
-def concat[D](*iterables: Iterable[D]) -> Iterator[D]: ...
-def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[D]: ...
-def exhaust[D](*iterables: Iterable[D]) -> Iterator[D]: ...
-def blend[D](
-    *iterables: Iterable[D],
-    merge_enum: MergeEnum = MergeEnum.Concat,
-    yield_partials: bool = False,
-) -> Iterator[D]: ...