pythonic-fp.iterables 5.1.2__py3-none-any.whl → 5.1.3__py3-none-any.whl

pythonic_fp/iterables/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2024 Geoffrey R. Scheller
+# 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.
@@ -13,30 +13,33 @@
 # limitations under the License.
 
 """
-Library of functions for iterating iterables
-============================================
+Tools for iterables
+-------------------
 
-+-----------+-------------------------------------------+
-| Module    | Description                               |
-+===========+===========================================+
-| merging   | Concatenating and merging iterables       |
-+-----------+-------------------------------------------+
-| drop_take | Dropping and taking values from iterables |
-+-----------+-------------------------------------------+
-| folding   | Reducing and accumulating iterables       |
-+-----------+-------------------------------------------+
+.. admonition:: Library of functions for iterating iterables
 
-Assumptions
------------
+    +-----------+-------------------------------------------+
+    | Module    | Description                               |
+    +===========+===========================================+
+    | merging   | Concatenating and merging iterables       |
+    +-----------+-------------------------------------------+
+    | drop_take | Dropping and taking values from iterables |
+    +-----------+-------------------------------------------+
+    | folding   | Reducing and accumulating iterables       |
+    +-----------+-------------------------------------------+
 
-- iterables are not necessarily iterators
-- at all times iterator protocol is assumed to be followed
+.. important::
 
-  - all iterators are assumed to be iterable
-  - for all iterators ``foobar`` we assume ``iter(foobar) is foobar``
+    **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'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
 __license__ = 'Apache License 2.0'

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/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/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.dist-info → pythonic_fp_iterables-5.1.3.dist-info}/METADATA

@@ -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.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+pythonic_fp/iterables/__init__.py,sha256=oAoufgaFeHBH81d-ey738bBsVSximbrp0Rseb3EafnI,1663
+pythonic_fp/iterables/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/iterables/drop_take.py,sha256=Kvj-B_xXD9t4tsIjMRdMXwSDKAeUsfbtLPs6X7wRapg,4847
+pythonic_fp/iterables/drop_take.pyi,sha256=vPyByY4PxCGEuL6trI0aTK8fBr4xCuOgqhaKALwJ5Ys,653
+pythonic_fp/iterables/folding.py,sha256=5-EJT-lp8EhAghMlNghla3rnVL0ywRS3-kGuO13oEVI,8711
+pythonic_fp/iterables/folding.pyi,sha256=ZVrpB-D4kWoVwpCsQ2rc3GJ8iTzavAOQ5YK9LteAukU,1175
+pythonic_fp/iterables/merging.py,sha256=mJ4nmIxSwuoi8LvYTHbU-JEUqkii1BdociRs59Dxq-A,4613
+pythonic_fp/iterables/merging.pyi,sha256=KnuSFREXEpnbtTvMWsvn-KfeSjZ3ybP-6n9hCxjNKVs,533
+pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_iterables-5.1.3.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_iterables-5.1.3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_iterables-5.1.3.dist-info/METADATA,sha256=Mi8wDsA-nnmMXWfrhS42W1CULGDYOcsSRqTk1nxNJNo,2064
+pythonic_fp_iterables-5.1.3.dist-info/RECORD,,

pythonic_fp_iterables-5.1.2.dist-info/RECORD

@@ -1,13 +0,0 @@
-pythonic_fp/iterables/__init__.py,sha256=UTde8stsDVG_5Z7fo37yiYeTu8fhkkv0QsQcQb_ixTU,1590
-pythonic_fp/iterables/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/iterables/drop_take.py,sha256=VpcnQp0Nr4bUGXb-TD2UFl5kHo1fllAFoV_hlYHo8G0,4772
-pythonic_fp/iterables/drop_take.pyi,sha256=vPyByY4PxCGEuL6trI0aTK8fBr4xCuOgqhaKALwJ5Ys,653
-pythonic_fp/iterables/folding.py,sha256=lUvQzRU1wFbolw-b3bI1oU_xk7yIj2V5J8WA-qQxvUc,8612
-pythonic_fp/iterables/folding.pyi,sha256=ZVrpB-D4kWoVwpCsQ2rc3GJ8iTzavAOQ5YK9LteAukU,1175
-pythonic_fp/iterables/merging.py,sha256=CiBYp-iAr-iQrVTWK0wOkFDs9EJ9139p_MRiffIZJ2s,4485
-pythonic_fp/iterables/merging.pyi,sha256=KnuSFREXEpnbtTvMWsvn-KfeSjZ3ybP-6n9hCxjNKVs,533
-pythonic_fp/iterables/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_iterables-5.1.2.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_iterables-5.1.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_iterables-5.1.2.dist-info/METADATA,sha256=G2d_xgzY-1WoYRBu-QoJbAO9PbV5O3uzcchy9fOO6ho,2143
-pythonic_fp_iterables-5.1.2.dist-info/RECORD,,