dtools.circular-array 3.14.0__py3-none-any.whl → 3.15.0__py3-none-any.whl

dtools/circular_array.py

@@ -12,10 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""### An indexable circular array data structure.
-
-An indexable, sliceable, auto-resizing circular array
-data structure with amortized O(1) pushes and pops either end.
+"""An indexable circular array data structure.
+
+- generic, stateful, invariant data structure
+- amortized O(1) pushing and popping from either end
+- O(1) random access any element
+- will resize itself as needed
+- sliceable
+- makes defensive copies of contents for the purposes of iteration
+- in boolean context returns
+    - `True` when not empty
+    - `False` when empty
+- in comparisons compare identity before equality, like builtins do
 
 """
 
@@ -36,7 +44,6 @@ D = TypeVar('D')
 class CA[D]:
     """Indexable circular array data structure
 
-    - generic, stateful, invariant data structure
     - amortized O(1) pushing and popping from either end
     - O(1) random access any element
     - will resize itself as needed

{dtools_circular_array-3.14.0.dist-info → dtools_circular_array-3.15.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: dtools.circular-array
-Version: 3.14.0
-Summary: ### An indexable circular array data structure.
+Version: 3.15.0
+Summary: An indexable circular array data structure.
 Keywords: circular array,dequeue,pop,push,indexable,auto resizing
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.12
@@ -24,7 +24,8 @@ Provides-Extra: test
 # Developer Tools - Circular Array
 
 Python package containing a module implementing a circular array data
-structure,
+structure, This project is part of the [Developer Tools for Python][4]
+**dtools** namespace projects.
 
 - **Repositories**
   - [dtools.circular-array][1] project on *PyPI*
@@ -32,31 +33,26 @@ structure,
 - **Detailed documentation**
   - [Detailed API documentation][3] on *GH-Pages*
 
-This project is part of the [Developer Tools for Python][4] **dtools**
-namespace projects.
-
 ## Overview
 
-- O(1) amortized pushes and pops either end.
-- O(1) indexing
-- fully supports slicing
-- safely mutates over previous state
-
-### Module circular_array
-
 A full featured auto resizing circular array data structure. Double
 sided, indexable, sliceable, and iterable. When iterated, uses cached
 copies of its present state so that the circular array itself can safely
 be mutated.
 
+- O(1) amortized pushes and pops either end.
+- O(1) indexing
+- fully supports slicing
+- safely mutates over previous state
+
 Useful either if used directly like a Python list, or in a "has-a"
 relationship when implementing other data structures.
 
 - *module* dtools.circular_array
   - *class* `CA:` circular array data structure
     - initializer takes 1 or 0 iterators
-    - like `list` or `set`
-  - *function* `ca`: produces a `CA` from function's arguments
+      - like `list` or `set` does
+  - *function* `ca`: produces a `CA` from the function's arguments
     - similar use case as syntactic constructs `[]` or `{}`
 
 Above nomenclature modeled after builtin data types like `list`, where

dtools_circular_array-3.15.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+dtools/circular_array.py,sha256=01aPPNR-N0yVoo1U94AQH1zYCis4upKp4Zo0aQ_EIqM,16405
+dtools_circular_array-3.15.0.dist-info/licenses/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
+dtools_circular_array-3.15.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+dtools_circular_array-3.15.0.dist-info/METADATA,sha256=byIqLKMsbJCiPQqVfQJqjtdAQdAugl_rb8OtdETS6Jc,3576
+dtools_circular_array-3.15.0.dist-info/RECORD,,

dtools_circular_array-3.14.0.dist-info/RECORD

@@ -1,5 +0,0 @@
-dtools/circular_array.py,sha256=GJn30Xub6oSd2Ltiy76ccUytiNpVS43RJNU4Oax6EkM,16184
-dtools_circular_array-3.14.0.dist-info/licenses/LICENSE,sha256=csqbZRvA3Nyuav1aszWvswE8CZtaKr-hMjjjcKqms7w,10774
-dtools_circular_array-3.14.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-dtools_circular_array-3.14.0.dist-info/METADATA,sha256=PPfMaC0yPeiMRUp9rsXxFtEmw7mUVkJK-DAtffjKjhI,3597
-dtools_circular_array-3.14.0.dist-info/RECORD,,