pythonic-fp-circulararray 5.3.0__tar.gz

pythonic_fp_circulararray-5.3.0/.gitignore

@@ -0,0 +1,6 @@
+# Minimal version - only add to when necessary
+**/__pycache__/
+dist/
+**/.mypy_cache/
+**/.pytest_cache/
+**/.ruff_cache

pythonic_fp_circulararray-5.3.0/CHANGELOG.rst

@@ -0,0 +1,405 @@
+CHANGELOG
+=========
+
+Latest version of
+`PyPI pythonic-fp.circulararray project changelog
+<https://github.com/grscheller/pythonic-fp-circulararray/blob/main/README.rst>`_.
+
+Semantic Versioning
+-------------------
+
+Strict 3 digit semantic versioning adopted 2025-05-19.
+
+- **MAJOR** version incremented for incompatible API changes
+- **MINOR** version incremented for backward compatible added functionality
+- **PATCH** version incremented for backward compatible bug fixes
+
+See `Semantic Versioning 2.0.0 <https://semver.org>`_.
+
+Releases and Important Milestones
+---------------------------------
+
+5.3.0 - TBD
+~~~~~~~~~~~
+
+Added a second version of circulararray which has a fixed capacity.
+
+Also, significant docstring changes as the maintainer irons out
+how best to leverage Sphinx.
+
+5.2.0 - 2025-07-13
+~~~~~~~~~~~~~~~~~~
+
+API addition, removed position only parameters from API `/` 
+
+- new API should not affect old code
+- adapted overall Sphinx documentation structure from pythonic-fp.queues
+  - document generation now done in pythonic-fp repo
+  - pythonic_fp.circulararray docstrings still a bit rough
+- fixed broken PyPI links
+
+5.1.2 - 2025-07-06
+~~~~~~~~~~~~~~~~~~
+
+Documentation across pythonic-fp namespace projects brought closer into agreement.
+
+5.1.1 - 2025-07-06
+~~~~~~~~~~~~~~~~~~
+
+Devel environment and documentation changes only.
+
+- documentation improvements
+- forgot to updated changelog.rst before PyPI release
+- Pythonic FP homepage now points to its GitHub README.md
+
+  - used to point to its GH-Pages
+
+
+5.1.0 - 2025-07-04
+~~~~~~~~~~~~~~~~~~
+
+First PyPI Release with Sphinx replacing pdoc.
+
+- switched from ``pdoc`` to ``sphinx`` for document generation
+
+  - no longer source code controlling generated HTML (too wasteful)
+  - using ``sphinx.ext.githubpages`` extension to publish from this repo
+  - using ``sphinx.ext.autodoc`` to generate detailed API documentation
+  - using the ``piccolo-theme at https://pypi.org/project/piccolo-theme/``
+
+    - beautiful dark mode
+    - plays nice with ``autodoc`` and ``DarkReader`` 
+
+- some formatting changes
+
+  - no actual code changes
+  - did remove TypeVar hack used for pdoc
+
+- made pyproject.toml improvements
+
+  - better tooling configurations
+  - removed all version caps from pyproject.toml, see this
+    `blog post <https://iscinumpy.dev/post/bound-version-constraints>`_.
+
+5.0.0 - 2025-05-23
+~~~~~~~~~~~~~~~~~~
+
+First PyPI release as ``pythonic-fp.circular-array``.
+
+- there was already a PyPI project with the dtools name
+- the name pythonic-fp was not taken
+
+  - using it as the namespace name for the entire group
+  - does exist as an "skeleton" project just to claim the name
+  - installing it will break all the namespace packages
+  - didn't want any confusion caused by someone else claiming the name
+
+3.14.0 - 2025-05-10
+~~~~~~~~~~~~~~~~~~~
+
+Made package just a single module.
+
+- dtools.circular_array.ca -> dtools.circular_array
+- docstring consolidations/updates
+
+3.13.0 - 2025-05-06
+~~~~~~~~~~~~~~~~~~~
+
+Version no longer determined dynamically.
+
+- made all non-splatted method parameters position only
+- version now set in pyproject.toml
+- no longer doing 4 part development versioning
+- version will either denote
+
+  - the current PyPI release - if no substantive changes made
+  - the next PyPI release - what development is working toward
+
+3.12.1 - 2025-04-22
+~~~~~~~~~~~~~~~~~~~
+
+- docstring changes
+- pyproject.toml standardization
+
+3.12.0 - 2025-04-07
+~~~~~~~~~~~~~~~~~~~
+
+API change.
+
+- class CA[D] no longer inherits from Sequence[D]
+- typing improvements
+
+3.11.0 - 2025-04-06
+~~~~~~~~~~~~~~~~~~~
+
+Major API change.
+
+- swapped names `ca` and `CA`
+
+  - class name now `CA`
+  - factory function taking variable number of arguments is now `ca`
+
+- class initializer still takes `1` or `0` iterables
+
+  - still want this class to behave like a builtin
+  - but got tired fighting linters
+  - maybe being "Pythonic" means
+
+    - that only builtins should break naming conventions
+    - naming conventions being
+
+      - snake_case for functions and method names
+      - CamelCase for class names
+
+    - perhaps a visual distinction is useful to tell when you
+      - are dealing with user/library Python code
+      - C code presenting itself as a Python class
+
+  - typing improvements
+
+3.10.1 - 2025-04-03
+~~~~~~~~~~~~~~~~~~~
+
+Major API changes.
+
+- class name still `ca`
+
+  - initializer takes 1 or 0 iterables
+
+    - like Python builtin types `list` or `tuple`
+
+  - factory function `CA` provided to create a `ca` from mult args
+
+    - like `[]` or `{}`
+
+- otherwise, method names are all snake_case compatible
+
+  - examples
+
+    - popL -> popl
+    - pushR -> pushr
+    - fractionFilled -> fraction_filled
+
+- updated pyproject.toml
+  - to better match other dtools namespace projects
+
+3.9.1 - 2025-02-16
+~~~~~~~~~~~~~~~~~~
+
+Fixed pdoc issues with new typing notation.
+
+- updated docstrings
+- had to add TypeVars
+
+3.9.0 - 2025-01-16
+~~~~~~~~~~~~~~~~~~
+
+First release as dtools.circular-array,
+was previously grscheller.circular-array.
+
+3.8.0 - 2025-01-03
+~~~~~~~~~~~~~~~~~~
+
+Now circular-array indexing methods fully support slicing, also added
+the rotL(n) and rotR(n) methods.
+
+3.7.1 - 2024-11-18
+~~~~~~~~~~~~~~~~~~
+
+For internal changes. Mostly for consistency across PyPI namespace projects
+
+3.7.0 - 2024-10-26
+~~~~~~~~~~~~~~~~~~
+
+Regenerated docs for PyPI release.
+
+3.6.3.2 - 2024-10-20
+~~~~~~~~~~~~~~~~~~~~
+
+Just a commit, preparing for a 3.7.0 PyPI release.
+
+- renamed class ca -> CA
+- created factory function for original constructor use case
+- generated docs in docs repo
+
+3.6.2 - 2024-10-20
+~~~~~~~~~~~~~~~~~~
+
+Removed docs from repo, now docs for all grscheller namespace projects located
+[here](https://grscheller.github.io/grscheller-pypi-namespace-docs/).
+
+3.6.1 - 2024-10-18
+~~~~~~~~~~~~~~~~~~
+
+Infrastructure and minor docstring changes. Should be compatible with
+version 3.6.0.
+
+3.6.0 - 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`
+
+3.5.0 - 2024-09-21
+~~~~~~~~~~~~~~~~~~
+
+- made the `double` method
+- O(1) amortized pushes and pops either end.
+- O(1) indexing
+- fully supports slicing
+- safely mutates over previous cached state, now called `_double_storage_capacity`
+- major docstring improvements
+- improved indentation and code alignment, now much more Pythonic
+
+3.4.1 - 2024-08-17
+~~~~~~~~~~~~~~~~~~
+
+- updated README.md to reflect name changes of CA methods
+- docstring improvements
+
+3.4.0 - 2024-08-15
+~~~~~~~~~~~~~~~~~~
+
+Updated `__eq__` comparisons.
+
+- first compare elements by identity before equality
+
+  - I noticed that is what Python builtins do
+  - makes dealing with grscheller.fp.nada module easier
+
+- standardizing docstrings across grscheller PyPI projects
+
+3.3.0.1 - 2024-08-05
+~~~~~~~~~~~~~~~~~~~~
+
+Just a commit, made a paradigm "regression".
+
+- 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
+
+The changes made were
+
+- removed grscheller.fp dependency
+- remove `_sentinel` and `_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 Sphinx 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`
+
+- 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
+
+3.2.0 - 2024-07-26
+~~~~~~~~~~~~~~~~~~
+
+The class name was changed ``CircularArray -> CA`` Now takes a "sentinel" or "fallback" value in its
+initializer, formally used ``None`` for this.
+
+3.1.0 - 2024-07-11
+~~~~~~~~~~~~~~~~~~
+
+Generic typing now being used, first PyPI release where multiple values can be
+pushed on CircularArray.
+
+3.0.0 - 2024-06-28
+~~~~~~~~~~~~~~~~~~
+Just a commit, not a PyPI release.
+
+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``
+
+2.0.0 - 2024-03-08
+~~~~~~~~~~~~~~~~~~
+
+New "epoch" due to resizing bug fixed on previous commit.
+
+- much improved and cleaned up
+- better test suite
+- method `_double()` made "public" and renamed `double()`
+- method `resize(new_size)` now resizes to at least new_size
+
+1.1.0.0 - 2024-03-08
+~~~~~~~~~~~~~~~~~~~~
+
+Just a commit to prepare for PyPI release 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 improve API for resizing CircularArrays
+  - need to test my other 2 PyPI projects, both use circular-array as a dependency
+
+1.0.1 - 2024-03-01
+~~~~~~~~~~~~~~~~~~
+
+Docstring updates to match other grscheller PyPI repos.
+
+1.0.0 - 2024-02-10
+~~~~~~~~~~~~~~~~~~
+
+First stable PyPI release, dropped minimum Python requirement to 3.10.
+
+0.1.1 - 2024-01-30
+~~~~~~~~~~~~~~~~~~
+
+Changed circular-array from a package to just a module, actually a breaking API
+change. Version number should have been 0.2.0 Also, gave CircularArray class
+`foldL` & `foldR` methods.
+
+0.1.0 - 2024-01-28
+~~~~~~~~~~~~~~~~~~
+
+- initial PyPI grscheller.circular-array release
+- migrated Circulararray class from grscheller.datastructures
+- update docstrings to reflect current nomenclature
+
+0.0.3 - 2024-01-28
+~~~~~~~~~~~~~~~~~~
+
+Got gh-pages working for the repo.
+
+0.0.2 - 2024-01-28
+~~~~~~~~~~~~~~~~~~
+
+Pushed repo up to GitHub, created README.md file for project.
+
+0.0.1 - 2024-01-28
+~~~~~~~~~~~~~~~~~~
+
+Decided to split Circulararray class out of grscheller.datastructures, will make it its own PyPI
+project. Got it working with datastructures locally.

pythonic_fp_circulararray-5.3.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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

pythonic_fp_circulararray-5.3.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-circulararray
+Version: 5.3.0
+Summary: Package implementing stateful circular array data structures.
+Keywords: auto resizing,circular array,dequeue,indexable,pop,push
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/x-rst
+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
+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: Source, https://github.com/grscheller/pythonic-fp-circulararray
+Provides-Extra: test
+
+PPythonic FP - Circular Array
+=============================
+
+PyPI project
+`pythonic-fp.circulararray
+<https://pypi.org/project/pythonic-fp.circulararray>`_.
+
+Python module implementing stateful circular array data structures.
+
+- O(1) pops either end 
+- O(1) amortized pushes either end 
+- O(1) indexing, fully supports slicing
+- Auto-resizing larger when necessary, manually compatible
+- iterable, can safely mutate while iterators continue iterating over previous state
+- comparisons compare identity before equality, like builtins
+- in boolean context returns true when not empty, false when empty
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_circulararray-5.3.0/README.rst

@@ -0,0 +1,33 @@
+PPythonic FP - Circular Array
+=============================
+
+PyPI project
+`pythonic-fp.circulararray
+<https://pypi.org/project/pythonic-fp.circulararray>`_.
+
+Python module implementing stateful circular array data structures.
+
+- O(1) pops either end 
+- O(1) amortized pushes either end 
+- O(1) indexing, fully supports slicing
+- Auto-resizing larger when necessary, manually compatible
+- iterable, can safely mutate while iterators continue iterating over previous state
+- comparisons compare identity before equality, like builtins
+- in boolean context returns true when not empty, false when empty
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.