pythonic-fp-circulararray 6.1.1__py3-none-any.whl → 6.2.1__py3-none-any.whl

pythonic_fp/circulararray/auto.py

@@ -13,7 +13,8 @@
 # limitations under the License.
 
 from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Final, overload
+from typing import Final, cast, overload
+
 from pythonic_fp.gadgets.sentinels.novalue import NoValue
 
 __all__ = ['CA', 'ca']
@@ -30,13 +31,14 @@ class CA[X]:
         - O(1) indexing, fully supports slicing
         - auto-resizing more storage capacity when necessary,
           manually compatible
-        - iterable but not threadsafe
+        - iterable (see __iter__ method below)
         - comparisons compare identity before equality, like builtins
         - in boolean context, falsy when empty, otherwise truthy
         - function ``ca`` produces auto-resizing circular array
           from arguments
 
     """
+
     __slots__ = '_xs', '_cnt', '_cap', '_front', '_rear'
 
     def __init__(self, *xs: Iterable[X]) -> None:
@@ -46,7 +48,7 @@ class CA[X]:
             Populate ``CA`` with an optional iterable
             from front (left) to rear (right).
 
-            :param xs: Takes 0 or 1 iterable parameters.
+            :param xs: Takes an optional iterable parameter.
             :raises ValueError: When more than one parameter is provided.
             :raises TypeError: When passed a non-iterable parameter.
 
@@ -83,9 +85,7 @@ class CA[X]:
                 self._front,
                 self._cap,
             ) = (
-                self._xs[: self._front]
-                + [nada] * self._cap
-                + self._xs[self._front :],
+                self._xs[: self._front] + [nada] * self._cap + self._xs[self._front :],
                 self._front + self._cap,
                 2 * self._cap,
             )
@@ -169,64 +169,17 @@ class CA[X]:
         """
         return self._cnt
 
-    def __eq__(self, other: object) -> bool:
-        """
-        .. admonition:: equality comparison
-
-            Efficiently compare ``CA`` to another object.
-
-            :param other: The object to be compared.
-            :returns: ``True`` if ``other`` is another ``CA`` whose
-                      contents compare as equal to the corresponding
-                      contents of the ``CA``, otherwise ``False``.
-
-        """
-        if self is other:
-            return True
-        if not isinstance(other, type(self)):
-            return False
-
-        (
-            front1,
-            cnt1,
-            capacity1,
-            front2,
-            cnt2,
-            capacity2,
-        ) = (
-            self._front,
-            self._cnt,
-            self._cap,
-            other._front,
-            other._cnt,
-            other._cap,
-        )
-
-        if cnt1 != cnt2:
-            return False
-
-        for nn in range(cnt1):
-            if (
-                self._xs[(front1 + nn) % capacity1]
-                is other._xs[(front2 + nn) % capacity2]
-            ):
-                continue
-            if (
-                self._xs[(front1 + nn) % capacity1]
-                != other._xs[(front2 + nn) % capacity2]
-            ):
-                return False
-        return True
-
     def __iter__(self) -> Iterator[X]:
         """
         .. admonition:: iterate
 
-            Iterates circular array, front (left) to rear (right).
+            Iterates circular array, left (front) to right (rear).
 
-            .. warning
+            :yields: The ``CA`` contents front to rear.
 
-                Not thread safe, especially for long living iterators.
+            .. warning::
+
+                Not threadsafe, especially for long living iterators.
 
                 .. tip::
 
@@ -257,7 +210,9 @@ class CA[X]:
         """
         .. admonition:: reverse iterate
 
-            Iterates circular array, rear (right) to front (left).
+            Iterates circular array, right (rear) to left (front).
+
+            :yields: The ``CA`` contents right to left.
 
             .. warning
 
@@ -288,6 +243,55 @@ class CA[X]:
                 position = (position - 1) % capacity
             yield cast(X, current_state[position])
 
