pythonic-fp-queues 5.1.0__tar.gz → 5.1.1__tar.gz

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/CHANGELOG.rst

@@ -17,6 +17,11 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 5.1.1 - 2026-01-15
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements for updated Sphinx documentation.
+
 PyPI 5.1.0 - 2025-09-25
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-queues
-Version: 5.1.0
+Version: 5.1.1
 Summary: Queues
 Keywords: queue,fifo,lifo,dqueue
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -14,12 +14,12 @@ 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-circulararray>=6.0.1
+Requires-Dist: pythonic-fp-fptools>=5.2.0
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/queues/development/build/html/index.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/queues/development/build/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-queues
 Provides-Extra: test
 
@@ -42,7 +42,7 @@ PyPI project
 
 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
@@ -50,7 +50,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/queues/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/queues>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/README.rst

@@ -17,7 +17,7 @@ PyPI project
 
 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
@@ -25,7 +25,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/queues/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/queues>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-queues"
-version = "5.1.0"
+version = "5.1.1"
 readme = "README.rst"
 requires-python = ">=3.12"
 license = { file = "LICENSE" }
@@ -16,15 +16,15 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-circulararray>=6.0.0",
-  "pythonic-fp-fptools>=5.1.2",
+  "pythonic-fp-circulararray>=6.0.1",
+  "pythonic-fp-fptools>=5.2.0",
 ]
 dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/queues/development/build/html/index.html"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Documentation = "https://grscheller.github.io/pythonic-fp/queues/development/build/html/"
+Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
 Source = "https://github.com/grscheller/pythonic-fp-queues"
 
 [project.optional-dependencies]

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/src/pythonic_fp/queues/__init__.py

@@ -14,7 +14,13 @@
 
 """
 Queues
-======
+------
+
+.. admonition:: Stateful Queues based on a circular array.
+
+    Geared to specific algorithms by limiting what can be done with the
+    queues. Sometimes the power of a data structure is not what it
+    empowers you to do, but what it prevents you from doing to yourself.
 
 +-------------------------+-----------+--------------------------+
 | module                  | class     | name                     |
@@ -29,5 +35,5 @@ Queues
 """
 
 __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_queues-5.1.0 → pythonic_fp_queues-5.1.1}/src/pythonic_fp/queues/de.py

@@ -39,6 +39,7 @@ class DEQueue[D]:
         :param dss: "Optionally" takes a single iterable to initialize data in FIFO order.
         :raises TypeError: When ``dss[0]`` not 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}'
@@ -74,6 +75,7 @@ class DEQueue[D]:
         """Shallow copy.
 
         :returns: Shallow copy of the DEQueue.
+
         """
         return DEQueue(self._ca)
 
@@ -81,6 +83,7 @@ class DEQueue[D]:
         """Push data onto left side of DEQueue.
 
         :param ds: Items to be pushed onto DEQueue from the left.
+
         """
         self._ca.pushl(*ds)
 
@@ -88,6 +91,7 @@ class DEQueue[D]:
         """Push data onto right side of DEQueue.
 
         :param ds: Items to be pushed onto DEQueue from the right.
+
         """
         self._ca.pushr(*ds)
 
@@ -95,6 +99,7 @@ class DEQueue[D]:
         """Pop next item from left side DEQueue, if it exists.
 
         :returns: MayBe of popped item if queue was not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca.popl())
@@ -104,6 +109,7 @@ class DEQueue[D]:
         """Pop next item off right side DEQueue, if it exists.
 
         :returns: MayBe of popped item if queue was not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca.popr())
@@ -113,6 +119,7 @@ class DEQueue[D]:
         """Peak left side of DEQueue. Does not consume item.
 
         :returns: MayBe of leftmost item if queue not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca[0])
@@ -122,6 +129,7 @@ class DEQueue[D]:
         """Peak right side of DEQueue. Does not consume item.
 
         :returns: MayBe of rightmost item if queue not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca[-1])
@@ -138,6 +146,7 @@ class DEQueue[D]:
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
         :returns: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given.
+
         """
         if start is None:
             if not self._ca:
@@ -156,6 +165,7 @@ class DEQueue[D]:
         :param f: Reducing function, second argument is for accumulator.
         :param start: Optional starting value.
         :returns: MayBe of reduced value with f, empty MayBe if queue empty and no starting value given.
+
         """
         if start is None:
             if not self._ca:
