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

{pythonic_fp_iterables-5.0.0 → pythonic_fp_iterables-5.1.1}/.gitignore

@@ -1,6 +1,7 @@
 # Minimal version - only add to when necessary
 **/__pycache__/
 dist/
+**/.dmypy.json
 **/.mypy_cache/
 **/.pytest_cache/
 **/.ruff_cache

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

@@ -17,6 +17,18 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+5.1.0 - 2025-08-02
+~~~~~~~~~~~~~~~~~~
+
+- changed singletons -> sentinels
+- Removed "from __future__ import annotations"
+- Added .pyi files
+
+5.0.0 - 2025-08-02
+~~~~~~~~~~~~~~~~~~
+
+General consistency tweaks and fixes across all pythonic-fp projects.
+
 4.0.0 - 2025-07-16
 ~~~~~~~~~~~~~~~~~~
 

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

@@ -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.1
+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.1
+Requires-Dist: pythonic-fp-gadgets>=3.0.1
+Requires-Dist: pythonic-fp-sentinels>=2.1.0
 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.0.0 → pythonic_fp_iterables-5.1.1}/pyproject.toml

@@ -1,12 +1,8 @@
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
 [project]
 name = "pythonic-fp-iterables"
-version = "5.0.0"
+version = "5.1.1"
 readme = "README.rst"
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 license = { file = "LICENSE" }
 authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
 keywords = ["iterables", "iterators"]
@@ -20,30 +16,36 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-fptools>=5.0.0",
-  "pythonic-fp>=1.1.0",
-  "pythonic-fp-singletons>=1.0.0",
+  "pythonic-fp-fptools>=5.1.1",
+  "pythonic-fp-gadgets>=3.0.1",
+  "pythonic-fp-sentinels>=2.1.0",
 ]
 dynamic = ["description"]
 
-[project.optional-dependencies]
-test = [
-  "pytest>=8.4.1",
-]
-
 [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"
 Source = "https://github.com/grscheller/pythonic-fp-iterables"
 
+[project.optional-dependencies]
+test = [
+  "pytest>=8.4.1",
+]
+
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [tool.flit.module]
 name = "pythonic_fp.iterables"
 
 [tool.mypy]
-enable_incomplete_feature = ["NewGenericSyntax"]
+enable_incomplete_feature = "NewGenericSyntax"
+explicit_package_bases = true
 implicit_reexport = false
 local_partial_types = true
+namespace_packages = true
 warn_redundant_casts = true
 warn_return_any = true
 warn_unused_configs = true
@@ -51,21 +53,25 @@ warn_unused_configs = true
 [tool.pylsp-mypy]
 enabled = true
 live-mode = true
+dmypy = false
 strict = true
 report_progress = true
 
 [tool.pytest.ini_options]
+addopts = "-ra"
 consider_namespace_packages = true
 testpaths = ["tests/"]
-addopts = "-ra"
 
 [tool.ruff]
 target-version = "py313"
-ignore = ["E741"]
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["C901"]
+"**/*.py" = ["E741"]
+
 [tool.ruff.format]
 quote-style = "single"
 docstring-code-line-length = 72

{pythonic_fp_iterables-5.0.0 → pythonic_fp_iterables-5.1.1}/src/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-5.0.0 → pythonic_fp_iterables-5.1.1}/src/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-5.1.1/src/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-5.0.0 → pythonic_fp_iterables-5.1.1}/src/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-5.1.1/src/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-5.0.0 → pythonic_fp_iterables-5.1.1}/src/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-5.1.1/src/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 → pythonic_fp_iterables-5.1.1}/tests/test_fold.py

@@ -143,7 +143,7 @@ class Test_fp_sc_reduce_left:
         else:
             assert False
 
-    def test_start_stop(self) -> None:
+    def test_start_stop(self) -> None:  # noqa: C901
         data = 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
 
         ge2 = partial(swap(ge_n), 2)