pythonic-fp.queues 3.0.0__py3-none-any.whl

pythonic_fp/queues/__init__.py

@@ -0,0 +1,43 @@
+# Copyright 2023-2024 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.
+
+"""Developer Tools - Queue based data structures
+
+These are modeled after Python builtins. The initializers take at most one
+iterable while factory functions stand in for Python syntax.
+
+Queue types:
+
+- *class* dtools.queues.fifo.FIFOQueue: First-In-First-Out Queue
+- *class* dtools.queues.lifo.LIFOQueue: Last-In-First-Out Queue
+- *class* dtools.queues.de.DEQueue: Double-Ended Queue
+
+Create queues from specific values:
+
+- *function* dtools.queues.fifo.fifo_queue: Create a FIFOQueue
+
+  - from function's arguments pushed on in natural FIFO order
+
+- *function* dtools.queues.lifo.lifo_queue: Create a LIFOQueue
+
+  - from function's arguments pushed on in natural LIFO order
+
+- *function* dtools.queues.de.de_queue: Create a DEQueue
+
+  - from function's arguments pushed on from the right
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp/queues/de.py

@@ -0,0 +1,190 @@
+# Copyright 2023-2024 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.
+
+"""
+### Double-Ended (DE) Queue
+
+- stateful DE queue data structures with amortized O(1) pushes and pops each end
+- obtaining length (number of elements) of a queue is an O(1) operation
+- implemented in a "has-a" relationship with a Python list based circular array
+- will resize itself larger as needed
+
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import Never, overload, TypeVar
+
+from pythonic_fp.circulararray import CA
+from pythonic_fp.containers.maybe import MayBe as MB
+
+
+__all__ = ['DEQueue', 'de_queue']
+
+D = TypeVar('D')
+
+
+class DEQueue[D]:
+    """Double Ended Queue
+
+    - stateful Double-Ended (DEQueue) data structure
+    - order of initial data retained, as if pushed on from the right
+    """
+    L = TypeVar('L')
+    R = TypeVar('R')
+
+    __slots__ = ('_ca',)
+
+    U = TypeVar('U')
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if (size := len(dss)) < 2:
+            self._ca = CA(dss[0]) if size == 1 else CA()
+        else:
+            msg = f'DEQueue expects at most 1 iterable argument, got {size}'
+            raise TypeError(msg)
+
+    def __bool__(self) -> bool:
+        return len(self._ca) > 0
+
+    def __len__(self) -> int:
+        return len(self._ca)
+
+    def __eq__(self, other: object, /) -> bool:
+        if not isinstance(other, DEQueue):
+            return False
+        return self._ca == other._ca
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> Sequence[D]: ...
+
+    def __getitem__(self, idx: int | slice, /) -> D | Sequence[D] | Never:
+        if isinstance(idx, slice):
+            msg = 'dtool.restictive queues are not slicable by design'
+            raise NotImplementedError(msg)
+        return self._ca[idx]
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(list(self._ca))
+
+    def __reversed__(self) -> Iterator[D]:
+        return reversed(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'DQ()'
+        return 'DQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return '>< ' + ' | '.join(map(str, self)) + ' ><'
+
+    def copy(self) -> DEQueue[D]:
+        """Return a shallow copy of the ``DEQueue``."""
+        return DEQueue(self._ca)
+
+    def pushl(self, *ds: D) -> None:
+        """Push data onto left side (front) of ``DEQueue``."""
+        self._ca.pushl(*ds)
+
+    def pushr(self, *ds: D) -> None:
+        """Push data onto right side (rear) of ``DEQueue``.
+        Like a Python List, does not return a value.
+        """
+        self._ca.pushr(*ds)
+
+    def popl(self) -> MB[D]:
+        """Pop Data from left side (front) of ``DEQueue``.
+
+        - pop left most item off of queue, return item in a maybe monad
+        - returns an empty ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca.popl())
+        return MB()
+
+    def popr(self) -> MB[D]:
+        """Pop Data from right side (rear) of ``DEQueue``.
+
+        - pop right most item off of queue, return item in a maybe monad
+        - returns an empty ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca.popr())
+        return MB()
+
+    def peakl(self) -> MB[D]:
+        """Peak left side of ``DEQueue``.
+
+        - return left most value in a maybe monad
+        - does not consume the item
+        - returns an empty ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca[0])
+        return MB()
+
+    def peakr(self) -> MB[D]:
+        """Peak right side of ``DEQueue``.
+
+        - return right most value in a maybe monad
+        - does not consume the item
+        - returns an empty ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        return MB()
+
+    def foldl[L](self, f: Callable[[L, D], L], initial: L | None = None, /) -> MB[L]:
+        """Reduce left to right with ``f`` using an optional initial value.
+
+        - note that when an initial value is not given then ``~L = ~D``
+        - if iterable empty & no initial value given, return ``MB()``
+        - traditional FP type order given for function ``f``
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldl(f, initial))
+
+    def foldr[R](self, f: Callable[[D, R], R], initial: R | None = None, /) -> MB[R]:
+        """Reduce right to left with ``f`` using an optional initial value.
+
+        - note that when an initial value is not given then ``~R = ~D``
+        - if iterable empty & no initial value given, return ``MB()``
+        - traditional FP type order given for function ``f``
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldr(f, initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> DEQueue[U]:
+        """Map a function over ``DEQueue``.
+
+        - map the function ``f`` over the ``DEQueue``
+
+          - left to right
+          - retain original order
+
+        - returns a new instance
+        """
+        return DEQueue(map(f, self._ca))
+
+
+def de_queue[D](*ds: D) -> DEQueue[D]:
+    """Create a ``DEQueue`` from the function arguments."""
+    return DEQueue(ds)

pythonic_fp/queues/fifo.py

@@ -0,0 +1,150 @@
+# Copyright 2023-2024 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.
+
+"""First-In-Last-Out (FIFO) Queue"""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import Never, overload, TypeVar
+
+from pythonic_fp.circulararray import CA
+from pythonic_fp.containers.maybe import MayBe as MB
+
+
+__all__ = ['FIFOQueue', 'fifo_queue']
+
+D = TypeVar('D')
+
+
+class FIFOQueue[D]:
+    """FIFO Queue
+
+    - stateful First-In-First-Out (FIFO) data structure
+    - initial data pushed on in natural FIFO order
+    """
+
+    __slots__ = ('_ca',)
+
+    T = TypeVar('T')
+    U = TypeVar('U')
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if (size := len(dss)) < 2:
+            self._ca = CA(dss[0]) if size == 1 else CA()
+        else:
+            msg = f'FIFOQueue expects at most 1 iterable argument, got {size}'
+            raise ValueError(msg)
+
+    def __bool__(self) -> bool:
+        return len(self._ca) > 0
+
+    def __len__(self) -> int:
+        return len(self._ca)
+
+    def __eq__(self, other: object, /) -> bool:
+        if not isinstance(other, FIFOQueue):
+            return False
+        return self._ca == other._ca
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> Sequence[D]: ...
+
+    def __getitem__(self, idx: int | slice, /) -> D | Sequence[D] | Never:
+        if isinstance(idx, slice):
+            msg = 'dtool.restictive queues are not slicable by design'
+            raise NotImplementedError(msg)
+        return self._ca[idx]
+
+    def __iter__(self) -> Iterator[D]:
+        return iter(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'FQ()'
+        return 'FQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return '<< ' + ' < '.join(map(str, self)) + ' <<'
+
+    def copy(self) -> FIFOQueue[D]:
+        """Return a shallow copy of the ``FIFOQueue``."""
+        return FIFOQueue(self._ca)
+
+    def push(self, *ds: D) -> None:
+        """Push data onto ``FIFOQueue``, does not return a value."""
+        self._ca.pushr(*ds)
+
+    def pop(self) -> MB[D]:
+        """Pop data from ``FIFOQueue``.
+
+        - pop item off queue, return item in a maybe monad
+        - returns an empty ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca.popl())
+        return MB()
+
+    def peak_last_in(self) -> MB[D]:
+        """Peak last data into ``FIFOQueue``.
+
+        - return a maybe monad of the last item pushed to queue
+        - does not consume the data
+        - if item already popped, return ``MB()``
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        return MB()
+
+    def peak_next_out(self) -> MB[D]:
+        """Peak next data out of ``FIFOQueue``.
+
+        - returns a maybe monad of the next item to be popped from the queue.
+        - does not consume it the item
+        - returns ``MB()`` if queue is empty
+        """
+        if self._ca:
+            return MB(self._ca[0])
+        return MB()
+
+    def fold[T](self, f: Callable[[T, D], T], initial: T | None = None, /) -> MB[T]:
+        """Reduce with ``f`` with an optional initial value.
+
+        - folds in natural FIFO Order (oldest to newest)
+        - note that when an initial value is not given then ``~L = ~D``
+        - if iterable empty & no initial value given, return ``MB()``
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldl(f, initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> FIFOQueue[U]:
+        """Map over the ``FIFOQueue``.
+
+        - map function ``f`` over the queue
+
+          - oldest to newest
+          - retain original order
+
+        - returns a new instance
+        """
+        return FIFOQueue(map(f, self._ca))
+
+
+def fifo_queue[D](*ds: D) -> FIFOQueue[D]:
+    """Create a FIFOQueue from the arguments."""
+    return FIFOQueue(ds)

pythonic_fp/queues/lifo.py

@@ -0,0 +1,152 @@
+# Copyright 2023-2024 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.
+
+"""
+### Last-In-Last-Out (LIFO) Queue
+
+- stateful LIFO queue data structures with amortized O(1) pushes and pops
+- obtaining length (number of elements) of a queue is an O(1) operation
+- implemented in a "has-a" relationship with a Python list based circular array
+- will resize itself larger as needed
+
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable, Iterable, Iterator, Sequence
+from typing import Never, TypeVar, overload
+
+from pythonic_fp.circulararray import CA
+from pythonic_fp.containers.maybe import MayBe as MB
+from pythonic_fp.fptools.function import swap
+
+__all__ = ['LIFOQueue', 'lifo_queue']
+
+D = TypeVar('D')
+
+
+class LIFOQueue[D]:
+    """LIFO Queue.
+
+    - stateful Last-In-First-Out (LIFO) data structure
+    - initial data pushed on in natural LIFO order
+
+    """
+
+    __slots__ = ('_ca',)
+
+    T = TypeVar('T')
+    U = TypeVar('U')
+
+    def __init__(self, *dss: Iterable[D]) -> None:
+        if (size := len(dss)) < 2:
+            self._ca = CA(dss[0]) if size == 1 else CA()
+        else:
+            msg = f'LIFOQueue expects at most 1 iterable argument, got {size}'
+            raise TypeError(msg)
+
+    def __bool__(self) -> bool:
+        return len(self._ca) > 0
+
+    def __len__(self) -> int:
+        return len(self._ca)
+
+    def __eq__(self, other: object, /) -> bool:
+        if not isinstance(other, LIFOQueue):
+            return False
+        return self._ca == other._ca
+
+    @overload
+    def __getitem__(self, idx: int, /) -> D: ...
+    @overload
+    def __getitem__(self, idx: slice, /) -> Sequence[D]: ...
+
+    def __getitem__(self, idx: int | slice, /) -> D | Sequence[D] | Never:
+        if isinstance(idx, slice):
+            msg = 'dtool.restictive queues are not slicable by design'
+            raise NotImplementedError(msg)
+        return self._ca[idx]
+
+    def __iter__(self) -> Iterator[D]:
+        return reversed(list(self._ca))
+
+    def __repr__(self) -> str:
+        if len(self) == 0:
+            return 'LQ()'
+        return 'LQ(' + ', '.join(map(repr, self._ca)) + ')'
+
+    def __str__(self) -> str:
+        return '|| ' + ' > '.join(map(str, self)) + ' ><'
+
+    def copy(self) -> LIFOQueue[D]:
+        """Return a shallow copy of the ``LIFOQueue``."""
+        return LIFOQueue(reversed(self._ca))
+
+    def push(self, *ds: D) -> None:
+        """Push data onto ``LIFOQueue``, does not return a value."""
+        self._ca.pushr(*ds)
+
+    def pop(self) -> MB[D]:
+        """Pop data from ``LIFOQueue``.
+
+        - pop item off of queue, return item in a maybe monad
+        - returns an empty ``MB()`` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca.popr())
+        return MB()
+
+    def peak(self) -> MB[D]:
+        """Peak next data out of ``LIFOQueue``.
+
+        - return a maybe monad of the next item to be popped from the queue
+        - does not consume the item
+        - returns ``MB()`` if queue is empty
+
+        """
+        if self._ca:
+            return MB(self._ca[-1])
+        return MB()
+
+    def fold[T](self, f: Callable[[T, D], T], initial: T | None = None, /) -> MB[T]:
+        """Reduce with ``f`` with an optional initial value.
+
+        - folds in natural LIFO Order (newest to oldest)
+        - note that when an initial value is not given then ``~T = ~D``
+        - if iterable empty & no initial value given, return ``MB()``
+
+        """
+        if initial is None:
+            if not self._ca:
+                return MB()
+        return MB(self._ca.foldr(swap(f), initial))
+
+    def map[U](self, f: Callable[[D], U], /) -> LIFOQueue[U]:
+        """Map Over the ``LIFOQueue``.
+
+        - map the function ``f`` over the queue
+
+          - newest to oldest
+          - retain original order
+
+        - returns a new instance
+
+        """
+        return LIFOQueue(reversed(CA(map(f, reversed(self._ca)))))
+
+
+def lifo_queue[D](*ds: D) -> LIFOQueue[D]:
+    """Create a LIFOQueue from the arguments."""
+    return LIFOQueue(ds)

pythonic_fp_queues-3.0.0.dist-info/METADATA

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: pythonic-fp.queues
+Version: 3.0.0
+Summary: Developer Tools - Queue based data structures
+Keywords: dqueue,fifo,lifo,queue
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+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.13
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: pythonic-fp.circulararray >= 5.0.0
+Requires-Dist: pythonic-fp.containers >=2.0.0
+Requires-Dist: pythonic-fp.fptools >=3.0.0
+Project-URL: Changelog, https://grscheller.github.io/pythonic-fp-queues/html/changelog.html
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-queues/html/
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-queues
+
+# Pythonic FP - Queues
+
+PyPI project
+[pythonic-fp.queues](https://pypi.org/project/pythonic-fp.queues/)
+Implementing 3 types of queue data structures.
+
+| Class     | Queue Type               |
+|:---------:|:------------------------ |
+| FIFOQueue | First-In-First-Out Queue |
+| LIFOQueue | Last-In-First-Out Queue  |
+| DEQueue   | Double-Ended Queue       |
+
+This PyPI project is part of of the grscheller
+[pythonic-fp namespace projects](https://github.com/grscheller/pythonic-fp/blob/main/README.md).
+
+## Documentation
+
+Documentation hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp-queues/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_queues-3.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pythonic_fp/queues/__init__.py,sha256=9gxtZ2HyHWVcpcTmTOc_ZNf4-WYGhRMOwhoOf64ulP8,1519
+pythonic_fp/queues/de.py,sha256=d4mgLa5MMPxjzWSEbOhWv1RuJtMwViZR4dxPYKezsUk,5918
+pythonic_fp/queues/fifo.py,sha256=IePckXP722Ky_MKZySawY-q9cFJ6XcMCa_eWXRrbPhI,4519
+pythonic_fp/queues/lifo.py,sha256=LuA3sg5uTMZMXFrf3hTPVDDJ9jbmdKqZNv0zBjcCUrk,4553
+pythonic_fp/queues/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_queues-3.0.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_queues-3.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_queues-3.0.0.dist-info/METADATA,sha256=svlf8vGt6_z1PwRAoyYG67cR2HbmxhnYCjkGFMtoSsI,1858
+pythonic_fp_queues-3.0.0.dist-info/RECORD,,

pythonic_fp_queues-3.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pythonic_fp_queues-3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright (c) 2023-2025 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.