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

pythonic_fp_queues-5.2.0/PKG-INFO

@@ -0,0 +1,51 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-queues
+Version: 5.2.0
+Summary: Queues geared to different use cases.
+Keywords: queue,fifo,lifo,dqueue
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+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.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: pythonic-fp-circulararray>=6.2.2,<6.4
+Requires-Dist: pythonic-fp-fptools>=6.1,<6.2
+Requires-Dist: pythonic-fp-gadgets>=4.5,<6
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-queues/release/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-queues
+
+# Pythonic FP - Queues
+
+Queue-like datastructures.
+
+PyPI project
+[pythonic-fp-queues](https://pypi.org/project/pythonic-fp-queues).
+Part of the
+[pythonic-fp](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).
+
+| module | class | name |
+|:------ |:-----:|:---- |
+| pythonic_fp.queues.fifo | FIFOQueue | First-In-First-Out Queue |
+| pythonic_fp.queues.lifo | LIFOQueue | Last-In-First-Out Queue |
+| pythonic_fp.queues.de | DEQueue | Double-Ended Queue |
+
+## Copyright and License
+
+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.2.0/README.md

@@ -0,0 +1,25 @@
+# Pythonic FP - Queues
+
+Queue-like datastructures.
+
+PyPI project
+[pythonic-fp-queues](https://pypi.org/project/pythonic-fp-queues).
+Part of the
+[pythonic-fp](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).
+
+| module | class | name |
+|:------ |:-----:|:---- |
+| pythonic_fp.queues.fifo | FIFOQueue | First-In-First-Out Queue |
+| pythonic_fp.queues.lifo | LIFOQueue | Last-In-First-Out Queue |
+| pythonic_fp.queues.de | DEQueue | Double-Ended Queue |
+
+## Copyright and License
+
+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 → pythonic_fp_queues-5.2.0}/pyproject.toml

@@ -4,9 +4,10 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-queues"
-version = "5.1.2"
-readme = "README.rst"
-requires-python = ">=3.13"
+version = "5.2.0"
+description = "Queues geared to different use cases."
+readme = "README.md"
+requires-python = ">=3.14"  # floor: PEP 649/749 deferred annotations — class-level self-reference possible NameErrors on <3.14
 authors = [
   { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
 ]
@@ -23,21 +24,26 @@ classifiers = [
   "License :: OSI Approved :: Apache Software License",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
   "Typing :: Typed",
 ]
 dependencies = [
-  "pythonic-fp-circulararray>=6.0.4",
-  "pythonic-fp-fptools>=5.2.0",
+  "pythonic-fp-circulararray>=6.2.2,<6.4",
+  "pythonic-fp-fptools>=6.1,<6.2",
+  "pythonic-fp-gadgets>=4.5,<6",
 ]
-dynamic = ["description"]
 
 [project.urls]
-Changelog = "https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/projects/queues.html"
+Changelog = "https://github.com/grscheller/pythonic-fp-queues/blob/main/CHANGELOG.md"
+Documentation ="https://grscheller.github.io/pythonic-fp-queues/release/html/"
 Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-queues"
 
-[project.optional-dependencies]
+[dependency-groups]
+docs = [
+  "furo>=2025.12.19",
+  "sphinx>=9.1",
+]
 test = [
   "pytest>=8.4.1",
 ]
@@ -45,6 +51,22 @@ test = [
 [tool.flit.module]
 name = "pythonic_fp.queues"
 
+[tool.flit.sdist]
+exclude = [
+  "docs/",
+  "tests/",
+  "**/.mypy_cache/",
+  "**/.ruff_cache/",
+  "**/.pytest_cache/",
+  "**/__pycache__/",
+  "**/.dmypy.json",
+]
+
+[tool.pytest]
+addopts = ["-ra"]
+consider_namespace_packages = true
+testpaths = ["tests/"]
+
 [tool.mypy]
 explicit_package_bases = true
 local_partial_types = true
@@ -53,23 +75,12 @@ warn_redundant_casts = true
 warn_return_any = true
 warn_unused_configs = true
 
-[tool.pylsp-mypy]
-enabled = true
-live-mode = true
-dmypy = false
-strict = true
-report_progress = true
-
-[tool.pytest]
-addopts = [
-  "-ra",
-]
-consider_namespace_packages = true
-testpaths = ["tests/"]
-
 [tool.ruff]
 target-version = "py314"
 
+[tool.ruff.lint]
+ignore = ["RUF022", "E741"]
+
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
@@ -78,7 +89,6 @@ docstring-quotes = "double"
   "E731",
   "C901",
 ]
-"**/*.py" = ["E741"]
 
 [tool.ruff.format]
 quote-style = "single"

{pythonic_fp_queues-5.1.2 → pythonic_fp_queues-5.2.0}/src/pythonic_fp/queues/de.py

@@ -38,18 +38,22 @@ class DEQueue[D]:
 
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable left to right.
+        .. admonition:: Initializer
+
+            Initialize ``DEQueue`` with 0 or 1 iterables to populate
+            the queue left (front) to right (rear).
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 1:
             msg = f'DEQueue expects at most 1 argument, got {size}'
             raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -61,9 +65,25 @@ class DEQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``DEQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``DEQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, DEQueue):
             return False
         return self._ca == other._ca
@@ -91,20 +111,40 @@ class DEQueue[D]:
         return reversed(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'DEQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``DEQueue``.
+
+        """
         if len(self) == 0:
             return 'DEQueue()'
         return 'DEQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        r"""
+        .. admonition:: User string
+
+            Construct string '>< d₁ | d₂ | … | dₙ ><' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '>< ' + ' | '.join(map(str, self)) + ' ><'
 
     def copy(self) -> 'DEQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the queue.
+            Shallow copy the ``DEQueue``.
 
-        :returns: Shallow copy of the ``DEQueue``.
+        :returns: New ``DEQueue`` instance containing the same references.
 
         """
         return DEQueue(self._ca)
@@ -200,7 +240,7 @@ class DEQueue[D]:
 
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
-        :returns: ``MayBe`` of reduced value with f, empty ``MayBe`` if
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe`` if
                   queue empty and no starting value given.
 
         """
@@ -223,8 +263,8 @@ class DEQueue[D]:
 
         :param f: Reducing function, second argument is for accumulator.
         :param start: Optional starting value.
-        :returns: ``MayBe`` of reduced value with f, empty ``MayBe`` if
-                  queue empty and no starting value given.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if queue empty and no starting value given.
 
         """
         if start is None:

{pythonic_fp_queues-5.1.2 → pythonic_fp_queues-5.2.0}/src/pythonic_fp/queues/fifo.py

@@ -37,18 +37,22 @@ class FIFOQueue[D]:
 
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable in FIFO order.
+        .. admonition:: Initializer
+
+            Initialize ``FIFOQueue`` with 0 or 1 iterables to populate
+            the queue in natural FIFO order.
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 1:
             msg = f'FIFOQueue expects at most 1 iterable argument, got {size}'
             raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -60,9 +64,25 @@ class FIFOQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``FIFOQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``FIFOQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, FIFOQueue):
             return False
         return self._ca == other._ca
@@ -79,20 +99,40 @@ class FIFOQueue[D]:
         return iter(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'FIFOQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``FIFOQueue``.
+
+        """
         if len(self) == 0:
            return 'FIFOQueue()'
         return 'FIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        """
+        .. admonition:: User string
+
+            Construct string '<< d₁ < d₂ < … < dₙ <<' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '<< ' + ' < '.join(map(str, self)) + ' <<'
 
     def copy(self) -> 'FIFOQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the ``FIFOQueue``.
+            Shallow copy the ``FIFOQueue``.
 
-        :returns: Shallow copy of the ``FIFOQueue``.
+        :returns: New ``FIFOQueue`` instance containing the same references.
 
         """
         return FIFOQueue(self._ca)
@@ -163,8 +203,8 @@ class FIFOQueue[D]:
 
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
-        :returns: ``MayBe`` of reduced value, empty ``MayBe`` if ``FIFOQueue``
-                  empty and no starting value given.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if ``FIFOQueue`` empty and no starting value given.
 
         """
         if start is None:

{pythonic_fp_queues-5.1.2 → pythonic_fp_queues-5.2.0}/src/pythonic_fp/queues/lifo.py

@@ -37,18 +37,22 @@ class LIFOQueue[D]:
     """
     __slots__ = ('_ca',)
 
-    def __init__(self, *dss: Iterable[D]) -> None:
+    def __init__(self, *ds: Iterable[D]) -> None:
         """
-        :param dss: Takes 0 or 1 iterable parameters. Populates
-                    queue from the iterable in LIFO order.
+        .. admonition:: Initializer
+
+            Initialize ``LIFOQueue`` with 0 or 1 iterables to populate
+            the queue in natural LIFO order.
+
+        :param ds: Takes 0 or 1 iterable parameters.
+        :raises ValueError: When more than one parameter is provided.
         :raises TypeError: When passed a non-iterable parameter.
-        :raises ValueError: When more than one parameter is given.
 
         """
-        if (size := len(dss)) > 1:
+        if (size := len(ds)) > 1:
             msg = f'LIFOQueue expects at most 1 iterable argument, got {size}'
             raise ValueError(msg)
-        self._ca = CA(dss[0]) if size == 1 else CA()
+        self._ca = CA(ds[0]) if size == 1 else CA()
 
     def __bool__(self) -> bool:
         """
@@ -60,9 +64,25 @@ class LIFOQueue[D]:
         return len(self._ca) > 0
 
     def __len__(self) -> int:
+        """
+        .. admonition:: Get length
+
+            Return the number of data elements in the ``LIFOQueue``.
+
+        """
         return len(self._ca)
 
     def __eq__(self, other: object) -> bool:
+        """
+        .. admonition:: Equality comparison
+
+            If ``other`` is a ``LIFOQueue`` and the corresponding
+            elements of ``self`` and ``other`` compare as equal,
+            then return ``True``. Otherwise return ``False``.
+
+        :returns: ``self == other``
+
+        """
         if not isinstance(other, LIFOQueue):
             return False
         return self._ca == other._ca
@@ -79,26 +99,49 @@ class LIFOQueue[D]:
         return reversed(list(self._ca))
 
     def __repr__(self) -> str:
+        """
+        .. admonition:: String representation
+
+            Construct string 'LIFOQueue(d₁, d₂, … dₙ)' where
+
+            - d₁, d₂, … dₙ are the contents displayed with ``repr()``
+
+        :returns: A string to reproduce the ``LIFOQueue``.
+
+        """
         if len(self) == 0:
             return 'LIFOQueue()'
         return 'LIFOQueue(' + ', '.join(map(repr, self._ca)) + ')'
 
     def __str__(self) -> str:
+        r"""
+        .. admonition:: User string
+
+            Construct string '|| d₁ > d₂ > … > dₙ ><' where
+
+            - d₁, d₂, ..., dₙ are the contents displayed with ``str()``
+
+        :returns: A string meaningful to an end user.
+
+        """
         return '|| ' + ' > '.join(map(str, self)) + ' ><'
 
     def copy(self) -> 'LIFOQueue[D]':
         """
-        .. admonition:: Shallow copy
+        .. admonition:: Copy
 
-            Make a shallow copy of the ``LIFOQueue``.
+            Shallow copy the ``LIFOQueue``.
 
-        :returns: Shallow copy of the ``LIFOQueue``.
+        :returns: New ``LIFOQueue`` instance containing the same references.
 
         """
         return LIFOQueue(reversed(self._ca))
 
     def push(self, *ds: D) -> None:
-        """Push items onto LIFOQueue.
+        """
+        .. admonition:: Push
+
+            Push items onto ``LIFOQueue``.
 
         :param ds: Items to be pushed onto ``LIFOQueue``.
 
@@ -145,8 +188,8 @@ class LIFOQueue[D]:
 
         :param f: Reducing function, first argument is for accumulator.
         :param start: Optional starting value.
-        :returns: ``MayBe`` of reduced value, empty ``MayBe`` if ``LIFOQueue``
-                  empty and no starting value given.
+        :returns: ``MayBe`` of reduced value with ``f``, empty ``MayBe``
+                  if ``LIFOQueue`` empty and no starting value given.
 
         """
         if start is None:

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

@@ -1,64 +0,0 @@
-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.2/.gitignore

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