pythonic-fp-queues 5.1.0__tar.gz → 5.1.2__tar.gz

pythonic_fp_queues-5.1.2/.github/workflows/static.yml

@@ -0,0 +1,64 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  RELEASE: '5.1.2'
+  DEVEL: '5.1.3'
+  PYTHON: '3.14'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Select Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON }}
+
+      - name: Install Sphinx Dependencies
+        run: |
+          pip install -r docs/requirements.txt
+          sudo apt-get install -y graphviz
+
+      - name: Build Release Docs
+        run: |
+          pip install pythonic-fp-queues
+          docs/gen_conf.py release ${{ env.RELEASE }} Queues queues > docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/release
+
+      - name: Build Development Docs
+        run: |
+          pip install -e .
+          docs/gen_conf.py devel ${{ env.DEVEL }} Queues queues > docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/development
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/build
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v5
+        id: deployment

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.2}/.gitignore

@@ -1,6 +1,9 @@
 # Minimal version - only add to when necessary
 **/__pycache__/
 dist/
+docs/build/
+docs/source/conf.py
+**/.dmypy.json
 **/.mypy_cache/
 **/.pytest_cache/
 **/.ruff_cache

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.2}/CHANGELOG.rst

@@ -17,6 +17,11 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 5.1.1 - 2026-01-15
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements for updated Sphinx documentation.
+
 PyPI 5.1.0 - 2025-09-25
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.2}/PKG-INFO

@@ -1,25 +1,25 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-queues
-Version: 5.1.0
+Version: 5.1.2
 Summary: Queues
 Keywords: queue,fifo,lifo,dqueue
 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
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-circulararray>=6.0.0
-Requires-Dist: pythonic-fp-fptools>=5.1.2
+Requires-Dist: pythonic-fp-circulararray>=6.0.4
+Requires-Dist: pythonic-fp-fptools>=5.2.0
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/queues/development/build/html/index.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/projects/queues.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-queues
 Provides-Extra: test
 
@@ -27,8 +27,8 @@ Pythonic FP - Queues
 ====================
 
 PyPI project
-`pythonic-fp.queues
-<https://pypi.org/project/pythonic-fp.queues>`_.
+`pythonic-fp-queues
+<https://pypi.org/project/pythonic-fp-queues>`_.
 
 +-------------------------+-----------+--------------------------+
 | module                  | class     | name                     |
@@ -42,19 +42,23 @@ PyPI project
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
+Documentation and other links for this project are hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/projects/queues.html>`_.
+
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/queues/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp-queues/development/html/>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.2}/README.rst

@@ -2,8 +2,8 @@ Pythonic FP - Queues
 ====================
 
 PyPI project
-`pythonic-fp.queues
-<https://pypi.org/project/pythonic-fp.queues>`_.
+`pythonic-fp-queues
+<https://pypi.org/project/pythonic-fp-queues>`_.
 
 +-------------------------+-----------+--------------------------+
 | module                  | class     | name                     |
