pythonic-fp.iterables 5.1.4__py3-none-any.whl → 5.2.0__py3-none-any.whl

pythonic_fp/iterables/__init__.py

@@ -27,7 +27,7 @@
     - 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``
+      - for all iterators ``foo`` we assume ``iter(foo) is foo``
 
 """
 

pythonic_fp/iterables/drop_take.py

@@ -74,7 +74,7 @@ def drop_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[
         Drop initial items from iterable while predicate is true.
 
         :param iterable: Iterable whose items are to be dropped.
-        :param pred: Single argument Boolean items function, the "predicate".
+        :param pred: Single argument Boolean valued function.
         :yields: items starting when ``pred`` returns ``False``.
 
     """
@@ -117,7 +117,7 @@ def take_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[
         Return an iterator of items until predicate false.
 
         :param iterable: Iterable providing the items to be taken.
-        :param pred: Single argument Boolean valued function, the "predicate".
+        :param pred: Single argument Boolean valued function.
         :yields: Items from iterable while predicate is true.
 
         .. warning::
@@ -146,7 +146,7 @@ def take_split[D](iterable: Iterable[D], n: int) -> tuple[Iterator[D], Iterator[
 
         .. admonition:: CONTRACT
 
-            **CONTRACT:** Do not access the second iterator until
+            **IMPORTANT:** Do not access the second iterator until
             the first one is completely exhausted.
 
         :param iterable: Iterable providing the items to be taken.
@@ -172,7 +172,7 @@ def take_while_split[D](
 
         .. admonition:: CONTRACT
 
-            **CONTRACT:** Do not access the second iterator until
+            **IMPORTANT:** Do not access the second iterator until
             the first one is completely exhausted.
 
         :param iterable: Iterable providing the items to be taken.

pythonic_fp/iterables/folding.py

@@ -42,11 +42,11 @@ def accumulate[D, L](
     """
     .. admonition:: accumulate
 
-        Returns an iterator of partial fold items. A pure Python
-        version of 
+        Returns an iterator of partially folded items.
 
         :param iterable: Iterable to be folded.
-        :param f: Two parameter function, first parameter for accumulated items.
+        :param f: Two parameter function, first parameter is for
+                  the accumulator.
         :param initial: Optional ``initial`` item to start fold.
         :yields: The intermediate folded items.
 
@@ -90,7 +90,8 @@ def reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D]) -> D | Never:
         Fold an iterable left with a function.
 
         :param iterable: Iterable to be reduced (folded).
-        :param f: Two parameter function, first parameter for accumulated items.
+        :param f: Two parameter function, first parameter is for
+                  the accumulator.
         :return: Reduced item from the iterable.
         :raises StopIteration: When called on an empty iterable.
         :raises Exception: Does not catch any exceptions from ``f``.
@@ -98,7 +99,7 @@ def reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D]) -> D | Never:
         .. warning::
 
             - never returns if given an infinite iterable
-            - does not catch or re-raises exceptions raised by ``f``
+            - does not catch or re-raise exceptions raised by ``f``
 
     """
     it = iter(iterable)
@@ -126,10 +127,11 @@ def fold_left[D, L](
         - initial item is required, does not default to ``0``
         - handles non-numeric data just find
 
-        :param iterable: iterable to be folded
-        :param f: two parameter function, first parameter for accumulated item
-        :param initial: mandatory initial item to start fold
-        :return: the folded item
+        :param iterable: Iterable to be folded.
+        :param f: Two parameter function, first parameter is for
+                  the accumulator.
+        :param initial: Mandatory initial item to start fold
+        :return: The folded item.
 
         .. warning::
 
@@ -155,7 +157,7 @@ def maybe_fold_left[D, L](
         - if iterable empty and no ``initial`` item given, return ``MayBe()``
 
         :param iterable: The iterable to be folded.
-        :param f: First argument is for the accumulated items.
+        :param f: First argument is for the accumulator.
         :param initial: Mandatory initial item to start fold.
         :return: ``MayBe`` of a successfully folded item,
                  otherwise returns ``MayBe()``.
@@ -199,7 +201,7 @@ def sc_reduce_left[D](
         Short circuit version of a left fold.
 
         :param iterable: Iterable to be reduced from the left.
-        :param f: Two parameter function, first parameter for
+        :param f: Two parameter function, first parameter is for
                   the accumulator.
         :param start: Delay starting the fold until it returns true.
         :param stop: Prematurely stop the fold when it returns true.
@@ -261,7 +263,7 @@ def sc_reduce_right[D](
         Short circuit version of a right fold.
 
         :param iterable: Iterable to be reduced from the right.
-        :param f: Two parameter function, second parameter for
+        :param f: Two parameter function, second parameter is for
                   the accumulator.
         :param start: Delay starting the fold until it returns true.
         :param stop: Prematurely stop the fold when it returns true.

pythonic_fp/iterables/merging.py

@@ -35,9 +35,9 @@ class MergeEnum(Enum):
     """
     .. admonition:: Iterable Blending Enums.
 
-        - **MergeEnum.Concat:** Concatenate first to last
-        - **MergeEnum.Merge:** Merge until one is exhausted
-        - **MergeEnum.Exhaust:** Merge until all are exhausted
+        - **Concat:** Concatenate first to last
+        - **Merge:** Merge until one is exhausted
+        - **Exhaust:** Merge until all are exhausted
 
     """
     Concat = auto()
@@ -76,7 +76,7 @@ def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[
     """
     .. admonition:: merge iterables
 
-        Merge multiple iterables until one is exhausted.
+        Merge multiple iterables until one of them is exhausted.
 
         :param iterables: Iterables to merge until one gets exhausted.
         :param yield_partials: Yield any unpaired yielded items from other iterables.
@@ -112,7 +112,7 @@ def exhaust[D](*iterables: Iterable[D]) -> Iterator[D]:
     """
     .. admonition:: exhaustively merge iterables
 
-        Merge multiple iterables until all are exhausted.
+        Merge multiple iterables until all of them are exhausted.
 
         :param iterables: Iterables to exhaustively merge.
         :yields: Merged items from the iterables until all of the
@@ -150,6 +150,10 @@ def blend[D](
 
         Merge behavior based on value of merge_enum parameter.
 
+        - Concat: Concatenate first to last
+        - Merge: Merge until one is exhausted
+        - Exhaust: Merge until all are exhausted
+
         :param iterables: Iterables to blend together.
         :param merge_enum: ``MergeEnum`` to determine merging behavior.
         :param yield_partials: Yield unpaired items from other iterables.

{pythonic_fp_iterables-5.1.4.dist-info → pythonic_fp_iterables-5.2.0.dist-info}/METADATA

@@ -1,62 +1,52 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.1.4
-Summary: .. admonition:: Composing and iterating iterables
+Version: 5.2.0
+Summary: Composing and iterating iterables.
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.13
-Description-Content-Type: text/x-rst
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Typing :: Typed
 License-File: LICENSE
-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/projects/iterables.html
+Requires-Dist: pythonic-fp-fptools>=6,<6.2
+Requires-Dist: pythonic-fp-gadgets>=4.5,<6
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-iterables/release/html/
 Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-iterables
-Provides-Extra: test
 
-Pythonic FP - Tools for iterables
-=================================
+# Pythonic FP - Tools for iterables
+
+Library of functions for iterating iterables.
 
 PyPI project
-`pythonic-fp-iterators
-<https://pypi.org/project/pythonic-fp-iterables>`_.
+[pythonic-fp-iterators](https://pypi.org/project/pythonic-fp-iterables).
+Part of the
+[pythonic-fp](https://grscheller.github.io/pythonic-fp/)
+PyPI projects.
 
-Library of functions for iterating iterables.
+## Documentation
+
+Documentation and other links for this project are hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp/projects/iterables.html).
 
 - Concatenating and merging iterables
 - Dropping and taking values from iterables
 - 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 ``foo`` we assume ``iter(foo) is foo``
 
-Part of the
-`pythonic-fp
-<https://grscheller.github.io/pythonic-fp/>`_
-PyPI projects.
-
-Documentation
--------------
-
-Documentation and other links for this project are hosted on
-`GitHub Pages
-<https://grscheller.github.io/pythonic-fp/projects/iterables.html>`_.
-
-Copyright and License
----------------------
+## Copyright and License
 
 Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_iterables-5.2.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pythonic_fp/iterables/__init__.py,sha256=lL6SETAAn9sn2dGRBxvbJlswZwweym4OumCKbJfokQI,1246
+pythonic_fp/iterables/drop_take.py,sha256=kZS8paCc-EOD42BGmCg-89e0W9CGFCXiB88Y4oE_lSg,5527
+pythonic_fp/iterables/folding.py,sha256=IZmoWyuh8D9rS_g9K8DhSu_owM1_IJ_oIMsLJNqH28I,9377
+pythonic_fp/iterables/merging.py,sha256=YYXrCNXHF9xuIMLOySTube6-_YUNB2GGirTa8VbpeLM,5038
+pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_iterables-5.2.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_iterables-5.2.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_iterables-5.2.0.dist-info/METADATA,sha256=yajE7AFhbVcOksI_nW2PdhDdURZjrRkRlpBfBAfiVdw,1997
+pythonic_fp_iterables-5.2.0.dist-info/RECORD,,

pythonic_fp/iterables/drop_take.pyi

@@ -1,10 +0,0 @@
-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/folding.pyi

@@ -1,13 +0,0 @@
-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/merging.pyi

@@ -1,14 +0,0 @@
-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.4.dist-info/RECORD

@@ -1,13 +0,0 @@
-pythonic_fp/iterables/__init__.py,sha256=j-Z9XV73LehhLwYvi_Wzhml7hPaEbHiRjRJt-BI6RKs,1255
-pythonic_fp/iterables/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/iterables/drop_take.py,sha256=0ydMGx-aj_-aK5PIx7Rowh_9h0niC6bRKMSotHjvy1g,5558
-pythonic_fp/iterables/drop_take.pyi,sha256=vPyByY4PxCGEuL6trI0aTK8fBr4xCuOgqhaKALwJ5Ys,653
-pythonic_fp/iterables/folding.py,sha256=tqFzxzWLpK6qIS9ff8tTwv58q2h4gjBAyuHrNeEWi20,9347
-pythonic_fp/iterables/folding.pyi,sha256=ZVrpB-D4kWoVwpCsQ2rc3GJ8iTzavAOQ5YK9LteAukU,1175
-pythonic_fp/iterables/merging.py,sha256=acQ8_Iw07CVvOnB_D8dbLvmkjv7P48CysareWlfAbRc,4912
-pythonic_fp/iterables/merging.pyi,sha256=KnuSFREXEpnbtTvMWsvn-KfeSjZ3ybP-6n9hCxjNKVs,533
-pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_iterables-5.1.4.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_iterables-5.1.4.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_iterables-5.1.4.dist-info/METADATA,sha256=zOdoxJujuqsKpXHZqKfI-0wJRmnKEDdy5T_KjMXMJGQ,2096
-pythonic_fp_iterables-5.1.4.dist-info/RECORD,,