pythonic-fp-circulararray 5.3.1__py3-none-any.whl → 5.3.3__py3-none-any.whl

pythonic_fp/circulararray/__init__.py

@@ -12,7 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Package implementing stateful circular array data structures.
+"""
+Circular Array
+--------------
+
+Package implementing stateful circular array data structures.
 
 - O(1) pops and pushes either end
 - O(1) indexing and size determination
@@ -25,7 +29,6 @@
 +-------------------------------------+-------------------------------------------+
 | **pythonic_fp.circulararray.fixed** | Fixed storage capacity circular array.    |
 +-------------------------------------+-------------------------------------------+
-
 """
 
 __author__ = 'Geoffrey R. Scheller'

pythonic_fp/circulararray/auto.py

@@ -12,7 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Circular array with variable storage capacity.
+"""
+Variable Storage Capacity
+=========================
+
+**Circular array with variable storage capacity.**
 
 - O(1) pops either end 
 - O(1) amortized pushes either end 
@@ -21,36 +25,26 @@
 - iterable, can safely mutate while iterators continue iterating over previous state
 - comparisons compare identity before equality, like builtins
 - in boolean context, falsy when empty, otherwise truthy
-- factory function ca produces a variable storage capacity circular array from its arguments
+- factory function ``ca`` produces a variable storage capacity circular array from its arguments
 
 """
 from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Never, overload, TypeVar
+from typing import cast, overload
 
 __all__ = ['CA', 'ca']
 
-I = TypeVar('I')
-T = TypeVar('T')
-
 
 class CA[I]():
 
-    L = TypeVar('L')
-    R = TypeVar('R')
-    U = TypeVar('U')
-
     __slots__ = '_items', '_cnt', '_cap', '_front', '_rear'
 
     def __init__(
             self,
             items: Iterable[I] | None = None
         ) -> None:
-        """Basically a list that can be grown from both ends
-        in O(1) time and space complexity.
-
-        :param items: optional iterable to initial populate circular array
-        :raises TypeError: if items is not Iterable
-
+        """
+        :param items: Optional iterable to initial populate circular array.
+        :raises TypeError: When ``items`` not Iterable.
         """
         if items is None:
             self._items: list[I | None] = [None, None]
@@ -312,10 +306,9 @@ class CA[I]():
         return True
 
     def pushl(self, *items: I) -> None:
-        """Push items onto left side (front) of circular array.
-
-        :param items: items pushed onto circular array from left
+        """Push ``items`` on from left.
 
+        :param items: Items pushed onto circular array from left (front).
         """
         for item in items:
             if self._cnt == self._cap:
@@ -331,10 +324,9 @@ class CA[I]():
                 )
 
     def pushr(self, *items: I) -> None:
-        """Push items onto right side (rear) of circular array.
-
-        :param items: items pushed onto circular array from right
+        """Push ``items`` on from right.
 