@@ -172,6 +182,7 @@ class DEQueue[D]:
 
         :param f: Function to map over queue.
         :returns: New DEQueue instance, retain original order.
+
         """
         return DEQueue(map(f, self._ca))
 
@@ -181,5 +192,6 @@ def de_queue[D](*ds: D) -> DEQueue[D]:
 
     :param ds: Initial items as if pushed on from right to left.
     :returns: DEQueue with items initialized in FIFO order.
+
     """
     return DEQueue(ds)

pythonic_fp_queues-5.1.1/src/pythonic_fp/queues/de.pyi

@@ -0,0 +1,31 @@
+from collections.abc import Callable, Iterable, Iterator
+from pythonic_fp.fptools.maybe import MayBe
+from typing import overload
+
+__all__ = ['DEQueue', 'de_queue']
+
+class DEQueue[D]:
+    def __init__(self, *dss: Iterable[D]) -> None: ...
+    def __bool__(self) -> bool: ...
+    def __len__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __iter__(self) -> Iterator[D]: ...
+    def __reversed__(self) -> Iterator[D]: ...
+    def copy(self) -> DEQueue[D]: ...
+    def pushl(self, *ds: D) -> None: ...
+    def pushr(self, *ds: D) -> None: ...
+    def popl(self) -> MayBe[D]: ...
+    def popr(self) -> MayBe[D]: ...
+    def peakl(self) -> MayBe[D]: ...
+    def peakr(self) -> MayBe[D]: ...
+    @overload
+    def foldl[L](self, f: Callable[[D, D], D]) -> MayBe[D]: ...
+    @overload
+    def foldl[L](self, f: Callable[[L, D], L], start: L) -> MayBe[L]: ...
+    @overload
+    def foldr[R](self, f: Callable[[D, D], D]) -> MayBe[D]: ...
+    @overload
+    def foldr[R](self, f: Callable[[D, R], R], start: R) -> MayBe[R]: ...
+    def map[U](self, f: Callable[[D], U]) -> DEQueue[U]: ...
+
+def de_queue[D](*ds: D) -> DEQueue[D]: ...

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/src/pythonic_fp/queues/fifo.py

@@ -38,6 +38,7 @@ class FIFOQueue[D]:
         """
         :param dss: Takes 1 or 0 iterables, initializes items in natural FIFO order.
         :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}'
@@ -70,6 +71,7 @@ class FIFOQueue[D]:
         """Shallow copy.
 
         :returns: Shallow copy of the FIFOQueue.
+
         """
         return FIFOQueue(self._ca)
 
@@ -77,6 +79,7 @@ class FIFOQueue[D]:
         """Push items onto FIFOQueue.
 
         :param ds: Items to be pushed onto FIFOQueue.
+
         """
         self._ca.pushr(*ds)
 
@@ -84,6 +87,7 @@ class FIFOQueue[D]:
         """Pop oldest data item off of FIFOQueue.
 
         :returns: MayBe of popped data item if queue was not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca.popl())
@@ -93,6 +97,7 @@ class FIFOQueue[D]:
         """Peak at newest item on queue.
 
         :returns: MayBe of newest item on queue, empty MayBe if queue empty.
+
         """
         if self._ca:
             return MayBe(self._ca[-1])
@@ -102,6 +107,7 @@ class FIFOQueue[D]:
         """Peak at oldest data item on queue.
 
         :returns: MayBe of oldest item on queue, empty MayBe if queue empty.
+
         """
         if self._ca:
             return MayBe(self._ca[0])
@@ -118,6 +124,7 @@ class FIFOQueue[D]:
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
         :returns: MayBe of reduced value, empty MayBe if queue empty and no starting value given.
+
         """
         if start is None:
             if not self._ca:
@@ -130,6 +137,7 @@ class FIFOQueue[D]:
 
         :param f: Function to map over queue.
         :returns: New FIFOQueue instance.
+
         """
         return FIFOQueue(map(f, self._ca))
 
@@ -139,5 +147,6 @@ def fifo_queue[D](*ds: D) -> FIFOQueue[D]:
 
     :param ds: Initial items pushed on in FIFO order.
     :returns: FIFOQueue with initialized items from ``ds``.