+    def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: equality comparison
+
+            Efficiently compare ``CA`` to another object.
+
+            :param other: The object to be compared.
+            :returns: ``True`` if ``other`` is another ``CA`` whose
+                      contents compare as equal to the corresponding
+                      contents of the ``CA``, otherwise ``False``.
+
+        """
+        if self is other:
+            return True
+        if not isinstance(other, type(self)):
+            return False
+
+        (
+            front1,
+            cnt1,
+            capacity1,
+            front2,
+            cnt2,
+            capacity2,
+        ) = (
+            self._front,
+            self._cnt,
+            self._cap,
+            other._front,
+            other._cnt,
+            other._cap,
+        )
+
+        if cnt1 != cnt2:
+            return False
+
+        for nn in range(cnt1):
+            if (
+                self._xs[(front1 + nn) % capacity1]
+                is other._xs[(front2 + nn) % capacity2]
+            ):
+                continue
+            if (
+                self._xs[(front1 + nn) % capacity1]
+                != other._xs[(front2 + nn) % capacity2]
+            ):
+                return False
+        return True
+
     @overload
     def __getitem__(self, idx: int) -> X: ...
     @overload
@@ -408,7 +412,7 @@ class CA[X]:
             Construct string 'CA(x₁, x₂, … xₙ)' where
             x₁, x₂, … xₙ are the contents displayed with ``repr()``.
 
-            :returns: A string to reproduce the ``CA``. 
+            :returns: A string to reproduce the ``CA``.
 
         """
         return 'ca(' + ', '.join(map(repr, self)) + ')'
@@ -420,7 +424,7 @@ class CA[X]:
             Construct string '(\| x₁, x₂, … xₙ \|)' where
             x₁, x₂, ..., xₙ are the contents displayed with ``str()``.
 
-            :returns: A estring meaningful to an end user.
+            :returns: A string meaningful to an end user.
 
         """
         return '(| ' + ', '.join(map(str, self)) + ' |)'

pythonic_fp/circulararray/auto.pyi

@@ -7,9 +7,9 @@ class CA[X]:
     def __init__(self, *xs: Iterable[X]) -> None: ...
     def __bool__(self) -> bool: ...
     def __len__(self) -> int: ...
-    def __eq__(self, other: object) -> bool: ...
     def __iter__(self) -> Iterator[X]: ...
     def __reversed__(self) -> Iterator[X]: ...
+    def __eq__(self, other: object) -> bool: ...
     @overload
     def __getitem__(self, idx: int) -> X: ...
     @overload

pythonic_fp/circulararray/fixed.py

@@ -13,7 +13,8 @@
 # limitations under the License.
 
 from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Final, overload
+from typing import Final, cast, overload
+
 from pythonic_fp.gadgets.sentinels.novalue import NoValue
 
 __all__ = ['CAF', 'caf']
@@ -22,14 +23,13 @@ nada: Final[NoValue] = NoValue()
 
 
 class CAF[X]:
-
     """
     .. admonition:: Fixed storage capacity circular array CAF
 
         - O(1) pops and pushes either end
         - O(1) indexing, does not support slicing
         - fixed total storage capacity
-        - iterable but not threadsafe
+        - iterable (see __iter__ method below)
         - comparisons compare identity before equality, like builtins
         - in boolean context, falsy when either empty or full,
           otherwise truthy
@@ -37,6 +37,7 @@ class CAF[X]:
           from arguments
 
     """
+
     __slots__ = '_xs', '_cnt', '_cap', '_front', '_rear'
 
     def __init__(self, *xs: Iterable[X], cap: int = 2) -> None:
@@ -46,7 +47,7 @@ class CAF[X]:
             Populate ``CAF`` with an optional iterable
             from front (left) to rear (right).
 
-            :param xs: Takes 0 or 1 iterable parameters.
+            :param xs: Takes an optional iterable parameter.
             :raises ValueError: When more than one parameter is provided.
             :raises TypeError: When passed a non-iterable parameter.
 
@@ -96,64 +97,17 @@ class CAF[X]:
         """
         return self._cnt
 
