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

pythonic_fp/queues/de.py

@@ -38,18 +38,22 @@ class DEQueue[D]:
 
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable left to right.
+        .. admonition:: Initializer
+
+            Initialize ``DEQueue`` with 0 or 1 iterables to populate
+            the queue left (front) to right (rear).
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 1:
             msg = f'DEQueue expects at most 1 argument, got {size}'
             raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -61,9 +65,25 @@ class DEQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``DEQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``DEQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, DEQueue):
             return False
         return self._ca == other._ca
@@ -91,20 +111,40 @@ class DEQueue[D]:
         return reversed(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'DEQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``DEQueue``.
+
+        """
         if len(self) == 0:
             return 'DEQueue()'
         return 'DEQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        r"""
+        .. admonition:: User string
+
+            Construct string '>< d₁ | d₂ | … | dₙ ><' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '>< ' + ' | '.join(map(str, self)) + ' ><'
 
     def copy(self) -> 'DEQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the queue.
+            Shallow copy the ``DEQueue``.
 
-        :returns: Shallow copy of the ``DEQueue``.
+        :returns: New ``DEQueue`` instance containing the same references.
 
         """
         return DEQueue(self._ca)
@@ -200,7 +240,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
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe`` if
                   queue empty and no starting value given.
 
         """
@@ -223,8 +263,8 @@ 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.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if queue empty and no starting value given.
 
         """
         if start is None:

pythonic_fp/queues/fifo.py

@@ -37,18 +37,22 @@ class FIFOQueue[D]:
 
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable in FIFO order.
+        .. admonition:: Initializer
+
+            Initialize ``FIFOQueue`` with 0 or 1 iterables to populate
+            the queue in natural FIFO order.
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 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()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -60,9 +64,25 @@ class FIFOQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``FIFOQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``FIFOQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, FIFOQueue):
             return False
         return self._ca == other._ca
@@ -79,20 +99,40 @@ class FIFOQueue[D]:
         return iter(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'FIFOQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``FIFOQueue``.
+
+        """
         if len(self) == 0:
            return 'FIFOQueue()'
         return 'FIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        """
+        .. admonition:: User string
+
+            Construct string '<< d₁ < d₂ < … < dₙ <<' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '<< ' + ' < '.join(map(str, self)) + ' <<'
 
     def copy(self) -> 'FIFOQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the ``FIFOQueue``.
+            Shallow copy the ``FIFOQueue``.
 
-        :returns: Shallow copy of the ``FIFOQueue``.
+        :returns: New ``FIFOQueue`` instance containing the same references.
 
         """
         return FIFOQueue(self._ca)
@@ -163,8 +203,8 @@ 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 ``FIFOQueue``
-                  empty and no starting value given.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if ``FIFOQueue`` empty and no starting value given.
 
         """
         if start is None:

pythonic_fp/queues/lifo.py

@@ -37,18 +37,22 @@ class LIFOQueue[D]:
     """
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable in LIFO order.
+        .. admonition:: Initializer
+
+            Initialize ``LIFOQueue`` with 0 or 1 iterables to populate
+            the queue in natural LIFO order.
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 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()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -60,9 +64,25 @@ class LIFOQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``LIFOQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``LIFOQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, LIFOQueue):
             return False
         return self._ca == other._ca
@@ -79,26 +99,49 @@ class LIFOQueue[D]:
         return reversed(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'LIFOQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``LIFOQueue``.
+
+        """
         if len(self) == 0:
             return 'LIFOQueue()'
         return 'LIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        r"""
+        .. admonition:: User string
+
+            Construct string '|| d₁ > d₂ > … > dₙ ><' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '|| ' + ' > '.join(map(str, self)) + ' ><'
 
     def copy(self) -> 'LIFOQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the ``LIFOQueue``.
+            Shallow copy the ``LIFOQueue``.
 
-        :returns: Shallow copy of the ``LIFOQueue``.
+        :returns: New ``LIFOQueue`` instance containing the same references.
 
         """
         return LIFOQueue(reversed(self._ca))
 
     def push(self, *ds: D) -> None:
-        """Push items onto LIFOQueue.
+        """
+        .. admonition:: Push
+
+            Push items onto ``LIFOQueue``.
 
         :param ds: Items to be pushed onto ``LIFOQueue``.
 
@@ -145,8 +188,8 @@ 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 ``LIFOQueue``
-                  empty and no starting value given.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if ``LIFOQueue`` empty and no starting value given.
 
         """
         if start is None:

{pythonic_fp_queues-5.1.2.dist-info → pythonic_fp_queues-5.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-queues
-Version: 5.1.2
+Version: 5.1.3
 Summary: Queues
 Keywords: queue,fifo,lifo,dqueue
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -16,6 +16,7 @@ Classifier: Typing :: Typed
 License-File: LICENSE
 Requires-Dist: pythonic-fp-circulararray>=6.0.4
 Requires-Dist: pythonic-fp-fptools>=5.2.0
+Requires-Dist: pythonic-fp-gadgets>=4.1.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/projects/queues.html

{pythonic_fp_queues-5.1.2.dist-info → pythonic_fp_queues-5.1.3.dist-info}/RECORD

@@ -1,13 +1,13 @@
 pythonic_fp/queues/__init__.py,sha256=NOkkXOQaHmiemvY4Ke5ZdFJCl3_P3bmV87Xz5Y-R9cU,1028
 pythonic_fp/queues/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/queues/de.py,sha256=hRFeogJ4XuXRFV4xOpD3mLoNo1jklP4uT5Ilrw-PiJg,7456
+pythonic_fp/queues/de.py,sha256=ICPHkGz0JKIk8aLk75ZUSPS6T9jSTynkJ-2A5Sy_iig,8532
 pythonic_fp/queues/de.pyi,sha256=db74UiSLFme25Yhc28Hhw3EKb2GfvU4wNBJtkTlr_e4,1150
-pythonic_fp/queues/fifo.py,sha256=EvZub5bRsW3xqCbREKz8dXIt3heBmzsDOzJQuF6Mm30,5728
+pythonic_fp/queues/fifo.py,sha256=qQhv57VuF2QuaRtGJhCtj5qtGPjoGKlQS9RbZIGsvmY,6803
 pythonic_fp/queues/fifo.pyi,sha256=19TGU3Qg91hCLo5A-5p9vmREcl38EUWhIAvJZtlb1eA,885
-pythonic_fp/queues/lifo.py,sha256=_uBM9XnZMm-OYEDhAHPdcHBy_C6h2d0B0dTpoXaJ62A,5348
+pythonic_fp/queues/lifo.py,sha256=lQAzoCOzQrw3gF2A_GgF_4XkYpNivswPyZS-Qp5bxYw,6471
 pythonic_fp/queues/lifo.pyi,sha256=HdJ-t7R2w3VfCT06raCTXespdUZfpBgMepBlcxDvyuk,832
 pythonic_fp/queues/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_queues-5.1.2.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_queues-5.1.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_queues-5.1.2.dist-info/METADATA,sha256=fzVKSB2LG3S9c78klIzZ6zvaH1JT4mfRa6NZzZiD7d0,2350
-pythonic_fp_queues-5.1.2.dist-info/RECORD,,
+pythonic_fp_queues-5.1.3.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_queues-5.1.3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_queues-5.1.3.dist-info/METADATA,sha256=CeQO0Dt1zxfeu94F7ziEET_hegfeZUjlpzzoIzzdQr4,2392
+pythonic_fp_queues-5.1.3.dist-info/RECORD,,