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

pythonic_fp_iterables-5.0.0/.gitignore

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

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

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
-Name: pythonic-fp.iterables
-Version: 4.0.0
+Name: pythonic-fp-iterables
+Version: 5.0.0
 Summary: Library of functions for iterating iterables.
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.12
-Description-Content-Type: text/markdown
+Description-Content-Type: text/x-rst
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
@@ -14,43 +14,47 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp.circulararray>=5.0.0
-Requires-Dist: pythonic-fp.containers >=2.0.0
-Requires-Dist: pythonic-fp.fptools >=3.0.0
+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: 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/API/development/build/html/releases.html
+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: Source, https://github.com/grscheller/pythonic-fp-iterables
+Provides-Extra: test
 
-# Pythonic FP - Tools for iterables
+Pythonic FP - Tools for iterables
+=================================
 
 PyPI project
-[pythonic-fp.iterators](https://pypi.org/project/pythonic-fp.iterables/)
-implementing a Python library of functions for iterables and iterators.
+`pythonic-fp.iterators <https://pypi.org/project/pythonic-fp.iterables>`_.
+
+Library of functions for iterating iterables.
 
 - Concatenating and merging iterables
 - Dropping and taking values from iterables
 - Reducing and accumulating iterables
+- Assumptions
 
-#### Info:
-
-This library assumes that at all times iterator protocol
-is followed. This means that all iterators are iterable and
-that ``iter(some_iterator) is some_iterator``.
-
-#### Note:
+  - iterables are not necessarily iterators
+  - at all times iterator protocol is assumed to be followed
 
-Iterables are not necessarily iterators.
+    - 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 grscheller
-[pythonic-fp namespace projects](https://github.com/grscheller/pythonic-fp/blob/main/README.md).
+This PyPI project is part of of the
+`pythonic-fp namespace projects <https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
 
-## Documentation
+Documentation
+-------------
 
-Documentation for this PyPI projects is hosted on
-[GitHub Pages](https://grscheller.github.io/pythonic-fp/iterators/API/development/build/html/releases.html).
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
 
-## Copyright and License
+Copyright and License
+---------------------
 
 Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_iterables-5.0.0/README.rst

@@ -0,0 +1,34 @@
+Pythonic FP - Tools for iterables
+=================================
+
+PyPI project
+`pythonic-fp.iterators <https://pypi.org/project/pythonic-fp.iterables>`_.
+
+Library of functions for iterating 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``
+
+This PyPI project is part of of the
+`pythonic-fp namespace projects <https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.

{pythonic_fp_iterables-4.0.0 → pythonic_fp_iterables-5.0.0}/pyproject.toml

@@ -1,7 +1,11 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [project]
-name = "pythonic-fp.iterables"
-version = "4.0.0"
-readme = "README.md"
+name = "pythonic-fp-iterables"
+version = "5.0.0"
+readme = "README.rst"
 requires-python = ">=3.12"
 license = { file = "LICENSE" }
 authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
@@ -16,24 +20,25 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp.circulararray>=5.0.0",
-  "pythonic-fp.containers >=2.0.0",
-  "pythonic-fp.fptools >=3.0.0",
+  "pythonic-fp-fptools>=5.0.0",
+  "pythonic-fp>=1.1.0",
+  "pythonic-fp-singletons>=1.0.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/API/development/build/html/releases.html"
+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"
 
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
-[tool.flit.sdist]
-exclude = ["dist", "tests", ".gitignore", ".mypy_cache", ".pytest_cache"]
+[tool.flit.module]
+name = "pythonic_fp.iterables"
 
 [tool.mypy]
 enable_incomplete_feature = ["NewGenericSyntax"]
@@ -48,18 +53,15 @@ enabled = true
 live-mode = true
 strict = true
 report_progress = true
-exclude = ["tests/.*"]
 
 [tool.pytest.ini_options]
 consider_namespace_packages = true
-testpaths = ["tests"]
+testpaths = ["tests/"]
 addopts = "-ra"
 
 [tool.ruff]
 target-version = "py313"
-
-[tool.ruff.lint.per-file-ignores]
-"__init__.py" = ["F401"]
+ignore = ["E741"]
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"

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

@@ -0,0 +1,39 @@
+# 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.0.0/src/pythonic_fp/iterables/drop_take.py

@@ -0,0 +1,177 @@
+# 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.
+
+"""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'
+
+from collections.abc import Callable, Iterable, Iterator
+from pythonic_fp.gadgets.box import Box
+from .merging import concat
+
+__all__ = [
+    'drop',
+    'drop_while',
+    'take',
+    'take_while',
+    'take_split',
+    'take_while_split',
+]
+
+
+## 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
+    :return: an iterator of the remaining values
+
+    """
+    iterator = iter(iterable)
+    for _ in range(n):
+        try:
+            next(iterator)
+        except StopIteration:
+            break
+    return iterator
+
+
+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
+
+    """
+    iterator = iter(iterable)
+    while True:
+        try:
+            value = next(iterator)
+            if not pred(value):
+                iterator = concat((value,), iterator)
+                break
+        except StopIteration:
+            break
+    return 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
+
+    """
+    iterator = iter(iterable)
+    for _ in range(n):
+        try:
+            value = next(iterator)
+            yield value
+        except StopIteration:
+            break
+
+
+def take_while[D](
+        iterable: Iterable[D],
+        pred: Callable[[D], bool]
+    ) -> Iterator[D]:
+    """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
+
+    """
+    iterator = iter(iterable)
+    while True:
+        try:
+            value = next(iterator)
+            if pred(value):
+                yield value
+            else:
+                break
+        except StopIteration:
+            break
+
+
+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::
+
+       **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
+
+    """
+    iterator = iter(iterable)
+    itn = take(iterator, n)
+
+    return itn, iterator
+
+
+def take_while_split[D](
+    iterable: Iterable[D], pred: Callable[[D], bool]
+) -> tuple[Iterator[D], Iterator[D]]:
+    """Yield values from iterable while predicate is true.
+
+    .. Warning::
+
+       **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
+
+    """
+    def _take_while(
+        iterator: Iterator[D], pred: Callable[[D], bool], val: Box[D]
+    ) -> Iterator[D]:
+        while True:
+            try:
+                val.put(next(iterator))
+                if pred(val.get()):
+                    yield val.pop()
+                else:
+                    break
+            except StopIteration:
+                break
+
+    iterator = iter(iterable)
+    value: Box[D] = Box()
+    it_pred = _take_while(iterator, pred, value)
+
+    return (it_pred, concat(value, iterator))