pythonic-fp-circulararray 5.4.0__tar.gz → 6.0.0__tar.gz

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/CHANGELOG.rst

@@ -17,12 +17,20 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-PyPI 5.4.0 - TBD
-~~~~~~~~~~~~~~~~
+PyPI 6.0.0 - 2025-09-25
+~~~~~~~~~~~~~~~~~~~~~~~
 
-- updated README.rst
+Changed how "optional" iterator in initializer signature is handled.
 
-  - previous version never fully updated for two circular array types
+- same trick as is done in queues project.
+- no longer need to use a sentinel in the signature
+- less typing boilerplate
+- required a bump in major version number
+
+PyPI 5.4.0 - 2025-09-25
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Gave both circular arrays the ability to store None as a value.
 
 - realized that both circular array types cannot store None as a value
 
@@ -30,10 +38,14 @@ PyPI 5.4.0 - TBD
 
     - typing for foldl & foldr a bit quirky (mypy bug?)
 
-  - bumping minor version number
+  - bumping minor version number to 5.4.0
 
     - more than a bug fix but not really an API change either
 
+- updated README.rst for last two PyPI releases
+
+  - previous version never fully updated for two circular array types
+
 PyPI 5.3.3 - 2025-09-21
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 5.4.0
+Version: 6.0.0
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-circulararray"
-version = "5.4.0"
+version = "6.0.0"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/src/pythonic_fp/circulararray/auto.py

@@ -41,22 +41,21 @@ nada: Final[NoValue] = NoValue()
 class CA[I]:
     __slots__ = '_items', '_cnt', '_cap', '_front', '_rear'
 
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I]) -> None: ...
-
-    def __init__(self, items: Iterable[I | NoValue] | NoValue = nada) -> None:
+    def __init__(self, *items: Iterable[I]) -> None:
         """
-        :param items: "Optional" iterable to initial populate circular array.
-        :raises TypeError: When ``items`` not Iterable.
+        :param items: "Optionally" takes a single iterable to populate circular array.
+        :raises TypeError: When ``items[0]`` not iterable.
+        :raises ValueError: If more than 1 iterable is given.
         """
-        if items is nada:
-            self._items: list[I | NoValue] = [nada, nada]
-        else:
-            values: list[I | NoValue] = list(cast(Iterable[I | NoValue], items))
+        if (size := len(items)) > 1:
+            msg = f'CA expects at most 1 argument, got {size}'
+            raise ValueError(msg)
+        if size:
+            values: list[I | NoValue] = list(cast(Iterable[I | NoValue], items[0]))
             self._items = [nada] + values + [nada]
-        self._cap = cap = len(self._items)
+        else:
+            self._items = [nada, nada]
+        self._cap = (cap := len(self._items))
         self._cnt = cap - 2
         if cap == 2:
             self._front = 0
@@ -292,10 +291,10 @@ class CA[I]:
 
         (
             front1,
-            count1,
+            cnt1,
             capacity1,
             front2,
-            count2,
+            cnt2,
             capacity2,
         ) = (
             self._front,
@@ -306,10 +305,10 @@ class CA[I]:
             other._cap,
         )
 
-        if count1 != count2:
+        if cnt1 != cnt2:
             return False
 
-        for nn in range(count1):
+        for nn in range(cnt1):
             if (
                 self._items[(front1 + nn) % capacity1]
                 is other._items[(front2 + nn) % capacity2]

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/src/pythonic_fp/circulararray/fixed.py

@@ -40,44 +40,38 @@ nada: Final[NoValue] = NoValue()
 class CAF[I]:
     __slots__ = '_items', '_cnt', '_cap', '_front', '_rear'
 
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I]) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I], capacity: int) -> None: ...
-
-    def __init__(
-        self, items: Iterable[I | NoValue] | NoValue = nada, capacity: int = 2
-    ) -> None:
+    def __init__(self, *items: Iterable[I], cap: int = 2) -> None:
         """
-        :param items: "Optional" iterable to initial populate circular array.
-        :param capacity: Minimum fixed storage capacity of circular array.
-        :raises TypeError: When ``items`` not Iterable,
+        :param items: "Optionally" takes a single iterable to populate circular array.
+        :param cap: Minimum fixed storage capacity of circular array.
+        :raises TypeError: When ``items[0]`` not iterable,
+        :raises ValueError: If more than 1 iterable is given.
         """