@@ -17,18 +17,22 @@ PyPI project
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
+Documentation and other links for this project are hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/projects/queues.html>`_.
+
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/queues/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp-queues/development/html/>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_queues-5.1.2/docs/Makefile

@@ -0,0 +1,79 @@
+# Makefile for Sphinx documentation
+
+# Last and future releases
+#  - former needs to agree with PyPI
+#  - later needs to agree with pyproject.toml
+PROJECT_NAME = Queues
+PYPI_NAME = queues
+RELEASE_VERSION = 5.1.2
+DEVEL_VERSION = 5.1.3
+CUSTOM_VERSION = 0.0.0
+
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+STATICDIR = source/_static
+TEMPLATEDIR = source/_templates
+
+
+# Put help first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+clean_source:
+	@rm -f "$(SOURCEDIR)"/conf.py
+
+clean_devel:
+	@rm -rf "$(BUILDDIR)"/development
+
+clean_release:
+	@rm -rf "$(BUILDDIR)"/release
+
+clean_custom:
+	@rm -rf "$(BUILDDIR)"/custom
+
+clean: clean_devel clean_release clean_custom clean_source
+	@rm -rf $(BUILDDIR)
+	@echo Removed all doc build artifacts.
+
+setup_devel: clean_devel
+	@./gen_conf.py devel "$(DEVEL_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_release: clean_release
+	@./gen_conf.py release "$(RELEASE_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_custom: clean_custom
+	@./gen_conf.py custom "$(CUSTOM_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_redo: clean_custom
+	@echo Redoing custom build with a possibly reeditted conf.py
+	@./gen_conf.py redo "" "" ""
+
+# Build development labeled html docs.
+devel: Makefile setup_devel
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: Makefile setup_release
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+# Build custom labeled html docs.
+custom: Makefile setup_custom
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Build HTML docs with previous generated (possibly hand edited) source/conf.py,
+# put results in $(BUILDDIR)/custom.
+redo: Makefile setup_redo
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Catch-all target: route all unknown targets to Sphinx and save to $(BUILDDIR)/custom.
+# Reuse a previously generated source/conf.py.
+%: Makefile setup_redo
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+.PHONY: help Makefile
+.PHONY: setup_devel setup_release setup_custom
+.PHONY: devel release
+.PHONY: clean_source clean_devel clean_release clean_custom clean

pythonic_fp_queues-5.1.2/docs/gen_conf.py

@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+# Generate conf.py Sphinx configuration executable
+
+import sys
+import os
+
+project_prefix = 'Pythonic FP'
+pypi_prefix = 'pythonic-fp'
+author = 'Geoffrey R. Scheller'
+copyright = f'2023-2026, {author}'
+
+args = sys.argv[1:]
+num_args = len(args)
+
+if num_args == 4:
+    build_type, version, project_name, pypi_name = args
+    project = project_prefix + ' - ' + project_name
+    pypi_project_repo = pypi_prefix + '-' + pypi_name
+    project_url_rst = f'`{project} <https://pypi.org/project/{pypi_project_repo}/>`_'
+    homepage_url_rst = f'`{project_prefix} <https://grscheller.github.io/{pypi_prefix}/>`_'
+
+else:
+    sys.exit('Error: gen_conf.py takes exactly 4 arguments')
+
+match build_type:
+    case 'custom':
+        release = f'{version}'
+        release_string = f'**Custom PyPI Non-release version {release}**'
+    case 'devel':
+        release = f'{version}'
+        release_string = f'**Proposed PyPI release version {release}**'
+    case 'release':
+        release = f'{version}'
+        release_string = f'**PyPI release version {release}**'
+    case 'redo':
+        if not os.path.isfile('source/conf.py'):
+            sys.exit('Error: cannot redo without source/conf.py')
+        sys.exit()
+    case _:
+        sys.exit(f'Error: unknown built_type {build_type} given')
+
+print(f'''# Generated conf.py Sphinx configuration executable
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = '{project}'
+author = '{author}'
+copyright = '{copyright}'
+release = '{release}'
+release_string = '{release_string}'
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {{
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': False,
+    'show-inheritance': True,
+}}
+autodoc_member_order = 'bysource'
+autoclass_content = 'class'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {{
+    'light_css_variables': {{
+        'color-link--visited': 'var(--color-link)',
+    }},
+    'dark_css_variables': {{
+        'color-link--visited': 'var(--color-link)',
+    }},
+}}
+html_theme = 'furo'
+html_static_path = ['_static']
+
+rst_epilog = """
+.. |RELEASE_STRING| replace:: {release_string}
+
+"""
+''')

pythonic_fp_queues-5.1.2/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=9.1
+furo

pythonic_fp_queues-5.1.2/docs/source/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+---------
+
+Change log for the
+`pythonic-fp-queues
+<https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst>`_
+PyPI project.

pythonic_fp_queues-5.1.2/docs/source/description.rst

@@ -0,0 +1,7 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.queues
+    :synopsis:
+    :noindex:
+

pythonic_fp_queues-5.1.2/docs/source/docs/de.rst

@@ -0,0 +1,6 @@
+de
+==
+
+.. automodule:: pythonic_fp.queues.de
+    :members:
+    :special-members:

pythonic_fp_queues-5.1.2/docs/source/docs/fifo.rst

@@ -0,0 +1,6 @@
+filo
+====
+
+.. automodule:: pythonic_fp.queues.fifo
+    :members:
+    :special-members:

pythonic_fp_queues-5.1.2/docs/source/docs/index.rst

@@ -0,0 +1,23 @@
+Queues
+======
+
+.. automodule:: pythonic_fp.queues
+    :synopsis:
+
+.. toctree::
+    :caption: First In First Out
+    :maxdepth: 2
+
+    fifo
+
+.. toctree::
+    :caption: Last In First Out
+    :maxdepth: 2
+
+    lifo
+
+.. toctree::
+    :caption: Double Ended
+    :maxdepth: 2
+
+    de

pythonic_fp_queues-5.1.2/docs/source/docs/lifo.rst

