pythonic-fp-gadgets 2.2.0__py3-none-any.whl

pythonic_fp/gadgets/__init__.py

@@ -0,0 +1,33 @@
+# Copyright 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.
+
+"""Simple Gadgets.
+
+Library of simple, but useful, functions and classes with minimal dependencies.
+
++-------------------------------------+-----------------------------------+------------------------------+
+| Gadget                              | Description                       | Module                       |
++=====================================+===================================+==============================+
+| class ``Box``                       | Single item box                   | ``pythonic_fp.gadgets.box``  |
++-------------------------------------+-----------------------------------+------------------------------+
+| function ``it``                     | Returns iterator of its arguments | ``pythonic_fp.gadgets.it``   |
++-------------------------------------+-----------------------------------+------------------------------+
+| function ``latest_common_ancestor`` | Find least common base class      | ``pythonic_fp.gadgets.lca``  |
++-------------------------------------+-----------------------------------+------------------------------+
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp/gadgets/box.py

@@ -0,0 +1,172 @@
+# Copyright 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.
+
+"""Class for a stateful container that can hold at most one item."""
+
+__all__ = ['Box']
+
+from collections.abc import Callable, Iterator
+from typing import ClassVar, cast, Final, Never, overload, TypeVar
+from pythonic_fp.sentinels.flavored import Sentinel
+
+T = TypeVar('T')
+
+
+class Box[T]:
+    """Container holding at most one item of a given type.
+
+    .. note::
+
+         - ``Box(item: T)``: contains at one item of type ``T``
+         - ``Box[T]()``: creates empty container
+
+       Where type ``T`` is some definite type, which
+       could be ``None`` or even ``Never``.
+
+    .. tip ::
+
+       ``Box`` objects can be used in Python match statements.
+
+    """
+    __slots__ = ('_item',)
+    __match_args__ = ('_item',)
+
+    _sentinel: Final[ClassVar[Sentinel[str]]] = Sentinel('_Box')
+
+    @overload
+    def __init__(self) -> None: ...
+    @overload
+    def __init__(self, item: T) -> None: ...
+
+    def __init__(self, item: T | Sentinel[str] = Sentinel('_Box')) -> None:
+        """
+        :param item: an "optional" initial contained ``item`` for the ``Box``.
+        :returns: New ``Box`` instance.
+
+        """
+        self._item = item
+
+    def __bool__(self) -> bool:
+        return self._item is not Sentinel('_Box')
+
+    def __iter__(self) -> Iterator[T]:
+        if self:
+            yield cast(T, self._item)
+
+    def __repr__(self) -> str:
+        if self:
+            return 'Box(' + repr(self._item) + ')'
+        return 'Box()'
+
+    def __len__(self) -> int:
+        return 1 if self else 0
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._item is other._item:
+            return True
+        if self._item == other._item:
+            return True
+        return False
+
+    @overload
+    def get(self) -> T | Never: ...
+    @overload
+    def get(self, alt: T) -> T: ...
+
+    def get(self, alt: T | Sentinel[str] = Sentinel('_Box')) -> T | Never:
+        """Return the contained item if it exists, otherwise an alternate item.
+
+        :param alt: an "optional" item of type ``T`` to return if ``Box`` is empty
+        :returns: contents of ``Box``, or an alternate item if given and ``Box`` empty
+        :raises ValueError: when an ``alt`` item is not provided but needed
+
+        """
+        if self._item is not self._sentinel:
+            return cast(T, self._item)
+        if alt is self._sentinel:
+            msg = 'Box: get from empty Box with no alternate return item provided'
+            raise ValueError(msg)
+        return cast(T, alt)
+
+    def pop(self) -> T | Never:
+        """Pop the contained item if ``Box`` is not empty.
+
+        :returns: item contained in the ``Box``
+        :raises: ``ValueError`` if Box is empty
+
+        """
+        if self._item is self._sentinel:
+            msg = 'Box: Trying to pop an item from an empty Box'
+            raise ValueError(msg)
+        popped = cast(T, self._item)
+        self._item = self._sentinel
+        return popped
+
+    def push(self, item: T) -> None | Never:
+        """Push an item into an empty ``Box``.
+
+        :param item: Item to push into the empty ``Box``.
+        :raises ValueError: If ``Box`` is not empty.
+
+        """
+        if self._item is Sentinel('_Box'):
+            self._item = item
+        else:
+            msg = 'Box: Trying to push an item in a non-empty Box'
+            raise ValueError(msg)
+        return None
+
+    def put(self, item: T) -> None:
+        """Put an item in the Box. Discard any previous contents."""
+        self._item = item
+
+    def exchange(self, new_item: T) -> T | Never:
+        """Exchange an item with what is in the Box.
+
+        :param ``new_item``: New item to exchange for current item.
+        :returns: Original contents of the ``Box``.
+        :raises ValueError: If Box is empty.
+        """
+        if self._item is self._sentinel:
+            msg = 'Box: Trying to exchange items from an empty Box'
+            raise ValueError(msg)
+        popped = cast(T, self._item)
+        self._item = new_item
+        return popped
+
+    def map[U](self, f: Callable[[T], U]) -> 'Box[U]':
+        """Map function ``f`` over contents. We need to return a new
+        instance since the type of Box can change.
+
+        :param f: mapping function
+        :returns: a new instance
+
+        """
+        if self._item is Sentinel('_Box'):
+            return Box()
+        return Box(f(cast(T, self._item)))
+
+    def bind[U](self, f: Callable[[T], 'Box[U]']) -> 'Box[U]':
+        """Flatmap ``Box`` with function ``f``.
+
+        :param f: binding function
+        :returns: a new instance
+
+        """
+        if self._item is self._sentinel:
+            return Box()
+        return f(cast(T, self._item))

pythonic_fp/gadgets/box.pyi

@@ -0,0 +1,29 @@
+from _typeshed import Incomplete
+from collections.abc import Callable, Iterator
+from typing import Never, TypeVar, overload
+
+__all__ = ['Box']
+
+T = TypeVar('T')
+
+class Box[T]:
+    __match_args__: Incomplete
+    T = TypeVar('T')
+    @overload
+    def __init__(self) -> None: ...
+    @overload
+    def __init__(self, item: T) -> None: ...
+    def __bool__(self) -> bool: ...
+    def __iter__(self) -> Iterator[T]: ...
+    def __len__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    @overload
+    def get(self) -> T | Never: ...
+    @overload
+    def get(self, alt: T) -> T: ...
+    def pop(self) -> T | Never: ...
+    def push(self, item: T) -> None | Never: ...
+    def put(self, item: T) -> None: ...
+    def exchange(self, new_item: T) -> T | Never: ...
+    def map[U](self, f: Callable[[T], U]) -> Box[U]: ...
+    def bind[U](self, f: Callable[[T], 'Box[U]']) -> Box[U]: ...

pythonic_fp/gadgets/it.py

@@ -0,0 +1,36 @@
+# Copyright 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.
+
+"""Function which returns an iterator of its arguments."""
+
+from collections.abc import Iterator
+
+__all__ = ['it']
+
+
+def it[A](*args: A) -> Iterator[A]:
+    """Function returning an iterator of its arguments.
+
+    .. note::
+
+       Does not create an object to iterate over.
+
+         - well, not in the Python world
+         - maybe in the C world
+
+    :param args: Objects to iterate over.
+    :returns: An iterator of the arguments.
+
+    """
+    yield from args

pythonic_fp/gadgets/it.pyi

@@ -0,0 +1,5 @@
+from collections.abc import Iterator
+
+__all__ = ['it']
+
+def it[A](*args: A) -> Iterator[A]: ...

pythonic_fp/gadgets/lca.py

@@ -0,0 +1,52 @@
+# Copyright 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.
+
+"""Lastest Common Ancestor of Two Classes."""
+
+from inspect import getmro
+from typing import Never
+
+__all__ = ['latest_common_ancestor']
+
+
+def latest_common_ancestor(cls1: type, cls2: type) -> type | Never:
+    """Find the least upper bound in the inheritance graph
+    of two classes.
+
+    .. warning::
+
+       This function can fail with a TypeError. Some error messages
+       seen are
+
+         - multiple bases have instance lay-out conflict
+         - type 'bool' is not an acceptable base type
+
+       This happens frequently when the function is given
+       Python builtin types.
+
+    :param cls1: first class
+    :param cls2: second class
+    :returns: Least common ancestor base class of ``cls1`` and ``cls2``.
+    :raises TypeError: theoretically only from ``inspect.getmto``
+
+    """
+    if issubclass(cls1, cls2):
+        return cls2
+    if issubclass(cls2, cls1):
+        return cls1
+
+    for common_ancestor in getmro(type('LcaDiamondClass', (cls1, cls2), {})):
+        if issubclass(cls1, common_ancestor) and issubclass(cls2, common_ancestor):
+            return common_ancestor
+    raise TypeError("latest_common_ancestor: no common ancestor found!!!") 

pythonic_fp/gadgets/lca.pyi

@@ -0,0 +1,5 @@
+from typing import Never
+
+__all__ = ['latest_common_ancestor']
+
+def latest_common_ancestor(cls1: type, cls2: type) -> type | Never: ...

pythonic_fp_gadgets-2.2.0.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-gadgets
+Version: 2.2.0
+Summary: Simple Gadgets.
+Keywords: gadgets
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+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-sentinels>=2.1.0
+Requires-Dist: pytest>=8.4.1 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/gadgets/development/build/html/releases.html
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-gadgets
+Provides-Extra: test
+
+Pythonic FP - Gadgets
+=====================
+
+PyPI project
+`pythonic-fp
+<https://pypi.org/project/pythonic-fp>`_.
+
+Library of simple, but useful, data structures with minimal dependencies.
+
+- single item box
+- function returning iterator of its arguments
+- find the last common ancestor of two classes
+
+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 for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/gadgets/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_gadgets-2.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+pythonic_fp/gadgets/__init__.py,sha256=lXVeP7kcS60TErlGUjUCfnZ8uWNF0FAoVTQ5dLHjOB0,1794
+pythonic_fp/gadgets/box.py,sha256=_3OA7Idvy7Oce3V8hp1pg8YSG7ch8kq36LVcU7OgHU8,5318
+pythonic_fp/gadgets/box.pyi,sha256=yap1syNrDMbO05bi8rltaKtaZssZrKdy7mQ1LXWKNt8,900
+pythonic_fp/gadgets/it.py,sha256=Zwk0ZE49sky_LRKwvzKjjv-_64cq7omVT1JZO5irxhI,1055
+pythonic_fp/gadgets/it.pyi,sha256=BI_0BuEd5lYSRhx591iUsQbfR2tSAcRiz5jn1Go4ASg,96
+pythonic_fp/gadgets/lca.py,sha256=I841udZLmm6WbF7SLI8xHzGCGUKM-QIp1bNHgGycklI,1763
+pythonic_fp/gadgets/lca.pyi,sha256=PYWPpmrM7238cpXmYyi5uPlSUsAiYVA0Chgq3VUUbyY,136
+pythonic_fp/gadgets/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_gadgets-2.2.0.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_gadgets-2.2.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_gadgets-2.2.0.dist-info/METADATA,sha256=ys2SZaA5nNiMrLa_D2WW8uBv6AYXPXpdehJtvcTNbHo,1821
+pythonic_fp_gadgets-2.2.0.dist-info/RECORD,,

pythonic_fp_gadgets-2.2.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_gadgets-2.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                 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