pythonic-fp.iterables 5.0.0__py3-none-any.whl → 5.1.0__py3-none-any.whl

pythonic_fp/iterables/__init__.py

@@ -12,7 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Library of functions for iterating iterables.
+"""
+Library of functions for iterating iterables
+============================================
 
 +-----------+-------------------------------------------+
 | Module    | Description                               |
@@ -24,7 +26,8 @@
 | folding   | Reducing and accumulating iterables       |
 +-----------+-------------------------------------------+
 
-Assumptions:
+Assumptions
+-----------
 
 - iterables are not necessarily iterators
 - at all times iterator protocol is assumed to be followed

pythonic_fp/iterables/drop_take.py

@@ -12,13 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module pythonic_fp.iterables.drop_take"""
-
-from __future__ import annotations
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'
+"""
+Module pythonic_fp.iterables.drop_take
+"""
 
 from collections.abc import Callable, Iterable, Iterator
 from pythonic_fp.gadgets.box import Box
@@ -42,7 +38,7 @@ def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]:
 
     :param iterable: iterable whose values are to be dropped
     :param n: number of values to be dropped
-    :return: an iterator of the remaining values
+    :returns: an iterator of the remaining values
 
     """
     iterator = iter(iterable)
@@ -54,10 +50,7 @@ def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]:
     return iterator
 
 
-def drop_while[D](
-        iterable: Iterable[D],
-        pred: Callable[[D], bool]
-    ) -> 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
@@ -94,10 +87,7 @@ def take[D](iterable: Iterable[D], n: int) -> Iterator[D]:
             break
 
 
-def take_while[D](
-        iterable: Iterable[D],
-        pred: Callable[[D], bool]
-    ) -> Iterator[D]:
+def take_while[D](iterable: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]:
     """Yield values from iterable while predicate is true.
 
     .. warning::
@@ -120,10 +110,7 @@ def take_while[D](
             break
 
 
-def take_split[D](
-        iterable: Iterable[D],
-        n: int
-    ) -> tuple[Iterator[D], Iterator[D]]:
+def take_split[D](iterable: Iterable[D], n: int) -> tuple[Iterator[D], Iterator[D]]:
     """Same as take except also return iterator of remaining values.
 
     .. Warning::
@@ -157,6 +144,7 @@ def take_while_split[D](
     :return: tuple containing an iterator of values taken and an iterator of remaining values
 
     """
+
     def _take_while(
         iterator: Iterator[D], pred: Callable[[D], bool], val: Box[D]
     ) -> Iterator[D]:

pythonic_fp/iterables/drop_take.pyi

@@ -0,0 +1,33 @@
+# 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/folding.py

@@ -14,17 +14,11 @@
 
 """Module pythonic_fp.iterables.folding"""
 
-from __future__ import annotations
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'
-
 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.singletons.novalue import NoValue
+from pythonic_fp.sentinels.novalue import NoValue
 from .drop_take import drop_while, take_while_split
 
 __all__ = [
@@ -36,11 +30,10 @@ __all__ = [
     'sc_reduce_right',
 ]
 
+
 def accumulate[D, L](
-        iterable: Iterable[D],
-        f: Callable[[L, D], L],
-        initial: L | NoValue = NoValue()
-    ) -> Iterator[L]:
+    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = NoValue()
+) -> Iterator[L]:
     """Returns an iterator of partial fold values.
 
     A pure Python version of standard library's ``itertools.accumulate``
@@ -78,10 +71,7 @@ def accumulate[D, L](
             yield acc
 
 
-def reduce_left[D](
-        iterable: Iterable[D],
-        f: Callable[[D, D], D]
-    ) -> D | Never:
+def reduce_left[D](iterable: Iterable[D], f: Callable[[D, D], D]) -> D | Never:
     """Fold an iterable left with a function.
 
     .. Warning::
@@ -113,10 +103,8 @@ def reduce_left[D](
 
 
 def fold_left[D, L](
-        iterable: Iterable[D],
-        f: Callable[[L, D], L],
-        initial: L
-    ) -> L | Never:
+    iterable: Iterable[D], f: Callable[[L, D], L], initial: L
+) -> L | Never:
     """Fold an iterable left with a function and initial value.
 
     - not restricted to ``__add__`` for the folding function
@@ -144,10 +132,8 @@ def fold_left[D, L](
 
 
 def maybe_fold_left[D, L](
-        iterable: Iterable[D],
-        f: Callable[[L, D], L],
-        initial: L | NoValue = NoValue()
-    ) -> MayBe[L] | Never:
+    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = NoValue()
+) -> MayBe[L] | Never:
     """Folds an iterable left with an "optional" initial value..
 
     - when an initial value is not given then ``L = D``
@@ -188,13 +174,13 @@ def maybe_fold_left[D, L](
 
 
 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]]:
+    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]]:
     """Short circuit version of a left reduce.
 
     Useful for infinite iterables.
@@ -240,13 +226,13 @@ def sc_reduce_left[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]]:
+    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]]:
     """Short circuit version of a right reduce.
 
     Useful for infinite and non-reversible iterables.

pythonic_fp/iterables/folding.pyi

@@ -0,0 +1,56 @@
+# 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/merging.py

@@ -14,8 +14,6 @@
 
 """Module pythonic_fp.iterables.merging"""
 
-from __future__ import annotations
-
 from collections.abc import Iterable, Iterator
 from enum import auto, Enum
 
