pythonic-fp.containers 3.0.0__py3-none-any.whl → 4.0.0__py3-none-any.whl

pythonic_fp/containers/__init__.py

@@ -12,21 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Package of container like data structures.
-
-+------------------+--------+----------------------------------------------------+
-| Description      | Class  | Package/Module                                     |
-+==================+========+====================================================+
-| Functional tuple | FTuple | module ``pythonic_fp.containers.functional_tuple`` |
-+------------------+--------+----------------------------------------------------+
-| Immutable list   | IList  | module ``pythonic_fp.containers.immutable_list``   |
-+------------------+--------+----------------------------------------------------+
-| Queues           |        | package ``pythonic_fp.containers.queues``          |
-+------------------+--------+----------------------------------------------------+
-
-.. note::
+"""
+Container with FP interfaces
+============================
 
-    Module ``box`` has  been moved to ``pythonic_fp.gadgets.box``.
++---------------------------------------------+-----------+------------------+
+| module                                      | class     | description      |
++=============================================+===========+==================+
+| ``pythonic_fp.containers.functional_tuple`` | FTuple    | Functional Tuple |
++---------------------------------------------+-----------+------------------+
+| ``pythonic_fp.containers.immutable_list``   | IList     | Immutable List   |
++---------------------------------------------+-----------+------------------+
 
 """
 

pythonic_fp/containers/functional_tuple.py

@@ -14,22 +14,19 @@
 
 """Pythonic FP - Functional Tuple"""
 
-from __future__ import annotations
-
 from collections.abc import Callable, Iterator
-from typing import cast, Never, overload, TypeVar
+from typing import cast, Never, overload, SupportsIndex
 from pythonic_fp.iterables.folding import accumulate
 from pythonic_fp.iterables.merging import blend, concat, MergeEnum
 
 __all__ = ['FTuple']
 
-D = TypeVar('D', covariant=True)
 
 class FTuple[D](tuple[D, ...]):
-    """Functional Tuple suitable for inheritance
+    """Functional Tuple suitable for inheritance.
 
-    - Supports both indexing and slicing
-    - FTuple addition and int multiplication supported
+    - 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
@@ -37,9 +34,9 @@ class FTuple[D](tuple[D, ...]):
       - supports being further inherited from
       - unslotted
 
