pythonic-fp.iterables 5.1.2__tar.gz → 5.1.3__tar.gz

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.1.2
-Summary: Library of functions for iterating iterables
+Version: 5.1.3
+Summary: Tools for iterables
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
@@ -14,8 +14,8 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-fptools>=5.1.2
-Requires-Dist: pythonic-fp-gadgets>=3.1.0
+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/iterables/development/build/html/
@@ -44,7 +44,7 @@ Library of functions for iterating iterables.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
 Documentation
@@ -52,7 +52,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/iterables>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/README.rst

@@ -19,7 +19,7 @@ Library of functions for iterating iterables.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
 Documentation
@@ -27,7 +27,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/iterables>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-iterables"
-version = "5.1.2"
+version = "5.1.3"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -16,8 +16,8 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-fptools>=5.1.2",
-  "pythonic-fp-gadgets>=3.1.0",
+  "pythonic-fp-fptools>=5.2.0",
+  "pythonic-fp-gadgets>=4.0.2",
 ]
 dynamic = ["description"]
 

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

@@ -0,0 +1,45 @@
+# Copyright 2023-2026 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.
+
+"""
+Tools for iterables
+-------------------
+
+.. admonition:: 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       |
+    +-----------+-------------------------------------------+
+
+.. important::
+
+    **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-2026 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/drop_take.py

@@ -13,7 +13,13 @@
 # limitations under the License.
 
 """
-Module pythonic_fp.iterables.drop_take
+Drop and Take
+-------------
+
+.. admonition:: module pythonic_fp.iterables.drop_take
+
+    Functions to drop or take values from an iterable.
+
 """
 
 from collections.abc import Callable, Iterable, Iterator
@@ -30,9 +36,6 @@ __all__ = [
 ]
 
 
-## dropping and taking
-
-
 def drop[D](iterable: Iterable[D], n: int) -> Iterator[D]:
     """Drop the next n values from iterable.
 
@@ -163,4 +166,4 @@ def take_while_split[D](
     value: Box[D] = Box()
     it_pred = _take_while(iterator, pred, value)
 
-    return (it_pred, concat(value, iterator))
+    return it_pred, concat(value, iterator)

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/folding.py

@@ -12,7 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module pythonic_fp.iterables.folding"""
+"""
+Folding
+-------
+
+.. admonition:: module pythonic_fp.iterables.folding
+
+    Functions to reduce and accumulate values from iterables.
+
+"""
 
 from collections.abc import Callable, Iterable, Iterator
 from typing import cast, Never

{pythonic_fp_iterables-5.1.2 → pythonic_fp_iterables-5.1.3}/src/pythonic_fp/iterables/merging.py

@@ -12,7 +12,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Module pythonic_fp.iterables.merging"""
+"""
+Merging Iterables
+-----------------
+
+.. admonition:: module pythonic_fp.iterables.merging
+
+    Functions to merge multiple iterables together into one.
+
+"""
 
 from collections.abc import Iterable, Iterator
 from enum import auto, Enum
@@ -126,7 +134,7 @@ def blend[D](
     merge_enum: MergeEnum = MergeEnum.Concat,
     yield_partials: bool = False,
 ) -> Iterator[D]:
-    """Base merge behavior on name only parameters.
+    """Merge behavior based on value of merge_enum parameter.
 
     :param iterables: Iterables to blend together.
     :param merge_enum: ``MergeEnum`` to determine merging behavior.

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

@@ -1,42 +0,0 @@
-# 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'