@@ -27,6 +25,7 @@ __all__ = [
     'blend',
 ]
 
+
 class MergeEnum(Enum):
     """Iterable Blending Enums.
 
@@ -35,6 +34,7 @@ class MergeEnum(Enum):
     - **MergeEnum.Exhaust:** Merge until all are exhausted
 
     """
+
     Concat = auto()
     Merge = auto()
     Exhaust = auto()
@@ -46,7 +46,7 @@ def concat[D](*iterables: Iterable[D]) -> Iterator[D]:
     .. warning::
         An infinite iterable will prevent subsequent iterables from
         yielding any values.
-    
+
     .. note::
 
         Performant to the standard library's ``itertools.chain``.
@@ -64,10 +64,7 @@ def concat[D](*iterables: Iterable[D]) -> Iterator[D]:
                 break
 
 
-def merge[D](
-        *iterables: Iterable[D],
-        yield_partials: bool = False
-    ) -> Iterator[D]:
+def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[D]:
     """Merge together ``iterables`` until one is exhausted.
 
     .. note::
@@ -124,10 +121,11 @@ def exhaust[D](*iterables: Iterable[D]) -> Iterator[D]:
         yield from values
 
 
-def blend[D](*iterables: Iterable[D],
-        merge_enum: MergeEnum = MergeEnum.Concat,
-        yield_partials: bool = False
-    ) -> Iterator[D]:
+def blend[D](
+    *iterables: Iterable[D],
+    merge_enum: MergeEnum = MergeEnum.Concat,
+    yield_partials: bool = False,
+) -> Iterator[D]:
     """Base merge behavior on name only parameters.
 
     :param iterables: iterables to blend together
@@ -141,7 +139,7 @@ def blend[D](*iterables: Iterable[D],
         case MergeEnum.Concat:
             return concat(*iterables)
         case MergeEnum.Merge:
-            return merge(*iterables, yield_partials = yield_partials)
+            return merge(*iterables, yield_partials=yield_partials)
         case MergeEnum.Exhaust:
             return exhaust(*iterables)
 

pythonic_fp/iterables/merging.pyi

@@ -0,0 +1,38 @@
+# 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]: ...

{pythonic_fp_iterables-5.0.0.dist-info → pythonic_fp_iterables-5.1.0.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.0.0
-Summary: Library of functions for iterating iterables.
+Version: 5.1.0
+Summary: Library of functions for iterating iterables
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
@@ -14,9 +14,9 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-fptools>=5.0.0
-Requires-Dist: pythonic-fp>=1.1.0
-Requires-Dist: pythonic-fp-singletons>=1.0.0
+Requires-Dist: pythonic-fp-fptools>=5.1.0
+Requires-Dist: pythonic-fp-gadgets>=3.0.1
+Requires-Dist: pythonic-fp-sentinels>=2.1.1
 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

pythonic_fp_iterables-5.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+pythonic_fp/iterables/__init__.py,sha256=UTde8stsDVG_5Z7fo37yiYeTu8fhkkv0QsQcQb_ixTU,1590
+pythonic_fp/iterables/drop_take.py,sha256=bHxVTJAY9vof570cFQNXNZZAUAtnWBDZgRu7df2aV9E,4707
+pythonic_fp/iterables/drop_take.pyi,sha256=6BtavkUHIxMJmJfcvDAnds9R29OXrCRkDK12jG575VY,1276
+pythonic_fp/iterables/folding.py,sha256=A4VoU7piryt6Fun6Inn1SJSr1IiN-aTqzeSs-mds5oQ,8604
+pythonic_fp/iterables/folding.pyi,sha256=BUslV-cn9eOxlYAF_3wz09TcHDbMATUL0uqU7IjJyAM,2035
+pythonic_fp/iterables/merging.py,sha256=tPVjw5Fr32gMTd4Uq3SKQPqdV9p5fs3xW-0elt8Yz8U,4462
+pythonic_fp/iterables/merging.pyi,sha256=5QBH0NEoqWQwCvWMPBFVoUOWAwmMYqj2W4s2b1rn9J0,1189
+pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_iterables-5.1.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_iterables-5.1.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_iterables-5.1.0.dist-info/METADATA,sha256=FjgztLEfjG2VBYMtg_XUa0gyZTplavSKb523m746npY,2218
+pythonic_fp_iterables-5.1.0.dist-info/RECORD,,

pythonic_fp_iterables-5.0.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-pythonic_fp/iterables/__init__.py,sha256=gtTAk0cCZ4kjfx54hZcwURNXYg02BNr3nKcOP5gdJEk,1534
-pythonic_fp/iterables/drop_take.py,sha256=70K6q0DGumK0XHFgPCpLK-lLDfNTkBzzjb2P5uttEqM,4940
-pythonic_fp/iterables/folding.py,sha256=o3m7MNCWtlPoUsQUrXJ-xhrGsb3Nxp-iJJ7xJE5bbo0,8925
-pythonic_fp/iterables/merging.py,sha256=mhFgSuIFb64wq9gnNkk63zoh92T7lkWB16VQ2L8t3-4,4530
-pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_iterables-5.0.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_iterables-5.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_iterables-5.0.0.dist-info/METADATA,sha256=kFDuTmQMieyCjmD-KmXzZy5970iL39BV-QXMEGaDcxA,2212
-pythonic_fp_iterables-5.0.0.dist-info/RECORD,,