pythonic-fp.containers 4.0.0__tar.gz → 4.0.1__tar.gz

{pythonic_fp_containers-4.0.0 → pythonic_fp_containers-4.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-containers
-Version: 4.0.0
+Version: 4.0.1
 Summary: Container with FP interfaces
 Keywords: functional_containers,functional_tuple,immutable_list
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -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-circulararray>=6.0.0
-Requires-Dist: pythonic-fp-fptools>=5.1.2
-Requires-Dist: pythonic-fp-iterables>=5.1.2
+Requires-Dist: pythonic-fp-circulararray>=6.0.1
+Requires-Dist: pythonic-fp-fptools>=5.2.0
+Requires-Dist: pythonic-fp-iterables>=5.1.3
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-containers/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/containers/development/build/html/
@@ -44,7 +44,7 @@ programming inspired tweaks.
 
 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/containers/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/containers>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_containers-4.0.0 → pythonic_fp_containers-4.0.1}/README.rst

@@ -18,7 +18,7 @@ programming inspired tweaks.
 
 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
@@ -26,7 +26,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/containers/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/containers>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_containers-4.0.0 → pythonic_fp_containers-4.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-containers"
-version = "4.0.0"
+version = "4.0.1"
 readme = "README.rst"
 requires-python = ">=3.12"
 license = { file = "LICENSE" }
@@ -20,9 +20,9 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-circulararray>=6.0.0",
-  "pythonic-fp-fptools>=5.1.2",
-  "pythonic-fp-iterables>=5.1.2",
+  "pythonic-fp-circulararray>=6.0.1",
+  "pythonic-fp-fptools>=5.2.0",
+  "pythonic-fp-iterables>=5.1.3",
 ]
 dynamic = ["description"]
 

{pythonic_fp_containers-4.0.0 → pythonic_fp_containers-4.0.1}/src/pythonic_fp/containers/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2025 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.
@@ -14,7 +14,7 @@
 
 """
 Container with FP interfaces
-============================
+----------------------------
 
 +---------------------------------------------+-----------+------------------+
 | module                                      | class     | description      |
@@ -27,5 +27,5 @@ Container with FP interfaces
 """
 
 __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_containers-4.0.0 → pythonic_fp_containers-4.0.1}/src/pythonic_fp/containers/functional_tuple.py

@@ -1,4 +1,5 @@
-# Copyright 2023-2025 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.
@@ -23,18 +24,17 @@ __all__ = ['FTuple']
 
 
 class FTuple[D](tuple[D, ...]):
-    """Functional Tuple suitable for inheritance.
-
-    - supports both indexing and slicing
-    - int multiplication and FTuple addition supported
+    """
+    .. admonition:: Functional Tuple suitable for inheritance.
 
-      - addition concatenates results, resulting in a Union type
-      - both left and right int multiplication supported
-      - homogeneous in its data type
-      - supports being further inherited from
-      - unslotted
+        - supports both indexing and slicing
+        - int multiplication and FTuple addition supported
+        - addition concatenates results, resulting in a Union type
+        - both left and right int multiplication supported
+        - homogeneous in its data type
+        - supports being further inherited from
+        - unslotted
 
-    Since these tuples are homogeneous, their covariance may be quirky.
     """
 
     def __reversed__(self) -> Iterator[D]:
@@ -84,6 +84,7 @@ class FTuple[D](tuple[D, ...]):
         :param default: An optional default value if fold does not exist.
         :raises ValueError: When ``FTuple`` empty and a start value not given.
         :returns: The folded value if it exists, otherwise the default value.
+
         """
         it_self = iter(self)
         if start is not None:
@@ -113,6 +114,7 @@ class FTuple[D](tuple[D, ...]):
         :param default: An optional default value if fold does not exist.
         :raises ValueError: when FTuple empty and a start value not given
         :returns: The folded value if it exists, otherwise the default value.
