pythonic-fp.iterables 5.1.4__tar.gz → 6.0.0__tar.gz

{pythonic_fp_iterables-5.1.4 → pythonic_fp_iterables-6.0.0}/PKG-INFO

@@ -1,62 +1,52 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.1.4
-Summary: .. admonition:: Composing and iterating iterables
+Version: 6.0.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
-Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 4 - Beta
 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
-Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
+Requires-Dist: pythonic-fp-fptools>=6.2,<7
+Requires-Dist: pythonic-fp-gadgets>=6,<7
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-iterables
+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-iterables).
 
 - 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>`_.
+    - for all iterators `foo` we assume `iter(foo)` is `foo`
 
-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.1.4/README.rst → pythonic_fp_iterables-6.0.0/README.md

@@ -1,37 +1,28 @@
-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-iterables).
 
 - 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>`_.
+    - for all iterators `foo` we assume `iter(foo)` is `foo`
 
-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.1.4 → pythonic_fp_iterables-6.0.0}/pyproject.toml

@@ -4,9 +4,10 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-iterables"
-version = "5.1.4"
-readme = "README.rst"
-requires-python = ">=3.13"
+version = "6.0.0"
+description = "Composing and iterating iterables."
+readme = "README.md"
+requires-python = ">=3.14"  # floor: PEP 649/749 deferred annotations — class-level self-reference NameErrors on <3.14
 authors = [
   { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
 ]
@@ -15,27 +16,31 @@ keywords = [
   "iterators",
 ]
 classifiers = [
-  "Development Status :: 5 - Production/Stable",
+  "Development Status :: 4 - Beta",
   "Framework :: Pytest",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: Apache Software License",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-fptools>=5.2.0",
-  "pythonic-fp-gadgets>=4.0.2",
+  "pythonic-fp-fptools>=6.2,<7",
+  "pythonic-fp-gadgets>=6,<7",
 ]
-dynamic = ["description"]
 
 [project.urls]
-Changelog = "https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/projects/iterables.html"
-Homepage = "https://grscheller.github.io/pythonic-fp/"
+Changelog = "https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.md"
+Documentation ="https://grscheller.github.io/pythonic-fp-iterables"
+Homepage = "https://grscheller.github.io/pythonic-fp"
 Source = "https://github.com/grscheller/pythonic-fp-iterables"
 
-[project.optional-dependencies]
+[dependency-groups]
+docs = [
+  "furo>=2025.12.19",
+  "sphinx>=9.1",
+]
 test = [
   "pytest>=8.4.1",
 ]
@@ -43,31 +48,41 @@ test = [
 [tool.flit.module]
 name = "pythonic_fp.iterables"
 
+[tool.flit.sdist]
+exclude = [
+  "docs/",
+  "tests/",
+  "**/.mypy_cache/",
+  "**/.ruff_cache/",
+  "**/.pytest_cache/",
+  "**/__pycache__/",
+  "**/.dmypy.json",
+]
+
+[tool.pytest]
+addopts = ["-ra"]
+consider_namespace_packages = true
+testpaths = ["tests/"]
+
 [tool.mypy]
 explicit_package_bases = true
 local_partial_types = true
 namespace_packages = true
+strict = true
 warn_redundant_casts = true
 warn_return_any = true
 warn_unused_configs = true
 
-[tool.pylsp-mypy]
-enabled = true
-live-mode = true
-dmypy = false
-strict = true
-report_progress = true
-
-[tool.pytest]
-addopts = [
-  "-ra",
-]
-consider_namespace_packages = true
-testpaths = ["tests/"]
+[[tool.mypy.overrides]]
+module = ["tests.*"]
+strict_equality = false
 
 [tool.ruff]
 target-version = "py314"
 
+[tool.ruff.lint]
+ignore = ["RUF022", "E741"]
+
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
@@ -76,8 +91,11 @@ docstring-quotes = "double"
   "E731",
   "C901",
 ]
-"**/*.py" = ["E741"]
 
 [tool.ruff.format]
 quote-style = "single"
 docstring-code-line-length = 72
+
+[tool.uv.sources]
+pythonic-fp-fptools = { path = "../pythonic-fp-fptools", editable = true }
+pythonic-fp-gadgets = { path = "../pythonic-fp-gadgets", editable = true }

{pythonic_fp_iterables-5.1.4 → pythonic_fp_iterables-6.0.0}/src/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-5.1.4 → pythonic_fp_iterables-6.0.0}/src/pythonic_fp/iterables/drop_take.py

