pythonic-fp-circulararray 5.3.2__tar.gz → 5.4.0__tar.gz

{pythonic_fp_circulararray-5.3.2 → pythonic_fp_circulararray-5.4.0}/CHANGELOG.rst

@@ -1,9 +1,7 @@
 CHANGELOG
 =========
 
-Latest version of
-`PyPI pythonic-fp.circulararray project changelog
-<https://github.com/grscheller/pythonic-fp-circulararray/blob/main/README.rst>`_.
+PyPI pythonic-fp-circulararray project.
 
 Semantic Versioning
 -------------------
@@ -19,8 +17,30 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-5.3.2 - TBD
-~~~~~~~~~~~
+PyPI 5.4.0 - TBD
+~~~~~~~~~~~~~~~~
+
+- updated README.rst
+
+  - previous version never fully updated for two circular array types
+
+- realized that both circular array types cannot store None as a value
+
+  - now using pythonic_fp.gadgets.sentinels.novalue.NoValue as the sentinel
+
+    - typing for foldl & foldr a bit quirky (mypy bug?)
+
+  - bumping minor version number
+
+    - more than a bug fix but not really an API change either
+
+PyPI 5.3.3 - 2025-09-21
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Polished up docstrings. PyPI documentation link now goes to root, not releases.
+
+PyPI 5.3.2 - 2025-09-04
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - removed TypeVar declarations
 - removed Never from union return types
@@ -30,32 +50,34 @@ Releases and Important Milestones
 - regenerated .pyi files with mypy's stubgen
 - updated docstrings for Sphinx documentation
 
-5.3.1 - 2025-08-02
-~~~~~~~~~~~~~~~~~~
+PyPI 5.3.1 - 2025-08-02
+~~~~~~~~~~~~~~~~~~~~~~~
 
 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
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 5.1.2 - 2025-07-06
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Documentation across pythonic-fp namespace projects brought closer into agreement.
 
-5.1.1 - 2025-07-06
-~~~~~~~~~~~~~~~~~~
+PyPI 5.1.1 - 2025-07-06
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Devel environment and documentation changes only.
 
@@ -65,9 +87,8 @@ Devel environment and documentation changes only.
 
   - used to point to its GH-Pages
 
-
-5.1.0 - 2025-07-04
-~~~~~~~~~~~~~~~~~~
+PyPI 5.1.0 - 2025-07-04
+~~~~~~~~~~~~~~~~~~~~~~~
 
 First PyPI Release with Sphinx replacing pdoc.
 
@@ -92,12 +113,13 @@ First PyPI Release with Sphinx replacing pdoc.
   - removed all version caps from pyproject.toml, see this
     `blog post <https://iscinumpy.dev/post/bound-version-constraints>`_.
 
-5.0.0 - 2025-05-23
-~~~~~~~~~~~~~~~~~~
+PyPI 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
@@ -105,16 +127,16 @@ First PyPI release as ``pythonic-fp.circular-array``.
   - 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
-~~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~~
+PyPI 3.13.0 - 2025-05-06
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Version no longer determined dynamically.
 
@@ -126,22 +148,21 @@ Version no longer determined dynamically.
   - the current PyPI release - if no substantive changes made
   - the next PyPI release - what development is working toward
 
-3.12.1 - 2025-04-22
-~~~~~~~~~~~~~~~~~~~
+PyPI 3.12.1 - 2025-04-22
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-- docstring changes
-- pyproject.toml standardization
+Docstring changes and pyproject.toml standardization.
 
-3.12.0 - 2025-04-07
-~~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~~
+PyPI 3.11.0 - 2025-04-06
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Major API change.
 
@@ -163,13 +184,14 @@ Major API change.
       - 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
-~~~~~~~~~~~~~~~~~~~
+PyPI 3.10.1 - 2025-04-03
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Major API changes.
 
@@ -192,40 +214,41 @@ Major API changes.
     - fractionFilled -> fraction_filled
 
 - updated pyproject.toml
+
   - to better match other dtools namespace projects
 
-3.9.1 - 2025-02-16
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 3.9.0 - 2025-01-16
+~~~~~~~~~~~~~~~~~~~~~~~
 
 First release as dtools.circular-array,
 was previously grscheller.circular-array.
 
-3.8.0 - 2025-01-03
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 3.7.1 - 2024-11-18
+~~~~~~~~~~~~~~~~~~~~~~~
 
 For internal changes. Mostly for consistency across PyPI namespace projects
 
-3.7.0 - 2024-10-26
-~~~~~~~~~~~~~~~~~~
+PyPI 3.7.0 - 2024-10-26
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Regenerated docs for PyPI release.
 
-3.6.3.2 - 2024-10-20
-~~~~~~~~~~~~~~~~~~~~
+Version 3.6.3.2 - 2024-10-20
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Just a commit, preparing for a 3.7.0 PyPI release.
 
@@ -233,20 +256,20 @@ Just a commit, preparing for a 3.7.0 PyPI release.
 - created factory function for original constructor use case
 - generated docs in docs repo
 
-3.6.2 - 2024-10-20
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 3.6.0 - 2024-09-21
+~~~~~~~~~~~~~~~~~~~~~~~
 
 No future changes planned for the foreseeable future
 
@@ -257,8 +280,8 @@ No future changes planned for the foreseeable future
 - several more pytest tests added
 - made the `compact` method private, now called `_compact_storage_capacity`
 
