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

{pythonic_fp_circulararray-5.3.1 → pythonic_fp_circulararray-5.3.3}/.gitignore

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

{pythonic_fp_circulararray-5.3.1 → pythonic_fp_circulararray-5.3.3}/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,16 +17,30 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-5.3.0 - TBD
-~~~~~~~~~~~
+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
+  - seems Never is now interpreted as a bottom
+- regenerated .pyi files with mypy's stubgen
+- updated docstrings for Sphinx documentation
+
+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 `/` 
 
@@ -38,72 +50,63 @@ API addition, removed position only parameters from API `/`
   - 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.
 
 - 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
-~~~~~~~~~~~~~~~~~~
+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>`_.
 
-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
   - 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
-~~~~~~~~~~~~~~~~~~~
+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.
 
@@ -111,31 +114,28 @@ 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
 
-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.
 
 - swapped names `ca` and `CA`
-
   - class name now `CA`
   - factory function taking variable number of arguments is now `ca`
 
@@ -144,77 +144,65 @@ 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
 
-3.10.1 - 2025-04-03
-~~~~~~~~~~~~~~~~~~~
+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
 
-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.
 
@@ -222,20 +210,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
 
@@ -246,8 +234,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.
@@ -257,33 +245,30 @@ 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.
 
 - 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
-~~~~~~~~~~~~~~~~~~~~
+Version 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
 
@@ -297,34 +282,29 @@ 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
 
-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,
@@ -337,8 +317,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.
 
@@ -347,59 +327,56 @@ 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!!!
 
 - 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
-~~~~~~~~~~~~~~~~~~
+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.
 
-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.1 → pythonic_fp_circulararray-5.3.3}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 5.3.1
-Summary: Package implementing stateful circular array data structures.
-Keywords: auto resizing,circular array,dequeue,indexable,pop,push
+Version: 5.3.3
+Summary: Circular Array
+Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Framework :: Pytest
@@ -16,13 +16,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: 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
 
-PPythonic FP - Circular Array
-=============================
+Pythonic FP - Circular Array
+============================
 
 PyPI project
 `pythonic-fp-circulararray

{pythonic_fp_circulararray-5.3.1 → pythonic_fp_circulararray-5.3.3}/README.rst

@@ -1,5 +1,5 @@
-PPythonic FP - Circular Array
-=============================
+Pythonic FP - Circular Array
+============================
 
 PyPI project
 `pythonic-fp-circulararray

{pythonic_fp_circulararray-5.3.1 → pythonic_fp_circulararray-5.3.3}/pyproject.toml

@@ -1,17 +1,14 @@
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
 [project]
 name = "pythonic-fp-circulararray"
-version = "5.3.1"
+version = "5.3.3"
 readme = "README.rst"
-requires-python = ">=3.12"
+requires-python = ">=3.13"
 license = { file = "LICENSE" }
 authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
 keywords = [
   "auto resizing",
   "circular array",
+  "circulararray",
   "dequeue",
   "indexable",
   "pop",
@@ -29,24 +26,30 @@ classifiers = [
 dependencies = []
 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/index.html"
+Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Source = "https://github.com/grscheller/pythonic-fp-circulararray"
+
 [project.optional-dependencies]
 test = [
   "pytest>=8.4.1",
 ]
 
-[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"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.rst"
-Source = "https://github.com/grscheller/pythonic-fp-circulararray"
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
 
 [tool.flit.module]
 name = "pythonic_fp.circulararray"
 
 [tool.mypy]
-enable_incomplete_feature = ["NewGenericSyntax"]
+enable_incomplete_feature = "NewGenericSyntax"
+explicit_package_bases = true
 implicit_reexport = false
 local_partial_types = true
+namespace_packages = true
 warn_redundant_casts = true
 warn_return_any = true
 warn_unused_configs = true
@@ -54,21 +57,25 @@ warn_unused_configs = true
 [tool.pylsp-mypy]
 enabled = true
 live-mode = true
+dmypy = false
 strict = true
 report_progress = true
 
 [tool.pytest.ini_options]
+addopts = "-ra"
 consider_namespace_packages = true
 testpaths = ["tests/"]
-addopts = "-ra"
 
 [tool.ruff]
 target-version = "py313"
-ignore = ["E741"]
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["C901"]
+"**/*.py" = ["E741"]
+
 [tool.ruff.format]
 quote-style = "single"
 docstring-code-line-length = 72

{pythonic_fp_circulararray-5.3.1 → pythonic_fp_circulararray-5.3.3}/src/pythonic_fp/circulararray/__init__.py

@@ -12,7 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Package implementing stateful circular array data structures.
+"""
+Circular Array
+--------------
+
+Package implementing stateful circular array data structures.
 
 - O(1) pops and pushes either end
 - O(1) indexing and size determination
@@ -25,7 +29,6 @@
 +-------------------------------------+-------------------------------------------+
 | **pythonic_fp.circulararray.fixed** | Fixed storage capacity circular array.    |
 +-------------------------------------+-------------------------------------------+
-
 """
 
 __author__ = 'Geoffrey R. Scheller'