-    def __eq__(self, other: object) -> bool:
-        """
-        .. admonition:: equality comparison
-
-            Efficiently compare ``CAF`` to another object.
-
-            :param other: The object to be compared.
-            :returns: ``True`` if ``other`` is another ``CAF`` whose
-                      contents compare as equal to the corresponding
-                      contents of the ``CAF``, otherwise ``False``.
-
-        """
-        if self is other:
-            return True
-        if not isinstance(other, type(self)):
-            return False
-
-        (
-            front1,
-            cnt1,
-            cap1,
-            front2,
-            cnt2,
-            cap2,
-        ) = (
-            self._front,
-            self._cnt,
-            self._cap,
-            other._front,
-            other._cnt,
-            other._cap,
-        )
-
-        if cnt1 != cnt2:
-            return False
-
-        for nn in range(cnt1):
-            if (
-                self._xs[(front1 + nn) % cap1]
-                is other._xs[(front2 + nn) % cap2]
-            ):
-                continue
-            if (
-                self._xs[(front1 + nn) % cap1]
-                != other._xs[(front2 + nn) % cap2]
-            ):
-                return False
-        return True
-
     def __iter__(self) -> Iterator[X]:
         """
         .. admonition:: iterate
 
-            Iterates circular array, front (left) to rear (right).
+            Iterates circular array, left (front) to right (rear).
 
-            .. warning
+            :yields: The ``CA`` contents front to rear.
 
-                Not thread safe, especially for long living iterators.
+            .. warning::
+
+                Not threadsafe, especially for long living iterators.
 
                 .. tip::
 
@@ -184,7 +138,9 @@ class CAF[X]:
         """
         .. admonition:: reverse iterate
 
-            Iterates circular array, rear (right) to front (left).
+            Iterates circular array, right (rear) to left (front).
+
+            :yields: The ``CAF`` contents rear to front.
 
             .. warning
 
@@ -215,6 +171,49 @@ class CAF[X]:
                 position = (position - 1) % cap
             yield cast(X, current_state[position])
 
+    def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: equality comparison
+
+            Efficiently compare ``CAF`` to another object.
+
+            :param other: The object to be compared.
+            :returns: ``True`` if ``other`` is another ``CAF`` whose
+                      contents compare as equal to the corresponding
+                      contents of the ``CAF``, otherwise ``False``.
+
+        """
+        if self is other:
+            return True
+        if not isinstance(other, type(self)):
+            return False
+
+        (
+            front1,
+            cnt1,
+            cap1,
+            front2,
+            cnt2,
+            cap2,
+        ) = (
+            self._front,
+            self._cnt,
+            self._cap,
+            other._front,
+            other._cnt,
+            other._cap,
+        )
+
+        if cnt1 != cnt2:
+            return False
+
+        for nn in range(cnt1):
+            if self._xs[(front1 + nn) % cap1] is other._xs[(front2 + nn) % cap2]:
+                continue
+            if self._xs[(front1 + nn) % cap1] != other._xs[(front2 + nn) % cap2]:
+                return False
+        return True
+
     def __getitem__(self, idx: int) -> X:
         """
         .. admonition:: getitem
@@ -271,7 +270,7 @@ class CAF[X]:
         """
         item_list = list(self)
         del item_list[idx]
-        _ca = CAF(item_list, cap = self._cap)
+        _ca = CAF(item_list, cap=self._cap)
         (
             self._xs,
             self._cnt,
@@ -562,7 +561,7 @@ class CAF[X]:
             :returns: New fixed capacity circular array instance.
 
         """
-        return CAF(map(f, self), cap = self._cap)
+        return CAF(map(f, self), cap=self._cap)
 
     @overload
     def foldl[L](self, f: Callable[[X, X], X]) -> X: ...

pythonic_fp/circulararray/fixed.pyi

@@ -7,9 +7,9 @@ class CAF[X]:
     def __init__(self, *xs: Iterable[X], cap: int = 2) -> None: ...
     def __bool__(self) -> bool: ...
     def __len__(self) -> int: ...
-    def __eq__(self, other: object) -> bool: ...
     def __iter__(self) -> Iterator[X]: ...
     def __reversed__(self) -> Iterator[X]: ...
+    def __eq__(self, other: object) -> bool: ...
     def __getitem__(self, idx: int) -> X: ...
     def __setitem__(self, idx: int, val: X) -> None: ...
     def __delitem__(self, idx: int) -> None: ...

{pythonic_fp_circulararray-6.1.1.dist-info → pythonic_fp_circulararray-6.2.1.dist-info}/METADATA

@@ -1,38 +1,39 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 6.1.1
-Summary: Circular Array
+Version: 6.2.1
+Summary: Circular array datastructures.
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.13
-Description-Content-Type: text/x-rst
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
 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.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Typing :: Typed
 License-File: LICENSE
 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-circulararray/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/projects/circulararray.html
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-circulararray/release/html/
 Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
-Provides-Extra: test
 
