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

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

@@ -17,6 +17,23 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+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
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -27,7 +44,9 @@ PyPI 5.3.2 - 2025-09-04
 
 - removed TypeVar declarations
 - removed Never from union return types
+
   - seems Never is now interpreted as a bottom
+
 - regenerated .pyi files with mypy's stubgen
 - updated docstrings for Sphinx documentation
 
@@ -46,8 +65,10 @@ 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
 
 PyPI 5.1.2 - 2025-07-06
@@ -63,6 +84,7 @@ 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
 
 PyPI 5.1.0 - 2025-07-04
@@ -71,16 +93,22 @@ PyPI 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>`_.
@@ -91,7 +119,9 @@ 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
   - does exist as an "skeleton" project just to claim the name
   - installing it will break all the namespace packages
@@ -114,6 +144,7 @@ Version no longer determined dynamically.
 - 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
 
@@ -136,6 +167,7 @@ PyPI 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`
 
@@ -144,13 +176,18 @@ Major API change.
   - 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
 
 PyPI 3.10.1 - 2025-04-03
@@ -159,16 +196,25 @@ PyPI 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
 
 PyPI 3.9.1 - 2025-02-16
@@ -257,8 +303,10 @@ PyPI 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
 
 Version 3.3.0.1 - 2024-08-05
@@ -269,6 +317,7 @@ 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
 
@@ -282,12 +331,17 @@ The changes made were
 - 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
 
@@ -333,10 +387,13 @@ Version 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
@@ -356,7 +413,7 @@ 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.
 
 PyPI 0.1.0 - 2024-01-28
 ~~~~~~~~~~~~~~~~~~~~~~~

{pythonic_fp_circulararray-5.3.3 → pythonic_fp_circulararray-5.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 5.3.3
+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,6 +14,7 @@ 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/index.html
@@ -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.3 → pythonic_fp_circulararray-5.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-circulararray"
-version = "5.3.3"
+version = "5.4.0"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -23,7 +23,9 @@ classifiers = [
   "Programming Language :: Python :: 3.13",
   "Typing :: Typed",
 ]
-dependencies = []
+dependencies = [
+  "pythonic-fp-gadgets>=3.1.0",
+]
 dynamic = ["description"]
 
 [project.urls]