-        capacity = max(2, capacity)
-        if items is nada:
-            self._items: list[I | NoValue] = [nada] * capacity
-            count = 0
+        cap = max(2, cap)
+        if (size := len(items)) > 1:
+            msg = f'CAF expects at most 1 argument, got {size}'
+            raise ValueError(msg)
+        if size:
+            values: list[I | NoValue] = list(cast(Iterable[I | NoValue], items[0]))
+            cnt = len(values)
+            cap = max(cnt, cap)
+            self._items = values + [nada] * (cap - cnt)
         else:
-            values: list[I | NoValue] = list(cast(Iterable[I | NoValue], items))
-            dlist: list[I | NoValue] = list(values)
-            count = len(dlist)
-            capacity = max(count, capacity)
-            self._items = dlist + [nada] * (capacity - count)
-        self._cap: Final[int] = capacity
-        self._cnt = count
-        if count == 0:
+            self._items = [nada] * cap
+            cnt = 0
+        self._cap: Final[int] = cap
+        self._cnt = cnt
+        if cnt == 0:
             self._front = 0
-            self._rear = capacity - 1
+            self._rear = cap - 1
         else:
             self._front = 0
-            self._rear = count - 1
+            self._rear = cnt - 1
 
     def __iter__(self) -> Iterator[I]:
         if self._cnt > 0:
             (
-                capacity,
+                cap,
                 rear,
                 position,
                 current_state,
@@ -90,13 +84,13 @@ class CAF[I]:
 
             while position != rear:
                 yield cast(I, current_state[position])
-                position = (position + 1) % capacity
+                position = (position + 1) % cap
             yield cast(I, current_state[position])
 
     def __reversed__(self) -> Iterator[I]:
         if self._cnt > 0:
             (
-                capacity,
+                cap,
                 front,
                 position,
                 current_state,
@@ -109,7 +103,7 @@ class CAF[I]:
 
             while position != front:
                 yield cast(I, current_state[position])
-                position = (position - 1) % capacity
+                position = (position - 1) % cap
             yield cast(I, current_state[position])
 
     def __repr__(self) -> str:
@@ -159,7 +153,7 @@ class CAF[I]:
     def __delitem__(self, idx: int) -> None:
         item_list = list(self)
         del item_list[idx]
-        _ca = CAF(item_list, self._cap)
+        _ca = CAF(item_list, cap = self._cap)
         (
             self._items,
             self._cnt,
@@ -181,11 +175,11 @@ class CAF[I]:
 
         (
             front1,
-            count1,
-            capacity1,
+            cnt1,
+            cap1,
             front2,
-            count2,
-            capacity2,
+            cnt2,
+            cap2,
         ) = (
             self._front,
             self._cnt,
@@ -195,18 +189,18 @@ class CAF[I]:
             other._cap,
         )
 
-        if count1 != count2:
+        if cnt1 != cnt2:
             return False
 
-        for nn in range(count1):
+        for nn in range(cnt1):
             if (
-                self._items[(front1 + nn) % capacity1]
-                is other._items[(front2 + nn) % capacity2]
+                self._items[(front1 + nn) % cap1]
+                is other._items[(front2 + nn) % cap2]
             ):
                 continue
             if (
-                self._items[(front1 + nn) % capacity1]
-                != other._items[(front2 + nn) % capacity2]
+                self._items[(front1 + nn) % cap1]
+                != other._items[(front2 + nn) % cap2]
             ):
                 return False
         return True
@@ -409,7 +403,7 @@ class CAF[I]:
         :param f: Callable from type ``I`` to type ``U``.
         :returns: New fixed capacity circular array instance.
         """
-        return CAF(map(f, self), self._cap)
+        return CAF(map(f, self), cap = self._cap)
 
     @overload
     def foldl[L](self, f: Callable[[I, I], I]) -> I: ...
@@ -500,11 +494,11 @@ class CAF[I]:
         return self._cnt / self._cap
 
 
-def caf[T](*items: T, capacity: int = 2) -> CAF[T]:
+def caf[T](*items: T, cap: int = 2) -> CAF[T]:
     """Produce a circular array from a variable number of arguments.
 
     :param items: Initial items for a new fixed capacity :circular array.
-    :param capacity: The minimum storage capacity to set.
+    :param cap: The minimum storage capacity to set.
     :returns: New fixed storage capacity circular array.
     """
-    return CAF(items, capacity=capacity)
+    return CAF(items, cap=cap)

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/tests/auto/test_ca.py

@@ -485,3 +485,13 @@ class TestCircularArrayResizing:
         assert baz == ca(3, 2, 1, 3, 4, 0, 6, 1, 8, 2, 10)
         del baz[6:10:2]
         assert baz == ca(3, 2, 1, 3, 4, 0, 1, 2, 10)
+
+    def test_store_none(self) -> None:
+        ca1 = ca(1, 'a', None, (), 42)
+        assert ca1.popl() == 1
+        assert ca1.popr() == 42
+        assert ca1
+        assert ca1.popl() == 'a'
+        assert ca1.popl() is None
+        assert ca1.popr() == ()
+        assert not ca1

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/tests/fixed/test_caf.py

@@ -20,7 +20,7 @@ class TestCircularArrayFixed:
 
     def test_mutate_returns_none(self) -> None:
         """Test for builtin behaviors"""
-        ca1: CAF[int] = caf(capacity=4)
+        ca1: CAF[int] = caf(cap=4)
         assert not ca1
         assert ca1.pushl(1) is None  # type: ignore[func-returns-value]
         assert ca1
@@ -63,7 +63,7 @@ class TestCircularArrayFixed:
 
     def test_push_then_pop(self) -> None:
         """Functionality test"""
-        ca0: CAF[str] = caf(capacity=42)
+        ca0: CAF[str] = caf(cap=42)
         pushed1 = '42'
         ca0.pushl(pushed1)
         popped1 = ca0.popl()
@@ -156,8 +156,8 @@ class TestCircularArrayFixed:
 
     def test_equality(self) -> None:
         """Functionality test"""
-        c1: CAF[object] = caf(1, 2, 3, 'Forty-Two', (7, 11, 'foobar'), capacity=7)
-        c2: CAF[object] = caf(2, 3, 'Forty-Two', capacity=7)
+        c1: CAF[object] = caf(1, 2, 3, 'Forty-Two', (7, 11, 'foobar'), cap=7)
+        c2: CAF[object] = caf(2, 3, 'Forty-Two', cap=7)
         c2.pushl(1)
         c2.pushr((7, 11, 'foobar'))
         assert c1 == c2
@@ -175,7 +175,7 @@ class TestCircularArrayFixed:
         assert c1 == c2
 
         hold_a = c1.popl()
-        c1 = CAF(c1, 42)
+        c1 = CAF(c1, cap=42)
         hold_b = c1.popl()
         hold_c = c1.popr()
         c1.pushl(hold_b)
@@ -312,7 +312,7 @@ class TestCircularArrayFixed:
 
     def test_readme(self) -> None:
         """Functionality test"""
-        ca0 = caf(1, 2, 3, capacity=10)
+        ca0 = caf(1, 2, 3, cap=10)
         assert ca0.popl() == 1
         assert ca0.popr() == 3
         ca0.pushr(42)
@@ -340,7 +340,7 @@ class TestCircularArrayFixed:
 
     def test_pop(self) -> None:
         """Functionality test"""
-        ca1 = caf(1, 2, 3, capacity=4)
+        ca1 = caf(1, 2, 3, cap=4)
         assert ca1.popld(42) == 1
         assert ca1.poprd(42) == 3
         assert ca1.popld(42) == 2
@@ -348,7 +348,7 @@ class TestCircularArrayFixed:
         assert ca1.popld(42) == 42
         assert len(ca1) == 0
 
-        ca2: CAF[int] = caf(0, 1, 2, 3, 4, 5, 6, capacity=10)
+        ca2: CAF[int] = caf(0, 1, 2, 3, 4, 5, 6, cap=10)
         assert ca2.popl() == 0
         assert ca2.popr() == 6
         assert ca2 == caf(1, 2, 3, 4, 5)
@@ -437,8 +437,8 @@ class TestCircularArrayFixed:
             (4, 1),
             (4, 3),
         )
-        foo = caf(0, 1, 2, 3, 4, capacity=10)
-        bar = CAF[tuple[int, int]]((), capacity=100)
+        foo = caf(0, 1, 2, 3, 4, cap=10)
+        bar = CAF[tuple[int, int]]((), cap=100)
 
         for ii in foo:
             if ii % 2 == 1:
@@ -489,3 +489,14 @@ class TestCircularArrayFixed:
             assert False
         else:
             assert bar == 0
+
+    def test_store_none(self) -> None:
+        caf1 = caf(1, 'a', None, (), 42)
+        assert not caf1
+        assert caf1.popl() == 1
+        assert caf1.popr() == 42
+        assert caf1
+        assert caf1.popl() == 'a'
+        assert caf1.popl() is None
+        assert caf1.popr() == ()
+        assert not caf1

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/tests/fixed/test_caf_capacity.py

@@ -22,7 +22,7 @@ class TestCapacityFixed:
         ca0: CAF[int] = CAF()
         assert ca0.capacity() == 2
 
-        ca0 = caf(1, 2, capacity=8)
+        ca0 = caf(1, 2, cap=8)
         assert ca0.fraction_filled() == 2 / 8
 
         ca0.pushl(0)
@@ -49,7 +49,7 @@ class TestCapacityFixed:
 
     def test_empty(self) -> None:
         """Functionality test"""
-        c: CAF[int] = caf(capacity=401)
+        c: CAF[int] = caf(cap=401)
         assert c == caf()
         assert len(c) == 0
         for ii in 1, 2, 3, 4, 5:
@@ -73,7 +73,7 @@ class TestCapacityFixed:
 
     def test_one(self) -> None:
         """Functionality test"""
-        c = caf(42, capacity=5)
+        c = caf(42, cap=5)
         assert c.capacity() == 5
         assert len(c) == 1
         popped = c.popld(0)

{pythonic_fp_circulararray-5.4.0 → pythonic_fp_circulararray-6.0.0}/tests/fixed/test_repr_str_fixed.py

@@ -25,7 +25,7 @@ class TestReprFixed:
         bar: CAF[int] = eval(repr(ca0))
         assert foo == bar
 
-        ca1: CAF[str|int] = CAF((), capacity=10)
+        ca1: CAF[str|int] = CAF((), cap=10)
         assert repr(ca1) == 'caf()'
         ca2: CAF[int|str] = eval(repr(ca1))
         assert ca2 == ca1
@@ -51,7 +51,7 @@ class TestReprFixed:
         assert ca2 == ca1
         assert ca2 is not ca1
 
-        ca3: CAF[int] = caf(1, 10, 0, 42, capacity=10)
+        ca3: CAF[int] = caf(1, 10, 0, 42, cap=10)
         ca3.pushr(2)
         ca3.pushr(100)
         ca3.pushr(3)
@@ -65,7 +65,7 @@ class TestReprFixed:
         ca3.pushr(3)
         assert repr(ca3) == 'caf(8, 9, 10, 0, 42, 1, 2, 3)'
 
-        ca4: CAF[int] = CAF([1, 10, 0, 42], capacity=100)
+        ca4: CAF[int] = CAF([1, 10, 0, 42], cap=100)
         ca4.pushr(2)
         ca4.pushr(100)
         ca4.pushr(3)

pythonic_fp_circulararray-5.4.0/src/pythonic_fp/circulararray/auto.pyi

@@ -1,52 +0,0 @@
-from collections.abc import Callable, Iterable, Iterator
-from typing import overload
-
-__all__ = ['CA', 'ca']
-
-class CA[I]:
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I]) -> None: ...
-    def __iter__(self) -> Iterator[I]: ...
-    def __reversed__(self) -> Iterator[I]: ...
-    def __bool__(self) -> bool: ...
-    def __len__(self) -> int: ...
-    @overload
-    def __getitem__(self, idx: int) -> I: ...
-    @overload
-    def __getitem__(self, idx: slice) -> CA[I]: ...
-    @overload
-    def __setitem__(self, idx: int, vals: I) -> None: ...
-    @overload
-    def __setitem__(self, idx: slice, vals: Iterable[I]) -> None: ...
-    @overload
-    def __delitem__(self, idx: int) -> None: ...
-    @overload
-    def __delitem__(self, idx: slice) -> None: ...
-    def __eq__(self, other: object) -> bool: ...
-    def pushl(self, *items: I) -> None: ...
-    def pushr(self, *items: I) -> None: ...
-    def popl(self) -> I: ...
-    def popr(self) -> I: ...
-    def popld(self, default: I) -> I: ...
-    def poprd(self, default: I) -> I: ...
-    def poplt(self, maximum: int) -> tuple[I, ...]: ...
-    def poprt(self, maximum: int) -> tuple[I, ...]: ...
-    def rotl(self, n: int = 1) -> None: ...
-    def rotr(self, n: int = 1) -> None: ...
-    def map[U](self, f: Callable[[I], U]) -> CA[U]: ...
-    @overload
-    def foldl[L](self, f: Callable[[I, I], I]) -> I: ...
-    @overload
-    def foldl[L](self, f: Callable[[L, I], L], start: L) -> L: ...
-    @overload
-    def foldr[R](self, f: Callable[[I, I], I]) -> I: ...
-    @overload
-    def foldr[R](self, f: Callable[[I, R], R], start: R) -> R: ...
-    def capacity(self) -> int: ...
-    def empty(self) -> None: ...
-    def fraction_filled(self) -> float: ...
-    def resize(self, minimum_capacity: int = 2) -> None: ...
-
-def ca[T](*items: T) -> CA[T]: ...

pythonic_fp_circulararray-5.4.0/src/pythonic_fp/circulararray/fixed.pyi

@@ -1,44 +0,0 @@
-from collections.abc import Callable, Iterable, Iterator
-from typing import overload
-
-__all__ = ['CAF', 'caf']
-
-class CAF[I]:
-    @overload
-    def __init__(self) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I]) -> None: ...
-    @overload
-    def __init__(self, items: Iterable[I], capacity: int) -> None: ...
-    def __iter__(self) -> Iterator[I]: ...
-    def __reversed__(self) -> Iterator[I]: ...
-    def __bool__(self) -> bool: ...
-    def __len__(self) -> int: ...
-    def __getitem__(self, idx: int) -> I: ...
-    def __setitem__(self, idx: int, val: I) -> None: ...
-    def __delitem__(self, idx: int) -> None: ...
-    def __eq__(self, other: object) -> bool: ...
-    def pushl(self, item: I) -> None: ...
-    def pushr(self, item: I) -> None: ...
-    def popl(self) -> I: ...
-    def popr(self) -> I: ...
-    def popld(self, default: I) -> I: ...
-    def poprd(self, default: I) -> I: ...
-    def poplt(self, maximum: int) -> tuple[I, ...]: ...
-    def poprt(self, maximum: int) -> tuple[I, ...]: ...
-    def rotl(self, n: int = 1) -> None: ...
-    def rotr(self, n: int = 1) -> None: ...
-    def map[U](self, f: Callable[[I], U]) -> CAF[U]: ...
-    @overload
-    def foldl[L](self, f: Callable[[I, I], I]) -> I: ...
-    @overload
-    def foldl[L](self, f: Callable[[L, I], L], start: L) -> L: ...
-    @overload
-    def foldr[R](self, f: Callable[[I, I], I]) -> I: ...
-    @overload
-    def foldr[R](self, f: Callable[[I, R], R], start: R) -> R: ...
-    def capacity(self) -> int: ...
-    def empty(self) -> None: ...
-    def fraction_filled(self) -> float: ...
-
-def caf[T](*items: T, capacity: int = 2) -> CAF[T]: ...