-Pythonic FP - Circular Array
-============================
+# Pythonic FP - Circular Array
+
+Stateful circular array data structures.
 
 PyPI project
-`pythonic-fp-circulararray
-<https://pypi.org/project/pythonic-fp-circulararray>`_.
+[pythonic-fp-circulararray](https://pypi.org/project/pythonic-fp-circulararray).
+Part of the
+[pythonic-fp](https://grscheller.github.io/pythonic-fp/)
+PyPI projects.
 
-Python module implementing stateful circular array data structures.
+## Description
 
 - variable storage capacity circular array
-
   - O(1) pops either end 
   - O(1) amortized pushes either end 
   - O(1) indexing, fully supports slicing
@@ -41,9 +42,7 @@ Python module implementing stateful circular array data structures.
   - comparisons compare identity before equality, like builtins
   - in boolean context, falsy when empty, otherwise truthy
   - function ``ca`` produces auto-resizing circular array from arguments
-
 - fixed storage capacity circular array
-
   - O(1) pops and pushes either end 
   - O(1) indexing, does not support slicing
   - fixed total storage capacity
@@ -52,20 +51,7 @@ Python module implementing stateful circular array data structures.
   - in boolean context, falsy when either empty or full, otherwise truthy
   - function ``caf`` produces fixed capacity circular array from arguments
 
-Part of the
-`pythonic-fp
-<https://grscheller.github.io/pythonic-fp/>`_
-PyPI projects.
-
-Documentation
--------------
-
-Documentation and other links for this project are hosted on
-`GitHub Pages
-<https://grscheller.github.io/pythonic-fp/projects/circulararray.html>`_.
-
-Copyright and License
----------------------
+## Copyright and License
 
 Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_circulararray-6.2.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+pythonic_fp/circulararray/__init__.py,sha256=PJsikfFReHq2QXpmcg_AYeBbuyauGjfJ9bBdc2YNtzo,1016
+pythonic_fp/circulararray/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/circulararray/auto.py,sha256=xOZV5v_MQJFBz76l4H2zOCFQHDWz7nP90y1P8g7zjF0,23883
+pythonic_fp/circulararray/auto.pyi,sha256=M1gGKXsTifzinGTU9UH2LUfEb5-ki_jSFwtzeuXlEfA,1786
+pythonic_fp/circulararray/fixed.py,sha256=BoHokzCY-UxFYeVkLAhvw7aeSWGn_ct2WD5IOjE4C3U,19786
+pythonic_fp/circulararray/fixed.pyi,sha256=05-A1T91VIhOTAXqUNMQLolM4pMZ2HgEaRHkqg8V9os,1497
+pythonic_fp/circulararray/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_circulararray-6.2.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_circulararray-6.2.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_circulararray-6.2.1.dist-info/METADATA,sha256=37XgIgjczhdXlI-gDnRJIzB0-bBC7Hy4DQFvT-9iv-M,2456
+pythonic_fp_circulararray-6.2.1.dist-info/RECORD,,

pythonic_fp_circulararray-6.1.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-pythonic_fp/circulararray/__init__.py,sha256=PJsikfFReHq2QXpmcg_AYeBbuyauGjfJ9bBdc2YNtzo,1016
-pythonic_fp/circulararray/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/circulararray/auto.py,sha256=ihXv7hYX5zdr8wHZd8iEIx-TldnV42FdzNchaUT-kVw,23787
-pythonic_fp/circulararray/auto.pyi,sha256=JHc72vNNMDgV46C5xM7V4ghgGwcmRXjKu8lI4ho-ogw,1786
-pythonic_fp/circulararray/fixed.py,sha256=WZa4duooDGWlizfkxBJD52NULGVTrZsd7TRkH4OiGAY,19756
-pythonic_fp/circulararray/fixed.pyi,sha256=T__Xqq66xf5AoUiMJU9ytveEaBaXMM-WuEw1q3AFjEY,1497
-pythonic_fp/circulararray/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_circulararray-6.1.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-pythonic_fp_circulararray-6.1.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_circulararray-6.1.1.dist-info/METADATA,sha256=H3J7lPw3gx2Xl9E3TwKCD_Gbz2Q7-fudOQ1ZnRbkKE0,2699
-pythonic_fp_circulararray-6.1.1.dist-info/RECORD,,