-    - Since these tuples are homogeneous, their covariance may be quirky
-
+    Since these tuples are homogeneous, their covariance may be quirky.
     """
+
     def __reversed__(self) -> Iterator[D]:
         for ii in range(len(self) - 1, -1, -1):
             yield (self[ii])
@@ -59,17 +56,14 @@ class FTuple[D](tuple[D, ...]):
                 return False
         return True
 
-    @overload    # type:ignore
-    def __getitem__(self, x: int) -> D: ...
     @overload
-    def __getitem__(self, x: slice) -> tuple[D, ...]: ...
-
-    def __getitem__(self, idx: int | slice, /) -> tuple[D, ...] | D:
-        def newtup(tup: tuple[D, ...]) -> tuple[D, ...]:
-            return tup[0:-1] + tup[-1:]
+    def __getitem__(self, idx: SupportsIndex) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice) -> tuple[D, ...]: ...
 
+    def __getitem__(self, idx: SupportsIndex | slice) -> tuple[D, ...] | D:
         if isinstance(idx, slice):
-            return self.__class__(newtup(super().__getitem__(idx)))
+            return self.__class__(super().__getitem__(idx))
         else:
             return super().__getitem__(idx)
 
@@ -79,14 +73,17 @@ class FTuple[D](tuple[D, ...]):
         /,
         start: L | None = None,
         default: L | None = None,
-    ) -> L | None:
-        """Fold Left
+    ) -> L:
+        """Fold Left with optional starting and default values.
 
         - fold left with an optional starting value
-        - first argument of function f is for the accumulated value
-
-        :raises ValueError: when FTuple empty and a start value not given
+        - first argument of function ``f`` is for the accumulated value
 
+        :param f: The folding function, first argument is for the accumulated value.
+        :param start: An optional starting value.
+        :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:
@@ -108,14 +105,14 @@ class FTuple[D](tuple[D, ...]):
         /,
         start: R | None = None,
         default: R | None = None,
-    ) -> R | None:
-        """Fold Right
-
-        - fold right with an optional starting value
-        - second argument of function f is for the accumulated value
+    ) -> R:
+        """Fold Right with optional starting and default values.
 
+        :param f: The folding function, second argument is for the accumulated value.
+        :param start: An optional starting value.
+        :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:
@@ -131,54 +128,58 @@ class FTuple[D](tuple[D, ...]):
             acc = f(v, acc)
         return acc
 
-    def copy(self) -> FTuple[D]:
-        """Return a shallow copy of ``FTuple`` in O(1) time & space complexity."""
+    def copy(self) -> 'FTuple[D]':
+        """Return a shallow copy of ``FTuple`` in O(1) time & space complexity.
+
+        :returns: New ``FTuple``.
+        """
         return self.__class__(self)
 
     def __add__(self, other: object, /) -> tuple[D, ...]:
-        if not isinstance(other, FTuple):
+        if not isinstance(other, tuple):
             msg = 'FTuple being added to something not an FTuple'
             raise ValueError(msg)
         return self.__class__(concat(self, other))
 
-    def __mul__(self, num: int, /) -> tuple[D, ...]:
+    def __mul__(self, num: SupportsIndex) -> tuple[D, ...]:
         return self.__class__(super().__mul__(num))
 
-    def __rmul__(self, num: int, /) -> tuple[D]:
+    def __rmul__(self, num: SupportsIndex) -> tuple[D, ...]:
         return self.__class__(super().__rmul__(num))
 
     def accummulate[L](
         self, f: Callable[[L, D], L], s: L | None = None, /
-    ) -> FTuple[L]:
-        """Accumulate partial folds
+    ) -> 'FTuple[L]':
+        """Accumulate partial folds.
 
-        Accumulate partial fold results in an ``FTuple`` with an optional
-        starting value.
+        Accumulate partial fold with an optional starting value,
+        results in an ``FTuple``.
 
+        :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))
         return FTuple(accumulate(self, f, s))
 
-    def map[U](self, f: Callable[[D], U], /) -> FTuple[U]:
+    def map[U](self, f: Callable[[D], U], /) -> 'FTuple[U]':
         return FTuple(map(f, self))
 
     def bind[U](
-            self, f: Callable[[D], FTuple[U]],
-            merge_enum: MergeEnum = MergeEnum.Concat,
-            yield_partials: bool = False,
-        ) -> FTuple[U] | Never:
+        self,
+        f: 'Callable[[D], FTuple[U]]',
+        merge_type: MergeEnum = MergeEnum.Concat,
+        yield_partials: bool = False,
+    ) -> 'FTuple[U] | Never':
         """Bind function ``f`` to the ``FTuple``.
 
-        :param ds: values to instantiate FTuple
-        :return: resulting FTuple
-        :raises ValueError: if given unknown merge_type
-
+        :param f: Function ``D -> FTuple[U]``
+        :param merge_type: ``MergeEnum`` to determine how to merge the result. 
+        :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_enum,
-                yield_partials=yield_partials
-            )
+            blend(*map(f, self), merge_enum=merge_type, yield_partials=yield_partials)
         )

pythonic_fp/containers/functional_tuple.pyi

@@ -0,0 +1,22 @@
+from collections.abc import Callable, Iterator
+from pythonic_fp.iterables.merging import MergeEnum
+from typing import Never, SupportsIndex, overload
+
+__all__ = ['FTuple']
+
+class FTuple[D](tuple[D, ...]):
+    def __reversed__(self) -> Iterator[D]: ...
+    def __eq__(self, other: object) -> bool: ...
+    @overload
+    def __getitem__(self, idx: SupportsIndex) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice) -> tuple[D, ...]: ...
+    def foldl[L](self, f: Callable[[L, D], L], /, start: L | None = None, default: L | None = None) -> L: ...
+    def foldr[R](self, f: Callable[[D, R], R], /, start: R | None = None, default: R | None = None) -> R: ...
+    def copy(self) -> FTuple[D]: ...
+    def __add__(self, other: object) -> tuple[D, ...]: ...
+    def __mul__(self, num: SupportsIndex) -> tuple[D, ...]: ...
+    def __rmul__(self, num: SupportsIndex) -> tuple[D, ...]: ...
+    def accummulate[L](self, f: Callable[[L, D], L], s: L | None = None, /) -> FTuple[L]: ...
+    def map[U](self, f: Callable[[D], U], /) -> FTuple[U]: ...
+    def bind[U](self, f: Callable[[D], FTuple[U]], merge_type: MergeEnum = ..., yield_partials: bool = False) -> FTuple[U] | Never: ...