+
     """
     return FIFOQueue(ds)

pythonic_fp_queues-5.1.1/src/pythonic_fp/queues/fifo.pyi

@@ -0,0 +1,24 @@
+from collections.abc import Callable, Iterable, Iterator
+from pythonic_fp.fptools.maybe import MayBe
+from typing import overload
+
+__all__ = ['FIFOQueue', 'fifo_queue']
+
+class FIFOQueue[D]:
+    def __init__(self, *dss: Iterable[D]) -> None: ...
+    def __bool__(self) -> bool: ...
+    def __len__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __iter__(self) -> Iterator[D]: ...
+    def copy(self) -> FIFOQueue[D]: ...
+    def push(self, *ds: D) -> None: ...
+    def pop(self) -> MayBe[D]: ...
+    def peak_last_in(self) -> MayBe[D]: ...
+    def peak_next_out(self) -> MayBe[D]: ...
+    @overload
+    def fold[T](self, f: Callable[[D, D], D]) -> MayBe[D]: ...
+    @overload
+    def fold[T](self, f: Callable[[T, D], T], start: T) -> MayBe[T]: ...
+    def map[U](self, f: Callable[[D], U]) -> FIFOQueue[U]: ...
+
+def fifo_queue[D](*ds: D) -> FIFOQueue[D]: ...

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.1}/src/pythonic_fp/queues/lifo.py

@@ -38,6 +38,7 @@ class LIFOQueue[D]:
         """
         :param dss: Takes 1 or 0 iterables, initializes data in natural LIFO order.
         :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}'
@@ -70,6 +71,7 @@ class LIFOQueue[D]:
         """Shallow copy.
 
         :returns: Shallow copy of the LIFOQueue.
+
         """
         return LIFOQueue(reversed(self._ca))
 
@@ -77,6 +79,7 @@ class LIFOQueue[D]:
         """Push items onto LIFOQueue.
 
         :param ds: Items to be pushed onto LIFOQueue.
+
         """
         self._ca.pushr(*ds)
 
@@ -84,6 +87,7 @@ class LIFOQueue[D]:
         """Pop newest data item off of LIFOQueue.
 
         :returns: MayBe of popped item if queue was not empty, empty MayBe otherwise.
+
         """
         if self._ca:
             return MayBe(self._ca.popr())
@@ -93,6 +97,7 @@ class LIFOQueue[D]:
         """Peak at newest item on queue.
 
         :returns: MayBe of newest item on queue, empty MayBe if queue empty.
+
         """
         if self._ca:
             return MayBe(self._ca[-1])
@@ -109,6 +114,7 @@ class LIFOQueue[D]:
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
         :returns: MayBe of reduced value, empty MayBe if queue empty and no starting value given.
+
         """
         if start is None:
             if not self._ca:
@@ -121,6 +127,7 @@ class LIFOQueue[D]:
 
         :param f: Function to map over queue.
         :returns: New LIFOQueue instance.
+
         """
         return LIFOQueue(reversed(CA(map(f, reversed(self._ca)))))
 
@@ -130,5 +137,6 @@ def lifo_queue[D](*ds: D) -> LIFOQueue[D]:
 
     :param ds: Initial items pushed on in LIFO order.
     :returns: LIFOQueue with initialized items from ``ds``.
+
     """
     return LIFOQueue(ds)

pythonic_fp_queues-5.1.1/src/pythonic_fp/queues/lifo.pyi

@@ -0,0 +1,23 @@
+from collections.abc import Callable, Iterable, Iterator
+from pythonic_fp.fptools.maybe import MayBe
+from typing import overload
+
+__all__ = ['LIFOQueue', 'lifo_queue']
+
+class LIFOQueue[D]:
+    def __init__(self, *dss: Iterable[D]) -> None: ...
+    def __bool__(self) -> bool: ...
+    def __len__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __iter__(self) -> Iterator[D]: ...
+    def copy(self) -> LIFOQueue[D]: ...
+    def push(self, *ds: D) -> None: ...
+    def pop(self) -> MayBe[D]: ...
+    def peak(self) -> MayBe[D]: ...
+    @overload
+    def fold[T](self, f: Callable[[D, D], D]) -> MayBe[D]: ...
+    @overload
+    def fold[T](self, f: Callable[[T, D], T], start: T) -> MayBe[T]: ...
+    def map[U](self, f: Callable[[D], U]) -> LIFOQueue[U]: ...
+
+def lifo_queue[D](*ds: D) -> LIFOQueue[D]: ...