+        :param items: Items pushed onto circular array from right (rear).
         """
         for item in items:
             if self._cnt == self._cap:
@@ -349,12 +341,11 @@ class CA[I]():
                     self._cnt + 1,
                 )
 
-    def popl(self) -> I | Never:
-        """Pop item off left side (front) of circular array.
-
-        :return: item popped from left side of circular array
-        :raises ValueError: when called on an empty circular array
+    def popl(self) -> I:
+        """Pop single item off from left side.
 
+        :returns: Item popped from left side (front) of circular array.
+        :raises ValueError: When called on an empty circular array.
         """
         if self._cnt > 1:
             (
@@ -387,12 +378,11 @@ class CA[I]():
             raise ValueError(msg)
         return cast(I, d)
 
-    def popr(self) -> I | Never:
-        """Pop item off right side (rear) of circular array.
-
-        :return: item popped from right side of circular array
-        :raises ValueError: when called on an empty circular array
+    def popr(self) -> I:
+        """Pop single item off from right.
 
+        :returns: Item popped from right side (rear) of circular array.
+        :raises ValueError: When called on an empty circular array.
         """
         if self._cnt > 1:
             (
@@ -427,11 +417,10 @@ class CA[I]():
 
     def popld(self, default: I) -> I:
         """Pop one item from left side of the circular array, provide
-        a mandatory default value. "Safe" version of popl.
-
-        :param default: item returned if circular array is empty
-        :return: item popped from left side or default item if empty
+        a mandatory default value. "Safe" version of ``popl``.
 
+        :param default: Item returned if circular array is empty.
+        :returns: Item popped from left side or default item if empty.
         """
         try:
             return self.popl()
@@ -440,11 +429,10 @@ class CA[I]():
 
     def poprd(self, default: I) -> I:
         """Pop one item from right side of the circular array, provide
-        a mandatory default value. "Safe" version of popr.
-
-        :param default: item returned if circular array is empty
-        :return: item popped from right side or default item if empty
+        a mandatory default value. "Safe" version of ``popr``.
 
+        :param default: Item returned if circular array is empty.
+        :returns: Item popped from right side or default item if empty.
         """
         try:
             return self.popr()
@@ -454,9 +442,8 @@ class CA[I]():
     def poplt(self, maximum: int) -> tuple[I, ...]:
         """Pop multiple items from left side of circular array.
 
-        :param maximum: maximum number of items to pop, may pop less if not enough items
-        :return: items in the order popped, left to right
-
+        :param maximum: Maximum number of items to pop, may pop less if not enough items.
+        :returns: Tuple of items in the order popped, left to right.
         """
         item_list: list[I] = []
 
@@ -473,9 +460,8 @@ class CA[I]():
     def poprt(self, maximum: int) -> tuple[I, ...]:
         """Pop multiple items from right side of circular array.
 
-        :param maximum: maximum number of items to pop, may pop less if not enough items
-        :return: items in the order popped, right to left
-
+        :param maximum: Maximum number of items to pop, may pop less if not enough items.
+        :returns: Tuple of items in the order popped, right to left.
         """
         item_list: list[I] = []
         while maximum > 0:
@@ -488,10 +474,9 @@ class CA[I]():
         return tuple(item_list)
 
     def rotl(self, n: int = 1) -> None:
-        """Rotate items left.
-
-        :param n: number of times to shift elements to the left
+        """Rotate items to the left.
 
+        :param n: Number of times to shift elements to the left.
         """
         if self._cnt < 2:
             return
@@ -499,10 +484,9 @@ class CA[I]():
             self.pushr(self.popl())
 
     def rotr(self, n: int = 1) -> None:
-        """Rotate items right.
-
-        :param n: number of times to shift elements to the right
+        """Rotate items to the right.
 
+        :param n: Number of times to shift elements to the right.
         """
         if self._cnt < 2:
             return
@@ -510,22 +494,20 @@ class CA[I]():
             self.pushl(self.popr())
 
     def map[U](self, f: Callable[[I], U]) -> "CA[U]":
-        """Apply function f over the circular array's contents,
-
-        :param f: callable from type I to type U
-        :return: new circular array instance
+        """Apply function ``f`` over the circular array's contents.
 
+        :param f: Callable from type ``I`` to type ``U``.
+        :returns: New auto-resizing circular array instance.
         """
         return CA(map(f, self))
 
-    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L | Never:
+    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L:
         """Fold left with a function and optional starting item.
 
-        :param f: first argument to f is for the accumulator
-        :param start: optional starting item
-        :return: reduced value produced by the left fold
-        :raises ValueError: when circular array empty and no starting item given
-
+        :param f: Folding function, first argument to ``f`` is for the accumulator.
+        :param start: Optional starting item.
+        :returns: Reduced value produced by the left fold.
+        :raises ValueError: When circular array empty and no starting item given.
         """
         if self._cnt == 0:
             if start is None:
@@ -544,14 +526,13 @@ class CA[I]():
             acc = f(acc, d)
         return acc
 
-    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R | Never:
+    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R:
         """Fold right with a function and an optional starting item.
 
-        :param f: second argument to f is for the accumulator
-        :param start: optional starting item
-        :return: reduced value produced by the right fold
-        :raises ValueError: when circular array empty and no starting item given
-
+        :param f: Folding function, second argument to ``f`` is for the accumulator.
+        :param start: Optional starting item.
+        :returns: Reduced value produced by the right fold.
+        :raises ValueError: When circular array empty and no starting item given.
         """
         if self._cnt == 0:
             if start is None:
@@ -573,8 +554,7 @@ class CA[I]():
     def capacity(self) -> int:
         """Return current storage capacity of the circular array.
 
-        :return: current storage capacity
-
+        :returns: Current storage capacity.
         """
         return self._cap
 
@@ -595,8 +575,7 @@ class CA[I]():
     def fraction_filled(self) -> float:
         """Find fraction of the storage capacity which is filled.
 
-        :return: the ratio count/capacity
-
+        :returns: The ratio count/capacity.
         """
         return self._cnt / self._cap
 
@@ -605,8 +584,7 @@ class CA[I]():
         storage capacity. To just compact the circular array, do not
         provide ``minimum_capacity``.
 
-        :param minimum_capacity: minimum storage capacity to compact the circular array
-
+        :param minimum_capacity: Minimum storage capacity to compact the circular array.
         """
         self._compact_storage_capacity()
         if (min_cap := minimum_capacity) > self._cap:
@@ -624,8 +602,7 @@ class CA[I]():
 def ca[T](*items: T) -> CA[T]:
     """Produce circular array from a variable number of arguments.
 
-    :param items: initial items for a new circular array
-    :return: new variable storage capacity circular array
-
+    :param items: Initial items for a new auto-resizing circular array.
+    :returns: New variable storage capacity circular array.
     """
     return CA(items)

pythonic_fp/circulararray/auto.pyi

@@ -1,103 +1,43 @@
-# Copyright 2023-202 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.
-
 from collections.abc import Callable, Iterable, Iterator
-from typing import Never, overload, TypeVar
+from typing import overload
 
 __all__ = ['CA', 'ca']
 
-I = TypeVar('I')
-T = TypeVar('T')
-
-
-class CA[I]():
-
-    L = TypeVar('L')
-    R = TypeVar('R')
-    U = TypeVar('U')
-
-    def __init__(
-            self,
-            items: Iterable[I] | None = None
-        ) -> None: ...
-
-    def _double_storage_capacity(self) -> None: ...
-
-    def _compact_storage_capacity(self) -> None: ...
-
+class CA[I]:
+    def __init__(self, items: Iterable[I] | None = None) -> None: ...
     def __iter__(self) -> Iterator[I]: ...
-
     def __reversed__(self) -> Iterator[I]: ...
-
-    def __repr__(self) -> str: ...
-
-    def __str__(self) -> str: ...
-
     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 | Never: ...
-
-    def popr(self) -> I | Never: ...
-
+    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]: ...
-
-    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L | Never: ...
-
-    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R | Never: ...
-
+    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L: ...
+    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> 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/fixed.py

@@ -12,7 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Circular array with fixed storage capacity.
+"""
+Fixed Storage Capacity
+======================
+
+**Circular array with fixed storage capacity.**
 
 - O(1) pops and pushes either end 
 - O(1) indexing, does not support slicing
@@ -20,24 +24,17 @@
 - iterable, can safely mutate while iterators continue iterating over previous state
 - comparisons compare identity before equality, like builtins
 - in boolean context, falsy when either empty or full, otherwise truthy
-- factory function caf produces a fixed storage capacity circular array from its arguments
+- factory function ``caf`` produces a fixed storage capacity circular array from its arguments
 
 """
 from collections.abc import Callable, Iterable, Iterator
-from typing import cast, Final, Never, TypeVar
+from typing import cast, Final
 
 __all__ = ['CAF', 'caf']
 
-I = TypeVar('I')
-T = TypeVar('T')
-
 
 class CAF[I]():
 
-    L = TypeVar('L')
-    R = TypeVar('R')
-    U = TypeVar('U')
-
     __slots__ = '_items', '_cnt', '_cap', '_front', '_rear'
 
     def __init__(
@@ -45,13 +42,10 @@ class CAF[I]():
             items: Iterable[I] | None = None,
             capacity: int = 2
         ) -> None:
-        """Basically a list that can be grown from both ends
-        in O(1) time and space complexity.
-
-        :param items: optional iterable to initial populate circular array
-        :param capacity: fixed storage capacity of circular array
-        :raises TypeError: if items is not Iterable
-
+        """
+        :param items: Optional iterable to initial populate circular array.
+        :param capacity: Fixed storage capacity of circular array.
+        :raises TypeError: When ``items`` not Iterable,
         """
         capacity = max(2, capacity)
         if items is None:
@@ -203,11 +197,10 @@ class CAF[I]():
         return True
 
     def pushl(self, item: I) -> None:
-        """Push single item onto left side (front) of circular array.
-
-        :param item: single item pushed onto circular array from left
-        :raises ValueError: when called on a full CAF
+        """Push ``item`` on from left.
 
+        :param item: Single item pushed onto circular array from left (front).
+        :raises ValueError: When called on a full ``CAF``.
         """
         if self._cnt == self._cap:
             msg = 'Method pushl called on a full CAF'
@@ -224,11 +217,10 @@ class CAF[I]():
             )
 
     def pushr(self, item: I) -> None:
-        """Push a single item onto right side (rear) of circular array.
-
-        :param item: single item pushed onto circular array from right
-        :raises ValueError: when called on a full fixed storage capacity circular array
+        """Push ``item`` on from Right.
 
+        :param item: Single ``item`` pushed onto circular array from right (rear).
+        :raises ValueError: When called on a full fixed storage capacity circular array.
         """
         if self._cnt == self._cap:
             msg = 'Method pushr called on a full CAF'
@@ -244,12 +236,11 @@ class CAF[I]():
                 self._cnt + 1,
             )
 