@@ -0,0 +1,6 @@
+lifo
+====
+
+.. automodule:: pythonic_fp.queues.lifo
+    :members:
+    :special-members:

pythonic_fp_queues-5.1.2/docs/source/index.rst

@@ -0,0 +1,30 @@
+pythonic-fp-queues
+==================
+
+PyPI Project
+`Pythonic FP - Queues <https://pypi.org/project/pythonic-fp-queues/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+projects.
+
+|RELEASE_STRING|
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_queues-5.1.2/docs/source/releases.rst

@@ -0,0 +1,16 @@
+PyPI releases
+=============
+
+**pythonic-fp-queues:** pythonic_fp.queues
+
++------------------------------------------------------------------------------------+--------------+
+| PyPI Release                                                                       | Release date |
++====================================================================================+==============+
+| `development <https://grscheller.github.io/pythonic-fp-queues/development/html/>`_ |              |
++------------------------------------------------------------------------------------+--------------+
+| `v5.1.2 <https://grscheller.github.io/pythonic-fp-queues/release/html/>`_          | 2026-05-02   |
++------------------------------------------------------------------------------------+--------------+
+| v5.1.1                                                                             | 2026-01-15   |
++------------------------------------------------------------------------------------+--------------+
+| v5.1.0                                                                             | 2025-09-28   |
++------------------------------------------------------------------------------------+--------------+

pythonic_fp_queues-5.1.2/docs/source/usage.rst

@@ -0,0 +1,22 @@
+Usage
+=====
+
+How to install the package
+--------------------------
+
+Install the project into your Python environment:
+
+.. code:: console
+
+   $ pip install pythonic-fp.queues
+
+Importing the package
+---------------------
+
+Import the queue classes and "factory functions" into your code.
+
+.. code:: python
+
+    from pythonic_fp.queues.fifo import FIFOQueue, fifo_queue
+    from pythonic_fp.queues.lifo import LIFOQueue, lifo_queue
+    from pythonic_fp.queues.de import DEQueue, de_queue

{pythonic_fp_queues-5.1.0 → pythonic_fp_queues-5.1.2}/pyproject.toml

@@ -1,30 +1,40 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [project]
 name = "pythonic-fp-queues"
-version = "5.1.0"
+version = "5.1.2"
 readme = "README.rst"
-requires-python = ">=3.12"
-license = { file = "LICENSE" }
-authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
-keywords = ["queue", "fifo", "lifo", "dqueue"]
+requires-python = ">=3.13"
+authors = [
+  { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
+keywords = [
+  "queue",
+  "fifo",
+  "lifo",
+  "dqueue",
+]
 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",
+  "Programming Language :: Python :: 3.14",
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-circulararray>=6.0.0",
-  "pythonic-fp-fptools>=5.1.2",
+  "pythonic-fp-circulararray>=6.0.4",
+  "pythonic-fp-fptools>=5.2.0",
 ]
 dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/queues/development/build/html/index.html"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Documentation = "https://grscheller.github.io/pythonic-fp/projects/queues.html"
+Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-queues"
 
 [project.optional-dependencies]
@@ -32,17 +42,11 @@ test = [
   "pytest>=8.4.1",
 ]
 
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
 [tool.flit.module]
 name = "pythonic_fp.queues"
 
 [tool.mypy]
-enable_incomplete_feature = "NewGenericSyntax"
 explicit_package_bases = true
-implicit_reexport = false
 local_partial_types = true
 namespace_packages = true
 warn_redundant_casts = true
@@ -56,19 +60,24 @@ dmypy = false
 strict = true
 report_progress = true
 
-[tool.pytest.ini_options]
-addopts = "-ra"
+[tool.pytest]
+addopts = [
+  "-ra",
+]
 consider_namespace_packages = true
 testpaths = ["tests/"]
 
 [tool.ruff]
-target-version = "py313"
+target-version = "py314"
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["C901"]
+"tests/**/*.py" = [
+  "E731",
+  "C901",
+]
 "**/*.py" = ["E741"]
 
 [tool.ruff.format]

pythonic_fp_queues-5.1.2/src/pythonic_fp/queues/__init__.py

@@ -0,0 +1,31 @@
+# Copyright 2023-2026 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.
+
+"""
+Queues
+------
+
+.. admonition:: Stateful Queues
+
+    By limiting how their data can be accessed, each queue type
+    supports different algorithmic use cases.
+
+    Sometimes the power of a data structure comes not what it empowers
+    you to do, but what it prevents you from doing to yourself.
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'