dtools.circular-array 3.9.0__tar.gz

dtools_circular_array-3.9.0/CHANGELOG.md

@@ -0,0 +1,192 @@
+# CHANGELOG
+
+PyPI grscheller.circular-array project.
+
+#### Semantic Versioning
+
+* first digit - major event, epoch, or paradigm shift
+* second digit - breaking API changes, major changes
+* third digit - bug fixes, API additions, breaking API in dev env
+* forth digit - commit count changes/regressions (dev environment only)
+
+## Releases and Important Milestones
+
+### Version 3.9.0 - PyPI release date 2025-10-??
+* Final release as dtools.circular-array
+  * was previously grscheller.circular-array
+
+### Version 3.8.0 - PyPI release date 2025-01-03
+
+* now circular-array indexing methods fully support slicing
+  * `__getitem__`
+  * `__setitem__`
+  * `__delitem__`
+* added rotL(n) and rotR(n) methods
+
+### Version 3.7.1 - PyPI release date 2024-11-18
+
+* for internal changes
+  * mostly for consistency across PyPI namespace projects
+
+### Version 3.7.0 - PyPI release date 2024-10-26
+
+* regenerated docs for PyPI release
+
+### Version 3.6.3.2 - Commit date 2024-10-20
+
+* preparing for a 3.7.0 PyPI release
+  * renamed class ca -> CA
+    * ca now takes 0 or 1 iterables
+  * created factory function for original constructor use case
+    * CA[D](*ds: D) -> ca[D]
+* generated docs in docs repo - 2024-10-23
+
+### Version 3.6.2 - PyPI release date 2024-10-20
+
+* removed docs from repo
+* docs for all grscheller namespace projects maintained here
+  * https://grscheller.github.io/grscheller-pypi-namespace-docs/
+
+### Version 3.6.1 - PyPI release date 2024-10-18
+
+* infrastructure and minor docstring changes
+  * should be compatible with version 3.6.0
+
+### Version 3.6.0 - PyPI release date 2024-09-21
+
+* no future changes planned for the foreseeable future
+  * feature complete
+  * no external dependencies
+  * well tested with other grscheller namespace packages
+* final API tweaks made
+* several more pytest tests added
+* made the `compact` method private
+  * now called `_compact_storage_capacity`
+
+### Version 3.5.0 - PyPI release date 2024-09-21
+
+* made the `double` method private
+  * now called `_double_storage_capacity`
+* major docstring improvements
+* improved indentation and code alignment
+  * now much more Pythonic
+
+### Version 3.4.1 - PyPI release date 2024-08-17
+
+* updated README.md to reflect name changes of CA methods
+* docstring improvements
+
+### Version 3.4.0 - PyPI release date 2024-08-15
+
+* updated `__eq__` comparisons
+  * first compare elements by identity before equality
+    * noticed that is what Python builtins do
+    * makes dealing with grscheller.fp.nada module easier
+* standardizing docstrings across grscheller PyPI projects
+
+### Version 3.3.0.1 - commit date 2024-08-05
+
+* made a paradigm "regression", preparing for a 3.4.0 release
+* felt CA was becoming way too complicated
+* grscheller.datastructures needed it to fully embrace type annotations
+  * but I was shifting too many features back into grscheller.circular-array
+  * want ca to be useful for non-functional applications
+* changes made
+  * removed grscheller.fp dependency
+  * remove _sentinel & _storable slots from CA class
+  * remove copy method, just use ca2 = CA(*ca1) to make a shallow copy
+  * adjust __repr__ and __str__ methods
+  * experimenting with Spinx syntax in docstrings (still using pdoc3)
+  * changed nomenclature from "left/right" to "front/rear"
+  * unsafe and safe versions of pop & fold functionality
+  * left and right folds improvements
+    * consolidated `foldL, foldL1, foldR, foldR1` into `foldL` & `foldR`
+    * TODO: rename `foldL` to `fold_forward` & `foldR` to `fold_backward`
+  * tests working
+    * basically I changed pops to unsafe pops and added `try except` blocks
+    * safe versions tests needed
+      * safe pops return multiple values in tuples
+      * will take a `default` value to return
+        * if only asked to return 1 value and CA is empty
+        * seems to work properly from iPython
+
+### Version 3.2.0 - PyPI release date 2024-07-26
+
+* class name changed CircularArray -> CA
+* Now takes a "sentinel" or "fallback" value in its initializer
+  * formally used None for this
+
+### Version 3.1.0 - PyPI release date 2024-07-11
+
+* generic typing now being used
+* first PyPI release where mult values can be pushed on CircularArray
+
+### Version 3.0.0 - commit date 2024-06-28
+
+* CircularArray class now using Generic Type Parameter
+
+* new epoch in development, start of 3.0 series
+* now using TypeVars
+* API changes
+  * foldL(self, f: Callable[[T, T], T]) -> T|None
+  * foldR(self, f: Callable[[T, T], T]) -> T|None
+  * foldL1(self, f: Callable[[S, T], S], initial: S) -> S
+  * foldR1(self, f: Callable[[T, S], S], initial: S) -> S
+
+### Version 2.0.0 - PyPI release date 2024-03-08
+
+* new epoch due to resizing bug fixed on previous commit
+  * much improved and cleaned up
+  * much better test suite
+* method _double() made "public" and renamed double()
+* resize(new_size) now resizes to at least new_size
+
+### Version 1.1.0.0 - commit date 2024-03-08
+
+* NEXT PyPI RELEASE WILL BE 2.0.0 !!!!!!!!!!!
+* BUGFIX: Fixed a subtle resizing bug
+  * bug probably present in all previous versions
+    * not previously identified due to inadequate test coverage
+  * test coverage improved vastly
+* made some major code API changes
+  * upon initialization minimizing size of the CircularArray
+  * have some ideas on how to to improve API for resizing CircularArrays
+  * need to test my other 2 PyPI projects
+    * both use circular-array as a dependency
+
+### Version 1.0.1 - PyPI release date 2024-03-01
+
+* docstring updates to match other grscheller PyPI repos
+
+### Version 1.0.0 - PyPI release date 2024-02-10
+
+* first stable release
+* dropped minimum Python requirement to 3.10
+
+### Version 0.1.1 - PyPI release date 2024-01-30
+
+* changed circular-array from a package to just a module
+  * actually breaking API change
+  * version number should have been 0.2.0
+* gave CircularArray class foldL & foldR methods
+
+### Version 0.1.0 - PyPI release date 2024-01-28
+
+* initial PyPI grscheller.circular-array release
+* migrated Circulararray class from grscheller.datastructutes
+* update docstrings to reflect current nomenclature
+
+### Version 0.0.3 - commit date 2024-01-28
+
+* got gh-pages working for the repo
+
+### Version 0.0.2 - commit date 2024-01-28
+
+* pushed repo up to GitHub
+* created README.md file for project
+
+### Version 0.0.1 - commit date 2024-01-28
+
+* decided to split Circulararray class out of datastructures
+  * will make it its own PyPI project
+* got working with datastructures locally