pythonic_fp/containers/immutable_list.py

@@ -12,47 +12,36 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Pythonic FP - Immutable guaranteed hashable lists
-
-- hashable if elements are hashable
-- declared covariant in its generic datatype
-  - hashability should be enforced by LSP tooling
-  - hashability will be enforced at runtime
-  - IList addition supported via concatenation
-  - IList integer multiplication supported
-
-"""
-
-from __future__ import annotations
+"""Pythonic FP - Immutable guaranteed hashable lists."""
 
 from collections.abc import Callable, Iterable, Iterator, Hashable
-from typing import cast, Never, overload, TypeVar
+from typing import cast, Never, overload
 from pythonic_fp.iterables.folding import accumulate
 from pythonic_fp.iterables.merging import blend, concat, MergeEnum
 
 __all__ = ['IList']
 
-D = TypeVar('D', covariant=True)
-T = TypeVar('T')
 
 class IList[D](Hashable):
     """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
-    - hashability will be enforced by LSP tooling
     - supports both indexing and slicing
-    - addition concatenates results, resulting type a Union type
-    - both left and right int multiplication supported
+    - addition and left & right ``int`` multiplication supported
+
+      - addition is concatenation resulting in a union type
 
     """
+
     __slots__ = ('_ds', '_len', '_hash')
     __match_args__ = ('_ds', '_len')
 
-    L = TypeVar('L')
-    R = TypeVar('R')
-    U = TypeVar('U')
-
     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}'
             raise ValueError(msg)
@@ -98,9 +87,9 @@ class IList[D](Hashable):
     @overload
     def __getitem__(self, idx: int, /) -> D: ...
     @overload
-    def __getitem__(self, idx: slice, /) -> IList[D]: ...
+    def __getitem__(self, idx: slice, /) -> 'IList[D]': ...
 
-    def __getitem__(self, idx: slice | int, /) -> IList[D] | D:
+    def __getitem__(self, idx: slice | int, /) -> 'IList[D] | D':
         if isinstance(idx, slice):
             return IList(self._ds[idx])
         return self._ds[idx]
@@ -112,13 +101,13 @@ class IList[D](Hashable):
         start: L | None = None,
         default: L | None = None,
     ) -> L | None:
-        """Fold Left
-
-        - fold left with an optional starting value
-        - first argument of function ``f`` is for the accumulated value
-        
-        "raises ValueError: when empty and a start value not given
+        """Fold Left.
 
+        :param f: Folding function, first argument is for the accumulated value.
+        :param start: Optional starting value.
+        :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:
@@ -143,13 +132,13 @@ class IList[D](Hashable):
         start: R | None = None,
         default: R | None = None,
     ) -> R | None:
-        """Fold Right
-
-        - fold right with an optional starting value
-        - second argument of function ``f`` is for the accumulated value
-
-        "raises ValueError: when empty and a start value not given
+        """Fold Right.
 
+        :param f: Folding function, second argument is for the accumulated value.
+        :param start: Optional starting value.
+        :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:
@@ -167,52 +156,59 @@ class IList[D](Hashable):
             acc = f(v, acc)
         return acc
 
-    def __add__(self, other: IList[D], /) -> IList[D]:
+    def __add__(self, other: 'IList[D]', /) -> 'IList[D]':
         if not isinstance(other, IList):
-            msg = 'IList being added to something not a IList'
+            msg = 'IList being added to something not an IList'
             raise ValueError(msg)
 
         return IList(concat(self, other))
 
-    def __mul__(self, num: int, /) -> IList[D]:
+    def __mul__(self, num: int, /) -> 'IList[D]':
         return IList(self._ds.__mul__(num if num > 0 else 0))
 
-    def __rmul__(self, num: int, /) -> IList[D]:
+    def __rmul__(self, num: int, /) -> 'IList[D]':
         return IList(self._ds.__mul__(num if num > 0 else 0))
 
     def accummulate[L](
         self, f: Callable[[L, D], L], s: L | None = None, /
-    ) -> IList[L]:
-        """Accumulate partial folds
+    ) -> 'IList[L]':
+        """Accumulate partial folds.
 
-        Accumulate partial fold results in an IList with
-        an optional starting value.
+        Accumulate partial fold with an optional starting value,
+        results in an ``IList``.
 
+        :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))
         return IList(accumulate(self, f, s))
 
-    def map[U](self, f: Callable[[D], U], /) -> IList[U]:
+    def map[U](self, f: Callable[[D], U], /) -> 'IList[U]':
         return IList(map(f, self))
 
     def bind[U](
-            self,
-            f: Callable[[D], IList[U]],
-            merge_enum: MergeEnum = MergeEnum.Concat,
-            yield_partials: bool = False,
-        ) -> IList[U] | Never:
+        self,
+        f: 'Callable[[D], IList[U]]',
+        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]``
+        :param merge_type: ``MergeEnum`` to determine how to merge the result. 
+        :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
-            )
+            blend(*map(f, self), merge_enum=merge_enum, yield_partials=yield_partials)
         )

pythonic_fp/containers/immutable_list.pyi

@@ -0,0 +1,28 @@
+from _typeshed import Incomplete
+from collections.abc import Callable, Hashable, Iterable, Iterator
+from pythonic_fp.iterables.merging import MergeEnum
+from typing import Never, overload
+
+__all__ = ['IList']
+
+class IList[D](Hashable):
+    __match_args__: Incomplete
+    def __init__(self, *dss: Iterable[D]) -> None: ...
+    def __hash__(self) -> int: ...
+    def __iter__(self) -> Iterator[D]: ...
+    def __reversed__(self) -> Iterator[D]: ...
+    def __bool__(self) -> bool: ...
+    def __len__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    @overload
+    def __getitem__(self, idx: int) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice) -> IList[D]: ...
+    def foldl[L](self, f: Callable[[L, D], L], /, start: L | None = None, default: L | None = None) -> L | None: ...
+    def foldr[R](self, f: Callable[[D, R], R], /, start: R | None = None, default: R | None = None) -> R | None: ...
+    def __add__(self, other: IList[D]) -> IList[D]: ...
+    def __mul__(self, num: int) -> IList[D]: ...
+    def __rmul__(self, num: int) -> IList[D]: ...
+    def accummulate[L](self, f: Callable[[L, D], L], s: L | None = None, /) -> IList[L]: ...
+    def map[U](self, f: Callable[[D], U], /) -> IList[U]: ...
+    def bind[U](self, f: Callable[[D], IList[U]], merge_enum: MergeEnum = ..., yield_partials: bool = False) -> IList[U] | Never: ...

pythonic_fp_containers-4.0.0.dist-info/METADATA

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-containers
+Version: 4.0.0
+Summary: Container with FP interfaces
+Keywords: functional_containers,functional_tuple,immutable_list
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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: 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/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-containers
+Provides-Extra: test
+
+Pythonic FP - Containers
+========================
+
+PyPI project
+`pythonic-fp.containers
+<https://pypi.org/project/pythonic-fp.containers>`_.
+
+Python package of container like data structures with functional
+programming inspired tweaks.
+
++---------------------------------------------+-----------+------------------+
+| module                                      | class     | name             |
++=============================================+===========+==================+
+| ``pythonic_fp.containers.functional_tuple`` | FTuple    | Functional Tuple |
++---------------------------------------------+-----------+------------------+
+| ``pythonic_fp.containers.immutable_list``   | IList     | Immutable List   |
++---------------------------------------------+-----------+------------------+
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+PyPI projects.
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/containers/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_containers-4.0.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pythonic_fp/containers/__init__.py,sha256=48lsc3kU2Yf5IKjeExlOtO2ISwZv_1SWyL-e9OtP3VI,1346
+pythonic_fp/containers/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/containers/functional_tuple.py,sha256=aSFAnuAinT6XgLsRwh2JX1J6a6fFOJYS5N3TAUH5u0s,6518
+pythonic_fp/containers/functional_tuple.pyi,sha256=g8IvlIhPxecEsetEexZ7WmN9Ifdh-vAeK0z9SwLiCGE,1182
+pythonic_fp/containers/immutable_list.py,sha256=SoPYqIRgXbhfVC5dP9x1xYOIZqUrcIPH317A5bIPPos,7065
+pythonic_fp/containers/immutable_list.pyi,sha256=HRm0Updbx9UJpl5RI0prOwimSHDUJtM-3t2hEmYz6kw,1372
+pythonic_fp/containers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_containers-4.0.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_containers-4.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_containers-4.0.0.dist-info/METADATA,sha256=sTGVrVvUqjf7KyG-FzkvpdcMrzuaWLomCDKoRjwbPDE,2438
+pythonic_fp_containers-4.0.0.dist-info/RECORD,,

pythonic_fp/containers/queues/__init__.py

@@ -1,31 +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.
-
-"""Three types of queues.
-
-+------------------------------------+-----------+--------------------------+
-| module                             | Class     | description              |
-+====================================+===========+==========================+
-| pythonic_fp.containers.queues.fifo | FIFOQueue | First-In-First-Out queue |
-+------------------------------------+-----------+--------------------------+
-| pythonic_fp.containers.queues.lifo | LIFOQueue | Last-In-First-Out queue  |
-+------------------------------------+-----------+--------------------------+
-| pythonic_fp.containers.queues.de   | DEQueue   | Double-Ended queue       |
-+------------------------------------+-----------+--------------------------+
-
-"""
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'

pythonic_fp/containers/queues/de.py

@@ -1,180 +0,0 @@
-# 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.
-
-"""Stateful Double-Ended (DE) Queue data structure.
-
-- O(1) pops each end
-- O(1) amortized pushes each end
-- O(1) length determination
-- will automatically increase storage capacity when needed
-- in a Boolean context, true if not empty, false if empty
-- neither indexable nor sliceable by design
-
-"""
-from __future__ import annotations
-
-from collections.abc import Callable, Iterable, Iterator
-from typing import TypeVar
-from pythonic_fp.circulararray.auto import CA
-from pythonic_fp.fptools.maybe import MayBe
-
-__all__ = ['DEQueue', 'de_queue']
-
-D = TypeVar('D')
-
-
-class DEQueue[D]:
-
-    __slots__ = ('_ca',)
-
-    def __init__(self, *dss: Iterable[D]) -> None:
-        """Initial data in FIFO order, newest to oldest, as if
-        pushed on from the right side.
-
-        :param dss: takes up to one iterable
-        :raises ValueError: if more than 1 iterable is given
-
-        """
-        if (size := len(dss)) > 1:
-            msg = f'DEQueue expects at most 1 argument, got {size}'
-            raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
-
-    def __bool__(self) -> bool:
-        return len(self._ca) > 0
-
-    def __len__(self) -> int:
-        return len(self._ca)
-
-    def __eq__(self, other: object) -> bool:
-        if not isinstance(other, DEQueue):
-            return False
-        return self._ca == other._ca
-
-    def __iter__(self) -> Iterator[D]:
-        return iter(list(self._ca))
-
-    def __reversed__(self) -> Iterator[D]:
-        return reversed(list(self._ca))
-
-    def __repr__(self) -> str:
-        if len(self) == 0:
-            return 'DEQueue()'
-        return 'DEQueue(' + ', '.join(map(repr, self._ca)) + ')'
-
-    def __str__(self) -> str:
-        return '>< ' + ' | '.join(map(str, self)) + ' ><'
-
-    def copy(self) -> DEQueue[D]:
-        """Shallow copy.
-
-        :return: shallow copy of the DEQueue
-
-        """
-        return DEQueue(self._ca)
-
-    def pushl(self, *ds: D) -> None:
-        """Push data onto left side of DEQueue.
-
-        :param ds: items to be pushed onto DEQueue from the left
-
-        """
-        self._ca.pushl(*ds)
-
-    def pushr(self, *ds: D) -> None:
-        """Push data onto right side of DEQueue.
-
-        :param ds: items to be pushed onto DEQueue from the right
-
-        """
-        self._ca.pushr(*ds)
-
-    def popl(self) -> MayBe[D]:
-        """Pop next data item from left side DEQueue, if it exists.
-
-        :return: MayBe of popped item if queue was not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca.popl())
-        return MayBe()
-
-    def popr(self) -> MayBe[D]:
-        """Pop next item off right side DEQueue.
-
-        :return: MayBe of popped item if queue was not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca.popr())
-        return MayBe()
-
-    def peakl(self) -> MayBe[D]:
-        """Peak at data on left side of DEQueue.
-
-        :return: MayBe of leftmost data if queue not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca[0])
-        return MayBe()
-
-    def peakr(self) -> MayBe[D]:
-        """Peak at right side of DEQueue. Does not consume item.
-
-        :return: MayBe of rightmost data if queue not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca[-1])
-        return MayBe()
-
-    def foldl[L](self, f: Callable[[L, D], L], start: L | None = None) -> MayBe[L]:
-        """Reduces DEQueue left to right.
-
-        :param f: reducing function, first argument is for accumulator
-        :param start: optional starting value
-        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
-
-        """
-        if start is None:
-            if not self._ca:
-                return MayBe()
-        return MayBe(self._ca.foldl(f, start))
-
-    def foldr[R](self, f: Callable[[D, R], R], start: R | None = None) -> MayBe[R]:
-        """Reduces DEQueue right to left.
-
-        :param f: reducing function, second argument is for accumulator
-        :param start: optional starting value
-        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
-
-        """
-        if start is None:
-            if not self._ca:
-                return MayBe()
-        return MayBe(self._ca.foldr(f, start))
-
-    def map[U](self, f: Callable[[D], U]) -> DEQueue[U]:
-        """Map f over the DEQueue left to right, retain original order.
-
-        :return: new DEQueue instance
-
-        """
-        return DEQueue(map(f, self._ca))
-
-
-def de_queue[D](*ds: D) -> DEQueue[D]:
-    """DEQueue factory function."""
-    return DEQueue(ds)

pythonic_fp/containers/queues/fifo.py

@@ -1,145 +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.
-
-"""Stateful First-In-First-Out (FIFO) Queue data structure.
-
-- O(1) pops
-- O(1) amortized pushes
-- in a Boolean context, true if not empty, false if empty
-- will automatically increase storage capacity when needed
-- neither indexable nor sliceable by design
-- O(1) length determination
-
-"""
-from __future__ import annotations
-
-from collections.abc import Callable, Iterable, Iterator
-from typing import TypeVar
-from pythonic_fp.circulararray.auto import CA
-from pythonic_fp.fptools.maybe import MayBe
-
-__all__ = ['FIFOQueue', 'fifo_queue']
-
-D = TypeVar('D')
-
-
-class FIFOQueue[D]:
-
-    __slots__ = ('_ca',)
-
-    def __init__(self, *dss: Iterable[D]) -> None:
-        """Initial data in natural FIFO order, newest to oldest.
-
-        :param dss: takes up to one iterable
-        :raises ValueError: if more than 1 iterable is given
-
-        """
-        if (size := len(dss)) > 1:
-            msg = f'FIFOQueue expects at most 1 iterable argument, got {size}'
-            raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
-
-    def __bool__(self) -> bool:
-        return len(self._ca) > 0
-
-    def __len__(self) -> int:
-        return len(self._ca)
-
-    def __eq__(self, other: object) -> bool:
-        if not isinstance(other, FIFOQueue):
-            return False
-        return self._ca == other._ca
-
-    def __iter__(self) -> Iterator[D]:
-        return iter(list(self._ca))
-
-    def __repr__(self) -> str:
-        if len(self) == 0:
-           return 'FIFOQueue()'
-        return 'FIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
-
-    def __str__(self) -> str:
-        return '<< ' + ' < '.join(map(str, self)) + ' <<'
-
-    def copy(self) -> FIFOQueue[D]:
-        """Shallow copy.
-
-        :return: shallow copy of the FIFOQueue
-
-        """
-        return FIFOQueue(self._ca)
-
-    def push(self, *ds: D) -> None:
-        """Push data onto FIFOQueue.
-
-        :param ds: data items to be pushed onto FIFOQueue
-
-        """
-        self._ca.pushr(*ds)
-
-    def pop(self) -> MayBe[D]:
-        """Pop oldest data item off of FIFOQueue.
-
-        :return: MayBe of popped data item if queue was not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca.popl())
-        return MayBe()
-
-    def peak_last_in(self) -> MayBe[D]:
-        """Peak at newest data item on queue.
-
-        :return: MayBe of newest data item on queue, empty MayBe if queue empty
-        
-        """
-        if self._ca:
-            return MayBe(self._ca[-1])
-        return MayBe()
-
-    def peak_next_out(self) -> MayBe[D]:
-        """Peak at oldest data item on queue.
-
-        :return: MayBe of oldest data item on queue, empty MayBe if queue empty
-
-        """
-        if self._ca:
-            return MayBe(self._ca[0])
-        return MayBe()
-
-    def fold[T](self, f: Callable[[T, D], T], start: T | None = None) -> MayBe[T]:
-        """Reduces FIFOQueue in natural FIFO Order, oldest to newest.
-
-        :param f: reducing function, first argument is for accumulator
-        :param start: optional starting value
-        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
-
-        """
-        if start is None:
-            if not self._ca:
-                return MayBe()
-        return MayBe(self._ca.foldl(f, start))
-
-    def map[U](self, f: Callable[[D], U]) -> FIFOQueue[U]:
-        """Map f over the FIFOQueue, retain original order.
-
-        :return: new FIFOQueue instance
-
-        """
-        return FIFOQueue(map(f, self._ca))
-
-
-def fifo_queue[D](*ds: D) -> FIFOQueue[D]:
-    """FIFOQueue factory function."""
-    return FIFOQueue(ds)

