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

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

@@ -17,7 +17,13 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-PyPI 6.0.0 - 2025-09-25
+PyPI 6.0.1 - 2026-01-TBD
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements based on lessons learned from my PyPI
+boring-math-abstract-algebra project.
+
+PyPI 6.0.0 - 2025-09-26
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Changed how "optional" iterator in initializer signature is handled.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 6.0.0
+Version: 6.0.1
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -14,11 +14,11 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-gadgets>=3.1.0
+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/circulararray/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/circulararray/development/build/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
 Provides-Extra: test
 
@@ -54,7 +54,7 @@ Python module implementing stateful circular array data structures.
 
 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
@@ -62,7 +62,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/circulararray>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_circulararray-6.0.0 → pythonic_fp_circulararray-6.0.1}/README.rst

@@ -30,7 +30,7 @@ Python module implementing stateful circular array data structures.
 
 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
@@ -38,7 +38,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/circulararray>`_.
 
 Copyright and License
 ---------------------

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

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-circulararray"
-version = "6.0.0"
+version = "6.0.1"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -24,14 +24,14 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-gadgets>=3.1.0",
+  "pythonic-fp-gadgets>=4.0.2",
 ]
 dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/index.html"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Documentation = "https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/"
+Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
 Source = "https://github.com/grscheller/pythonic-fp-circulararray"
 
 [project.optional-dependencies]

pythonic_fp_circulararray-6.0.1/src/pythonic_fp/circulararray/__init__.py

@@ -0,0 +1,37 @@
+# Copyright 2024-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.
+
+"""
+Circular Array
+--------------
+
+.. admonition:: Stateful circular array data structures.
+
+    +-------------------------------------+-------------------------------------------+
+    | Module                              | Description                               |
+    +=====================================+===========================================+
+    | **pythonic_fp.circulararray.auto**  | Variable storage capacity circular array. |
+    +-------------------------------------+-------------------------------------------+
+    | **pythonic_fp.circulararray.fixed** | Fixed storage capacity circular array.    |
+    +-------------------------------------+-------------------------------------------+
+
+    - O(1) pops and pushes either end
+    - O(1) size determination
+    - O(1) indexing
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

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

@@ -13,19 +13,16 @@
 # limitations under the License.
 
 """
-Variable Storage Capacity
-=========================
+.. admonition:: Variable storage capacity circular array.**
 
-**Circular array with variable storage capacity.**
-
-- O(1) pops either end
-- O(1) amortized pushes either end
-- O(1) indexing, fully supports slicing
-- auto-resizing more storage capacity when necessary, manually compatible
-- iterable, safely mutates while iterators iterating over previous state
-- comparisons compare identity before equality, like builtins
-- in boolean context, falsy when empty, otherwise truthy
-- function ``ca`` produces auto-resizing circular array from arguments
+    - O(1) pops either end
+    - O(1) amortized pushes either end
+    - O(1) indexing, fully supports slicing
+    - auto-resizing more storage capacity when necessary, manually compatible
+    - iterable, safely mutates while iterators iterating over previous state
+    - comparisons compare identity before equality, like builtins
+    - in boolean context, falsy when empty, otherwise truthy
+    - function ``ca`` produces auto-resizing circular array from arguments
 
 """
 
@@ -43,7 +40,8 @@ class CA[I]:
 
     def __init__(self, *items: Iterable[I]) -> None:
         """
-        :param items: "Optionally" takes a single iterable to populate circular array.
+        :param items: Optionally takes a single iterable to
+                      initially populate the circular array.
         :raises TypeError: When ``items[0]`` not iterable.
         :raises ValueError: If more than 1 iterable is given.
         """
@@ -284,6 +282,12 @@ class CA[I]:
         del _ca
 
     def __eq__(self, other: object) -> bool:
+        """
+        :param other: The object to be compared to.
+        :returns: ``True`` if object is another CA whose items compare
+                  as equal to the corresponding items in the CA,
+                  otherwise ``False``.
+        """
         if self is other:
             return True
         if not isinstance(other, type(self)):
@@ -458,7 +462,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.
+        :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] = []
@@ -476,7 +481,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.
+        :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] = []
@@ -525,10 +531,12 @@ class CA[I]:
     def foldl[L](self, f: Callable[[L, I], L], start: L | NoValue = NoValue()) -> L:
         """Fold left with a function and optional starting item.
 
-        :param f: Folding function, first argument to ``f`` is for the accumulator.
+        :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.
+        :raises ValueError: When circular array empty and no starting
+                            item given.
         """
         if self._cnt == 0:
             if start is nada:
@@ -555,10 +563,12 @@ class CA[I]:
     def foldr[R](self, f: Callable[[I, R], R], start: R | NoValue = nada) -> R:
         """Fold right with a function and an optional starting item.
 
-        :param f: Folding function, second argument to ``f`` is for the accumulator.
-        :param start: "Optional" starting item.
+        :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.
+        :raises ValueError: When circular array empty and no starting
+                            item given.
         """
         if self._cnt == 0:
             if start is nada:
@@ -610,7 +620,8 @@ 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:

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

@@ -0,0 +1,49 @@
+from collections.abc import Callable, Iterable, Iterator
+from typing import overload
+
+__all__ = ['CA', 'ca']
+
+class CA[I]:
+    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-6.0.0 → pythonic_fp_circulararray-6.0.1}/src/pythonic_fp/circulararray/fixed.py

@@ -13,18 +13,15 @@
 # limitations under the License.
 
 """
-Fixed Storage Capacity
-======================
+.. admonition:: Fixed storage capacity circular array.**
 
-**Circular array with fixed storage capacity.**
-
-- O(1) pops and pushes either end
-- O(1) indexing, does not support slicing
-- fixed total storage capacity
-- iterable, safely mutates while iterators iterating over previous state
-- comparisons compare identity before equality, like builtins
-- in boolean context, falsy when either empty or full, otherwise truthy
-- function ``caf`` produces fixed capacity circular array from arguments
+    - O(1) pops and pushes either end
+    - O(1) indexing, does not support slicing
+    - fixed total storage capacity
+    - iterable, safely mutates while iterators iterating over previous state
+    - comparisons compare identity before equality, like builtins
+    - in boolean context, falsy when either empty or full, otherwise truthy
+    - function ``caf`` produces fixed capacity circular array from arguments
 
 """
 
@@ -42,7 +39,8 @@ class CAF[I]:
 
     def __init__(self, *items: Iterable[I], cap: int = 2) -> None:
         """
-        :param items: "Optionally" takes a single iterable to populate circular array.
+        :param items: Optionally takes a single iterable to
+                      initially populate the 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.
@@ -168,6 +166,12 @@ class CAF[I]:
         del _ca
 
     def __eq__(self, other: object) -> bool:
+        """
+        :param other: The object to be compared to.
+        :returns: ``True`` if object is another CAF whose items compare
+                  as equal to the corresponding items in the CAF,
+                  otherwise ``False``.
+        """
         if self is other:
             return True
         if not isinstance(other, type(self)):
@@ -346,7 +350,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.
+        :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] = []
@@ -364,7 +369,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.
+        :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] = []
@@ -413,10 +419,12 @@ class CAF[I]:
     def foldl[L](self, f: Callable[[L, I], L], start: L | NoValue = nada) -> L:
         """Fold left with a function and optional stating item.
 
-        :param f: Folding function, first argument to ``f`` is for the accumulator.
+        :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.
+        :raises ValueError: When circular array empty and no starting
+                            item given.
         """
         if self._cnt == 0:
             if start is nada:
@@ -443,10 +451,12 @@ class CAF[I]:
     def foldr[R](self, f: Callable[[I, R], R], start: R | NoValue = nada) -> R:
         """Fold right with a function and an optional starting item.
 
-        :param f: Folding function, second argument to ``f`` is for the accumulator.
+        :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.
+        :raises ValueError: When circular array empty and no starting
+                            item given.
         """
         if self._cnt == 0:
             if start is nada:

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

@@ -0,0 +1,39 @@
+from collections.abc import Callable, Iterable, Iterator
+from typing import overload
+
+__all__ = ['CAF', 'caf']
+
+class CAF[I]:
+    def __init__(self, *items: Iterable[I], cap: int = 2) -> 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, cap: int = 2) -> CAF[T]: ...

pythonic_fp_circulararray-6.0.0/src/pythonic_fp/circulararray/__init__.py

@@ -1,36 +0,0 @@
-# Copyright 2024-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.
-
-"""
-Circular Array
---------------
-
-Package implementing stateful circular array data structures.
-
-- O(1) pops and pushes either end
-- O(1) indexing and size determination
-- O(1) size determination
-
-+-------------------------------------+-------------------------------------------+
-| Module                              | Description                               |
-+=====================================+===========================================+
-| **pythonic_fp.circulararray.auto**  | Variable storage capacity circular array. |
-+-------------------------------------+-------------------------------------------+
-| **pythonic_fp.circulararray.fixed** | Fixed storage capacity circular array.    |
-+-------------------------------------+-------------------------------------------+
-"""
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'