dtools_circular_array-3.9.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2023-2024 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.

dtools_circular_array-3.9.0/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.3
+Name: dtools.circular-array
+Version: 3.9.0
+Summary: ### Circular Array
+Keywords: circular array,circle array,CA,double ended queue,dequeue,dqueue,pop,push,popL,popR,pushL,pushR,indexable,auto-resizing,auto resizing,resizing
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: pytest >=8.3.2 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/dtools-circular-array/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/dtools-docs/circular-array
+Project-URL: Source, https://github.com/grscheller/dtools-circular-array
+Provides-Extra: test
+
+# Python Circular Array Implementation
+
+Python module implementing an indexable, double sided,
+auto-resizing queue data structure.
+
+* **Repositories**
+  * [dtools.circular-array][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* **Detailed documentation**
+  * [Detailed API documentation][3] on *GH-Pages*
+
+### Overview
+
+Useful if used directly as an improved version of a Python List or in
+a "has-a" relationship when implementing other data structures.
+
+* O(1) pushes and pops either end.
+* O(1) indexing
+* now fully supports slicing!
+
+### Usage
+
+```python
+from dtools.circular_array.ca import CA
+
+ca = CA(1, 2, 3)
+assert ca.popL() == 1
+assert ca.popR() == 3
+ca.pushR(42, 0)
+ca.pushL(0, 1)
+assert repr(ca) == 'CA(1, 0, 2, 42, 0)'
+assert str(ca) == '(|1, 0, 2, 42, 0|)'
+
+ca = CA(*range(1,11))
+assert repr(ca) == 'CA(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)'
+assert str(ca) == '(|1, 2, 3, 4, 5, 6, 7, 8, 9, 10|)'
+assert len(ca) == 10
+tup3 = ca.popLT(3)
+tup4 = ca.popRT(4)
+assert tup3 == (1, 2, 3)
+assert tup4 == (10, 9, 8, 7)
+
+assert ca == CA(4, 5, 6)
+four, *rest = ca.popFT(1000)
+assert four == 4
+assert rest == [5, 6]
+assert len(ca) == 0
+
+ca = CA(1, 2, 3)
+assert ca.popLD(42) == 1
+assert ca.popRD(42) == 3
+assert ca.popLD(42) == 2
+assert ca.popRD(42) == 42
+assert ca.popLD(42) == 42
+assert len(ca) == 0
+```
+
+---
+
+[1]: https://pypi.org/project/dtools.circular-array
+[2]: https://github.com/grscheller/dtools-circular-array
+[3]: https://grscheller.github.io/dtools-namespace-docs/circular-array/
+
+

dtools_circular_array-3.9.0/README.md

@@ -0,0 +1,63 @@
+# Python Circular Array Implementation
+
+Python module implementing an indexable, double sided,
+auto-resizing queue data structure.
+
+* **Repositories**
+  * [dtools.circular-array][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* **Detailed documentation**
+  * [Detailed API documentation][3] on *GH-Pages*
+
+### Overview
+
+Useful if used directly as an improved version of a Python List or in
+a "has-a" relationship when implementing other data structures.
+
+* O(1) pushes and pops either end.
+* O(1) indexing
+* now fully supports slicing!
+
+### Usage
+
+```python
+from dtools.circular_array.ca import CA
+
+ca = CA(1, 2, 3)
+assert ca.popL() == 1
+assert ca.popR() == 3
+ca.pushR(42, 0)
+ca.pushL(0, 1)
+assert repr(ca) == 'CA(1, 0, 2, 42, 0)'
+assert str(ca) == '(|1, 0, 2, 42, 0|)'
+
+ca = CA(*range(1,11))
+assert repr(ca) == 'CA(1, 2, 3, 4, 5, 6, 7, 8, 9, 10)'
+assert str(ca) == '(|1, 2, 3, 4, 5, 6, 7, 8, 9, 10|)'
+assert len(ca) == 10
+tup3 = ca.popLT(3)
+tup4 = ca.popRT(4)
+assert tup3 == (1, 2, 3)
+assert tup4 == (10, 9, 8, 7)
+
+assert ca == CA(4, 5, 6)
+four, *rest = ca.popFT(1000)
+assert four == 4
+assert rest == [5, 6]
+assert len(ca) == 0
+
+ca = CA(1, 2, 3)
+assert ca.popLD(42) == 1
+assert ca.popRD(42) == 3
+assert ca.popLD(42) == 2
+assert ca.popRD(42) == 42
+assert ca.popLD(42) == 42
+assert len(ca) == 0
+```
+
+---
+
+[1]: https://pypi.org/project/dtools.circular-array
+[2]: https://github.com/grscheller/dtools-circular-array
+[3]: https://grscheller.github.io/dtools-namespace-docs/circular-array/
+

dtools_circular_array-3.9.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["flit_core>=3.4,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "dtools.circular-array"
+authors = [
+    { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed"
+]
+dependencies = []
+dynamic = ["version", "description"]
+keywords = [
+    "circular array", "circle array", "CA",
+    "double ended queue", "dequeue", "dqueue",
+    "pop", "push", "popL", "popR", "pushL", "pushR", "indexable",
+    "auto-resizing", "auto resizing", "resizing"
+]
+
+[project.optional-dependencies]
+test = ["pytest >=8.3.2"]
+
+[project.urls]
+Source = "https://github.com/grscheller/dtools-circular-array"
+Changelog = "https://github.com/grscheller/dtools-circular-array/blob/main/CHANGELOG.md"
+Documentation = "https://grscheller.github.io/dtools-docs/circular-array"
+
+[tool.flit.sdist]
+exclude = ["dist", "docs", ".gitignore", ".mypy_cache"]
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+strict = true
+report_progress = true
+
+[tool.mypy]
+enable_incomplete_feature = ["NewGenericSyntax"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+consider_namespace_packages = true
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"

dtools_circular_array-3.9.0/src/dtools/circular_array/__init__.py

@@ -0,0 +1,27 @@
+# Copyright 2016-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 for an indexable circular array data structure.
+
+#### Modules
+
+* module dtools.circular_array.ca: circular array Python data structure
+
+"""
+__version__ = "3.9.0"
+__author__ = "Geoffrey R. Scheller"
+__copyright__ = "Copyright (c) 2023-2025 Geoffrey R. Scheller"
+__license__ = "Apache License 2.0"