pythonic_fp/containers/queues/lifo.py

@@ -1,136 +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.
-
-"""Stateful Last-In-First-Out (LIFO) Queue data structure.
-
-- O(1) pops
-- O(1) amortized pushes
-- in a Boolean context, true if not empty, false if empty
-- will automatically increase storage capacity when needed
-- neither indexable nor sliceable by design
-- O(1) length determination
-
-"""
-from __future__ import annotations
-
-from collections.abc import Callable, Iterable, Iterator
-from typing import TypeVar
-from pythonic_fp.circulararray.auto import CA
-from pythonic_fp.fptools.function import swap
-from pythonic_fp.fptools.maybe import MayBe
-
-__all__ = ['LIFOQueue', 'lifo_queue']
-
-D = TypeVar('D')
-
-
-class LIFOQueue[D]:
-
-    __slots__ = ('_ca',)
-
-    def __init__(self, *dss: Iterable[D]) -> None:
-        """Initial data in natural LIFO order, oldest to newest.
-
-        :param dss: takes up to one iterable
-        :raises ValueError: if more than 1 iterable is given
-
-        """
-        if (size := len(dss)) > 1:
-            msg = f'LIFOQueue expects at most 1 iterable argument, got {size}'
-            raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
-
-    def __bool__(self) -> bool:
-        return len(self._ca) > 0
-
-    def __len__(self) -> int:
-        return len(self._ca)
-
-    def __eq__(self, other: object) -> bool:
-        if not isinstance(other, LIFOQueue):
-            return False
-        return self._ca == other._ca
-
-    def __iter__(self) -> Iterator[D]:
-        return reversed(list(self._ca))
-
-    def __repr__(self) -> str:
-        if len(self) == 0:
-            return 'LIFOQueue()'
-        return 'LIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
-
-    def __str__(self) -> str:
-        return '|| ' + ' > '.join(map(str, self)) + ' ><'
-
-    def copy(self) -> LIFOQueue[D]:
-        """Shallow copy.
-
-        :return: shallow copy of the LIFOQueue
-
-        """
-        return LIFOQueue(reversed(self._ca))
-
-    def push(self, *ds: D) -> None:
-        """Push data onto LIFOQueue.
-
-        :param ds: data items to be pushed onto LIFOQueue
-
-        """
-        self._ca.pushr(*ds)
-
-    def pop(self) -> MayBe[D]:
-        """Pop newest data item off of LIFOQueue.
-
-        :return: MayBe of popped data item if queue was not empty, empty MayBe otherwise
-
-        """
-        if self._ca:
-            return MayBe(self._ca.popr())
-        return MayBe()
-
-    def peak(self) -> MayBe[D]:
-        """Peak at newest data item on queue.
-
-        :return: MayBe of newest data item on queue, empty MayBe if queue empty
-
-        """
-        if self._ca:
-            return MayBe(self._ca[-1])
-        return MayBe()
-
-    def fold[T](self, f: Callable[[T, D], T], start: T | None = None) -> MayBe[T]:
-        """Reduces LIFOQUEUE in natural LIFO Order, newest to oldest.
-
-        :param f: reducing function, first argument is for accumulator
-        :param start: optional starting value
-        :return: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given
-
-        """
-        if start is None:
-            if not self._ca:
-                return MayBe()
-        return MayBe(self._ca.foldr(swap(f), start))
-
-    def map[U](self, f: Callable[[D], U]) -> LIFOQueue[U]:
-        """Map f over the LIFOQueue, retain original order.
-
-        :return: new LIFOQueue instance
-
-        """
-        return LIFOQueue(reversed(CA(map(f, reversed(self._ca)))))
-
-
-def lifo_queue[D](*ds: D) -> LIFOQueue[D]:
-    """LIFOQueue factory function."""
-    return LIFOQueue(ds)

