dtools.circular-array 3.11.0__py3-none-any.whl → 3.12.1__py3-none-any.whl

dtools/circular_array/__init__.py

@@ -12,23 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""### Developer Tools - circular array data structure
+"""### Developer Tools - Circular Array Data Structure
 
 Package for an indexable, sliceable, auto-resizing circular array
 data structure with amortized O(1) pushes and pops either end.
 
-#### Circular Array Data Structure
+Circular array data structure.
 
-* *module* dtools.circular_array.ca
-  * circular array data structure
-* *class* dtools.circular_array.ca.CA
-  * initializer takes 1 or 0 iterables
-* *function* dtools.circular_array.ca.ca
-  * factory function taking a variable number of arguments
+- *module* dtools.circular_array
+  - *class* dtools.circular_array.ca.CA
+    - initializer takes up to 1 iterable
+  - *function* dtools.circular_array.ca.ca
+    - factory function taking a variable number of arguments
 
 """
 
-__version__ = '3.11.0'
+__version__ = '3.12.1'
 __author__ = 'Geoffrey R. Scheller'
 __copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
 __license__ = 'Apache License 2.0'

dtools/circular_array/ca.py

@@ -15,18 +15,19 @@
 """### Module for an indexable circular array data structure."""
 
 from __future__ import annotations
-from collections.abc import Callable, Iterable, Iterator, Sequence
+from collections.abc import Callable, Iterable, Iterator
 from typing import cast, Never, overload, TypeVar
 
 __all__ = ['CA', 'ca']
 
-D = TypeVar('D')  # type: ignore[unused-ignore]  # Needed only for pdoc
-L = TypeVar('L')  # type: ignore[unused-ignore]  # documentation generation.
-R = TypeVar('R')  # type: ignore[unused-ignore]  # Otherwise, not needed
-U = TypeVar('U')  # type: ignore[unused-ignore]  # by either MyPy or Python.
+D = TypeVar('D')  # Needed only for pdoc documentation generation. Otherwise,
+L = TypeVar('L')  # ignored by both MyPy and Python. Makes linters unhappy
+R = TypeVar('R')  # when these are used on function and method signatures due
+U = TypeVar('U')  # to "redefined-outer-name" warnings. Function and method
+T = TypeVar('T')  # signatures do not support variance and bounds constraints.
 
 
-class CA[D](Sequence[D]):
+class CA[D]():
     """Indexable circular array data structure
 
     - generic, stateful data structure
@@ -349,7 +350,7 @@ class CA[D](Sequence[D]):
         except ValueError:
             return default
 
-    def poplt(self, maximum: int) -> tuple[D, ...]:
+    def poplt(self, maximum: int, /) -> tuple[D, ...]:
         """Pop multiple values from left side of `CA`.
 
         - returns the results in a tuple of type `tuple[~D, ...]`
@@ -370,7 +371,7 @@ class CA[D](Sequence[D]):
 
         return tuple(ds)
 
-    def poprt(self, max: int) -> tuple[D, ...]:
+    def poprt(self, maximum: int, /) -> tuple[D, ...]:
         """Pop multiple values from right side of `CA`.
 
         - returns the results in a tuple of type `tuple[~D, ...]`
@@ -380,31 +381,29 @@ class CA[D](Sequence[D]):
 
         """
         ds: list[D] = []
-        while max > 0:
+        while maximum > 0:
             try:
                 ds.append(self.popr())
             except ValueError:
                 break
             else:
-                max -= 1
+                maximum -= 1
 
         return tuple(ds)
 
-    def rotl(self, n: int = 1) -> None:
+    def rotl(self, n: int = 1, /) -> None:
         """Rotate `CA` arguments left n times."""
         if self._cnt < 2:
             return
-        while n > 0:
+        for _ in range(n, 0, -1):
             self.pushr(self.popl())
-            n -= 1
 
-    def rotr(self, n: int = 1) -> None:
+    def rotr(self, n: int = 1, /) -> None:
         """Rotate `CA` arguments right n times."""
         if self._cnt < 2:
             return
-        while n > 0:
+        for _ in range(n, 0, -1):
             self.pushl(self.popr())
-            n -= 1
 
     def map[U](self, f: Callable[[D], U], /) -> CA[U]:
         """Apply function f over contents, returns new `CA` instance.
@@ -488,7 +487,7 @@ class CA[D](Sequence[D]):
     def resize(self, minimum_capacity: int = 2) -> None:
         """Compact `CA` and resize to `minimum_capacity` if necessary.
 
-        To just compact the `CA`, do not provide a minimum capacity.
+        * to just compact the `CA`, do not provide a minimum capacity
 
         """
         self._compact_storage_capacity()
@@ -498,6 +497,6 @@ class CA[D](Sequence[D]):
                 self._front, self._rear = 0, self._cap - 1
 
 
-def ca[D](*ds: D) -> CA[D]:
+def ca[T](*ds: T) -> CA[T]:
     """Function to produce a `CA` array from a variable number of arguments."""
     return CA(ds)

{dtools_circular_array-3.11.0.dist-info → dtools_circular_array-3.12.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: dtools.circular-array
-Version: 3.11.0
-Summary: ### Developer Tools - circular array data structure
+Version: 3.12.1
+Summary: ### Developer Tools - Circular Array Data Structure
 Keywords: circular array,circle array,CA,dequeue,dqueue,FIFO,LIFO,pop,push,indexable,auto-resizing,auto resizing,resizing
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.12
@@ -61,7 +61,7 @@ syntactic sugar like `[]` or `{}`.
 #### Usage
 
 ```python
-    from dtools.circular_array.ca import CA
+    from dtools.circular_array.ca import CA, ca
     
     ca1 = ca(1, 2, 3)
     assert ca1.popl() == 1

dtools_circular_array-3.12.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+dtools/circular_array/__init__.py,sha256=2CvFEORjHTaRYTteVH-Ifo7THhbttgif71VigBM-3-Y,1189
+dtools/circular_array/ca.py,sha256=PRt-AOvR9WqwS6EdKFWXde7VxBc1yOD6kuCK_lXuWFQ,16683
+dtools/circular_array/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtools_circular_array-3.12.1.dist-info/licenses/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
+dtools_circular_array-3.12.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+dtools_circular_array-3.12.1.dist-info/METADATA,sha256=9HGyzkYTReGc9LUbP_X1qbWEK-EQKVwA_gAaZdI_5cI,3495
+dtools_circular_array-3.12.1.dist-info/RECORD,,

dtools_circular_array-3.11.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-dtools/circular_array/__init__.py,sha256=JfokAp0Jh8b5oU6aYQKNG1_8FB1OFT4geAowCLQSGQ0,1222
-dtools/circular_array/ca.py,sha256=nAyi-fuIriMt2R08Ibq_KCdKuMNM199hTfye7Ap9qj8,16604
-dtools/circular_array/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dtools_circular_array-3.11.0.dist-info/licenses/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
-dtools_circular_array-3.11.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-dtools_circular_array-3.11.0.dist-info/METADATA,sha256=lE6GWKO2BQU_EEKseM5UKSLqsz5Rc-s8YdAiQt8Gjvw,3491
-dtools_circular_array-3.11.0.dist-info/RECORD,,