-    def popl(self) -> I | Never:
-        """Pop item off left side (front) of circular array.
-
-        :return: item popped from left side of circular array
-        :raises ValueError: when called on an empty circular array
+    def popl(self) -> I:
+        """Pop single item off from left side.
 
+        :returns: Item popped from left side (front) of circular array.
+        :raises ValueError: When called on an empty circular array.
         """
         if self._cnt > 1:
             (
@@ -282,12 +273,11 @@ class CAF[I]():
             raise ValueError(msg)
         return cast(I, d)
 
-    def popr(self) -> I | Never:
-        """Pop item off right side (rear) of circular array.
-
-        :return: item popped from right side of circular array
-        :raises ValueError: when called on an empty circular array
+    def popr(self) -> I:
+        """Pop single item off from right side.
 
+        :returns: Item popped from right side (rear) of circular array.
+        :raises ValueError: When called on an empty circular array.
         """
         if self._cnt > 1:
             (
@@ -324,13 +314,8 @@ class CAF[I]():
         """Pop one item from left side of the circular array, provide
         a mandatory default value. "Safe" version of popl.
 
-
-        Pop one item from left side of the circular array, provide
-        a mandatory default value. "Safe" version of popl.
-
-        :param default: item returned if circular array is empty
-        :return: item popped from left side or default item if empty
-
+        :param default: Item returned if circular array is empty.
+        :returns: Item popped from left side or default item if empty.
         """
         try:
             return self.popl()
@@ -341,9 +326,8 @@ class CAF[I]():
         """Pop one item from right side of the circular array, provide
         a mandatory default value. "Safe" version of popr.
 
-        :param default: item returned if circular array is empty
-        :return: item popped from right side or default item if empty
-
+        :param default: Item returned if circular array is empty.
+        :returns: Item popped from right side or default item if empty.
         """
         try:
             return self.popr()
@@ -353,9 +337,8 @@ class CAF[I]():
     def poplt(self, maximum: int) -> tuple[I, ...]:
         """Pop multiple items from left side of circular array.
 
-        :param maximum: maximum number of items to pop, may pop less if not enough items
-        :return: items in the order popped, left to right
-
+        :param maximum: Maximum number of items to pop, may pop less if not enough items.
+        :returns: Tuple of items in the order popped, left to right.
         """
         item_list: list[I] = []
 
@@ -372,9 +355,8 @@ class CAF[I]():
     def poprt(self, maximum: int) -> tuple[I, ...]:
         """Pop multiple items from right side of circular array.
 
-        :param maximum: maximum number of items to pop, may pop less if not enough items
-        :return: items in the order popped, right to left
-
+        :param maximum: Maximum number of items to pop, may pop less if not enough items.
+        :returns: Tuple of items in the order popped, right to left.
         """
         item_list: list[I] = []
         while maximum > 0:
@@ -387,10 +369,9 @@ class CAF[I]():
         return tuple(item_list)
 
     def rotl(self, n: int = 1) -> None:
-        """Rotate items left.
-
-        :param n: number of times to shift elements to the left
+        """Rotate items to the left.
 
+        :param n: Number of times to shift elements to the left.
         """
         if self._cnt < 2:
             return
@@ -398,10 +379,9 @@ class CAF[I]():
             self.pushr(self.popl())
 
     def rotr(self, n: int = 1) -> None:
-        """Rotate items right.
-
-        :param n: number of times to shift elements to the right
+        """Rotate items to the right.
 
+        :param n: Number of times to shift elements to the right.
         """
         if self._cnt < 2:
             return
@@ -409,22 +389,20 @@ class CAF[I]():
             self.pushl(self.popr())
 
     def map[U](self, f: Callable[[I], U]) -> "CAF[U]":
-        """Apply function f over the circular array's contents,
-
-        :param f: callable from type I to type U
-        :return: new fixed circular array instance
+        """Apply function ``f`` over the circular array's contents,
 
+        :param f: Callable from type ``I`` to type ``U``.
+        :returns: New fixed capacity circular array instance.
         """
         return CAF(map(f, self), self._cap)
 
-    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L | Never:
+    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L:
         """Fold left with a function and optional stating item.
 
-        :param f: first argument to f is for the accumulator
-        :param start: optional starting item
-        :return: reduced value produced by the left fold
-        :raises ValueError: when circular array empty and no starting item given
-
+        :param f: Folding function, first argument to ``f`` is for the accumulator.
+        :param start: Optional starting item.
+        :returns: Reduced value produced by the left fold.
+        :raises ValueError: When circular array empty and no starting item given.
         """
         if self._cnt == 0:
             if start is None:
@@ -443,14 +421,13 @@ class CAF[I]():
             acc = f(acc, d)
         return acc
 
-    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R | Never:
+    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R:
         """Fold right with a function and an optional starting item.
 
-        :param f: second argument to f is for the accumulator
-        :param start: optional starting item
-        :return: reduced value produced by the right fold
-        :raises ValueError: when circular array empty and no starting item given
-
+        :param f: Folding function, second argument to ``f`` is for the accumulator.
+        :param start: Optional starting item.
+        :returns: Reduced value produced by the right fold.
+        :raises ValueError: When circular array empty and no starting item given.
         """
         if self._cnt == 0:
             if start is None:
@@ -472,8 +449,7 @@ class CAF[I]():
     def capacity(self) -> int:
         """Return fixed storage capacity of the circular array.
 
-        :return: fixed storage capacity
-
+        :returns: Fixed storage capacity.
         """
         return self._cap
 
@@ -494,8 +470,7 @@ class CAF[I]():
     def fraction_filled(self) -> float:
         """Find fraction of the storage capacity which is filled.
 
-        :return: the ratio count/capacity
-
+        :returns: The ratio count/capacity.
         """
         return self._cnt / self._cap
 
@@ -503,9 +478,8 @@ class CAF[I]():
 def caf[T](*items: T, capacity: int = 2) -> CAF[T]:
     """Produce a circular array from a variable number of arguments.
 
-    :param items: initial items for a new circular array
-    :param capacity: the minimum storage capacity to set
-    :return: new fixed storage capacity circular array
-
+    :param items: Initial items for a new fixed capacity :circular array.
+    :param capacity: The minimum storage capacity to set.
+    :returns: New fixed storage capacity circular array.
     """
     return CAF(items, capacity = capacity)

pythonic_fp/circulararray/fixed.pyi

@@ -1,89 +1,32 @@
-# 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.
-
 from collections.abc import Callable, Iterable, Iterator
-from typing import Never, TypeVar
 
 __all__ = ['CAF', 'caf']
 
-I = TypeVar('I')
-T = TypeVar('T')
-
-
-class CAF[I]():
-
-    L = TypeVar('L')
-    R = TypeVar('R')
-    U = TypeVar('U')
-
-    def __init__(
-            self,
-            items: Iterable[I] | None = None,
-            capacity: int = 2
-        ) -> None: ...
-
+class CAF[I]:
+    def __init__(self, items: Iterable[I] | None = None, capacity: int = 2) -> None: ...
     def __iter__(self) -> Iterator[I]: ...
-
     def __reversed__(self) -> Iterator[I]: ...
-
-    def __repr__(self) -> str: ...
-
-    def __str__(self) -> str: ...
-
     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 | Never: ...
-
-    def popr(self) -> I | Never: ...
-
+    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]: ...
-
-    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L | Never: ...
-
-    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R | Never: ...
-
+    def foldl[L](self, f: Callable[[L, I], L], start: L | None = None) -> L: ...
+    def foldr[R](self, f: Callable[[I, R], R], start: R | None = None) -> R: ...
     def capacity(self) -> int: ...
-
     def empty(self) -> None: ...
-
     def fraction_filled(self) -> float: ...
 
-
 def caf[T](*items: T, capacity: int = 2) -> CAF[T]: ...

{pythonic_fp_circulararray-5.3.1.dist-info → pythonic_fp_circulararray-5.3.3.dist-info}/METADATA

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 5.3.1
-Summary: Package implementing stateful circular array data structures.
-Keywords: auto resizing,circular array,dequeue,indexable,pop,push
+Version: 5.3.3
+Summary: Circular Array
+Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
@@ -16,13 +16,13 @@ Classifier: Typing :: Typed
 License-File: LICENSE
 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/circulararray/development/build/html/releases.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.rst
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/index.html
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
 Provides-Extra: test
 
-PPythonic FP - Circular Array
-=============================
+Pythonic FP - Circular Array
+============================
 
 PyPI project
 `pythonic-fp-circulararray

pythonic_fp_circulararray-5.3.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+pythonic_fp/circulararray/__init__.py,sha256=uR0KASmw1Zraz9l3VPbqPm9WUKzWk-0_tUGT0opabzQ,1515
+pythonic_fp/circulararray/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/circulararray/auto.py,sha256=_rZhOsC3PGs97j15qM4vXpkpRDTfVkxEGwYyBi9uAQU,19334
+pythonic_fp/circulararray/auto.pyi,sha256=yfQ2kzIiXFb2Bpg3cMwHwv2oSlyOUMTgmdPZM_-oU_8,1669
+pythonic_fp/circulararray/fixed.py,sha256=nzwPnaVOh-KKv503_c--f_m0SkOaUI6mSe1Bo5WACCA,15316
+pythonic_fp/circulararray/fixed.pyi,sha256=y_7eMvH18B1lpLPp2P-VkN-xcQVKJn6cOisp9LSBBRk,1362
+pythonic_fp/circulararray/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_circulararray-5.3.3.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_circulararray-5.3.3.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_circulararray-5.3.3.dist-info/METADATA,sha256=rdgGmosD6wF1Cfye7QBuZJXGnjs3uDgPzmYYvVpUx-M,2180
+pythonic_fp_circulararray-5.3.3.dist-info/RECORD,,

pythonic_fp_circulararray-5.3.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-pythonic_fp/circulararray/__init__.py,sha256=YjAKcjcSpEYW5mhTiGwtnx9xhCdK68CrAiYAhlqSkCY,1484
-pythonic_fp/circulararray/auto.py,sha256=DzQJl6-Yuns3pgYe7a_pgKxEPY5RBx8gHD4rUIvhHcc,19407
-pythonic_fp/circulararray/auto.pyi,sha256=xK10nhGdyHcBSEsaWfZA83y3fZc89FP2_YsFAO7Iyzc,2647
-pythonic_fp/circulararray/fixed.py,sha256=-FhBFwxnSgeqJhNLSARM_jhUIr0nPmFiMmGXMWotmMc,15533
-pythonic_fp/circulararray/fixed.pyi,sha256=HhAWh7hHl432wsvMUuTrlqgzZ7MSK7mpWF4k_Wq32Xk,2263
-pythonic_fp/circulararray/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_circulararray-5.3.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-pythonic_fp_circulararray-5.3.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_circulararray-5.3.1.dist-info/METADATA,sha256=C0ZzZsk64VYRXKGUl2wWd5IoVfT5S7hp9eYQvjHYztE,2219
-pythonic_fp_circulararray-5.3.1.dist-info/RECORD,,