pythonic_fp_containers-3.0.0.dist-info/METADATA

@@ -1,63 +0,0 @@
-Metadata-Version: 2.4
-Name: pythonic-fp-containers
-Version: 3.0.0
-Summary: Package of container like data structures.
-Keywords: boxes,functional_tuple,immutable_list,queue,fifo,lifo,dqueue,dequeue
-Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.12
-Description-Content-Type: text/x-rst
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: Pytest
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Typing :: Typed
-License-File: LICENSE
-Requires-Dist: pythonic-fp-circulararray>= 5.3.0
-Requires-Dist: pythonic-fp-fptools>=5.0.0
-Requires-Dist: pythonic-fp-iterables>=5.0.0
-Requires-Dist: pythonic-fp-singletons>=1.0.0
-Requires-Dist: pytest>=8.4.1 ; extra == "test"
-Requires-Dist: pythonic-fp-splitends>=1.0.0 ; 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/releases.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
-Project-URL: Source, https://github.com/grscheller/pythonic-fp-containers
-Provides-Extra: test
-
-Pythonic FP - Containers
-========================
-
-PyPI project
-`pythonic-fp.containers <https://pypi.org/project/pythonic-fp.containers>`_.
-
-Python package of container like data structures.
-
-+------------------+------------------------------------------------------+
-| Description      |                        Module                        |
-+==================+======================================================+
-| Single item box  | *module* ``pythonic_fp.containers.box``              |
-| Functional tuple | *module* ``pythonic_fp.containers.functional_tuple`` |
-| Immutable list   | *module* ``pythonic_fp.containers.immutable_list``   |
-+------------------+------------------------------------------------------+
-
-**DEPRECATION WARNING:** ``pythonic_fp.fptools.box`` as been deprecated.
-Use ``pythonic_fp.box`` instead.
-
-This PyPI project is part of of the grscheller
-`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/containers/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_containers-3.0.0.dist-info/RECORD

@@ -1,13 +0,0 @@
-pythonic_fp/containers/__init__.py,sha256=N5-djJadhpE6h8bg31AtUrqami8RPjsiUYwlwrPpYnI,1603
-pythonic_fp/containers/functional_tuple.py,sha256=AffGbovvg0WpnImZwzhD47djLps27Ns29eKzFosXOC4,5799
-pythonic_fp/containers/immutable_list.py,sha256=SGfGKRyDyBylrNn9qvpoKog531RKAusRsxhtnVa5Rps,6677
-pythonic_fp/containers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/containers/queues/__init__.py,sha256=GJdzodYt32pADih2UHOiR9U4jfZ6SQSw6PsCYZ2r1wg,1459
-pythonic_fp/containers/queues/de.py,sha256=lBoZE8SRe6__NEFpNiqKhumDtdIVvm7S7HMojEUAL1s,5288
-pythonic_fp/containers/queues/fifo.py,sha256=Q9luMfZzSJzGU3aJwnJ5OIeT6hs-6ieh70b5wYGodI4,4221
-pythonic_fp/containers/queues/lifo.py,sha256=xudvLpEvqv9bl3bCqTiwlC2IDZ9A5kHVl-aIjNAKyeA,4031
-pythonic_fp/containers/queues/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_containers-3.0.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_containers-3.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_containers-3.0.0.dist-info/METADATA,sha256=UeoEZi26JqOUc0AYxcwpr8FrxsNEA7XOu5IMySlm_jk,2672
-pythonic_fp_containers-3.0.0.dist-info/RECORD,,