@@ -34,7 +34,9 @@
 """
 
 from collections.abc import Callable, Iterable, Iterator
+
 from pythonic_fp.gadgets.box import Box
+
 from .merging import concat
 
 __all__ = [
@@ -74,7 +76,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 +119,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 +148,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 +174,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-5.1.4 → pythonic_fp_iterables-6.0.0}/src/pythonic_fp/iterables/folding.py

@@ -20,10 +20,13 @@
 """
 
 from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Never
+from typing import cast
+
 from pythonic_fp.fptools.function import negate, swap
 from pythonic_fp.fptools.maybe import MayBe
+from pythonic_fp.fptools.recoverable import RECOVERABLE
 from pythonic_fp.gadgets.sentinels.novalue import NoValue
+
 from .drop_take import drop_while, take_while_split
 
 __all__ = [
@@ -34,19 +37,20 @@ __all__ = [
     'sc_reduce_left',
     'sc_reduce_right',
 ]
+novalue = NoValue()
 
 
 def accumulate[D, L](
-    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = NoValue()
+    iterable: Iterable[D], f: Callable[[L, D], L], initial: L | NoValue = novalue
 ) -> Iterator[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.
 
@@ -83,14 +87,15 @@ 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:
     """
     .. admonition:: reduce left
 
         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 +103,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)
@@ -116,7 +121,7 @@ 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:
+) -> L:
     """
     .. admonition:: fold left
 
@@ -126,10 +131,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::
 
@@ -144,8 +150,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]:
     """
     .. admonition:: maybe fold left
 
@@ -155,7 +161,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()``.
@@ -179,7 +185,7 @@ def maybe_fold_left[D, L](
     for v in it:
         try:
             acc = f(acc, v)
-        except Exception:
+        except RECOVERABLE:
             return MayBe()
 
     return MayBe(acc)
@@ -199,7 +205,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 +267,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-5.1.4 → pythonic_fp_iterables-6.0.0}/src/pythonic_fp/iterables/merging.py

@@ -20,7 +20,7 @@
 """
 
 from collections.abc import Iterable, Iterator
-from enum import auto, Enum
+from enum import Enum, auto
 
 __all__ = [
     'MergeEnum',
@@ -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()
@@ -63,7 +63,7 @@ def concat[D](*iterables: Iterable[D]) -> Iterator[D]:
             Performant to the standard library's ``itertools.chain``.
 
     """
-    for iterator in map(lambda x: iter(x), iterables):
+    for iterator in (iter(x) for x in iterables):
         while True:
             try:
                 item = next(iterator)
@@ -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.
@@ -93,7 +93,7 @@ def merge[D](*iterables: Iterable[D], yield_partials: bool = False) -> Iterator[
             iterators with external references.
 
     """
-    iter_list = list(map(lambda x: iter(x), iterables))
+    iter_list = [iter(x) for x in iterables]
     items = []
     if (num_iters := len(iter_list)) > 0:
         while True:
@@ -112,14 +112,14 @@ 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
                  iterables are exhausted.
 
     """
-    iter_list = list(map(lambda x: iter(x), iterables))
+    iter_list = [iter(x) for x in iterables]
     if (num_iters := len(iter_list)) > 0:
         ii = 0
         items = []
@@ -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/.github/workflows/static.yml

@@ -1,64 +0,0 @@
-name: Build and Deploy Furo Themed Sphinx Documentation
-
-on:
-  push:
-    branches: ["main"]
-  workflow_dispatch:
-
-env:
-  RELEASE: '5.1.4'
-  DEVEL: '5.1.5'
-  PYTHON: '3.14'
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-
-      - name: Select Python
-        uses: actions/setup-python@v6
-        with:
-          python-version: '3.14'
-
-      - name: Install Sphinx Dependencies
-        run: |
-          pip install -r docs/requirements.txt
-          sudo apt-get install -y graphviz
-
-      - name: Build Release Docs
-        run: |
-          pip install pythonic-fp-iterables
-          docs/gen_conf.py release ${{ env.RELEASE }} Iterables iterables > docs/source/conf.py
-          sphinx-build -M html docs/source docs/build/release
-
-      - name: Build Development Docs
-        run: |
-          pip install -e .
-          docs/gen_conf.py devel ${{ env.DEVEL }} Iterables iterables > docs/source/conf.py
-          sphinx-build -M html docs/source docs/build/development
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v6
-
-      - name: Upload Artifact
-        uses: actions/upload-pages-artifact@v5
-        with:
-          path: docs/build
-
-      - name: Deploy to GitHub Pages
-        uses: actions/deploy-pages@v5
-        id: deployment

pythonic_fp_iterables-5.1.4/.gitignore

@@ -1,9 +0,0 @@
-# Minimal version - only add to when necessary
-**/__pycache__/
-dist/
-docs/build/
-docs/source/conf.py
-**/.dmypy.json
-**/.mypy_cache/
-**/.pytest_cache/
-**/.ruff_cache