-3.5.0 - 2024-09-21
-~~~~~~~~~~~~~~~~~~
+PyPI 3.5.0 - 2024-09-21
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - made the `double` method
 - O(1) amortized pushes and pops either end.
@@ -268,14 +291,14 @@ No future changes planned for the foreseeable future
 - major docstring improvements
 - improved indentation and code alignment, now much more Pythonic
 
-3.4.1 - 2024-08-17
-~~~~~~~~~~~~~~~~~~
+PyPI 3.4.1 - 2024-08-17
+~~~~~~~~~~~~~~~~~~~~~~~
 
 - updated README.md to reflect name changes of CA methods
 - docstring improvements
 
-3.4.0 - 2024-08-15
-~~~~~~~~~~~~~~~~~~
+PyPI 3.4.0 - 2024-08-15
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Updated `__eq__` comparisons.
 
@@ -286,8 +309,8 @@ Updated `__eq__` comparisons.
 
 - standardizing docstrings across grscheller PyPI projects
 
-3.3.0.1 - 2024-08-05
-~~~~~~~~~~~~~~~~~~~~
+Version 3.3.0.1 - 2024-08-05
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Just a commit, made a paradigm "regression".
 
@@ -322,20 +345,20 @@ The changes made were
       - if only asked to return 1 value and CA is empty
       - seems to work properly from iPython
 
-3.2.0 - 2024-07-26
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+Version 3.0.0 - 2024-06-28
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 Just a commit, not a PyPI release.
 
 CircularArray class now using Generic Type Parameter. new epoch in development,
@@ -348,8 +371,8 @@ API changes:
 - ``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
-~~~~~~~~~~~~~~~~~~
+PyPI 2.0.0 - 2024-03-08
+~~~~~~~~~~~~~~~~~~~~~~~
 
 New "epoch" due to resizing bug fixed on previous commit.
 
@@ -358,8 +381,8 @@ New "epoch" due to resizing bug fixed on previous commit.
 - 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
-~~~~~~~~~~~~~~~~~~~~
+Version 1.1.0.0 - 2024-03-08
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Just a commit to prepare for PyPI release 2.0.0!!!
 
@@ -375,42 +398,42 @@ Just a commit to prepare for PyPI release 2.0.0!!!
   - 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
-~~~~~~~~~~~~~~~~~~
+PyPI 1.0.1 - 2024-03-01
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Docstring updates to match other grscheller PyPI repos.
 
-1.0.0 - 2024-02-10
-~~~~~~~~~~~~~~~~~~
+PyPI 1.0.0 - 2024-02-10
+~~~~~~~~~~~~~~~~~~~~~~~
 
 First stable PyPI release, dropped minimum Python requirement to 3.10.
 
-0.1.1 - 2024-01-30
-~~~~~~~~~~~~~~~~~~
+PyPI 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.
+``foldL`` & ``foldR`` methods.
 
-0.1.0 - 2024-01-28
-~~~~~~~~~~~~~~~~~~
+PyPI 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
-~~~~~~~~~~~~~~~~~~
+Version 0.0.3 - 2024-01-28
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Got gh-pages working for the repo.
 
-0.0.2 - 2024-01-28
-~~~~~~~~~~~~~~~~~~
+Version 0.0.2 - 2024-01-28
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Pushed repo up to GitHub, created README.md file for project.
 
-0.0.1 - 2024-01-28
-~~~~~~~~~~~~~~~~~~
+Version 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.2 → pythonic_fp_circulararray-5.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 5.3.2
+Version: 5.4.0
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -14,9 +14,10 @@ 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: 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: 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: Source, https://github.com/grscheller/pythonic-fp-circulararray
 Provides-Extra: test
@@ -30,17 +31,31 @@ PyPI project
 
 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>`_
+- variable storage capacity circular array
+
+  - 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
+
+- fixed storage capacity circular array
+
+  - 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
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+PyPI projects.
 
 Documentation
 -------------

pythonic_fp_circulararray-5.4.0/README.rst

@@ -0,0 +1,47 @@
+Pythonic FP - Circular Array
+============================
+
+PyPI project
+`pythonic-fp-circulararray
+<https://pypi.org/project/pythonic-fp-circulararray>`_.
+
+Python module implementing stateful circular array data structures.
+
+- variable storage capacity circular array
+
+  - 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
+
+- fixed storage capacity circular array
+
+  - 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
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+PyPI projects.
+
+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.2 → pythonic_fp_circulararray-5.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-circulararray"
-version = "5.3.2"
+version = "5.4.0"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -23,12 +23,14 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Typing :: Typed",
 ]
-dependencies = []
+dependencies = [
+  "pythonic-fp-gadgets>=3.1.0",
+]
 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/releases.html"
+Documentation = "https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/index.html"
 Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
 Source = "https://github.com/grscheller/pythonic-fp-circulararray"
 

{pythonic_fp_circulararray-5.3.2 → pythonic_fp_circulararray-5.4.0}/src/pythonic_fp/circulararray/__init__.py

@@ -14,7 +14,7 @@
 
 """
 Circular Array
-==============
+--------------
 
 Package implementing stateful circular array data structures.
 
@@ -29,7 +29,6 @@ Package implementing stateful circular array data structures.
 +-------------------------------------+-------------------------------------------+
 | **pythonic_fp.circulararray.fixed** | Fixed storage capacity circular array.    |
 +-------------------------------------+-------------------------------------------+
-
 """
 
 __author__ = 'Geoffrey R. Scheller'