+
         """
         it_self = reversed(self)
         if start is not None:
@@ -132,6 +134,7 @@ class FTuple[D](tuple[D, ...]):
         """Return a shallow copy of ``FTuple`` in O(1) time & space complexity.
 
         :returns: New ``FTuple``.
+
         """
         return self.__class__(self)
 
@@ -158,6 +161,7 @@ class FTuple[D](tuple[D, ...]):
         :param f: Folding function used to produce partial folds.
         :param s: Optional starting value.
         :returns: New ``FTuple`` of the partial folds.
+
         """
         if s is None:
             return FTuple(accumulate(self, f))
@@ -179,6 +183,7 @@ class FTuple[D](tuple[D, ...]):
         :param yield_partials: Yield unmatched values if ``MergeEnum`` given as merge type.
         :return: Resulting ``FTuple``.
         :raises ValueError: If given an unknown merge enumeration.
+
         """
         return FTuple(
             blend(*map(f, self), merge_enum=merge_type, yield_partials=yield_partials)

{pythonic_fp_containers-4.0.0 → pythonic_fp_containers-4.0.1}/src/pythonic_fp/containers/immutable_list.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2025 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.
@@ -23,15 +23,16 @@ __all__ = ['IList']
 
 
 class IList[D](Hashable):
-    """Immutable List like data structure.
+    """
+    .. admonition:: Immutable List like data structure.
 
-    - hashability should be enforced by LSP tooling
-    - hashability will be enforced at runtime
-    - its method type parameters are also covariant
-    - supports both indexing and slicing
-    - addition and left & right ``int`` multiplication supported
+        - hashability should be enforced by LSP tooling
+        - hashability will be enforced at runtime
+        - its method type parameters are also covariant
+        - supports both indexing and slicing
+        - addition and left & right ``int`` multiplication supported
 
-      - addition is concatenation resulting in a union type
+          - addition is concatenation resulting in a union type
 
     """
 
@@ -41,6 +42,7 @@ class IList[D](Hashable):
     def __init__(self, *dss: Iterable[D]) -> None:
         """
         :param dss: 0 or 1 iterables
+
         """
         if (size := len(dss)) > 1:
             msg = f'IList expects at most 1 iterable argument, got {size}'
@@ -108,6 +110,7 @@ class IList[D](Hashable):
         :param default: Optional default value if fold does not exist.
         :returns: Folded value.
         :raises ValueError: When empty and a start value not given.
+
         """
         it = iter(self._ds)
         if start is not None:
@@ -139,6 +142,7 @@ class IList[D](Hashable):
         :param default: Optional default value if fold does not exist.
         :returns: Folded value.
         :raises ValueError: When empty and a start value not given.
+
         """
         it = reversed(self._ds)
         if start is not None:
@@ -180,6 +184,7 @@ class IList[D](Hashable):
         :param f: Folding function used to produce partial folds.
         :param s: Optional starting value.
         :returns: New ``FTuple`` of the partial folds.
+
         """
         if s is None:
             return IList(accumulate(self, f))
@@ -194,13 +199,6 @@ class IList[D](Hashable):
         merge_enum: MergeEnum = MergeEnum.Concat,
         yield_partials: bool = False,
     ) -> 'IList[U] | Never':
-        """Bind function `f` to the `IList`.
-
-        :param ds: values to instantiate IList
-        :return: resulting IList
-        :raises ValueError: if given unknown merge_type
-
-        """
         """Bind function ``f`` to the ``IList``.
 
         :param f: Function ``D -> IList[U]``
@@ -208,6 +206,7 @@ class IList[D](Hashable):
         :param yield_partials: Yield unmatched values if ``MergeEnum`` given as merge type.
         :return: Resulting ``IList``.
         :raises ValueError: If given an unknown merge enumeration.
+
         """
         return IList(
             blend(*map(f, self), merge_enum=merge_enum, yield_partials=yield_partials)